TF1-项目搭建配置及用户登录

• • 1、项目介绍
  • • 1.1、功能列表
    • 1.2、项目背景
    • 1.3、功能概述
    • • 1.3.1 用户登录
      • 1.3.2、交友
      • • 首页
        • 探花
        • 搜附近
        • 桃花传音
        • 测灵魂
      • 1.3.3、圈子
      • 1.3.4、消息
      • 1.3.5、小视频
      • 1.3.6、我的
    • 1.4、技术方案
    • 1.5、技术解决方案
  • 2、前后端分离
  • • 2.1、前后端分离的概述
    • 2.2、YAPI介绍
  • 3、开发工具
  • • 3.1、虚拟机配置
    • 3.2、Android模拟器
    • 3.3、调试工具PostMan
  • 4、环境搭建
  • • 4.1、MYSQL数据库
    • • 4.1.1、导入数据库
    • 4.2、基础服务组件
    • 4.3、IDEA配置
    • • 设置项目编码格式
      • 设置Maven仓库
    • 4.4、Maven模块分析
    • 4.5、模块依赖
    • • tanhua
      • tanhua-app-server
      • tanhua-autoconfig
      • tanhua-commons
      • tanhua-dubbo-db
      • tanhua-dubbo-interface
      • tanhua-dubbo-mongo
      • tanhua-model
    • 4.6、搭建环境
    • 4.7、Lombok
    • • 配置安装
      • 常用注解
  • 5、注册登录需求分析
  • • 5.1、业务说明
    • 5.2、需求分析
    • 5.3、数据库表
    • 5.4、实体类
  • 6、短信验证码
  • • 6.1、阿里云短信服务
    • • 6.1.1、申请签名与模板
      • 6.1.2、示例代码
      • • 3.6.1.4、实现发送短信方法
    • 6.2、模板组件
    • • 6.2.1、配置类
      • 6.2.2、发送短信模板对象
      • 6.2.3、自动装配类
      • 6.2.4、自动装配配置
      • 6.2.5、测试
      • 3.6.2、SSO短信接口服务
      • • 3.6.2.1、mock接口
        • 3.6.2.2、编写接口服务
  • 7、用户登录
  • • 7.1、登录验证码
    • • 7.1.1、接口说明
      • 7.1.2、流程分析
      • 7.1.3、代码实现
      • • **LoginController**
        • UserService
    • 7.2、JWT
    • • 7.2.1、简介
      • 7.2.2、格式
      • 7.2.3、流程
      • 7.2.4、示例
      • 7.2.5 JWT工具类
    • 7.3、用户登录
    • • 7.3.1、接口文档
      • 7.3.2、LoginController
      • 7.3.3、UserService
      • 7.3.4、测试
  • 8、代码优化
  • • 8.1 抽取BasePojo
    • 8.2 自动填充

1、项目介绍

一个陌生人的在线交友平台，在该平台中可以搜索附近的人，查看好友动态，平台还会通过大数据计算进行智能推荐，通过智能推荐可以找到更加匹配的好友，这样才能增进用户对产品的喜爱度。探花平台还提供了在线即时通讯功能，可以实时的与好友进行沟通，让沟通随时随地的进行。

1.1、功能列表

1.2、项目背景

探花交友项目定位于 陌生人交友市场。

• 根据《2018社交领域投融资报告》中指出：虽然相比2017年，投融资事件减少29.5%，但是融资的总额却大幅增长，达到68%。
• 这些迹象说明：社交领域的发展规模正在扩大，而很多没有特色的产品也会被淘汰。而随着那些尾部产品的倒下，对我们来说就是机会，及时抓住不同社交需求的机会。以社交为核心向不同的细分领域衍生正在逐渐走向成熟化。
• 而我们按照娱乐形式和内容为主两个维度，将社交行业公司分类为：即时通信、内容社群、陌生人社交、泛娱乐社交以及兴趣社交几个领域。
• 而在2018年社交的各个细分领域下，均有备受资本所关注的项目，根据烯牛数据2018年的报告中，也同样指出：内容社交及陌生人社交为资本重要关注领域，合计融资占比达73%。

根据市场现状以及融资事件来看：陌生人社交、内容社群、兴趣社交在2019年仍然保持强劲的动力，占到近70%的比例，它们仍然是资本市场主要关注领域。从增长率来看陌生人社交的增长速度远远大于其他几类，因此我们要从这个方向入手

1.3、功能概述

1.3.1 用户登录

业务说明：

用户通过手机验证码进行登录，如果是第一次登录则需要完善个人信息，在上传图片时，需要对上传的图片做人像的校验，防止用户上传非人像的图片作为头像。流程完成后，则登录成功。

1.3.2、交友

交友是探花项目的核心功能之一，用户可以查看好友，添加好友，搜索好友等操作。

首页

在首页中，主要功能有“今日佳人”、“推荐”、“最近访客”等

• 今日佳人
  • 按照“缘分值”进行匹配，将“缘分值”最高的用户展现出来
• 推荐
  • 按照“缘分值”进行推荐，由后台的推荐系统计算得出，展现出来
• 最近访客
  • 显示最近来看“我”的用户

探花

说明：左划喜欢，右划不喜欢，每天限量不超过100个，开通会员可增加限额。双方互相喜欢则配对成功。

实现：数据来源推荐系统计算后的结果。

搜附近

根据用户当前所在的位置进行查询，并且在10km的范围内进行查询，可以通过筛选按钮进行条件筛选。

桃花传音

功能类似QQ中的漂流瓶，用户可以发送和接收语音消息，陌生人就会接收到消息。

测灵魂

1. 测试题用于对用户进行分类，每次提交答案后更新用户属性

2. 测试题在后台进行维护

3. 测试题测试完后产生结果页可以进行分享

4. 测试题为顺序回答，回答完初级题解锁下一级问题

5. 点击锁定问题 显示提示 请先回答上一级问题

1.3.3、圈子

1、推荐频道为根据问卷及喜好推荐相似用户动态

2、显示内容为用户头像、用户昵称、用户性别、用户年龄、用户标签和用户发布动态

3、图片最多不超过6张或发布一个小视频

4、动态下方显示发布时间距离当时时间，例如10分钟前、3小时前、2天前，显示时间进行取整

5、动态下方显示距离为发布动态地与本地距离

6、显示用户浏览量

7、显示点赞数、评论数 转发数

1.3.4、消息

消息包含通知类的消息和好友消息。

1.3.5、小视频

用户可以上传小视频，也可以查看小视频列表，并且可以进行点赞操作。

1.3.6、我的

显示关注数、喜欢数、粉丝数、我的动态等信息。

。

1.4、技术方案

前端：

• flutter + android + 环信SDK + redux + shared_preferences + connectivity + iconfont + webview + sqflite

后端：

• Spring Boot + SpringMVC + Mybatis + MybatisPlus + Dubbo
• Elasticsearch geo 实现地理位置查询
• MongoDB 实现海量数据的存储
• Redis 数据的缓存
• Spark + MLlib 实现智能推荐
• 第三方服务 环信即时通讯
• 第三方服务 阿里云 OSS 、 短信服务
• 第三方服务 虹软开放平台 / 阿里云

1.5、技术解决方案

• 使用Elasticsearch geo实现附近的人的解决方案
• 使用Spark + Mllib实现智能推荐的解决方案
• 使用MongoDB进行海量数据的存储的解决方案
• 使用采用分布式文件系统存储小视频数据的解决方案
• 使用百度人脸识别的解决方案
• 使用阿里云进行短信验证码发送的解决方案

2、前后端分离

2.1、前后端分离的概述

项目基于前后端分离的架构进行开发，前后端分离架构总体上包括前端和服务端，通常是多人协作开发

• 前后端分离开发基于HTTP+JSON交互

• 通过接口文档（API文档）定义规范

• 前后端按照文档定义请求及响应数据

2.2、YAPI介绍

YAPI已经在linux虚拟机中准备好了

请求地址：http://192.168.136.160:3000/

用户名/密码：tanhua@itcast.cn/123456

对于接口的定义我们采用YApi进行管理，YApi是一个开源的接口定义、管理、提供mock数据的管理平台。

接口定义：

mock数据，YApi提供了mock功能，就是模拟服务端返回测试数据：

还可以运行http请求（需要在Chrome中安装支持跨域扩展 https://juejin.im/post/6844904057707085832）：

3、开发工具

探花交友项目的开发统一使用提供的Centos7环境，该环境中部署安装了项目所需要的各种服务，如：RabbitMQ,MongoDB、Redis等。

• 虚拟机的root用户密码为：root123
• 默认参数：CPU：2核，内存：4G，硬盘：60G
• IP地址建议设置为192.168.136.160，否则有些服务将不可用，比如：Redis、RocketMQ等。

3.1、虚拟机配置

由于课程中使用了较多的软件，且之间会有联系，推荐同学IP地址设置为192.168.136.160

仅仅需要修改虚拟机中的子网IP即可。

3.2、Android模拟器

客户端由前端团队进行开发，前端提供apk进行对接，所以，需要我们安装安卓的模拟器进行测试。

目前对开发者有很多专业的模拟器如genymotion，但是这些模拟器功能强大，空间占用率高并不适用于教学，甚至在某些环境下不能正常的启动。所以可以选择国内的安卓模拟器产品，比如：网易、夜神等，在这里我们推荐使用网易模拟器，其兼容性好、功能完善而且还简洁，但是它不支持虚拟机中安装。

下载：https://mumu.163.com/

3.3、调试工具PostMan

Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。postman被500万开发者和超100,000家公司用于每月访问1.3亿个API。

官方网址：https://www.postman.com/

解压资料文件夹中的软件，安装即可

4、环境搭建

4.1、MYSQL数据库

数据库设计规范：详见资料文件夹下《探花交友-mysq表.md》文件

将资料中数据库表导入到MYSQL中

4.1.1、导入数据库

（1） 打开Navicat ，点击右键选择新建数据库，名字跟我们要导入的数据库的名字一样，字符集一般选utf-8

（2） 在新建的数据库上右击，选择“运行SQL文件”，在提示框中选择文件所在的路径，编码保持一致选择utf-8

（3） 提示Successfully 导入成功后，可能在左侧看不到导入的数据库，关闭Navicat，重新打开即可看到

4.2、基础服务组件

探花交友学习中，除MySQL数据库部署到本地电脑中。其他涉及到的所有组件都已经以docker形式安装到虚拟机中。我们只需要进入虚拟机，使用简单的命令即可。为了方便学习与减少基础服务占用的学习时间，全部使用docker-compose的方式集中式部署。这些文件在linux虚拟机中的/root/docker-file文件夹下

每个文件夹中都包含一个docker-compose.yml配置文件，一键启动并部署应用。

#进入组件目录
cd /root/docker-file/base/
#执行docker-compose命令
docker-compose up -d 

base

• 其中包含redis，nacos，yapi，mongo

fastdfs

• 包含fastdfs操作需要的组件

rmq

• 包含RabbitMQ需要所有组件

recommend

• 包含推荐系统需要所有组件

4.3、IDEA配置

项目依赖环境（需提前安装好）

• JDK1.8

• Intellij Idea

• maven-3.x以上

• Git

• UTF-8编码格式

设置项目编码格式

设置Maven仓库

设置本地仓库，建议使用资料中提供好的仓库

4.4、Maven模块分析

整体项目使用Maven架构搭建，采用聚合工程形式管理模块，为了便于调用，dubbo需要拆分为接口模块和服务模块

工程主体结构

模块依赖分析

4.5、模块依赖

tanhua

885.1.472.11.01.0.92.52.02.53.3.21.3.23.5.63.4.11.18.84.0.5Hoxton.SR102.2.5.RELEASE

org.springframework.bootspring-boot-starter-testtestjunitjunit4.12testorg.projectlomboklombokcn.hutoolhutool-all5.4.3com.alibabafastjson1.2.8
io.nettynetty-bom4.1.59.Finalpomimportio.projectreactorreactor-bom2020.0.4pomimportio.projectreactor.nettyreactor-netty0.9.8.RELEASEorg.springframework.cloudspring-cloud-dependencies${spring-cloud.version}pomimportcom.alibaba.cloudspring-cloud-alibaba-dependencies${spring-cloud-alibaba.version}pomimportjoda-timejoda-time${joda-time.version}com.baomidoumybatis-plus${mybatis.mybatis-plus}mysqlmysql-connector-java${mysql.version}org.mongodbmongodb-driver-sync${mongodb.version}org.projectlomboklomboktrue${lombok.version}org.apache.commonscommons-lang3${commons-lang3.version}org.apache.commonscommons-lang33.7com.fasterxml.jackson.corejackson-databind${jackson.version}com.alibabadruid${druid.version}commons-codeccommons-codec1.11
org.apache.maven.pluginsmaven-compiler-plugin3.21.81.8UTF-8

tanhua-app-server

org.springframework.bootspring-boot-starter-weborg.springframework.bootspring-boot-starter-data-redisorg.projectlomboklombokorg.apache.commonscommons-lang3com.fasterxml.jackson.corejackson-databindcommons-codeccommons-codecjoda-timejoda-timeio.jsonwebtokenjjwt0.9.1com.github.tobatofastdfs-client1.26.7ch.qos.logbacklogback-classiccom.alibaba.cloudspring-cloud-starter-dubbocom.alibaba.cloudspring-cloud-starter-alibaba-nacos-discoverycom.itheimatanhua-dubbo-interface1.0-SNAPSHOTcom.itheimatanhua-commons1.0-SNAPSHOTcom.itheimatanhua-autoconfig1.0-SNAPSHOT
tanhua-app-serverorg.springframework.bootspring-boot-maven-plugin2.3.9.RELEASE

tanhua-autoconfig

com.aliyunaliyun-java-sdk-core4.5.3com.aliyundysmsapi201705252.0.1com.aliyun.ossaliyun-sdk-oss3.10.2com.aliyunfacebody201912301.0.10com.baidu.aipjava-sdk4.8.0org.springframework.bootspring-boot-starter-webcom.easemob.imim-sdk-core0.2.5com.aliyunaliyun-java-sdk-green3.6.1

tanhua-commons

org.apache.commonscommons-lang3commons-codeccommons-codecjoda-timejoda-timeio.jsonwebtokenjjwt0.9.1

tanhua-dubbo-db

org.springframework.bootspring-boot-starter-webcom.baomidoumybatis-pluscom.baomidoumybatis-plus-boot-starter${mybatis.mybatis-plus}mysqlmysql-connector-javacom.alibabadruidorg.projectlomboklombokorg.apache.commonscommons-lang3com.fasterxml.jackson.corejackson-databindcommons-codeccommons-codecjoda-timejoda-timecom.alibaba.cloudspring-cloud-starter-dubbocom.alibaba.cloudspring-cloud-starter-alibaba-nacos-discoverycom.itheimatanhua-dubbo-interface1.0-SNAPSHOT
tanhua-dubbo-dborg.springframework.bootspring-boot-maven-plugin2.3.9.RELEASE

tanhua-dubbo-interface

com.itheimatanhua-model1.0-SNAPSHOT

tanhua-dubbo-mongo

org.springframework.bootspring-boot-starter-weborg.projectlomboklombokorg.apache.commonscommons-lang3com.fasterxml.jackson.corejackson-databindcommons-codeccommons-codecjoda-timejoda-timecom.alibaba.cloudspring-cloud-starter-dubbocom.alibaba.cloudspring-cloud-starter-alibaba-nacos-discoverycom.itheimatanhua-commons1.0-SNAPSHOTcom.itheimatanhua-dubbo-interface1.0-SNAPSHOT
tanhua-dubbo-dborg.springframework.bootspring-boot-maven-plugin2.3.9.RELEASE

tanhua-model

com.baomidoumybatis-plus

4.6、搭建环境

tanhua-app-server端添加引导类和配置文件application.yml

//启动类
@SpringBootApplication
public class AppServerApplication {public static void main(String[] args) {SpringApplication.run(AppServerApplication.class,args);}
}

4.7、Lombok

lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码，尤其是针对pojo。

官网：https://projectlombok.org/

配置安装

导入依赖：

org.projectlomboklomboktrue

安装IDEA插件：

如果不安装插件，程序可以正常执行，但是看不到生成的一些代码，如：get、set方法。

常用注解

• @Data：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
• @Setter：注解在属性上；为属性提供 setting 方法
• @Getter：注解在属性上；为属性提供 getting 方法
• @Slf4j：注解在类上；为类提供一个 属性名为log 的 slf4j日志对象
• @NoArgsConstructor：注解在类上；为类提供一个无参的构造方法
• @AllArgsConstructor：注解在类上；为类提供一个全参的构造方法
• @Builder：使用Builder模式构建对象

测试一：使用@Data注解

是不是很神奇？！

测试二：使用@Slf4j注解

测试：

测试三：@AllArgsConstructor、@NoArgsConstructor注解的使用

测试四：@Builder

测试结果：

5、注册登录需求分析

5.1、业务说明

用户通过手机验证码进行登录，如果是第一次登录则需要完善个人信息，在上传图片时，需要对上传的图片做人像的校验，防止用户上传非人像的图片作为头像。流程完成后，则登录成功。

• 已注册用户：
  • 输入手机号发送验证码
  • 输入验证码，进行比对完成登录
• 未注册用户：
  • 输入手机号发送验证码
  • 输入验证码，进行比对，自动注册（保存用户）
  • 完善用户信息

5.2、需求分析

服务端接受客户端请求

Java代码调用第三方服务实现短信返送（发送短信需要运营资质，只能借助第三方实现）

5.3、数据库表

数据库使用的mysql：

CREATE TABLE `tb_user` (`id` bigint(20) NOT NULL AUTO_INCREMENT,`mobile` varchar(11) DEFAULT NULL COMMENT '手机号',`password` varchar(32) DEFAULT NULL COMMENT '密码，需要加密',`created` datetime DEFAULT NULL,`updated` datetime DEFAULT NULL,PRIMARY KEY (`id`),KEY `mobile` (`mobile`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COMMENT='用户表';CREATE TABLE `tb_user_info` (`id` bigint(20) NOT NULL AUTO_INCREMENT,`user_id` bigint(20) NOT NULL COMMENT '用户id',`nick_name` varchar(50) DEFAULT NULL COMMENT '昵称',`logo` varchar(100) DEFAULT NULL COMMENT '用户头像',`tags` varchar(50) DEFAULT NULL COMMENT '用户标签：多个用逗号分隔',`sex` int(1) DEFAULT '3' COMMENT '性别，1-男，2-女，3-未知',`age` int(11) DEFAULT NULL COMMENT '用户年龄',`edu` varchar(20) DEFAULT NULL COMMENT '学历',`city` varchar(20) DEFAULT NULL COMMENT '居住城市',`birthday` varchar(20) DEFAULT NULL COMMENT '生日',`cover_pic` varchar(50) DEFAULT NULL COMMENT '封面图片',`industry` varchar(20) DEFAULT NULL COMMENT '行业',`income` varchar(20) DEFAULT NULL COMMENT '收入',`marriage` varchar(20) DEFAULT NULL COMMENT '婚姻状态',`created` datetime DEFAULT NULL,`updated` datetime DEFAULT NULL,PRIMARY KEY (`id`),KEY `user_id` (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户信息表';

5.4、实体类

User

@Data
@AllArgsConstructor  //满参构造方法
@NoArgsConstructor   //无参构造方法
public class User extends BasePojo {private Long id;private String mobile;private String password;//环信用户信息private String hxUser;private String hxPassword;
}

6、短信验证码

6.1、阿里云短信服务

官方网站：https://www.aliyun.com/product/sms?spm=5176.19720258.J_8058803260.611.48192c4abPvXEp

6.1.1、申请签名与模板

使用阿里云短信服务非常简单，仅需要简单的申请和认证即可

https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.0.ddysms.2a4316d0ql6PyD

说明：申请签名时，个人用户只能申请一个并且签名的名称必须为“ABC商城”，否则审核不通过。

申请模板：

审核时间需要1_{2小时，请耐心等待}

6.1.2、示例代码

文档：https://help.aliyun.com/document_detail/101414.html?spm=a2c4g.11186623.6.625.18705ffa8u4lwj：

导入依赖：

com.aliyundysmsapi201705252.0.1

package com.tanhua.sso.service;import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import com.aliyun.dysmsapi20170525.models.SendSmsResponseBody;
import com.aliyun.teaopenapi.models.Config;public class SendSms {/*** 使用AK&SK初始化账号Client* @param accessKeyId* @param accessKeySecret* @return Client* @throws Exception*/public static com.aliyun.dysmsapi20170525.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {Config config = new Config()// 您的AccessKey ID.setAccessKeyId(accessKeyId)// 您的AccessKey Secret.setAccessKeySecret(accessKeySecret).setEndpoint("dysmsapi.aliyuncs.com");// 访问的域名return new com.aliyun.dysmsapi20170525.Client(config);}public static void main(String[] args_) throws Exception {java.util.List args = java.util.Arrays.asList(args_);com.aliyun.dysmsapi20170525.Client client = SendSms.createClient("**********", "**********");SendSmsRequest sendSmsRequest = new SendSmsRequest().setPhoneNumbers( "158****7944") //目标手机号.setSignName("ABC商城") //签名名称.setTemplateCode("SMS_204756062") //短信模板code.setTemplateParam("{\"code\":\"1111\"}"); //模板中变量替换SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);SendSmsResponseBody body = sendSmsResponse.getBody();// code = OK 代表成功System.out.println(body.getCode() + "  " + body.getMessage());}}

3.6.1.4、实现发送短信方法

配置文件：aliyun.properties

aliyun.sms.accessKeyId = ***********
aliyun.sms.accessKeySecret = ***********
aliyun.sms.domain= dysmsapi.aliyuncs.com
aliyun.sms.signName= ABC商城
aliyun.sms.templateCode= SMS_204756062

需要注意中文编码问题：

读取配置：

package com.tanhua.sso.config;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;@Configuration
@PropertySource("classpath:aliyun.properties")
@ConfigurationProperties(prefix = "aliyun.sms")
@Data
public class AliyunSMSConfig {private String accessKeyId;private String accessKeySecret;private String domain;private String signName;private String templateCode;}

代码实现：

package com.tanhua.sso.service;import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import com.aliyun.dysmsapi20170525.Client;
import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import com.aliyun.dysmsapi20170525.models.SendSmsResponseBody;
import com.aliyun.teaopenapi.models.Config;
import com.tanhua.sso.config.AliyunSMSConfig;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
@Slf4j
public class SmsService {@Autowiredprivate AliyunSMSConfig aliyunSMSConfig;/*** 发送短信验证码** @param mobile* @return*/public String sendSms(String mobile) {//随机生成6位数字验证码String code = RandomUtil.randomNumbers(6);try {Config config = new Config().setAccessKeyId(this.aliyunSMSConfig.getAccessKeyId()).setAccessKeySecret(this.aliyunSMSConfig.getAccessKeySecret()).setEndpoint(this.aliyunSMSConfig.getDomain());Client client = new Client(config);SendSmsRequest sendSmsRequest = new SendSmsRequest().setPhoneNumbers(mobile)//目标手机号.setSignName(this.aliyunSMSConfig.getSignName()) //签名名称.setTemplateCode(this.aliyunSMSConfig.getTemplateCode()) //短信模板code.setTemplateParam("{\"code\":\"" + code + "\"}"); //模板中变量替换SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);SendSmsResponseBody body = sendSmsResponse.getBody();if (StrUtil.equals("OK", body.getCode())) {return code;}} catch (Exception e) {log.error("发送短信验证码失败！" + mobile, e);}return null;}
}

6.2、模板组件

企业开发中，往往将常见工具类封装抽取，以简洁便利的方式供其他工程模块使用。而SpringBoot的自动装配机制可以方便的实现组件抽取。SpringBoot执行流程如下

1. 扫描依赖模块中META-INF/spring.factories
2. 执行装配类中方法
3. 对象存入容器中
4. 核心工程注入对象，调用方法使用

6.2.1、配置类

tanhua-autoconfig创建配置信息类

@Data
@ConfigurationProperties(prefix = "tanhua.sms")
public class SmsProperties {private String signName;private String templateCode;private String accessKey;private String secret;
}

6.2.2、发送短信模板对象

tanhua-autoconfig创建模板对象对象发送信息

package com.tanhua.autoconfig.template;import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import com.aliyun.dysmsapi20170525.models.SendSmsResponseBody;
import com.aliyun.teaopenapi.models.Config;
import com.tanhua.autoconfig.properties.SmsProperties;public class SmsTemplate {private SmsProperties properties;public SmsTemplate(SmsProperties properties) {this.properties = properties;}public void sendSms(String mobile,String code) {try {//配置阿里云Config config = new Config()// 您的AccessKey ID.setAccessKeyId(properties.getAccessKey())// 您的AccessKey Secret.setAccessKeySecret(properties.getSecret());// 访问的域名config.endpoint = "dysmsapi.aliyuncs.com";com.aliyun.dysmsapi20170525.Client client =  new com.aliyun.dysmsapi20170525.Client(config);SendSmsRequest sendSmsRequest = new SendSmsRequest().setPhoneNumbers(mobile).setSignName(properties.getSignName()).setTemplateCode(properties.getTemplateCode()).setTemplateParam("{\"code\":\""+code+"\"}");// 复制代码运行请自行打印 API 的返回值SendSmsResponse response = client.sendSms(sendSmsRequest);SendSmsResponseBody body = response.getBody();System.out.println(body.getMessage());}catch (Exception e) {e.printStackTrace();}}}

6.2.3、自动装配类

tanhua-autoconfig创建自动装配的配置类

package com.tanhua.autoconfig;import com.tanhua.autoconfig.properties.*;
import com.tanhua.autoconfig.template.*;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;@EnableConfigurationProperties({SmsProperties.class
})
public class TanhuaAutoConfiguration {@Beanpublic SmsTemplate smsTemplate(SmsProperties properties) {return new SmsTemplate(properties);}
}

6.2.4、自动装配配置

根据自动装配原则，在tanhua-autoconfig工程创建 /META-INF/spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.tanhua.autoconfig.TanhuaAutoConfiguration

6.2.5、测试

tanhua-app-server工程加入短信配置

tanhua:sms:signName: 物流云商templateCode: SMS_106590012accessKey: LTAI4GKgob9vZ53k2SZdyAC7secret: LHLBvXmILRoyw0niRSBuXBZewQ30la

编写单元测试类

@RunWith(SpringRunner.class)
@SpringBootTest(classes = AppServerApplication.class)
public class SmsTemplateTest {//注入@Autowiredprivate SmsTemplate smsTemplate;//测试@Testpublic void testSendSms() {smsTemplate.sendSms("18618412321","4567");}
}

3.6.2、SSO短信接口服务

3.6.2.1、mock接口

地址：https://mock-java.itheima.net/project/35/interface/api/581

3.6.2.2、编写接口服务

编写ErrorResult，ErrorResult对象是与前端约定好的结构，如果发生错误需要返回该对象，如果未发生错误响应200即可。

package com.tanhua.sso.vo;import lombok.Builder;
import lombok.Data;@Data
@Builder
public class ErrorResult {private String errCode;private String errMessage;
}

SmsController：

package com.tanhua.sso.controller;import com.tanhua.sso.service.SmsService;
import com.tanhua.sso.vo.ErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.Map;@RestController
@RequestMapping("user")
@Slf4j
public class SmsController {@Autowiredprivate SmsService smsService;/*** 发送短信验证码接口** @param param* @return*/@PostMapping("login")public ResponseEntity sendCheckCode(@RequestBody Map param) {ErrorResult errorResult = null;String phone = param.get("phone");try {errorResult = this.smsService.sendCheckCode(phone);if (null == errorResult) {return ResponseEntity.ok(null);}} catch (Exception e) {log.error("发送短信验证码失败~ phone = " + phone, e);errorResult = ErrorResult.builder().errCode("000002").errMessage("短信验证码发送失败！").build();}return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResult);}}

SmsService：

package com.tanhua.sso.service;import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import com.aliyun.dysmsapi20170525.Client;
import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import com.aliyun.dysmsapi20170525.models.SendSmsResponseBody;
import com.aliyun.teaopenapi.models.Config;
import com.tanhua.sso.config.AliyunSMSConfig;
import com.tanhua.sso.vo.ErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;import java.time.Duration;@Service
@Slf4j
public class SmsService {@Autowiredprivate AliyunSMSConfig aliyunSMSConfig;@Autowiredprivate RedisTemplate redisTemplate;/*** 发送短信验证码** @param mobile* @return*/public String sendSms(String mobile) {//随机生成6位数字验证码String code = RandomUtil.randomNumbers(6);try {Config config = new Config().setAccessKeyId(this.aliyunSMSConfig.getAccessKeyId()).setAccessKeySecret(this.aliyunSMSConfig.getAccessKeySecret()).setEndpoint(this.aliyunSMSConfig.getDomain());Client client = new Client(config);SendSmsRequest sendSmsRequest = new SendSmsRequest().setPhoneNumbers(mobile)//目标手机号.setSignName(this.aliyunSMSConfig.getSignName()) //签名名称.setTemplateCode(this.aliyunSMSConfig.getTemplateCode()) //短信模板code.setTemplateParam("{\"code\":\"" + code + "\"}"); //模板中变量替换SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);SendSmsResponseBody body = sendSmsResponse.getBody();if (StrUtil.equals("OK", body.getCode())) {return code;}} catch (Exception e) {log.error("发送短信验证码失败！" + mobile, e);}return null;}/*** 发送短信验证码* 实现：发送完成短信验证码后，需要将验证码保存到redis中* @param phone* @return*/public ErrorResult sendCheckCode(String phone) {String redisKey = "CHECK_CODE_" + phone;//先判断该手机号发送的验证码是否还未失效if(this.redisTemplate.hasKey(redisKey)){String msg = "上一次发送的验证码还未失效！";return ErrorResult.builder().errCode("000001").errMessage(msg).build();}String code = this.sendSms(phone);if(StrUtil.isEmpty(code)){String msg = "发送短信验证码失败！";return ErrorResult.builder().errCode("000000").errMessage(msg).build();}//短信发送成功，将验证码保存到redis中，有效期为5分钟this.redisTemplate.opsForValue().set(redisKey, code, Duration.ofMinutes(5));return null;}
}

7、用户登录

7.1、登录验证码

7.1.1、接口说明

参见YAPI接口地址：http://192.168.136.160:3000/project/19/interface/api/94

7.1.2、流程分析

客户端发送请求

服务端调用第三方组件发送验证码

验证码发送成功，存入redis

响应客户端，客户端跳转到输入验证码页面

7.1.3、代码实现

LoginController

@RestController
@RequestMapping("/user")
public class LoginController {@Autowiredprivate UserService userService;/*** 获取登录验证码*   请求参数：phone （Map）*   响应：void*/@PostMapping("/login")public ResponseEntity login(@RequestBody Map map){String phone =(String) map.get("phone");userService.sendMsg(phone);return ResponseEntity.ok(null); //正常返回状态码200}
}

UserService

@Service
public class UserService {@Autowiredprivate SmsTemplate template;@Autowiredprivate RedisTemplate redisTemplate;/*** 发送短信验证码* @param phone*/public void sendMsg(String phone) {//1、随机生成6位数字//String code = RandomStringUtils.randomNumeric(6);String code = "123456";//2、调用template对象，发送手机短信//template.sendSms(phone,code);//3、将验证码存入到redisredisTemplate.opsForValue().set("CHECK_CODE_"+phone,code, Duration.ofMinutes(5));}}

7.2、JWT

7.2.1、简介

JSON Web token简称JWT， 是用于对应用程序上的用户进行身份验证的标记。也就是说, 使用 JWTS 的应用程序不再需要保存有关其用户的 cookie 或其他session数据。此特性便于可伸缩性, 同时保证应用程序的安全

7.2.2、格式

• JWT就是一个字符串，经过加密处理与校验处理的字符串，形式为：A.B.C

• A由JWT头部信息header加密得到

• B由JWT用到的身份验证信息json数据加密得到

• C由A和B加密得到，是校验部分

7.2.3、流程

7.2.4、示例

导入依赖：

io.jsonwebtokenjjwt0.9.1

编写测试用例：

    @Testpublic void testCreateToken() {//生成token//1、准备数据Map map = new HashMap();map.put("id",1);map.put("mobile","13800138000");//2、使用JWT的工具类生成tokenlong now = System.currentTimeMillis();String token = Jwts.builder().signWith(SignatureAlgorithm.HS512, "itcast") //指定加密算法.setClaims(map) //写入数据.setExpiration(new Date(now + 30000)) //失效时间.compact();System.out.println(token);}//解析token/*** SignatureException : token不合法* ExpiredJwtException：token已过期*/@Testpublic void testParseToken() {String token = "eyJhbGciOiJIUzUxMiJ9.eyJtb2JpbGUiOiIxMzgwMDEzODAwMCIsImlkIjoxLCJleHAiOjE2MTgzOTcxOTV9.2lQiovogL5tJa0px4NC-DW7zwHFqZuwhnL0HPAZunieGphqnMPduMZ5TtH_mxDrgfiskyAP63d8wzfwAj-MIVw";try {Claims claims = Jwts.parser().setSigningKey("itcast").parseClaimsJws(token).getBody();Object id = claims.get("id");Object mobile = claims.get("mobile");System.out.println(id + "--" + mobile);}catch (ExpiredJwtException e) {System.out.println("token已过期");}catch (SignatureException e) {System.out.println("token不合法");}}

通过解析Token得知，如果抛出SignatureException异常表示token不合法，如果抛出ExpiredJwtException异常表示token已过期

7.2.5 JWT工具类

public class JwtUtils {// TOKEN的有效期1小时（S）private static final int TOKEN_TIME_OUT = 1 * 3600;// 加密KEYprivate static final String TOKEN_SECRET = "itcast";// 生成Tokenpublic static String getToken(Map params){long currentTime = System.currentTimeMillis();return Jwts.builder().signWith(SignatureAlgorithm.HS512, TOKEN_SECRET) //加密方式.setExpiration(new Date(currentTime + TOKEN_TIME_OUT * 1000)) //过期时间戳.addClaims(params).compact();}/*** 获取Token中的claims信息*/public static Claims getClaims(String token) {return Jwts.parser().setSigningKey(TOKEN_SECRET).parseClaimsJws(token).getBody();}/*** 是否有效 true-有效，false-失效*/public static boolean verifyToken(String token) {if(StringUtils.isEmpty(token)) {return false;}try {Claims claims = Jwts.parser().setSigningKey("itcast").parseClaimsJws(token).getBody();}catch (Exception e) {return false;}return true;}
}

7.3、用户登录

用户接收到验证码后，进行输入验证码，点击登录，前端系统将手机号以及验证码提交到服务端进行校验。

7.3.1、接口文档

YAPI接口地址：https://mock-java.itheima.net/project/164/interface/api/12593

7.3.2、LoginController

    /*** 检验登录*/@PostMapping("/loginVerification")public ResponseEntity loginVerification(@RequestBody Map map) {//1、调用map集合获取请求参数String phone = (String) map.get("phone");String code = (String) map.get("verificationCode");//2、调用userService完成用户登录Map retMap = userService.loginVerification(phone,code);//3、构造返回return ResponseEntity.ok(retMap);}

7.3.3、UserService

    /*** 验证登录* @param phone* @param code*/public Map loginVerification(String phone, String code) {//1、从redis中获取下发的验证码String redisCode = redisTemplate.opsForValue().get("CHECK_CODE_" + phone);//2、对验证码进行校验（验证码是否存在，是否和输入的验证码一致）if(StringUtils.isEmpty(redisCode) || !redisCode.equals(code)) {//验证码无效throw new RuntimeException();}//3、删除redis中的验证码redisTemplate.delete("CHECK_CODE_" + phone);//4、通过手机号码查询用户User user = userApi.findByMobile(phone);boolean isNew = false;//5、如果用户不存在，创建用户保存到数据库中if(user == null) {user = new User();user.setMobile(phone);user.setPassword(DigestUtils.md5Hex("123456"));Long userId = userApi.save(user);user.setId(userId);isNew = true;}//6、通过JWT生成token(存入id和手机号码)Map tokenMap = new HashMap();tokenMap.put("id",user.getId());tokenMap.put("mobile",phone);String token = JwtUtils.getToken(tokenMap);//7、构造返回值Map retMap = new HashMap();retMap.put("token",token);retMap.put("isNew",isNew);return retMap;}

7.3.4、测试

8、代码优化

8.1 抽取BasePojo

为了简化实体类中created和updated字段，抽取BasePojo

@Data
public abstract class BasePojo implements Serializable {@TableField(fill = FieldFill.INSERT) //自动填充private Date created;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updated;}

8.2 自动填充

对于created和updated字段，每次操作都需要手动设置。为了解决这个问题，mybatis-plus支持自定义处理器的形式实现保存更新的自动填充

package com.tanhua.dubbo.server.handler;import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;import java.util.Date;@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {Object created = getFieldValByName("created", metaObject);if (null == created) {//字段为空，可以进行填充setFieldValByName("created", new Date(), metaObject);}Object updated = getFieldValByName("updated", metaObject);if (null == updated) {//字段为空，可以进行填充setFieldValByName("updated", new Date(), metaObject);}}@Overridepublic void updateFill(MetaObject metaObject) {//更新数据时，直接更新字段setFieldValByName("updated", new Date(), metaObject);}
}