一、技术版本
1. springBoot 2.2.2.RELEASE
2.SpringCloud Hoxton.SR1
3. consul latest
4. MySQL latest
5.redis latest
二、 pom文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.huang</groupId>
<artifactId>charter02-User</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- redis场景启动器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- 引入MYSQL的数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-consul-discovery</artifactId>
<version>2.2.2.RELEASE</version>
</dependency>
<!-- 引入 mybatis springboot 的集成组件-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.0</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.7</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
三、数据库设计
1.用户信息表
创建用户信息表SQL:
CREATE TABLE user_info(
id BIGINT(20) PRIMARY KEY AUTO_INCREMENT,
user_id VARCHAR(10),
nick_name VARCHAR(30),
mobile_no VARCHAR(11),
PASSWORD VARCHAR(64),
is_login INT,
login_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
is_del INT,
create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
2.短信验证码信息表
短信验证码信息表
CREATE TABLE user_sms_code(
id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,
mobile_no VARCHAR(11),
sms_code VARCHAR(10),
send_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
四:实体类
UserInfo实体类
@Data
@ToString
@Builder
public class UserInfo implements Serializable {
private Long id;
private String userId; //用户id
private String nickName;// 用户昵称
private String mobileNo;//用户登录手机号
private String password;//登录密码
private Integer isLogin;//是否登录,0表示未登录,1表示已登录
private Timestamp loginTime;//最近登录时间
private Integer isDel; // 是否注销 0表示注销,1表示未注销
private Timestamp createTime;// 创建时间
}
UserSmsCode实体类
@Data
@Builder
public class UserSmsCode implements Serializable {
private Integer id;
private String mobileNo; // 用户注册手机号
private String smsCode; // 短信验证码
private Timestamp sendTime;// 短息发送时间
private Timestamp createTime;// 创建时间
}
定义接口层统一JSON响应报文对象
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class ApiResponse<T> {
/**
* 该对象主要作用就是封装接口响应报文信息
*/
private String code;
private String message;
private T data;
public static <T> ApiResponse<T> success(String code,String message,T data){
ApiResponse<T> apiResponse = new ApiResponse<>();
apiResponse.setCode(code);
apiResponse.setMessage(message);
apiResponse.setData(data);
return apiResponse;
}
}
五、开发Mybatis 持久层(Dao层)组件
1.开发用户短信信息表的持久层(Dao层)组件UserSmsCodeDao
@Mapper
public interface UserSmsCodeDao {
int insert(UserSmsCode userSmsCode);
UserSmsCode selectByMobileNo(String mobileNo);
}
2.编写对应的Mybatis SQL 映射文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.huang.springcloud.dao.UserSmsCodeDao">
<insert id="insert" parameterType="com.huang.springcloud.entities.UserSmsCode" useGeneratedKeys="true" keyProperty="id">
insert into user_sms_code(mobile_no,sms_code,send_time,create_time) values(#{mobileNo},#{smsCode},#{sendTime},#{createTime})
</insert>
<resultMap id="baseSmsCode" type="com.huang.springcloud.entities.UserSmsCode">
<id column="id" property="id"></id>
<result column="mobile_no" property="mobileNo"></result>
<result column="sms_code" property="smsCode"></result>
<result column="send_time" property="sendTime"></result>
<result column="create_time" property="createTime"></result>
</resultMap>
<select id="selectByMobileNo" parameterType="String" resultMap="baseSmsCode">
select * from user_sms_code where mobile_no=#{mobileNo};
</select>
</mapper>
3、开发用户信息表的持久层(Dao层)组件UserInfoDao
@Mapper
public interface UserInfoDao {
UserInfo selectByMobileNo(String mobikeNo);
int insert(UserInfo userInfo);
int updateById(UserInfo userInfo);
}
4、编写对用的Mybatis SQL映射文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.huang.springcloud.dao.UserInfoDao">
<resultMap id="baseUserInfo" type="com.huang.springcloud.entities.UserInfo">
<id column="id" property="id"></id>
<result column="user_id" property="userId"></result>
<result column="nick_name" property="nickName"></result>
<result column="mobile_no" property="mobileNo"></result>
<result column="password" property="password"></result>
<result column="is_login" property="isLogin"></result>
<result column="login_time" property="loginTime" jdbcType="TIMESTAMP"></result>
<result column="is_del" property="isDel"></result>
<result column="create_time" property="createTime" jdbcType="TIMESTAMP"></result>
</resultMap>
<select id="selectByMobileNo" resultMap="baseUserInfo">
select * from user_info where mobile_no = #{mobikeNo}
</select>
<insert id="insert" parameterType="com.huang.springcloud.entities.UserInfo">
insert into user_info(user_id,nick_name,mobile_no,is_login,is_del,login_time,create_time) values(#{userId},#{nickName},#{mobileNo},#{isLogin},#{isDel},#{loginTime},#{createTime});
</insert>
<update id="updateById" parameterType="com.huang.springcloud.entities.UserInfo">
update user_info set user_id=#{userId},nick_name=#{nickName},mobile_no=#{mobileNo},is_del=#{isDel},is_login=#{isLogin},login_time=#{loginTime},create_time=#{createTime} where id=#{id}
</update>
</mapper>
六、开发用户微服务业务层(service层)代码
1. 定义业务层接口UserService
public interface UserService {
// 获取短信验证码
public boolean getSmsCode(GetSmsCodeReqVo getSmsCodeReqVo);
//短信登录
public LoginByMobileResVo loginByMobile(LoginByMobileReqVo loginByMobileReqVo);
//登录退出
public boolean loginExit(LoginExitReqVo loginExitReqVo);
}
2.实现接口的业务层方法
@Service
@Slf4j
public class UserServiceImpl implements UserService {
@Autowired
private UserSmsCodeDao userSmsCodeDao;
@Autowired
private UserInfoDao userInfoDao;
@Autowired
private RedisTemplate redisTemplate;
/**
* 获取短信验证码接口的业务类实现方法
* @param getSmsCodeReqVo
* @return
*/
@Override
public boolean getSmsCode(GetSmsCodeReqVo getSmsCodeReqVo) {
// 随机生成六位短息验证码
String smsCode = String.valueOf((int) (Math.random() * 100000 + 1));
// 真实场景中这里需要调用短信平台接口
// 存储用户短信验证码信息到短信验证码信息表
UserSmsCode userSmsCode = UserSmsCode.builder().mobileNo(getSmsCodeReqVo.getMobileNo()).smsCode(smsCode)
.sendTime(new Timestamp(new Date().getTime())).createTime(new Timestamp(new Date().getTime())).build();
userSmsCodeDao.insert(userSmsCode);
return true;
}
/**
* 实现短信验证码登录接口的业务层方法
* @param loginByMobileReqVo
* @return
*/
@Override
public LoginByMobileResVo loginByMobile(LoginByMobileReqVo loginByMobileReqVo) {
//1.验证短信验证码是否正确
UserSmsCode userSmsCode = userSmsCodeDao.selectByMobileNo(loginByMobileReqVo.getMobileNo());
if(userSmsCode == null){
throw new BizException(-1,"验证码输入错误");
}else if(!userSmsCode.getSmsCode().equals(loginByMobileReqVo.getSmsCode())){
throw new BizException(-1,"验证码输入错误");
}
//2.判断用户是否已注册
UserInfo userInfo = userInfoDao.selectByMobileNo(loginByMobileReqVo.getMobileNo());
if(userInfo == null){
// 随机生成用户id
String userId = String.valueOf((int) (Math.random() * 100000 +1));
userInfo = UserInfo.builder().userId(userId).mobileNo(loginByMobileReqVo.getMobileNo()).isLogin(1)
.loginTime(new Timestamp(new Date().getTime())).createTime(new Timestamp(new Date().getTime())).build();
// 完成系统默认的注册流程
userInfoDao.insert(userInfo);
}else{
userInfo.setIsLogin(1);
userInfo.setLoginTime(new Timestamp(new Date().getTime()));
userInfoDao.updateById(userInfo);
}
// 生成用户会话信息
String accessToken = UUID.randomUUID().toString().toUpperCase().replaceAll("-","");
// 将用户信息存储到redis服务
redisTemplate.opsForValue().set("accessToken",userInfo,30, TimeUnit.DAYS);
// 封装响应参数的数据
LoginByMobileResVo loginByMobileResVo = LoginByMobileResVo.builder().userId(userInfo.getUserId()).accessToken(accessToken).build();
return loginByMobileResVo;
}
/**
* 实现登录退出接口的业务层方法
* @param loginExitReqVo
* @return
*/
@Override
public boolean loginExit(LoginExitReqVo loginExitReqVo) {
try{
redisTemplate.delete(loginExitReqVo.getAccessToken());
return true;
}catch(Exception e){
log.info(e.toString() + "-" + e);
return false;
}
}
}
七、定义用户微服务Controller层
/**
* @author hzz
*
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userServiceImpl;
/**
* 编写短信验证码接口
* @param reqId
* @param mobileNo
* @return
*/
@PostMapping(value = "/getSmsCode")
public Boolean getSmsCode(@RequestParam("reqId") String reqId, @RequestParam("mobileNo") String mobileNo){
GetSmsCodeReqVo getSmsCodeReqVo = GetSmsCodeReqVo.builder().reqId(reqId).mobileNo(mobileNo).build();
boolean result = userServiceImpl.getSmsCode(getSmsCodeReqVo);
return result;
}
/**
* 短信验证码登录接口
* @param reqId
* @param mobileNo
* @param smsCode
* @return
*/
@PostMapping(value = "/loginByMobile")
public ApiResponse loginByMobile(@RequestParam("reqId") String reqId,@RequestParam("mobileNo") String mobileNo,@RequestParam("smsCode") String smsCode){
LoginByMobileReqVo loginByMobileReqVo = LoginByMobileReqVo.builder().reqId(reqId).mobileNo(mobileNo).smsCode(smsCode).build();
LoginByMobileResVo loginByMobileResVo = userServiceImpl.loginByMobile(loginByMobileReqVo);
return ApiResponse.success(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getDesc(),loginByMobileResVo);
}
/**
* 编写短信退出接口
* @param userId
* @param accessToken
* @return
*/
@PostMapping(value = "loginExit")
public boolean loginExt(@RequestParam("userId") String userId,@RequestParam("accessToken") String accessToken){
LoginExitReqVo loginExitReqVo = LoginExitReqVo.builder().userId(userId).accessToken(accessToken).build();
boolean result = userServiceImpl.loginExit(loginExitReqVo);
return result;
}
}
八、一些vo类、异常类,ResultCode类
vo类
@Data
@Builder
public class GetSmsCodeReqVo implements Serializable {
private String reqId;
private String mobileNo;
}
@Data
@Builder
public class LoginByMobileReqVo {
private String smsCode;
private String reqId;
private String mobileNo;
}
@Builder
@Data
public class LoginByMobileResVo {
private String userId;
private String accessToken;
}
@Data
@Builder
public class LoginExitReqVo {
private String userId;
private String accessToken;
}
异常类
@Data
@ToString
public class BizException extends RuntimeException {
private int code;
private String message;
public BizException(){
}
public BizException(int code,String message){
this.code = code;
this.message = message;
}
public BizException(int code,Throwable rootCause){
super(rootCause);
this.code = code;
this.message = rootCause.getMessage();
}
public BizException(int code,String message,Throwable rootCause){
super(rootCause);
this.code = code;
this.message = message;
}
}
ResultCode类
public enum ResultCode {
SUCCESS("0000","SUCCESS");
ResultCode(String code ,String desc){
this.code = code;
this.desc = desc;
}
private String code;
private String desc;
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getDesc() {
return desc;
}
public void setDesc(String desc) {
this.desc = desc;
}
}
九、application.yaml配置
server:
port: 9091
spring:
application:
name: User
datasource:
url: jdbc:mysql://106.14.166.222:3306/springboot_springcloud?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: hzz12345
mybatis:
mapper-locations: classpath:mapper/*.xml
configuration:
map-underscore-to-camel-case: true
10、将SpringBoot应用升级为SpringCloud微服务(部署服务注册中心consul)
在application.yaml中配置
spring:
application:
name: User
cloud:
consul:
host: 106.14.166.222
port: 8500
discovery:
hostname: 106.14.166.222
service-name: ${spring.application.name}
heartbeat:
enabled: true
health-check-interval: 10s
health-check-path: /actuator/health
prefer-ip-address: true
服务注册在consul中的显示结果
11、测试
用postman对服务发起获取验证码请求:
数据库中的显示:
用postman发起短信验证码登录请求: