- 接着学习。之前的博客的进度:完成用户模块的注册接口的开发以及注册时的参数合法性校验、也基本完成用户模块的登录接口的主逻辑的基础上、JWT令牌"的组成与使用以及完成了"登录认证"(生成与验证JWT令牌)具体往回看了解的链接如下。
springboot实战学习(8)(登录接口中使用“JWT令牌“完成登录认证)(拦截器的创建与注册)-CSDN博客文章浏览阅读525次,点赞10次,收藏6次。本篇博客主要学习和介绍了如何使用拦截器,去实现用户未登录时,用户不能访问其它接口(除了登录、注册)。其中先是进行简单粗暴的每个方法中直接完成JWT令牌的生成与校验。后面改变策略,使用拦截器处理所有接口的JWT令牌的生成和校验。所有的测试因为还未完成前端,所以都在postman中测试后端的接口,查看响应回来的数据......https://blog.csdn.net/m0_74363339/article/details/142463934?spm=1001.2014.3001.5501
- 在已完成开发注册、登录的接口的前提下。这篇博客主要完成获取用户详细信息。
目录
一、明确需求
(1)部分展示(最终需要完成的)
二、查看接口文档
(1)基本的信息(请求路径、请求方式、描述)
(2)请求参数(无)
(3)响应数据。
三、实现思路
(1)UserController层
(2)UserService层
(3)UserMapper层
四、开始操作
(0)Result类与JWT令牌工具类
(1)回到UserController类中
(2)重启工程。回到postman开始测试。
(I)测试结果。请求成功!
(II)postman中测试时,集合(Collections)一下的所有接口都可以统一添加相同请求头。
(3)问题与解决
.yml配置文件中配置mybatis“开启驼峰命名——>下划线命名的自动转换”。
一、明确需求
(1)部分展示(最终需要完成的)
- 当用户登录成功后,需要跳转到首页。
- 首页的导航栏这一块,需要展示用户的昵称、头像等。像这样的数据都需要访问后台的接口才能获取。
- 在个人中心这部分。有个人基本资料、更新头像、重置密码等等。像这些功能都需要先查询展示,然后再进行更新。所以也需要获取用户的详细信息。
二、查看接口文档
(1)基本的信息(请求路径、请求方式、描述)
(2)请求参数(无)
(3)响应数据。
- 响应数据依然是"code"、"message"、"data"。
- 而data对应的object类型的数据。如下面的响应数据样例。它有一个大括号,是一个对象。里面有("id"、"username"、"nickname"(昵称)、email、userPic(邮箱地址)、创建和更新时间)。
三、实现思路
(1)UserController层
- 同样,也需要在类'"UserController"里面声明一个方法。方法上边添加注解@GetMapping,因为现在是一个get请求。
- 指定的映射路径是:"/userInfo"。
- 而且在方法的内部,需要根据用户名去查询。注意:该用户名是已登录的用户名。
- 注意这个用户名的获取方式!!虽然这里没有请求参数,但是我们所有的接口都要求用户携带token令牌。而且程序在登录时生成的"JWT令牌"里面存放了用户的id和username。则用户名可以从token中获取。
- 所以要在方法里声明一个参数。名为"Authorization"的请求头,有了token后,就可以解析token,然后获取到用户名了。
(2)UserService层
(之前已经完成)
(3)UserMapper层
(之前已经完成)
四、开始操作
(0)Result类与JWT令牌工具类
package com.feisi.pojo; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; //统一响应结果 @NoArgsConstructor @AllArgsConstructor @Data public class Result<T> { private Integer code;//业务状态码 0-成功 1-失败 private String message;//提示信息 private T data;//响应数据 //快速返回操作成功响应结果(带响应数据) public static <E> Result<E> success(E data) { return new Result<>(0, "操作成功", data); } //快速返回操作成功响应结果 public static Result success() { return new Result(0, "操作成功", null); } public static Result error(String message) { return new Result(1, message, null); } }
package com.feisi.utils; import com.auth0.jwt.JWT; import com.auth0.jwt.algorithms.Algorithm; import java.util.Date; import java.util.Map; public class JwtUtil { private static final String KEY = "feisi"; //接收业务数据,生成token并返回 public static String genToken(Map<String, Object> claims) { return JWT.create() .withClaim("claims", claims) .withExpiresAt(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 12)) .sign(Algorithm.HMAC256(KEY)); } //接收token,验证token,并返回业务数据 public static Map<String, Object> parseToken(String token) { return JWT.require(Algorithm.HMAC256(KEY)) .build() .verify(token) .getClaim("claims") .asMap(); } }
(1)回到UserController类中
- 添加一个方法userInfo()。注意返回值类型为Result<User>,因为到时侯返回的是User对象。并且添加一个注解@GetMapping("/userInfo")。
- 要得到用户名,就在参数列表里面声明一个String类型的token。然后给这个参数加上注解@RequestHeader(name= "Authorization")。
- 有了token就去解析它。
- 解析token就要使用自己提供的工具类"JwtUtil"的方法"parseToken()"。把token传给它,它会返回一个业务数据的Map集合。
- 并且用map.get()方法获取指定键的值。因为存的时候是字符串,所有强转为String类型的。
@GetMapping("/userInfo") public Result<User> userInfo(@RequestHeader(name = "Authorization") String token){ //方法内部根据用户名查询用户 Map<String, Object> map = JwtUtil.parseToken(token); String username = map.get("username").toString(); //拿到username就去调用service层的据用户名查询用户方法 User user = userService.findByName(username); return Result.success(user); }
(2)重启工程。回到postman开始测试。
(I)测试结果。请求成功!
(II)postman中测试时,集合(Collections)一下的所有接口都可以统一添加相同请求头。
- 因为在postman测试时,请求头的参数与值总是每个都要重新写,很麻烦。
- 可以直接去集合然后点击Scripts——>"Pre-request"(请求前的一个脚本)。
- 在这里写上指定的东西即可。记得写完ctrl+s(保存一下)。
- 到时候这个集合下的所有接口请求都会自动的把这个头携带给服务器。
- 所有自己之前写的就不需要携带请求头了。然后当token令牌的时间过期了,也能重新登录,然后复制粘贴到这里,所有的请求就能直接快速用了。
(3)问题与解决
- 我们发现,请求回来的数据,携带了密码。这是不安全的。
- 这就要用到spring提供的对应的注解去解决这个问题了。
- 添加注解@JsonIgnore。作用是:springmvc把当前对象转换成json字符串的时候,忽略password,最终的json字符串中就没有password这个属性了。
- 注意这个注解导的包要是下面这个,不然不生效。
import com.fasterxml.jackson.annotation.JsonIgnore;
- 我们通过上面发现返回的data值,里面的email与nickname(昵称)没有值。是因为在注册的时候,只让用户填写用户名与密码。这些是当用户修改个人资料的时候就有值了。这样设置是为了用户能够快速的注册。
- 可以看到数据库中的表user中字段"create_time"、"update_time"的创建时间都有,为啥返回的数据data中"createTime"、"updateTime"却为"null"?
- 因为数据库里面的命名是以下划线命名,而实体类User中的变量是驼峰命名。这时候mybatis不知道咋去封装数据。
.yml配置文件中配置mybatis“开启驼峰命名——>下划线命名的自动转换”。
- 映射下划线——>驼峰命名。
- 这样mybatis就会发现数据库里面的下划线字段就会去实体类找一个对应的驼峰命名。
- 重新启动springboot工程。再去postman测试。这时就对了!