專案介紹&功能實現
1.專案介紹&環境搭建
一個以社交平臺為核心的輕電商專案,功能如下:
簡訊登入、商戶查詢快取、優惠券秒殺、達人探店、好友關注、附近的商戶、使用者簽到、UV統計
1.1專案架構
1.2專案環境搭建
1.2.1後端專案搭建
mysql的版本採用5.7及以上版本
(1)首先建立資料庫,需要建立的表有:
- tb_user:使用者表
- tb_user_info:使用者詳情表
- tb_shop:商品資訊表
- tb_shop_type:商品型別表
- tb_blog:使用者日記表(達人探店日記)
- tb_follow:使用者關注表
- tb_voucher:優惠券表
- tb_voucher_order:優惠券的訂單表
(2)匯入專案依賴
<dependencies>
<!--SpringBoot整合的redis-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--資料庫連線池-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<!--web-starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mysql驅動-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
<version>5.1.47</version>
</dependency>
<!--Lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--springboot-test-starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--mybatisplus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.3</version>
</dependency>
<!--hutool-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.17</version>
</dependency>
</dependencies>
(3)application.yml配置檔案
server:
port: 8081
spring:
application:
name: hmdp
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/hmdp?useSSL=false&serverTimezone=UTC
username: root
password: 123456
redis:
host: 192.168.1.3
port: 6379
password: 123456
lettuce:
pool:
max-active: 10
max-idle: 10
min-idle: 1
time-between-eviction-runs: 10s
jackson:
default-property-inclusion: non_null # JSON處理時忽略非空欄位
mybatis-plus:
type-aliases-package: com.hmdp.entity # 別名掃描包
logging:
level:
com.hmdp: debug
1.2.2部署前端專案
這裡部署已經實現好的前端專案
(1)解壓檔案:
(2)使用CMD視窗啟動 nginx.exe:
(3)開啟谷歌瀏覽器---右鍵頁面,點選“檢查”--位址列訪問 127.0.0.1:8080,即可看到頁面:
(4)若要退出Nginx服務,只需在目錄下執行命令 nginx -s quit
參考:Nginx關閉方法
2.功能01-簡訊登入
2.1基於Session實現登入
2.1.1思路分析
2.1.2程式碼實現
2.1.2.1傳送簡訊驗證碼
傳送簡訊驗證碼:
傳送驗證碼的介面為:http://127.0.0.1:8080/api/user/code?phone=xxxxx<手機號>
請求方式:POST
請求路徑:/user/code
請求引數:phone,電話號碼
返回值:無
部分程式碼
(1)User類、UserDTO類(DTO類主要是為了儲存非敏感資料)
package com.hmdp.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 使用者實體類
*
* @author 李
* @version 1.0
*/
@Data
@EqualsAndHashCode(callSuper = false)
//chain = true,則對應欄位的setter方法呼叫後,會返回當前物件
@Accessors(chain = true)
@TableName("tb_user")
public class User implements Serializable {
private static final long serialVersionUID = 1L;
//使用者id(主鍵)
@TableId(value = "id", type = IdType.AUTO)
private Long id;
//手機號碼
private String phone;
//密碼
private String password;
//暱稱
private String nickName;
//使用者頭像
private String icon = "";
//建立時間
private LocalDateTime createTime;
//更新時間
private LocalDateTime updateTime;
}
package com.hmdp.dto;
import lombok.Data;
@Data
public class UserDTO {
private Long id;
private String nickName;
private String icon;
}
(2)UserMapper
package com.hmdp.mapper;
import com.hmdp.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* Mapper 介面
*
* @author 李
* @version 1.0
*/
public interface UserMapper extends BaseMapper<User> {
}
(3)IUserService
package com.hmdp.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.entity.User;
import javax.servlet.http.HttpSession;
/**
* 服務類
*
* @author 李
* @version 1.0
*/
public interface IUserService extends IService<User> {
Result sendCode(String phone, HttpSession session);
}
(4)UserServiceImpl.java
package com.hmdp.service.impl;
import cn.hutool.core.util.RandomUtil;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.hmdp.dto.Result;
import com.hmdp.entity.User;
import com.hmdp.mapper.UserMapper;
import com.hmdp.service.IUserService;
import com.hmdp.utils.RegexUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import javax.servlet.http.HttpSession;
/**
* 服務實現類
*
* @author 李
* @version 1.0
*/
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public Result sendCode(String phone, HttpSession session) {
//1.校驗手機號
boolean phoneInvalid = RegexUtils.isPhoneInvalid(phone);
//2.如果不符合,返回錯誤資訊
if (phoneInvalid) {//true表示不符合格式
return Result.fail("手機號格式錯誤!");
}
//3.符合,生成驗證碼
String code = RandomUtil.randomNumbers(6);//生成6位數的隨機號碼
//4.儲存驗證碼
session.setAttribute("user", BeanUtil.copyProperties(user, UserDTO.class));
//5.傳送驗證碼(由於這裡涉及到一些其他方的工具,先不做)
log.debug("傳送簡訊驗證碼成功,驗證碼={}", code);
//6.返回OK
return Result.ok();
}
}
(2)UserController.java
package com.hmdp.controller;
import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.entity.UserInfo;
import com.hmdp.service.IUserInfoService;
import com.hmdp.service.IUserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;
/**
* 前端控制器
*
* @author 李
* @version 1.0
*/
@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {
@Resource
private IUserService userService;
/**
* 傳送手機驗證碼
* @param phone 使用者輸入的手機號碼
* @param session session域
* @return
*/
@PostMapping("code")
public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {
//傳送簡訊驗證碼並儲存驗證碼
return userService.sendCode(phone,session);
}
}
測試:輸入手機號,點選傳送驗證碼,後臺輸出如下:
2.1.2.2簡訊驗證碼登入/註冊
當點選登入的時候,前端傳送的請求如下:
傳送驗證碼的介面為:http://127.0.0.1:8080/api/user/login
請求方式:POST
請求路徑:/user/login
請求引數:phone,code
返回值:無
部分程式碼
(1)修改IUserService.java,宣告login()方法
package com.hmdp.service;
import ...
/**
* 服務類
*
* @author 李
* @version 1.0
*/
public interface IUserService extends IService<User> {
Result login(LoginFormDTO loginForm, HttpSession session);
}
(3)修改UserServiceImpl.java,實現login()
package com.hmdp.service.impl;
import cn.hutool.core.util.RandomUtil;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.entity.User;
import com.hmdp.mapper.UserMapper;
import com.hmdp.service.IUserService;
import com.hmdp.utils.RegexUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import javax.servlet.http.HttpSession;
import static com.hmdp.utils.SystemConstants.USER_NICK_NAME_PREFIX;
/**
* 服務實現類
*
* @author 李
* @version 1.0
*/
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
//...
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) {
//1.校驗手機號
String phone = loginForm.getPhone();
if (RegexUtils.isPhoneInvalid(phone)) {
//如果不符合,返回錯誤資訊
return Result.fail("手機號格式錯誤!");
}
//2.校驗驗證碼
Object cacheCode = session.getAttribute("code");
String code = loginForm.getCode();
if (cacheCode == null || !cacheCode.toString().equals(code)) {
//cacheCode == null 說明沒有發過驗證碼,因為session裡面沒有存放
//!cacheCode.toString().equals(code) == true
//說明使用者輸入的驗證碼和session的不一致
return Result.fail("驗證碼錯誤");
}
//3.根據手機號查詢使用者是否已經註冊
User user = query().eq("phone", phone).one();
if (user == null) {
//若不存在,則在建立使用者
user = createUserWithPhone(phone);
}
//4.儲存使用者到session(這裡只儲存id、暱稱、手機號)
session.setAttribute("user", BeanUtil.copyProperties(user, UserDTO.class));
return Result.ok();
}
private User createUserWithPhone(String phone) {
//1.建立使用者
User user = new User();
//設定手機號
user.setPhone(phone);
//設定暱稱,初始值為隨機的15位字串
user.setNickName(USER_NICK_NAME_PREFIX + RandomUtil.randomString(10));
//2.儲存使用者到DB
save(user);
return user;
}
}
(3)修改UserController
/**
* 登入功能
* @param loginForm 登入引數:包含手機號+驗證碼,或手機號+密碼
* @param session session域
*/
@PostMapping("/login")
public Result login(@RequestBody LoginFormDTO loginForm, HttpSession session){
//實現登入功能
return userService.login(loginForm,session);
}
(4)測試:前端輸入手機號碼,和驗證碼,點選登入
後臺輸出:
2.1.2.3校驗登入狀態
以上的邏輯放到攔截器去實現,並使用ThreadLocal去儲存使用者資訊,實現執行緒安全。
(1)建立攔截器 LoginInterceptor
package com.hmdp.interceptor;
import cn.hutool.http.HttpStatus;
import com.hmdp.dto.UserDTO;
import com.hmdp.entity.User;
import com.hmdp.utils.UserHolder;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
/**
* @author 李
* @version 1.0
* 登入攔截器
*/
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//1.獲取session中的使用者
HttpSession session = request.getSession();
UserDTO userDTO = (UserDTO) session.getAttribute("user");
//2.判斷使用者是否登入過
if (userDTO == null) {
//如果沒有登入過,攔截,返回狀態碼-401
response.setStatus(HttpStatus.HTTP_UNAUTHORIZED);
return false;//攔截
}
//3.如果存在,儲存使用者到ThreadLocal
UserHolder.saveUser(userDTO);//這裡是一個工具類,自動建立ThreadLocal
ThreadLocal<UserDTO> userThreadLocal = new ThreadLocal<UserDTO>();
userThreadLocal.set(userDTO);
//4.放行
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
//移除使用者(根據當前執行緒,移除使用者資訊)
/**
* 為什麼要移除使用者?
* 因為ThreadLocal對應的是一個執行緒的中資料
* 每次http請求,tomcat都會建立一個新的執行緒
* 但是一次http請求結束後,如果web容器使用了執行緒池(執行緒被重複利用),
* 問題一:ThreadLocal的生命週期不等於一次Request的生命週期,造成獲取threadLocal內資料異常
* 問題二:記憶體溢位,ThreadLocal依賴沒有釋放,無法GC
* 因此,需要手動移除資料
*/
UserHolder.removeUser();
}
}
(2)配置攔截器 MvcConfig
package com.hmdp.config;
import com.hmdp.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* @author 李
* @version 1.0
*/
@Configuration
public class MvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
.addPathPatterns().
excludePathPatterns(
"/shop/**",
"/voucher/**",
"/shop-type/**",
"/upload/**",
"/blog/hot",
"/user/login",
"/user/code"
);
}
}
(3)修改UserController,獲取當前登入使用者資訊,並返回
/**
* @return 返回當前登入使用者的資訊
*/
@GetMapping("/me")
public Result me() {
//獲取當前登入的使用者並返回
UserDTO user = UserHolder.getUser();
return Result.ok(user);
}
(4)測試:登入使用者
後臺輸出:
返回的響應:
前端成功顯示登入後的使用者資訊:
2.2叢集的session共享問題
叢集的Session共享問題:多臺Tomcat並不共享它們之間的Session儲存空間,如果有多臺tomcat伺服器,當請求切換到不同tomcat服務時,會導致資料丟失的問題。
(1)問題具體分析:
如上,當請求進入Nginx時,Nginx會做一個負載均衡(一般是對tomcat叢集進行輪詢)。
假設使用者的請求第一次被負載均衡到了tomcat_1,例如之前的登入驗證,那麼tomcat_1就會將資訊儲存到它的session域中;
如果使用者第二次的請求被負載均衡到了tomcat_2,當tomcat_2要去獲取驗證碼或者使用者資訊的時候,由於多臺tomcat不能共享它們之間的Session儲存空間,導致tomcat_2不能獲取儲存在tomcat_1的session資料,表現出來就是資料丟失的問題。
(2)解決方案:
如圖,session的替代方案必須滿足:資料共享、記憶體儲存(快)、k-v結構(方便存/取資料)。
如果使用redis,則剛好可以滿足這些需求:
首先,redis是在tomcat之外的一個儲存方案,所有的tomcat都可以訪問到,解決了資料共享問題;
其次,redis是記憶體儲存,效能很強,讀寫很快,讀寫延時基本上是在微秒級別;
最後,redis是k-v結構,方便資料的存取。
綜上,我們下面將會使用redis來實現session登入。
2.3基於Redis實現共享session登入
2.3.1思路分析
(1)傳送簡訊驗證碼:
如左圖所示,當使用者傳送簡訊驗證碼時,將生成的驗證碼存入到redis中,為了讓一個手機號碼對應一個驗證碼,這裡使用手機號作為key,value則是驗證碼。(使用Redis-String型別)
(2)簡訊驗證碼登入、註冊:
使用redis代替之後,我們在獲取簡訊驗證碼的時候,也使用手機號為key去取驗證碼,這就解決了傳送和登入手機號可能不一致的問題。如果需要儲存使用者資訊,可以使用Redis-Hash型別。
(3)登入狀態校驗:
session機制:之前直接使用session儲存使用者資訊後,tomcat會自動給瀏覽器返回一個cookie(包含jsessionid),每次向服務端傳送請求時,都會自動攜帶。這樣tomcat根據jsessionid,就能自動找到session,也就能找到session裡的資料。
登入成功後,會儲存一個token到redis中作為key,value就是使用者資訊。我們可以模仿jsessionid,儲存token到redis時,同時將token放到cookie中,返回給客戶端,之後每次客戶端傳送請求,都會攜帶token,伺服器就可以獲取token,到redis去獲取使用者資訊,從而進行一系列業務流程。
登入憑證token儲存在前端瀏覽器:前端程式碼會儲存token到SessionStorage中,設定request攔截器,將使用者token放入請求頭中。這樣,每次傳送請求的時候都會使用token作為請求頭。我們在服務端就可以獲取token資料校驗。
2.3.2程式碼實現
2.3.2.1傳送簡訊驗證碼
在2.1程式碼的基礎上修改
修改UserServiceImpl.java的sendCode()方法
@Resource
private StringRedisTemplate stringRedisTemplate;
@Override
public Result sendCode(String phone, HttpSession session) {
//1.校驗手機號
boolean phoneInvalid = RegexUtils.isPhoneInvalid(phone);
//2.如果不符合,返回錯誤資訊
if (phoneInvalid) {//true表示不符合格式
return Result.fail("手機號格式錯誤!");
}
//3.符合,生成驗證碼
String code = RandomUtil.randomNumbers(6);//生成6位數的隨機號碼
//4.儲存驗證碼到 redis中,這裡的 key 最好使用業務字首作為區分
// set key value ex
stringRedisTemplate.opsForValue()
.set(LOGIN_CODE_KEY + phone, code, LOGIN_CODE_TTL, TimeUnit.MINUTES);
//5.傳送驗證碼(由於這裡涉及到一些其他方的工具,先不做)
log.debug("傳送簡訊驗證碼成功,驗證碼={}", code);
//6.返回OK
return Result.ok();
}
2.3.2.2簡訊驗證碼登入/註冊
修改UserServiceImpl.java的login()方法
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) {
//1.校驗手機號
String phone = loginForm.getPhone();
if (RegexUtils.isPhoneInvalid(phone)) {
//如果不符合,返回錯誤資訊
return Result.fail("手機號格式錯誤!");
}
//2.從redis獲取驗證碼並校驗
String cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
String code = loginForm.getCode();
if (cacheCode == null || !cacheCode.equals(code)) {
return Result.fail("驗證碼錯誤");
}
//3.根據手機號查詢使用者是否已經註冊
User user = query().eq("phone", phone).one();
if (user == null) {
//若不存在,則在建立使用者
user = createUserWithPhone(phone);
}
//4.儲存使用者到redis中 (這裡只儲存id、暱稱、手機號)
//隨機生成token,作為登入令牌
String token = UUID.randomUUID().toString(true);
//將user物件轉為redis-hash
UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
//使用工具類轉(指定轉換後的資料型別為String)
Map<String, Object> map = BeanUtil.beanToMap(userDTO, new HashMap<>(),
CopyOptions.create()
.setIgnoreNullValue(true)
.setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));
//儲存到redis中,設定有效期為30分鐘
stringRedisTemplate.opsForHash().putAll(LOGIN_USER_KEY + token, map);
stringRedisTemplate.expire(LOGIN_USER_KEY + token, LOGIN_USER_TTL, TimeUnit.MINUTES);
//5.將token返回客戶端
return Result.ok(token);
}
2.3.2.3校驗登入狀態
(1)修改LoginInterceptor.java
在上述程式碼中,我們設定了token在redis中的過期時間。但是和session不同,redis的過期時間是絕對時間,即在設定的時間內,無論有沒有使用到token,從設定的那一刻起一直到第30分鐘,該資料都會被刪除。
因此,我們需要在攔截器中重新設定redis的token資訊:每當使用者有操作時,攔截器就重新設定過期時間。
package com.hmdp.interceptor;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.http.HttpStatus;
import com.hmdp.dto.UserDTO;
import com.hmdp.utils.UserHolder;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import static com.hmdp.utils.RedisConstants.LOGIN_USER_KEY;
import static com.hmdp.utils.RedisConstants.LOGIN_USER_TTL;
/**
* @author 李
* @version 1.0
* 登入攔截器
*/
public class LoginInterceptor implements HandlerInterceptor {
private StringRedisTemplate stringRedisTemplate;
//不能使用註解@Component將攔截器注入到spring容器中!!
//因為攔截器是在spring容器初始化之前執行的
//因此這裡使用構造器設定,在註冊攔截器的時候去注入
public LoginInterceptor(StringRedisTemplate stringRedisTemplate) {
this.stringRedisTemplate = stringRedisTemplate;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//1.獲取請求頭中的token
String token = request.getHeader("authorization");
//如果瀏覽器的token為空
if (StrUtil.isBlank(token)) {
//攔截,返回狀態碼-401
response.setStatus(HttpStatus.HTTP_UNAUTHORIZED);
return false;//攔截
}
//2.基於token獲取redis中的使用者
String key = LOGIN_USER_KEY + token;
Map<Object, Object> userMap =
stringRedisTemplate.opsForHash().entries(key);
//3.判斷使用者是否存在
if (userMap.isEmpty()) {
//攔截,返回狀態碼-401
response.setStatus(HttpStatus.HTTP_UNAUTHORIZED);
return false;//攔截
}
//4.如果存在,將查詢到的Hash資料轉為UserDTO物件
UserDTO userDTO =
BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
//5.然後儲存到ThreadLocal
UserHolder.saveUser(userDTO);
//6.重新整理token有效期(30mins)
stringRedisTemplate.expire(key, LOGIN_USER_TTL, TimeUnit.MINUTES);
//7.放行
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
//移除使用者(根據當前執行緒,移除使用者資訊)
UserHolder.removeUser();
}
}
(2)修改配置類 MvcConfig.java
不能使用註解@Component將攔截器注入到spring容器中!!因為攔截器是在spring容器初始化之前執行的,因此這裡使用構造器設定,在註冊攔截器的時候去注入
2.3.2.4測試
(1)啟動redis伺服器,重啟專案。
(2)輸入手機號,輸入驗證碼,點選登入
(3)成功登入,顯示個人主頁
(4)redis儲存的資料如下:
簡訊驗證碼:
token:
測試透過。
2.3.3總結
(1)基於Redis實現實現簡訊登入改造的點:
-
傳送簡訊驗證碼時,把簡訊驗證碼作為value,使用手機號作為key,存入redis中。
確保了:a.每個手機號都有唯一的驗證碼;b.使用者登入時可以基於手機號來獲取驗證碼,從而實現驗證
-
簡訊登入時,儲存使用者資訊到redis(key-token,value-使用者資訊),同時返回token給使用者瀏覽器,儲存在瀏覽器的SessionStorage。每次校驗登入狀態,都會從中取出token進行校驗。
(2)Redis代替Session需要考慮的問題:
- 選擇合適的資料結構
- 選擇合適的key
- 選擇合適的儲存粒度