用戶登錄
在之前的文章中我們實現了用戶注冊和驗證功能,接下來我們繼續實現它的登錄,以及登錄成功之后要在頁面上顯示的信息。
接下來,我們來編寫代碼。
實現service
在com.liferunner.service.IUserService
接口中添加用戶登錄方法:
public interface IUserService {
...
/**
* 用戶登錄
* @param userRequestDTO 請求dto
* @return 登錄用戶信息
* @throws Exception
*/
Users userLogin(UserRequestDTO userRequestDTO) throws Exception;
}
然后,在com.liferunner.service.impl.UserServiceImpl
實現類中實現:
@Service
@Slf4j
public class UserServiceImpl implements IUserService {
...
@Override
public Users userLogin(UserRequestDTO userRequestDTO) throws Exception {
log.info("======用戶登錄請求:{}", userRequestDTO);
Example example = new Example(Users.class);
val condition = example.createCriteria();
condition.andEqualTo("username", userRequestDTO.getUsername());
condition.andEqualTo("password", MD5GeneratorTools.getMD5Str(userRequestDTO.getPassword()));
val user = this.usersMapper.selectOneByExample(example);
log.info("======用戶登錄處理結果:{}", user);
return user;
}
}
Error Tips:
這里有一個小小的坑點
,大家一定要注意,在使用selectOneByExample()
查詢的時候,該方法傳入的參數一定注意是tk.mybatis.mapper.entity.Example
實例,而不是tk.mybatis.mapper.entity.Example.Criteria
,否則會報動態SQL生成查詢錯誤,信息如下:
org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'distinct' in 'class tk.mybatis.mapper.entity.Example$Criteria'
at org.mybatis.spring.MyBatisExceptionTranslator.translateExceptionIfPossible(MyBatisExceptionTranslator.java:92)
at org.mybatis.spring.SqlSessionTemplate$SqlSessionInterceptor.invoke(SqlSessionTemplate.java:440)
at com.sun.proxy.$Proxy106.selectOne(Unknown Source)
at org.mybatis.spring.SqlSessionTemplate.selectOne(SqlSessionTemplate.java:159)
at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:87)
at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:93)
at com.sun.proxy.$Proxy109.selectOneByExample(Unknown Source)
at com.liferunner.service.impl.UserServiceImpl.userLogin(UserServiceImpl.java:80)
...
新人在寫代碼的時候,特別容易在上一行寫了查詢變量,下一行就直接開用了,越是簡單的錯誤越是讓人無從下手。
實現Controller
@RestController
@RequestMapping(value = "/users")
@Slf4j
@Api(tags = "用戶管理")
public class UserController {
...
@ApiOperation(value = "用戶登錄", notes = "用戶登錄接口")
@PostMapping("/login")
public JsonResponse userLogin(@RequestBody UserRequestDTO userRequestDTO,
HttpServletRequest request,
HttpServletResponse response) {
try {
if (StringUtils.isBlank(userRequestDTO.getUsername()))
return JsonResponse.errorMsg("用戶名不能為空");
if (StringUtils.isBlank(userRequestDTO.getPassword()) ||
userRequestDTO.getPassword().length() < 8) {
return JsonResponse.errorMsg("密碼為空或長度小於8位");
}
val user = this.userService.userLogin(userRequestDTO);
UserResponseDTO userResponseDTO = new UserResponseDTO();
BeanUtils.copyProperties(user, userResponseDTO);
log.info("BeanUtils copy object {}", userResponseDTO);
if (null != userResponseDTO) {
// 設置前端存儲的cookie信息
CookieTools.setCookie(request, response, "user",
JSON.toJSONString(userResponseDTO), true);
return JsonResponse.ok(userResponseDTO);
}
} catch (Exception e) {
e.printStackTrace();
log.error("用戶登錄失敗,{},exception = {}", userRequestDTO, e.getMessage());
}
return JsonResponse.errorMsg("用戶登錄失敗");
}
}
在上面的代碼中,基本校驗問題就不再贅述,我們主要關注幾點新的特性信息:
com.liferunner.dto.UserResponseDTO
將我們需要展示給前端的數據封裝為一個新的返回對象,我們從數據庫中查詢出來的Users
pojo包含用戶的所有數據,比如其中的password
、mobile
等等一些用戶私密的數據是不應該展示給前端的,即便要展示,那也是需要經過脫敏以及加密。因此,常見的做法就是封裝一個新的返回對象,其中只需要包含前端需要的數據字段就可以了。
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(value = "用戶信息返回DTO", description = "用戶登錄成功后需要的返回對象")
public class UserResponseDTO {
/**
* 主鍵id
*/
private String id;
/**
* 用戶名
*/
private String username;
/**
* 昵稱 昵稱
*/
private String nickname;
/**
* 頭像
*/
private String face;
/**
* 性別 1:男 0:女 2:保密
*/
private Integer sex;
}
在這里建議大家使用Ctrl+C
我們的com.liferunner.pojo.Users
對象,然后刪除掉我們不需要的字段就可以了,為什么這么建議
呢,是因為下一個好處啦。
-
org.springframework.beans.BeanUtils.copyProperties(user, userResponseDTO);
大家可以看到,這里直接使用的是Spring BeanUtils
工具類進行的值拷貝,就減少了我們循環遍歷每一個字段去挨個賦值(SetValue)
的工作。(也是一種偷懶小技巧哦,這樣是不對的~) -
CookieTools.setCookie();
之前我們有提過,一般情況下,我們用戶登錄之后,數據都會被存儲在本地瀏覽器Cookie
中,比如我登錄的baidu.com
:
此時,鼠標在圖片中左側的Cookies => www.baidu.com
右鍵clear
,然后再次刷新我們當前界面,效果如下:
我們可以看到,從登錄狀態已經變為退出狀態了,並且Cookies
中的內容也少了很多,這就說明,百度是把我們的用戶登錄信息加密后存儲在了瀏覽器cookie中。
大家可以查看京東,淘寶等等,也是基於這種方式實現的,開篇之初就說過,我們的系統是基於生產來實現的demo,那么我們就是用主流的實現方法來做。當然,有的同學會說,這個應該我們把數據傳遞給前端,讓前端來實現的!!!當然,你說的對,可是我們掌握一種實現方式,對於我們個人而言應該是沒有壞處的吧?
這里就需要一個工具類了,大家可以在github傳送門來下載相關代碼。目錄com.liferunner.utils.CookieTools
. -
com.alibaba.fastjson.JSON.toJSONString(userResponseDTO)
因為我們要返回的是一個對象,但是cookie
中我們需要放入的是String
,這里我們引入了alibaba的JSON工具,在mscx-shop-common/pom.xml
,加入依賴:<dependencies> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.56</version> </dependency> </dependencies>
用戶登出
在用戶操作結束之后,我們需要將用戶從系統中退出登錄,因為我們的用戶登錄信息會存儲在瀏覽器cookie中,因此,我們需要根據用戶的登出操作來刪除相關用戶緩存:
@ApiOperation(value = "用戶登出",notes = "用戶登出",httpMethod = "POST")
@PostMapping("/logout")
public JsonResponse userLogout(@RequestParam String uid,
HttpServletRequest request,HttpServletResponse response){
// clear front's user cookies
CookieTools.deleteCookie(request,response,"user");
// return operational result
return JsonResponse.ok();
}
開發調試小福利
java日志追蹤
一般在電商場景中,對於請求的響應時間有着極其嚴格的要求,比如你在一個網站買商品的時候,如果每點擊一次按鈕都要等待,或者系統感覺卡頓一下,你會毫不猶豫的選擇右上角的小紅叉
,把它干掉。因此,在我們系統的開發過程中,很多時候需要對我們的請求響應時間進行監控,甚至會通過壓力測試來進行測試。但是,讓我們在每一個方法中都做這種請求的實現,顯然是不合理甚至說是讓開發人員難受的,所以,我們來實現一種通用的做法,那就是通過AOP
,面向切面來實現。關於切面的基本使用,大家可以參考AOP傳送門,接下來,開始我們的編碼。
根據springboot
實現功能三部曲:
setp 1. 添加依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
step 2. 啟動配置(沒有就忽略掉這一步)
setp 3. 加注解
在我們的mscx-shop-api
項目中,創建com.liferunner.api.aspect
package,然后創建com.liferunner.api.aspect.CommonLogAspect
,代碼如下:
package com.liferunner.api.aspect;
import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* CommonLogAspect for : AOP切面實現日志確認
*
* @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang | 若初</a>
* @since 2019/11/11
*/
@Component
@Aspect
@Slf4j
public class CommonLogAspect {
@Around("execution(* com.liferunner.api.controller..*.*(..))")
public void recordLogTime(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
log.info("----------- {}.{} process log time started.---------------",
proceedingJoinPoint.getTarget().getClass(),
proceedingJoinPoint.getSignature().getName());
val startTime = System.currentTimeMillis();
proceedingJoinPoint.proceed();
val afterTime = System.currentTimeMillis();
if (afterTime - startTime > 1000) {
log.warn("cost : {}", afterTime - startTime);
} else {
log.info("cost : {}", afterTime - startTime);
}
log.info("----------- {}.{} process log time ended.---------------",
proceedingJoinPoint.getSourceLocation().getClass(),
proceedingJoinPoint.getSignature().getName());
}
}
- 第一行日志代表我們想要監控的是哪個類的哪個方法
proceedingJoinPoint.proceed();
表示方法執行- 當請求查過1000ms的時候,我們使用
log.warn(...)
進行日志告警
step 4. 效果演示
- 查詢用戶耗時
- 注冊用戶耗時
從上圖,我們明顯能看出來我們每一次的請求耗時,之后就可以針對性的對每一個方法進行優化!!!
sql日志追蹤
在我們開發的過程中,往往會遇到針對數據庫的CRUD
的操作,但是,因為我們使用了mybatis
動態生成了簡單的SQL查詢,而不是手動編寫的,比如我們在UserServiceImpl.java
中實現的用戶查詢以及用戶注冊代碼中的tk.mybatis.mapper.entity.Example
以及 this.usersMapper.insertSelective(user);
public Users findUserByUserName(String username) {
// 構建查詢條件
Example example = new Example(Users.class);
val condition = example.createCriteria()
.andEqualTo("username", username);
return this.usersMapper.selectOneByExample(example);
}
@Transactional(propagation = Propagation.REQUIRED)
@Override
public Users createUser(UserRequestDTO userRequestDTO) throws Exception {
log.info("======begin create user : {}=======", userRequestDTO);
val user = Users.builder()
.id(sid.next()) //生成分布式id
.username(userRequestDTO.getUsername())
.password(MD5GeneratorTools.getMD5Str(userRequestDTO.getPassword()))
.birthday(DateUtils.parseDate("1970-01-01", "yyyy-MM-dd"))
.nickname(userRequestDTO.getUsername())
.face(this.FACE_IMG)
.sex(SexEnum.secret.type)
.createdTime(new Date())
.updatedTime(new Date())
.build();
this.usersMapper.insertSelective(user);
log.info("======end create user : {}=======", userRequestDTO);
return user;
}
一旦遇到了問題之后,我們往往不知道到底是哪里出現了錯誤,這個時候我們的SQL
是否有問題我們也不知道,因此,接下來我們來配置一種可以讓我們看
到SQL的小實現:
1.設置日志配置(如圖)
2.修改mybatis配置(log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
)
3.SELECT
效果演示
4.INSERT
效果演示
從上圖可以看出控制台JDBC操作進行了2次,其實第一次是對我們的用戶名進行校驗。第二次INSERT
是真實的插入。
通過上面的演示結果,大家可以想到,這個日志針在我們日常的開發中解決問題是非常有必要的。但是一定記得,在上生產的時候,日志一定要關閉,否則數據量一旦大了之后,會對系統的性能造成嚴重傷害!!!
源碼下載
下節預告
下一節我們將繼續開發我們電商的核心部分-商品以及廣告的展示,在過程中使用到的任何開發組件,我都會通過專門的一節來進行介紹的,兄弟們末慌!
gogogo!