jave web token实现登录验证

JWT

JWT官网： https://jwt.io/
JWT(Java版)的github地址:https://github.com/jwtk/jjwt

什么是JWT

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

JWT请求流程

image.png

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",
   "type": "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和进行验证，所以需要保护好。

作者：意识流丶
链接：https://www.jianshu.com/p/e88d3f8151db
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

Springboot集成JWT

pom文件

添加JWT依赖

<dependency>
      <groupId>com.auth0</groupId>
      <artifactId>java-jwt</artifactId>
      <version>3.4.0</version>
</dependency>

自定义注解

/**当使用@PassToken注解在接口/方法时调用，或者用于当做一个注解标识，可以通过调用接口时检查是否有该标识
@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：说明子类可以继承父类中的该注解
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
    boolean required() default true;
}

Token工具类

定义一个token工具类，用于生成token或者验证token等方法

@Component
public class TokenHelp {
    @Autowired
    private UserService userService;

    public boolean tokenValidate(String token,boolean isAdmin){
            // 执行认证
            if (token == null) {
                throw new RRException("无token，请重新登录");
            }
            // 获取 token 中的 user id
            String userId;
            try {
                userId = JWT.decode(token).getAudience().get(0);
            } catch (JWTDecodeException j) {
                throw new RRException("401");
            }
            UserEntity user = userService.getById(userId);
            //验证是否是管理员账号
            if(isAdmin){
                if(!user.getUserName().equals(Constant.SUPER_ADMIN_NAME)){
                    throw new RRException("该操作需要有管理员权限");
                }
            }
            if (user == null) {
                throw new RRException("用户不存在，请重新登录");
            }
            // 验证 token
            JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();
            try {
                jwtVerifier.verify(token);
            } catch (JWTVerificationException e) {
                throw new RRException("401");
            }
            return true;
    }

    public String getToken(UserEntity user) {
        String token="";
        //Algorithm.HMAC256():使用HS256生成token,**则是用户的密码，唯一**的话可以保存在服务端。
	//withAudience()存入需要保存在token的信息，这里把用户ID存入token中
        token= JWT.create().withAudience(user.getId().toString())
                .sign(Algorithm.HMAC256(user.getPassword()));
        return token;
    }
}

拦截器

定义一个拦截器，拦截所有请求，如果有接口声明需要登录才访问，则拦截该请求进行token验证

该类实现WebMvcConfigurer接口，重写拦截方法

WebMvcConfigurer详解链接：https://blog.csdn.net/zhangpower1993/article/details/89016503

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 拦截所有请求，通过判断是否有 登录验证相关注解 决定是否需要登录
        registry.addInterceptor(authenticationInterceptor())
                .addPathPatterns("/**");
    }
    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        //这个是自定义的拦截类，实现拦截后的操作
        return new AuthenticationInterceptor();
    }
}

自定义的拦截类

实现HandlerInterceptor接口，该接口用于拦截后的操作

public class AuthenticationInterceptor implements HandlerInterceptor {
    @Autowired
    UserService userService;

    @Autowired
    private TokenHelp tokenHelp;

    //预处理回调方法,实现处理器的预处理
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {
        // 从 http 请求头中取出 token
        String token = httpServletRequest.getHeader("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(UserAdminToken.class)) {
            UserAdminToken userAdminToken = method.getAnnotation(UserAdminToken.class);
            //对有这个请求验证的方法进行验证token
            if (userAdminToken.required()) {
                // 验证 token
                return tokenHelp.tokenValidate(token,true);
            }
        }
        //检查有没有需要用户权限的注解
        if (method.isAnnotationPresent(UserLoginToken.class)) {
            UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);
            //对有这个请求验证的方法进行验证token
            if (userLoginToken.required()) {
                // 验证 token
                return tokenHelp.tokenValidate(token,false);
            }
        }
        return true;
    }
//后处理回调方法，实现处理器的后处理（DispatcherServlet进行视图返回渲染之前进行调用）
    @Override
    public void postHandle(HttpServletRequest httpServletRequest,
                           HttpServletResponse httpServletResponse,
                           Object o, ModelAndView modelAndView) throws Exception {

    }
//整个请求处理完毕回调方法,该方法也是需要当前对应的Interceptor的preHandle()的返回值为true时才会执行，一般用于资源清理
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest,
                                HttpServletResponse httpServletResponse,
                                Object o, Exception e) throws Exception {
    }

登录接口

当用于登录验证成功时，返回token

//验证账号和密码是否正确
        if(userEntity.getUserName().equals(user.getUserName()) &&
                userEntity.getPassword().equals(user.getPassword())){
            String token = tokenHelp.getToken(userEntity);
            Result result = new Result<>();
            Map<String,Object> map  = new HashMap<String,Object>();
            map.put("token",token);
            map.put("user",userEntity);
            return result.ok(map);
        }

前端配置

前端登录请求成功时，拿到服务器返回的token，存入全局变量，以layui为例

 //请求登入接口
      admin.req({
        url:  //实际使用请改成服务端真实接口
        ,data: JSON.stringify(data)//用户名和密码
        ,type: 'post'
        ,dataType:"json"
        ,headers: { 'Content-Type': 'application/json;charset=utf8' }
        ,done: function(res){
         
          //请求成功后，写入 access_token
          layui.sessionData(setter.tableName, {
            key: "token"
            ,value: res.data.token
          });
          //登入成功的提示与跳转
          layer.msg('登录成功', {
            offset: '15px'
            ,icon: 1
            ,time: 1000
          }, function(){
           location.href = 'index.html'; //后台主页
          });
        }
       
      }
      
      );

在前端中的每次ajax请求的全局配置

 //给每次ajax请求默认加上token
  //全局配置
  $.ajaxSetup({
    beforeSend: function(jqXHR, settings) {
      jqXHR.setRequestHeader("token",layui.sessionData(layui.setter.tableName)['token']);
      }
      ,complete: function (req, status) { 
        if(req.status != 200){
          layer.msg(req.status+":"+req.responseJSON.message);
        }
        
      }
  });

以后请求需要登录的接口都需要加上token，否则报错

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-4y1VUpAQ-1594134501559)(D:\hstc\自学记录\movie\img\image-20200529222615740.png)]