Jwt实战教程

加油！望疫情早日结束，中国加油，郑州加油

---

🍓JWT

🍒 一，什么是JWT

JWT官网
JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret (with the HMAC algorithm) or a public/private key pair using RSA or ECDSA. --摘自官网

1. 翻译
-官网地址: https:/ ljwt.io/introduction /
-翻译: jsonwebtoken(JWT)是一个开放标准（rfc7519)，它定义了一种紧凑的、自包含的方式，
用于在各方之间以JSON对象安全地传输信息。此信息可以验证和信任，因为它是数字签名的。
jwt可以使用秘密（使用HNAC算法）或使用RSA或ECDSA的公钥/私钥对进行签名

2. 通俗解释
-JWT简称JSON Web Token ,也就是通过JSON形式作为Web应用中的令牌，
用于在各方之间安全地将信息作为JSON对象传输。在数据传输过程中还可以完成数据加密、
签名等相关处理。

🍇 二，JWT能做什么

1.授权
-这是使用JWT的最常见方案。一旦用户登录，每个后续请求将包括JWT，
从而允许用户访闷该令牌允许的路由，服务和资源。单点登录是当今广泛使用JWT的一项功能，
因为它的开销很小并且可以在不同的域中轻松使用。

2.信息交换
- JSON Web Token是在各方之间安全地传输信息的好方法。因为可以对JWT进行签名
《例如，使用公钥/私钥对)，所以您可以确保发件人是他们所说的人。
 此外，由于签名是使用标头和有效负载计算的，因此您还可以验证内容是否遭到篡改。

🍌 三，为什么是JWT

1.基于传统的Session认证

1.认证方式
  我们知道，http协议本身是一种无状态的协议，而这就意味着如果用户向我们的应用提供了用户名
  和密码来进行用户认证，那么下一次请求时，用户还要再一次进行用户认证才行，因为根据http协
  议，我们并不能知道是哪个用户发出的请求，所以为了让我们的应用能识别是哪个用户发出的请求，
  我们只能在服务器存储一份用户登录的信息，这份登录信息会在响应时传递给浏览器，告诉其保存为    cookie,以便下次请求时发送给我们的应用，这样我们的应用就能识别请求来自哪个用户了，
  这就是传统的基于session认证。
2.认证流程

3.暴露问题
-1.每个用户经过我们的应用认证之后，我们的应用都要在服务端做一次记录，以方便用户下次请求的
鉴别，通常而言session都是保存在内存中，而随着认证用户的增多，服务端的开销会明显增大

-2.用户认证之后，服务端做认证记录，如果认证的记录被保存在内存中的话，这意味着用户下次请求
还必须要请求在这台服务器上,这样才能拿到授权的资源，这样在分布式的应用上，相应的限制了负载
均衡器的能力。这也意味着限制了应用的扩展能力。

-3.因为是基于cookie来进行用户识别的,rcookie如果被截获，用户就会很容易受到跨站请求伪造的攻击。

- 4.在前后端分离系统中就更加痛苦:如下图所示
也就是说前后端分离在应用解耦后增加了部署的复杂性。通常用户一次请求就要转发多次。
如果用session每次携带sessionid到服务器，服务器还要查询用户信息。同时如果用户很多。
这些信息存储在服务器内存中，给服务器增加负担。还有就是CSRF(跨站伪造请求攻击)攻击，
session是基于cookie进行用户识别的,cookie如果被截获，用户就会很容易受到跨站请求伪造的攻击。
还有就是sessionid就是一个特征值，表达的信息不够丰富。不容易扩展。
而且如果你后端应用是多节点部署。那么就需要实现session共享机制。不方便集群应用。

2.基于JWT认证

1.认证流程
-首先，前端通过Web表单将自己的用户名和密码发送到后端的接口。这一过程一般
是一个HTTP POST请求。建议的方式是通过SSL加密的传输(https协议)，从而避免敏感信息被嗅探。
-后端核对用户名和密码成功后，将用户的id等其他信息作为JWT Payload(负载)，
将其与头部分别进行Base64编码拼接后签名形成一个JWT(Token)。
形成的JWT就是一个形同1l1.Zzz.xxx的字符串。
-后端将JWT字符串作为登录成功的返回结果返回给前端。前端可以将返回的结果保存在
localStorage或sessionStorage上，退出登录时前端删除保存的JWT即可。
-前端在每次请求时将JWT放入HTTP Header中的Authorization位。(解决XSS和XSRF问题)
-后端检查是否存在，如存在验证JWT的有效性。例如，检查签名是否正确;检查Token是否过期;
检查Token的接收方是否是自己（可选)。
–验证通过后后端使用JWT中包含的用户信息进行其他逻辑操作，返回相应结果。
2.jwt优势
-简洁(Compact):可以通过URL，POST参数或者在HTTP header发送，因为数据量小，
传输速度也很快-自包含(Self-contained)︰负载中包含了所有用户所需要的信息，
避免了多次查询数据库
-因为Token是以JSON加密的形式保存在客户端的，所以JWT是跨语言的，
原则上任何web形式都支持。-不需要在服务端保存会话信息，特别适用于分布式微服务。

🥝四，JWT的结构是什么?

1.令牌组成
-1.标头(Header)
-2.有效载荷(Payload)
-3.签名( Signature)
-因此，JWT通常如下所示:xXxxx.yyyyy.zzzzz Header.Payload.Signature

2.Header
–标头通常由两部分组成:令牌的类型(即JWT）和所使用的签名算法，
例如HNAC SHA256或RSA。它会使用Base64编码组成JWT结构的第一部分。
-注意:Base64是一种编码，也就是说，它是可以被翻译回原来的样子来的。它并不是一种加密过程。

	{
	"alg" : “Hs230,
	"typ" : "JWT”
	}

3.Payload
-令牌的第二部分是有效负载，其中包含声明。声明是有关实体（通常是用户）和其他数据的声明。
同样的，它会使用Base64编码组成JWT结构的第二部分

	{
	"sub" : "1234567898",
	"name" : "John Doe" ,
	"admin" : true
	}

4.Signature
-前面两部分都是使用Base64进行编码的，即前端可以解开知道里面的信息。Signature 需要使用编码后
的header和 payload以及我们提供的一个密钥，然后使用header中指定的签名算法(HS256)进行签名。
签名的作用是保证JWT没有被篡改过
-如:HMACSHA256 (base64UrlEncode(header) + "." + base64UrlEncode(payload) ,secret);

签名目的
-最后一步签名的过程，实际上是对头部以及负载内容进行签名，防止内容被窜改。如果有人对头部以及
负载的内容解码之后进行修改，再进行编码，最后加上之前的签名组合形成新的JWT的话，那么服务器端
会判断出新的头部和负载形成的签名和JWT附带上的签名是不一样的。如果要对新的头部和负载进行签名，在不知道服务器加密时用的密钥的话，得出来的签名也是不一样的。

信息安全问题
-在这里大家一定会问一个问题: Base64是一种编码，是可逆的，那么我的信息不就被暴露了吗?
-是的。所以，在JWT中，不应该在负载里面加入任何敏感的数据。在上面的例子中，我们传输的是
用户的User ID。这个值实际上不是什么敏﹐感内容，一般情况下被知道也是安全的。但是像密码
这样的内容就不能被放在JWT中了。如果将用户的密码放在了JWT中，那么怀有恶意的第﹐三方通过
Base64解码就能很快地知道你的密码了。因此JWT适合用于向Web应用传递一些非敏感信息。
JWT还经常用于设计用户认证和授权系统，甚至实现Web应用的单点登录。

5.放在一起
-输出是三个由点分隔的Base64-URL字符串，可以在HTML和HTTP环境中轻松传递这些字符串，
与基于XML的标准（例如SAML)相比，它更紧凑。
-简洁(Compact)
可以通过URL，POST参数或者在HTTP header发送，因为数据量小，传输速度快自包含(Self-contained)
负载中包含了所有用户所需要的信息,避免了多次查询数据库

🌽五，使用JWT

1.引入依赖

<!--引入jwt-->
<!-- https://mvnrepository.com/artifact/com.auth0/java-jwt -->
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.19.2</version>
        </dependency>

2.生成token

Calendar instance = Calendar.getInstance();
        instance.add(Calendar.SECOND,20);
        String token = JWT.create()
                .withClaim("userId",21)//payload
                .withClaim("userName","xiaochen")
                .withExpiresAt(instance.getTime())//指定令牌过期时间
                .sign(Algorithm.HMAC256("!Q@W#E$R"));//签名
        System.out.println(token);

3.生成结果

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6InhpYW9jaGVuIiwiZXhwIjoxNjUyMzYzODI1LCJ1c2VySWQiOjIxfQ.oD0Cz1nt7CM6-rSs2gTpnDw40J2XykOppvnpTIVvfG0

4.根据令牌和签名解析数据

//创建验证对象
        JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256("!Q@W#E$R")).build();//验证签名
        DecodedJWT verify = jwtVerifier.verify("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6InhpYW9jaGVuIiwiZXhwIjoxNjUyMzY2NTk5LCJ1c2VySWQiOjIxfQ.TPTyo64KXIGXITg_kxhoGlm40JsMfMA3f8dyf4WcDSQ");

        System.out.println(verify.getClaim("userId").asInt());//获取信息
        System.out.println(verify.getClaim("userName").asString());

5.常见异常信息

- SignatureVerificationException :签名不一致异常
- TokenExpiredException:令牌过期异常
- AlgorithmMismatchException:算法不匹配异常
- InvalidclaimException:失效的payload异常

🍉六，封装工具类

package com.hgd.zwh.utils;

import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;

import java.util.Calendar;
import java.util.Map;

public class JwtUtil {
    private static final String SING = "!Q@W#E$R";//签名
    /**
     * 生成token header.payload.sing
     */
    public static String getToken(Map<String,String> map){
        Calendar instance = Calendar.getInstance();
        instance.add(Calendar.DATE,7);//默认7天过期

        //创建jwt builder
        JWTCreator.Builder builder = JWT.create();
        //payload
        map.forEach((k,v)->{
            builder.withClaim(k,v);
        });
        //sing签名
        String token = builder.withExpiresAt(instance.getTime())//指定令牌过期时间
                .sign(Algorithm.HMAC256(SING));//签名

        return token;
    }

    /*
    *验证token 合法性
     */
    public static void verify(String token){
         JWT.require(Algorithm.HMAC256(SING)).build().verify(token);

    }

    /**
     * 获取token信息方法
     */
    public static DecodedJWT getTokenInfo(String token){
        DecodedJWT verify = JWT.require(Algorithm.HMAC256(SING)).build().verify(token);
        return verify;
    }
}

⭐️七，整合springboot

1.导入依赖（配置pom.xml文件）

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--父依赖-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.hgd</groupId>
    <artifactId>springboot-jwt</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-jwt</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 测试依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 引入jwt -->
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.19.2</version>
        </dependency>
        <!-- 引入lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
        <!-- 引入mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>
        <!-- 引入druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.4</version>
        </dependency>
        <!-- 引入MySQL -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.29</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.编写属性文件（application.properties）

## 配置端口号
server.port=8989

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.url=jdbc:mysql://localhost:3306/jwt?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

## 扫描实体类
mybatis.typeAliasesPackage=com.hgd.zwh.*
## 扫描映射
mybatis.mapperLocations=classpath:mapper/*.xml

3.新建用户表

CREATE TABLE `user` (
  `userId` int(11) NOT NULL AUTO_INCREMENT COMMENT '编号',
  `userName` varchar(255) NOT NULL COMMENT '用户名',
  `userPwd` varchar(255) NOT NULL COMMENT '密码',
  PRIMARY KEY (`userId`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

4.开发entity

package com.hgd.zwh.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor//有参
@NoArgsConstructor//无参
public class User {
    private Integer userId;
    private String userName;
    private String userPwd;
}

5.开发DAO接口层

package com.hgd.zwh.dao;

import com.hgd.zwh.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper {
    User login(User user);
}

6.开发mapper.xml映射

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.hgd.zwh.dao.UserMapper">
      <select id="login" parameterType="user" resultType="user">
          select * from user where userName=#{userName} and userPwd=#{userPwd}
      </select>
</mapper>

6.开发service层

package com.hgd.zwh.service;

import com.hgd.zwh.entity.User;

public interface UserService {
    User login(User user);//登录接口
}

7.开发service实现层

package com.hgd.zwh.service.impl;

import com.hgd.zwh.dao.UserMapper;
import com.hgd.zwh.entity.User;
import com.hgd.zwh.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@Service
@Transactional
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;

    @Override
    @Transactional(propagation = Propagation.SUPPORTS)
    public User login(User user) {
        User userDB = userMapper.login(user);

        if (userDB != null){
            return userDB;
        }
        throw new RuntimeException("登录失败~~");
    }
}

7.开发controller控制层

package com.hgd.zwh.controller;

import com.hgd.zwh.entity.User;
import com.hgd.zwh.service.UserService;
import com.hgd.zwh.utils.JwtUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
@Slf4j//日志
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping("/user/login")
    public Map<String,Object> login(User user){
         Map<String,Object> map = new HashMap<>();
         try {
             User userDB = userService.login(user);
             Map<String,String> payload = new HashMap<>();
             payload.put("name",userDB.getUserName());
             //生成JWT令牌
             String token = JwtUtil.getToken(payload);
             map.put("state",true);
             map.put("msg","认证成功");
             map.put("token",token);//响应token
         }catch (RuntimeException e){
             map.put("state",false);
             map.put("msg",e.getMessage());
         }
         return map;
    }
}

8.验证

9.验证token

@PostMapping("/user/test")
    public Map<String ,Object> test(String token){
        Map<String,Object> map = new HashMap<>();
        log.info("当前token为：[{}]",token);
        try {
            DecodedJWT verify = JwtUtil.getTokenInfo(token);
            map.put("state",true);
            map.put("msg","请求成功");
            return map;
        }catch (SignatureVerificationException e){
            e.printStackTrace();
            map.put("msg","无效签名");

        }catch (TokenExpiredException e){
            e.printStackTrace();
            map.put("msg","token过期");

        }catch (AlgorithmMismatchException e){
            e.printStackTrace();
            map.put("msg","token算法不一致");

        }catch (Exception e){
            e.printStackTrace();
            map.put("msg","token无效");

        }
        map.put("state",false);
        return map;
    }

10.问题

使用上述方式每次都要传递token数据，每个方法都需要验证token代码冗余,不够灵活?如何优化-使用拦截器进行优化

11.解决方案

1.编写拦截器（JWTInterceptor）

package com.hgd.zwh.Interceptor;

import com.auth0.jwt.exceptions.AlgorithmMismatchException;
import com.auth0.jwt.exceptions.SignatureVerificationException;
import com.auth0.jwt.exceptions.TokenExpiredException;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.hgd.zwh.utils.JwtUtil;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

public class JWTInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        //获取请求头中令牌
        String token = request.getHeader("token");
        Map<String,Object> map = new HashMap<>();
        try {
            JwtUtil.getTokenInfo(token);//验证令牌
            return true;
        }catch (SignatureVerificationException e){
            e.printStackTrace();
            map.put("msg","无效签名");

        }catch (TokenExpiredException e){
            e.printStackTrace();
            map.put("msg","token过期");

        }catch (AlgorithmMismatchException e){
            e.printStackTrace();
            map.put("msg","token算法不一致");

        }catch (Exception e){
            e.printStackTrace();
            map.put("msg","token无效");

        }
        map.put("state",false);//设置状态
        //将map转为json jackson
        String json = new ObjectMapper().writeValueAsString(map);
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().println(json);
        return false;

    }

}

2.编写拦截器配置文件（JWTInterceptorConfig）

package com.hgd.zwh.config;

import com.hgd.zwh.Interceptor.JWTInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

public class JWTInterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new JWTInterceptor())
                .addPathPatterns("/user/test")//其他接口token验证
                .excludePathPatterns("/user/login");//所有用户都放行
    }

}

3.重写userController控制器中的方法（test方法）

@PostMapping("/user/test")
    public Map<String ,Object> test(HttpServletRequest request){
        Map<String,Object> map = new HashMap<>();
            //处理自己的业务逻辑
            String token = request.getHeader("token");//获取token
            log.info("token",token);
            DecodedJWT verify = JwtUtil.getTokenInfo(token);//根据token获取数据
            log.info("用户名",verify.getClaim("userName").asString());
            map.put("state",true);
            map.put("msg","请求成功");
            return map;
    }

4.访问验证

❗️❗️❗️以上代码仅供参考❗️❗️❗️

❗️❗️❗️让好奇心促使技术的成长❗️❗️❗️