SpringBoot集成JWT实现token验证的流程

程序员文章站 2022-08-06 22:13:59

jwt官网： https://jwt.io/ jwt(java版)的github地址:https://github.com/jwtk/jjwt 什么是jwt json web t...

jwt(java版)的github地址:https://github.com/jwtk/jjwt

什么是jwt

json web token (jwt), 是为了在网络应用环境间传递声明而执行的一种基于json的开放标准（(rfc 7519).定义了一种简洁的，自包含的方法用于通信双方之间以json对象的形式安全的传递信息。因为数字签名的存在，这些信息是可信的，jwt可以使用hmac算法或者是rsa的公私秘钥对进行签名。

jwt请求流程

SpringBoot集成JWT实现token验证的流程

1. 用户使用账号和面发出post请求； 2. 服务器使用私钥创建一个jwt； 3. 服务器返回这个jwt给浏览器； 4. 浏览器将该jwt串在请求头中像服务器发送请求； 5. 服务器验证该jwt； 6. 返回响应的资源给浏览器。

jwt的主要应用场景

身份认证在这种场景下，一旦用户完成了登陆，在接下来的每个请求中包含jwt，可以用来验证用户身份以及对路由，服务和资源的访问权限进行验证。由于它的开销非常小，可以轻松的在不同域名的系统中传递，所有目前在单点登录（sso）中比较广泛的使用了该技术。信息交换在通信的双方之间使用jwt对数据进行编码是一种非常安全的方式，由于它的信息是经过签名的，可以确保发送者发送的信息是没有经过伪造的。

优点

1.简洁(compact): 可以通过url，post参数或者在http header发送，因为数据量小，传输速度也很快 2.自包含(self-contained)：负载中包含了所有用户所需要的信息，避免了多次查询数据库 3.因为token是以json加密的形式保存在客户端的，所以jwt是跨语言的，原则上任何web形式都支持。 4.不需要在服务端保存会话信息，特别适用于分布式微服务。

jwt的结构

jwt是由三段信息构成的，将这三段信息文本用.连接一起就构成了jwt字符串。就像这样:

eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9.eyjzdwiioiixmjm0nty3odkwiiwibmftzsi6ikpvag4grg9liiwiywrtaw4ionrydwv9.tjva95orm7e2cbab30rmhrhdcefxjoyzgefonfh7hgq

jwt包含了三部分： header 头部(标题包含了令牌的元数据，并且包含签名和/或加密算法的类型) payload 负载 (类似于飞机上承载的物品) signature 签名/签证

header

jwt的头部承载两部分信息：token类型和采用的加密算法。

{ 
 "alg": "hs256",
 "typ": "jwt"
}

声明类型:这里是jwt

声明加密的算法:通常直接使用 hmac sha256

加密算法是单向函数散列算法，常见的有md5、sha、hamc。 md5(message-digest algorithm 5) （信息-摘要算法）缩写，广泛用于加密和解密技术，常用于文件校验。校验？不管文件多大，经过md5后都能生成唯一的md5值 sha (secure hash algorithm，安全散列算法），数字签名等密码学应用中重要的工具，安全性高于md5 hmac (hash message authentication code)，散列消息鉴别码，基于密钥的hash算法的认证协议。用公开函数和密钥产生一个固定长度的值作为认证标识，用这个标识鉴别消息的完整性。常用于接口签名验证

payload

载荷就是存放有效信息的地方。

有效信息包含三个部分 1.标准中注册的声明 2.公共的声明 3.私有的声明

标准中注册的声明 (建议但不强制使用) ：

iss: jwt签发者 sub: 面向的用户(jwt所面向的用户) aud: 接收jwt的一方 exp: 过期时间戳(jwt的过期时间，这个过期时间必须要大于签发时间) nbf: 定义在什么时间之前，该jwt都是不可用的. iat: jwt的签发时间 jti: jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。

公共的声明：

公共的声明可以添加任何的信息，一般添加用户的相关信息或其他业务需要的必要信息.但不建议添加敏感信息，因为该部分在客户端可解密.

私有的声明：

私有声明是提供者和消费者所共同定义的声明，一般不建议存放敏感信息，因为base64是对称解密的，意味着该部分信息可以归类为明文信息。

signature

jwt的第三部分是一个签证信息这个部分需要base64加密后的header和base64加密后的payload使用.连接组成的字符串，然后通过header中声明的加密方式进行加盐secret组合加密，然后就构成了jwt的第三部分。密钥secret是保存在服务端的，服务端会根据这个密钥进行生成token和进行验证，所以需要保护好。

下面来进行springboot和jwt的集成

引入jwt依赖,由于是基于java，所以需要的是java-jwt

<dependency>
 <groupid>com.auth0</groupid>
 <artifactid>java-jwt</artifactid>
 <version>3.4.0</version>
 </dependency>

需要自定义两个注解

用来跳过验证的passtoken

@target({elementtype.method, elementtype.type})
 @retention(retentionpolicy.runtime)
public @interface passtoken {
 boolean required() default true;
}

需要登录才能进行操作的注解userlogintoken

@target({elementtype.method, elementtype.type})
 @retention(retentionpolicy.runtime)
public @interface userlogintoken {
 boolean required() default true;
}

@target:注解的作用目标

@target(elementtype.type)——接口、类、枚举、注解 @target(elementtype.field)——字段、枚举的常量 @target(elementtype.method)——方法 @target(elementtype.parameter)——方法参数 @target(elementtype.constructor) ——构造函数 @target(elementtype.local_variable)——局部变量 @target(elementtype.annotation_type)——注解 @target(elementtype.package)——包

@retention：注解的保留位置

retentionpolicy.source:这种类型的annotations只在源代码级别保留,编译时就会被忽略,在class字节码文件中不包含。 retentionpolicy.class:这种类型的annotations编译时被保留,默认的保留策略,在class文件中存在,但jvm将会忽略,运行时无法获得。 retentionpolicy.runtime:这种类型的annotations将被jvm保留,所以他们能在运行时被jvm或其他使用反射机制的代码所读取和使用。 @document：说明该注解将被包含在javadoc中 @inherited：说明子类可以继承父类中的该注解

简单自定义一个实体类user,使用lombok简化实体类的编写

@data
@allargsconstructor
@noargsconstructor
public class user {
 string id;
 string username;
 string password;
}

需要写token的生成方法

public string gettoken(user user) {
 string token="";
 token= jwt.create().withaudience(user.getid())
  .sign(algorithm.hmac256(user.getpassword()));
 return token;
 }

algorithm.hmac256():使用hs256生成token,密钥则是用户的密码，唯一密钥的话可以保存在服务端。 withaudience()存入需要保存在token的信息，这里我把用户id存入token中

接下来需要写一个拦截器去获取token并验证token

public class authenticationinterceptor implements handlerinterceptor {
 @autowired
 userservice userservice;
 @override
 public boolean prehandle(httpservletrequest httpservletrequest, httpservletresponse httpservletresponse, object object) throws exception {
 string token = httpservletrequest.getheader("token");// 从 http 请求头中取出 token
 // 如果不是映射到方法直接通过
 if(!(object instanceof handlermethod)){
  return true;
 }
 handlermethod handlermethod=(handlermethod)object;
 method method=handlermethod.getmethod();
 //检查是否有passtoken注释，有则跳过认证
 if (method.isannotationpresent(passtoken.class)) {
  passtoken passtoken = method.getannotation(passtoken.class);
  if (passtoken.required()) {
  return true;
  }
 }
 //检查有没有需要用户权限的注解
 if (method.isannotationpresent(userlogintoken.class)) {
  userlogintoken userlogintoken = method.getannotation(userlogintoken.class);
  if (userlogintoken.required()) {
  // 执行认证
  if (token == null) {
   throw new runtimeexception("无token，请重新登录");
  }
  // 获取 token 中的 user id
  string userid;
  try {
   userid = jwt.decode(token).getaudience().get(0);
  } catch (jwtdecodeexception j) {
   throw new runtimeexception("401");
  }
  user user = userservice.finduserbyid(userid);
  if (user == null) {
   throw new runtimeexception("用户不存在，请重新登录");
  }
  // 验证 token
  jwtverifier jwtverifier = jwt.require(algorithm.hmac256(user.getpassword())).build();
  try {
   jwtverifier.verify(token);
  } catch (jwtverificationexception e) {
   throw new runtimeexception("401");
  }
  return true;
  }
 }
 return true;
 }

 @override
 public void posthandle(httpservletrequest httpservletrequest, 
     httpservletresponse httpservletresponse, 
    object o, modelandview modelandview) throws exception {

 }
 @override
 public void aftercompletion(httpservletrequest httpservletrequest, 
      httpservletresponse httpservletresponse, 
      object o, exception e) throws exception {
 }

实现一个拦截器就需要实现handlerinterceptor接口

handlerinterceptor接口主要定义了三个方法 1.boolean prehandle ()：预处理回调方法,实现处理器的预处理，第三个参数为响应的处理器,自定义controller,返回值为true表示继续流程（如调用下一个拦截器或处理器）或者接着执行 posthandle()和aftercompletion()；false表示流程中断，不会继续调用其他的拦截器或处理器，中断执行。

2.void posthandle()：后处理回调方法，实现处理器的后处理（dispatcherservlet进行视图返回渲染之前进行调用），此时我们可以通过modelandview（模型和视图对象）对模型数据进行处理或对视图进行处理，modelandview也可能为null。

3.void aftercompletion(): 整个请求处理完毕回调方法,该方法也是需要当前对应的interceptor的prehandle()的返回值为true时才会执行，也就是在dispatcherservlet渲染了对应的视图之后执行。用于进行资源清理。整个请求处理完毕回调方法。如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中

主要流程:

1.从 http 请求头中取出 token， 2.判断是否映射到方法 3.检查是否有passtoken注释，有则跳过认证 4.检查有没有需要用户登录的注解，有则需要取出并验证 5.认证通过则可以访问，不通过会报相关错误信息

配置拦截器

在配置类上添加了注解@configuration，标明了该类是一个配置类并且会将该类作为一个springbean添加到ioc容器内

@configuration
public class interceptorconfig extends webmvcconfigureradapter {
 @override
 public void addinterceptors(interceptorregistry registry) {
 registry.addinterceptor(authenticationinterceptor())
  .addpathpatterns("/**"); // 拦截所有请求，通过判断是否有 @loginrequired 注解 决定是否需要登录
 }
 @bean
 public authenticationinterceptor authenticationinterceptor() {
 return new authenticationinterceptor();
 }
}

webmvcconfigureradapter该抽象类其实里面没有任何的方法实现，只是空实现了接口 webmvcconfigurer内的全部方法，并没有给出任何的业务逻辑处理，这一点设计恰到好处的让我们不必去实现那些我们不用的方法，都交由webmvcconfigureradapter抽象类空实现,如果我们需要针对具体的某一个方法做出逻辑处理,仅仅需要在

webmvcconfigureradapter子类中@override对应方法就可以了。

注：

在springboot2.0及spring 5.0中webmvcconfigureradapter已被废弃网上有说改为继承webmvcconfigurationsupport，不过试了下，还是过期的

解决方法:

直接实现webmvcconfigurer （官方推荐）

@configuration
public class interceptorconfig implements webmvcconfigurer {
 @override
 public void addinterceptors(interceptorregistry registry) {
 registry.addinterceptor(authenticationinterceptor())
  .addpathpatterns("/**"); 
 }
 @bean
 public authenticationinterceptor authenticationinterceptor() {
 return new authenticationinterceptor();
 }
}

interceptorregistry内的addinterceptor需要一个实现handlerinterceptor接口的拦截器实例，addpathpatterns方法用于设置拦截器的过滤路径规则。这里我拦截所有请求，通过判断是否有@loginrequired注解决定是否需要登录

在数据访问接口中加入登录操作注解

@restcontroller
@requestmapping("api")
public class userapi {
 @autowired
 userservice userservice;
 @autowired
 tokenservice tokenservice;
 //登录
 @postmapping("/login")
 public object login(@requestbody user user){
 jsonobject jsonobject=new jsonobject();
 user userforbase=userservice.findbyusername(user);
 if(userforbase==null){
  jsonobject.put("message","登录失败,用户不存在");
  return jsonobject;
 }else {
  if (!userforbase.getpassword().equals(user.getpassword())){
  jsonobject.put("message","登录失败,密码错误");
  return jsonobject;
  }else {
  string token = tokenservice.gettoken(userforbase);
  jsonobject.put("token", token);
  jsonobject.put("user", userforbase);
  return jsonobject;
  }
 }
 }
 @userlogintoken
 @getmapping("/getmessage")
 public string getmessage(){
 return "你已通过验证";
 }
}

不加注解的话默认不验证，登录接口一般是不验证的。在getmessage()中我加上了登录注解，说明该接口必须登录获取token后，在请求头中加上token并通过验证才可以访问

下面进行测试，启动项目，使用postman测试接口

在没token的情况下访问api/getmessage接口

SpringBoot集成JWT实现token验证的流程　　　　　　　　　　　　　