SpringBoot整合JWT的入门指南


Posted in Java/Android onJune 29, 2021
目录
  • 1.JWT
  • 2.JWT登录执行流程图
  • 3.为什么使用JWT?
  • 4.JWT的组成
  • 5.SpringBoot整合JWT
  • 测试
  • 总结

1.JWT

JWT(JSON Web Token),为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准。将用户信息加密到token中,服务器不保存任何用户信息,服务器通过保存的密钥验证token的正确性。

优点

1.简介:可以通过 URL POST 参数或者在 HTTP header 发送,因为数据量小,传输速度也很快;

2.自包含:负载中可以包含用户所需要的信息,避免了多次查询数据库;

3.因为 Token 是以 JSON 加密的形式保存在客户端的,所以 JWT 是跨语言的,原则上任何 web 形式都支持;

4.不需要再服务端保存会话信息,特别适用于分布式微服务;

缺点

1.无法作废已经发布的令牌;

2.不易应对数据过期;

2.JWT登录执行流程图

SpringBoot整合JWT的入门指南

3.为什么使用JWT?

  • 在传统的用户登录认证中,因为http是无状态的,所以都是采用session+cokokie,用户登录成功,服务端会保存一个session,并给客户端一个sessionId,客户端会把sessionId保存在cookie中,每次请求都会携带sessionId。cookie+session模式是保存在内存中,在分布式服务中会面临session共享问题,随着用户量得增加,开销就越来越大。而JWT不需要在服务端保存会话信息,特别适合分布式微服务。
  • 简洁:可以用过URL,POST参数或者在HTTP Header发送,因为数据量小,传输速度也快
  • JWT支持跨语言
  • 自包含: 载荷中包含了所有用户所需要的信息,避免了多次查询数据库。

4.JWT的组成

JWT由三部分构成,类似于如下:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJscyIsImV4cCI6MTYyNDU5Nzc5Nn0.4kwT1elZCb_k2D7AxbuFHM35VmBK4PcmLaqHhcHEq4_wVe8GVO8ODypGSKksTs-hraBopBCm2IC9EC2rO-GHng

第一部分为头部(header),承载两部分信息

声明类型(JWT)

声明加密算法,默认为HMAC SHA256

{
  "typ","JWT",
  "alg","HS256"
}

使用Base64加密后

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9 

第二部分为payload(载荷),存放有效信息的地方,这些有效信息分为三部分:

  • 标准中注册的声明
  • 公共的声明
  • 私有的声明

其中,标准中注册的声明 (建议但不强制使用)包括如下几个部分 :

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

公共的声明部分:

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

私有的声明部分:

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

第三部分为signature(签证)

var encodedString = base64UrlEncode(header) + '.' + base64UrlEncode(payload);

//密钥就是我们定义的secret,加密后得到签证
var signature = HMACSHA256(encodedString, '密钥');

5.SpringBoot整合JWT

引入依赖

<!--JWT-->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>0.7.0</version>
        </dependency>
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.4.0</version>
        </dependency>
          <!--StringUtils工具包-->
        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.6</version>
        </dependency>
        <!--ConfigurationProperties出现异常-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

配置application.yml文件

server:
  port: 8888
spring:
  jwt:
    #过期时间
    expireTime: 1800000
    #加密密钥
    secret: lsyyp5201314
    #token返回头部
    header: LOGINTOKEN

JWT工具类

package org.best.util;

import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.TokenExpiredException;
import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.Date;

@ConfigurationProperties(prefix = "spring.jwt")
public class JWTUtils {

    public static String header;
    private static String secret;
    private static String expireTime;

    /**
     * 生成token
     * @param sub 用户唯一信息
     * @return token
     */
    public  static   String createToken(String sub){
        return JWT
                .create()
                .withSubject(sub)
                .withExpiresAt(new Date(System.currentTimeMillis()+Long.parseLong(expireTime)))
                .sign(Algorithm.HMAC512(secret));
    }

    /**
     * 根据token获取用户信息
     * @param token
     * @return 用户信息
     */
    public static String validateToken(String token){
        return JWT
                .require(Algorithm.HMAC512(secret))
                .build()
                .verify(token)
                .getSubject();
    }

    /**
     * 检验Token是否需要刷新
     * @param token
     * @return
     */
    public static boolean refreshToken(String token) {
        Date expireDate = null;
        try {
            expireDate = JWT
                    .require(Algorithm.HMAC512(secret))
                    .build()
                    .verify(token)
                    .getExpiresAt();
        } catch (TokenExpiredException e) {
            return true;
        }
        return (expireDate.getTime()-System.currentTimeMillis())<0;
    }

    public void setHeader(String header) {
        this.header = header;
    }

    public String getSecret() {
        return secret;
    }

    public void setSecret(String secret) {
        this.secret = secret;
    }

    public String getExpireTime() {
        return expireTime;
    }

    public void setExpireTime(String expireTime) {
        this.expireTime = expireTime;
    }
}

自定义拦截器

package org.best.config;

import org.apache.commons.lang.StringUtils;
import org.best.common.TokenIsNullException;
import org.best.common.TokenValidateException;
import org.best.util.JWTUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String logintoken = request.getHeader("LOGINTOKEN");
        //如果token为空
        if (StringUtils.isBlank(logintoken)){
            throw new TokenIsNullException("请登录");
        }
        //校验Token
        String sub = JWTUtils.validateToken(logintoken);
        if (StringUtils.isBlank(sub)){
            throw new TokenValidateException("token校验失败");
        }

        //更新token有效期(生产新token)
        if (JWTUtils.refreshToken(logintoken)){
            String token = JWTUtils.createToken(sub);
            response.setHeader(JWTUtils.header,token);
        }

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

注册拦截器

package org.best.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry
                .addInterceptor(new LoginInterceptor())
                .addPathPatterns("/find")
                .excludePathPatterns("/login");
    }
}

自定义异常

package org.best.common;

/**
 * Token校验异常
 */
public class TokenValidateException extends RuntimeException {
    public TokenValidateException() {
    }

    public TokenValidateException(String message) {
        super(message);
    }
}
package org.best.common;

/**
 * Token为空异常
 */
public class TokenIsNullException extends RuntimeException{
    public TokenIsNullException() {
    }

    public TokenIsNullException(String message) {
        super(message);
    }
}

自定义Controller

package org.best.controller;

import org.best.pojo.User;
import org.best.util.JWTUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;

@RestController
public class LoginController {
    @GetMapping("/login")
    public String login(User user, HttpServletResponse response){
        //这里就不做数据库查询了

        //根据用户id生成token
        String token = JWTUtils.createToken(String.valueOf(user.getId()));
        //将token存入HTTP响应头中
        response.setHeader(JWTUtils.header,token);
        return user.toString();
    }

    @GetMapping("/find")
    public String find(){
        return "success";
    }
}

测试

登录接口

SpringBoot整合JWT的入门指南

我们来测试下find 接口 ,不带token会出现啥情况

SpringBoot整合JWT的入门指南

带上token

SpringBoot整合JWT的入门指南

总结

到此这篇关于SpringBoot整合JWT的文章就介绍到这了,更多相关SpringBoot整合JWT内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
Java各种比较对象的方式的对比总结
Jun 20 Java/Android
详细了解MVC+proxy
Jul 09 Java/Android
Log4j.properties配置及其使用
Aug 02 Java/Android
Java面试题冲刺第十九天--数据库(4)
Aug 07 Java/Android
Jpa Specification如何实现and和or同时使用查询
Nov 23 Java/Android
Eclipse+Java+Swing+Mysql实现电影购票系统(详细代码)
Jan 18 Java/Android
你知道Java Spring的两种事务吗
Mar 16 Java/Android
Java字符串逆序方法详情
Mar 21 Java/Android
Android自定义双向滑动控件
Apr 19 Java/Android
JAVA 线程池(池化技术)的实现原理
Apr 28 Java/Android
多线程Spring通过@Scheduled实现定时任务
May 25 Java/Android
Java结构型设计模式之组合模式详解
Sep 23 Java/Android
jackson json序列化实现首字母大写,第二个字母需小写
Java数组与堆栈相关知识总结
分析JVM源码之Thread.interrupt系统级别线程打断
Jun 29 #Java/Android
Jackson 反序列化时实现大小写不敏感设置
Jun 29 #Java/Android
Maven学习----Maven安装与环境变量配置教程
Spring Boot两种全局配置和两种注解的操作方法
Spring Boot 实现敏感词及特殊字符过滤处理
Jun 29 #Java/Android
You might like
哪吒敖丙传:新人物二哥敖乙出场 小敖丙奶气十足
2020/03/08 国漫
PHP 设置MySQL连接字符集的方法
2011/01/02 PHP
php数组函数序列之end() - 移动数组内部指针到最后一个元素,并返回该元素的值
2011/10/31 PHP
ThinkPHP应用模式扩展详解
2014/07/16 PHP
php与Mysql的一些简单的操作
2015/02/26 PHP
php微信开发之百度天气预报
2016/11/18 PHP
JS实多级联动下拉菜单类,简单实现省市区联动菜单!
2007/05/03 Javascript
De facto standard 世界上不可思议的事实标准
2010/08/29 Javascript
js下用eval生成JSON对象
2010/09/17 Javascript
jquery属性选择器not has怎么写 行悬停高亮显示
2013/11/13 Javascript
JS两种定义方式的区别、内部原理
2013/11/21 Javascript
当jQuery1.7遇上focus方法的问题
2014/01/26 Javascript
jQuery解决$符号命名冲突
2016/06/18 Javascript
Javascript操作表单实例讲解(下)
2016/06/20 Javascript
Bootstrap输入框组件简单实现代码
2017/03/06 Javascript
javascript实现下雨效果
2017/03/27 Javascript
Scala解析Json字符串的实例详解
2017/10/11 Javascript
vue权限管理系统的实现代码
2019/01/17 Javascript
[02:07]2017国际邀请赛中国区预选赛直邀战队前瞻
2017/06/23 DOTA
python通过自定义isnumber函数判断字符串是否为数字的方法
2015/04/23 Python
python爬虫之urllib3的使用示例
2018/07/09 Python
Windows下python3.6.4安装教程
2018/07/31 Python
PyTorch搭建一维线性回归模型(二)
2019/05/22 Python
Python操作SQLite/MySQL/LMDB数据库的方法
2019/11/07 Python
python爬虫使用requests发送post请求示例详解
2020/08/05 Python
Python requests接口测试实现代码
2020/09/08 Python
python GUI计算器的实现
2020/10/09 Python
汽车检测与维修个人求职信
2013/09/24 职场文书
浙江文明网签名寄语
2014/01/18 职场文书
《狐假虎威》教学反思
2014/02/07 职场文书
舞蹈专业求职信
2014/06/13 职场文书
个人借款协议书范本
2014/11/17 职场文书
2019年幼儿园家长接送责任书
2019/10/29 职场文书
让文件路径提取变得更简单的Python Path库
2021/05/27 Python
python中Matplotlib绘制直线的实例代码
2021/07/04 Python
Win7/8.1用户可以免费升级到Windows 11系统吗?
2021/11/21 数码科技