SpringBoot基于JWT的token做登录认证

背景

我们在基于Session做登录认证的时候，会有一些问题，因为Session存储到服务器端，然后通过客户端的Cookie进行匹配，如果正确，则通过认证，否则不通过认证。这在简单的系统中可以这么使用，并且难度是最低的，但是如果在大型分布式项目中，如果还是基于Session做登录认证的话，就不可行了。这个时候我们可以基于token做登录认证。token其实就是一个字符串，生成token的实现方案有很多种，可以使用uuid作为token，也可以使用jwt作为token，其中使用jwt实现的方案是最流行的，那么下面将会讲如何在SpringBoot中基于jwt实现token登录认证。

1. 引入依赖

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

2. 自定义注解

自定义一个注解，在需要认证的方法上添加该注解

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Auth {
    boolean require() default true;
}

3. 编写拦截器

通过识别是否在接口上添加@Auth注解来确定是否需要登录才能访问。

同时这里需要注意只拦截HandlerMethod类型，同时还要考虑放行BasicErrorController，因为基本的报错在这个控制器中，如果不放行，那么会看不到报错信息。

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            if (handlerMethod.getBean() instanceof BasicErrorController) {
                return true;
            }
            Auth auth = handlerMethod.getMethod().getAnnotation(Auth.class);
            if (auth != null && auth.require()) {
                String token = request.getHeader("token");
                if (StringUtils.isNotBlank(token)) {
                    if (TokenUtil.verifyToken(token)) { // 校验 token 是否正确
                        return true;
                    } else {
                        request.getRequestDispatcher("/error/tokenError").forward(request, response); // 这里你也可以直接抛出自定义异常，然后在全局异常处理器中处理
                    }
                } else {
                    request.getRequestDispatcher("/error/token").forward(request, response); // 这里你也可以直接抛出自定义异常，然后在全局异常处理器中处理
                }
            } else {
                return true;
            }
        } else {
            return true;
        }
        return false;
    }
}

4. 定义跨域拦截器

这里是做前后端分离需要做的步骤，解决跨域的方式有好几种，这里使用拦截器的方式解决跨域问题。

public class CrossInterceptorHandler implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "POST, GET , PUT , OPTIONS");
        response.setHeader("Access-Control-Max-Age", "3600");
        response.setHeader("Access-Control-Allow-Headers", "x-requested-with,accept,authorization,content-type");
        return true;
    }
}

5. 定义全局异常处理器

这里没有用到全局异常处理器，不过为了项目的完整性，我还是选择把这些常规的内容写上去。

@RestControllerAdvice
public class GlobalException {

    public final Logger logger = LoggerFactory.getLogger(this.getClass());

    @ExceptionHandler(TokenExpiredException.class)
    public R<?> handleTokenExpiredException(TokenExpiredException e) {
        logger.error("token 已过期");
        logger.error(e.getMessage());
        return R.error(ResponseEnum.TOKEN_EX);
    }
}

6. 定义工具类

6.1 统一错误状态码

编写一个枚举类，统一项目的报错状态码。

@AllArgsConstructor
@Getter
public enum ResponseEnum {

    SUCCESS(200, "操作成功"),

    FAIL(300,"获取数据失败"),

    USER_EX(301,"用户不存在，请重新登录"),

    ERROR(302,"错误请求"),

    USERNAME_PASSWORD_ERROR(303,"用户名或密码错误"),

    NO_TOKEN(400,"无token，请重新登录"),

    TOKEN_VERIFY_ERROR(401,"token验证失败，请重新登录"),

    TOKEN_EX(402,"token已过期");

    private final Integer code;

    private final String msg;

    public static ResponseEnum getResultCode(Integer code){
        for (ResponseEnum value : ResponseEnum.values()) {
            if (code.equals(value.getCode())){
                return value;
            }
        }
        return ResponseEnum.ERROR;
    }
}

6.2 统一响应类

@Data
public class R<T> implements Serializable {

    private static final long serialVersionUID = 56665257244236049L;

    private Integer code;

    private String message;

    private T data;

    private R() {
    }

    public static <T> R<T> ok(T data) {
        R<T> response = new R<>();
        response.setCode(ResponseEnum.SUCCESS.getCode());
        response.setMessage(ResponseEnum.SUCCESS.getMsg());
        response.setData(data);
        return response;
    }

    public static <T> R<T> error(Integer errCode, String errMessage) {
        R<T> response = new R<>();
        response.setCode(errCode);
        response.setMessage(errMessage);
        return response;
    }

    public static <T> R<T> error(ResponseEnum responseEnum) {
        R<T> response = new R<>();
        response.setCode(responseEnum.getCode());
        response.setMessage(responseEnum.getMsg());
        return response;
    }
}

6.3 Token工具类

通过TokenUtil可以生成token和验证token是否正确。

import cn.hutool.core.date.DateUtil;
import cn.hutool.json.JSONObject;
import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;

import java.util.Date;

/**
 * @author Luke Ewin
 * @date 2024/2/19 16:59
 * @blog blog.lukeewin.top
 */
public class TokenUtil {

    private final static String ENCRYPT_KEY = "abc123"; // 加密的密钥

    private final static int EXPIRE_TIME = 1; // token 过期时间，单位分钟

    private static final String ISSUER = "zhangsan";

    /**
     * 生成 token
     *
     * @param json 要封装到 token 的内容，如果要传递多个参数内容，可以定义为 JSON 或者 Map
     * @return 返回 token
     */
    public static String createToken(JSONObject json) {
        return JWT.create()
                .withSubject(json.toString()) // 不要把密码封装进去，不安全
                .withIssuer(ISSUER) // 设置发布者
                .withExpiresAt(DateUtil.offsetMinute(new Date(), EXPIRE_TIME)) // 设置过期时间
                .withClaim("test", "123") // 这里是随便设置的内容，类似 Map
                .sign(Algorithm.HMAC256(ENCRYPT_KEY)); // 加密
    }

    /**
     * 验证 token
     *
     * @param token
     * @return
     */
    public static boolean verifyToken(String token) {
        try {
            JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(ENCRYPT_KEY))
                    .withIssuer(ISSUER)
                    .build();
            jwtVerifier.verify(token);
            return true;
        } catch (Exception e) { // 如果 token 过期会报错 TokenExpiredException
            e.printStackTrace();
            return false;
        }
    }
}

7. 编写实体类

这里为了简单，并没有与数据库交互。

@Data
public class User {
    private String userName;
    private String password;
    private String token;
}

8. 定义控制器

8.1 定义登录控制器类

@RestController
@RequestMapping("/user")
public class LoginController {
    @PostMapping("/login")
    public R<User> login(String userName, String password) {
        if (StringUtils.isNotBlank(userName) && StringUtils.isNotBlank(password)) {
            if ("张三".equals(userName) && "123456".equals(password)) {
                User user = new User();
                JSONObject json = JSONUtil.createObj()
                        .put("name", "zhangsan");
                String token = TokenUtil.createToken(json);
                user.setToken(token);
                return R.ok(user);
            }
        }
        return R.error(ResponseEnum.USERNAME_PASSWORD_ERROR);
    }
}

8.2 定义报错处理器

@RestController
@RequestMapping("/error")
public class ErrorController {

    @PostMapping("/token")
    public R<?> token() {
        return R.error(ResponseEnum.NO_TOKEN);
    }

    @PostMapping("/tokenError")
    public R<?> tokenError() {
        return R.error(ResponseEnum.TOKEN_VERIFY_ERROR);
    }
}

8.3 定义测试控制器

@RestController
@RequestMapping("/test")
public class TestController {

    @Auth
    @PostMapping("/hello")
    public R<?> hello() {
        return R.ok("登录成功");
    }

    @PostMapping("/hi")
    public R<?> hi() {
        return R.ok("登录成功");
    }
}

9. 配置类

最后别忘了定义一个配置类，把我们自定义的两个拦截器注册进去。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new CrossInterceptorHandler()).addPathPatterns(new String[] {"/**"});
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**").excludePathPatterns("/user/login", "/error/**");
    }
}

10. 最终的效果

访问登录接口，通过提交表单方式提交请求，通过token验证后会返回一个token，然后我们请求添加了@Auth注解的接口都需要在请求头添加token字段和对应的值。

image-20240220174407236

如果请求头中没有填写token或者填写的不对，在请求需求登录后才能访问的接口时都会报错。比如这里的/test/hello是需要登录后才能访问的接口，如果没有正确填写token，那么会报错，如下图所示。

image-20240220175045471 image-20240220174939307

如果正确填写了token，那么效果如下。

image-20240220175214721

有一个test/hi接口没有@Auth注解，可以不用登录就能访问，如下图所示。

image-20240220175428818

以上就是本篇文章所分享的内容，如果对你有用，记得收藏哦！

更多Java干货，欢迎关注我的博客。

代码已经开源到github中，如需要下载源代码，可点击这里。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/402951.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

如何重启docker中运行的镜像

如何重启docker中运行的镜像

要重启 Docker 中运行的容器&#xff0c;您可以使用 docker restart 命令。首先&#xff0c;您需要知道容器的 ID 或名称&#xff0c;然后使用该信息来重启容器。以下是具体步骤&#xff1a; 找出容器的 ID 或名称 执行 docker ps 命令列出所有正在运行的容器&#xff0c;找到您…
阅读更多...
软件常见设计模式

软件常见设计模式

设计模式 设计模式是为了解决在软件开发过程中遇到的某些问题而形成的思想。同一场景有多种设计模式可以应用&#xff0c;不同的模式有各自的优缺点&#xff0c;开发者可以基于自身需求选择合适的设计模式&#xff0c;去解决相应的工程难题。 良好的软件设计和架构&#xff0…
阅读更多...
vite是什么

vite是什么

vite 是什么 vite —— 一个由 vue 作者尤雨溪开发的 web 开发工具 Vite由两个主要部分组成 dev server&#xff1a;利用浏览器的ESM能力来提供源文件&#xff0c;具有丰富的内置功能并具有高效的HMR生产构建&#xff1a;生产环境利用Rollup来构建代码&#xff0c;提供指令用…
阅读更多...
SpringIOC之support模块StaticApplicationContext

SpringIOC之support模块StaticApplicationContext

博主介绍&#xff1a;✌全网粉丝5W&#xff0c;全栈开发工程师&#xff0c;从事多年软件开发&#xff0c;在大厂呆过。持有软件中级、六级等证书。可提供微服务项目搭建与毕业项目实战&#xff0c;博主也曾写过优秀论文&#xff0c;查重率极低&#xff0c;在这方面有丰富的经验…
阅读更多...
vmware的ubuntu虚拟机因空间满无法启动

vmware的ubuntu虚拟机因空间满无法启动

正在虚拟机编译android源代码&#xff0c;没注意空间不足&#xff0c;结果回来发现了 Assuming drive cache: write through 的问题&#xff0c;经查是空间不足的原因 按照这个教程&#xff0c;清除出来部分空间&#xff0c;才能进去系统&#xff0c;并且对系统空间做下优化 …
阅读更多...
测试总监，让我们用这份《测试用例规范》，再也没加班过

测试总监，让我们用这份《测试用例规范》，再也没加班过

经常看到无论是刚入职场的新人&#xff0c;还是工作了一段时间的老人&#xff0c;都会对编写测试用例感到困扰&#xff1f;例如&#xff1a; 固然&#xff0c;编写一份好的测试用例需要&#xff1a;充分的需求分析能力 理论及经验加持&#xff0c;作为测试职场摸爬打滚的老人…
阅读更多...
GitHub热门项目之Memos 打造私有备忘录

GitHub热门项目之Memos 打造私有备忘录

效果 1. 写备忘录或简单笔记&#xff0c;支持Markdown 2. 时间线 3. 探索可以看到其他用户公开的内容 项目地址 usememos/memos&#xff1a;一种开源的轻量级笔记服务。轻松捕捉和分享您的伟大想法。 (github.com)https://github.com/usememos/memos 体验地址 Memoshttp://…
阅读更多...
2000-2022年各省环境规制数据（原始数据+计算过程+计算结果）

2000-2022年各省环境规制数据（原始数据+计算过程+计算结果）

2000-2022年各省环境规制数据&#xff08;原始数据计算过程计算结果&#xff09; 1、时间&#xff1a;2000-2022年 2、范围&#xff1a;30省 3、来源&#xff1a;各省年鉴、国家统计局、统计年鉴 4、指标&#xff1a;年份、省份、工业污染源治理投资完成实际额、工业增加值…
阅读更多...
基于SpringBoot的教师宿舍管理系统设计与实现（源码+调试）

基于SpringBoot的教师宿舍管理系统设计与实现（源码+调试）

项目描述 临近学期结束&#xff0c;还是毕业设计&#xff0c;你还在做java程序网络编程&#xff0c;期末作业&#xff0c;老师的作业要求觉得大了吗?不知道毕业设计该怎么办?网页功能的数量是否太多?没有合适的类型或系统?等等。今天给大家介绍一篇基于SpringBoot的教师宿…
阅读更多...
CapCut - 剪映国际版11.1.0

CapCut - 剪映国际版11.1.0

​【应用名称】&#xff1a;CapCut - 剪映国际版 【适用平台】&#xff1a;#Android 【软件标签】&#xff1a;#CapCut #剪映国际版 【应用版本】&#xff1a;11.1.0 【应用大小】&#xff1a;231MB 【软件说明】&#xff1a;软件升级更新。目前大家广泛使用的最令人惊叹、最专…
阅读更多...
【鸿蒙 HarmonyOS 4.0】开发工具安装

【鸿蒙 HarmonyOS 4.0】开发工具安装

一、准备开发环境 1.1、安装IDE 鸿蒙应用开发需要使用配套的IDE——HUAWEI DevEco Studio。 DevEco Studio基于IntelliJ IDEA Community&#xff08;IDEA社区版&#xff09;构建&#xff0c;为鸿蒙应用提供了一站式开发环境&#xff0c;集成了开发、运行、调试以及发布应用的…
阅读更多...
蓝色证件照怎么改？分享3款实用的证件照工具！

蓝色证件照怎么改？分享3款实用的证件照工具！

在日常生活和工作中&#xff0c;我们经常需要用到蓝色背景的证件照&#xff0c;无论是求职、办理证件还是其他正式场合&#xff0c;一张高质量的蓝色证件照都是必不可少的。然而&#xff0c;不是每个人都能在照相馆拍出完美的证件照&#xff0c;这时候&#xff0c;一些专业的证…
阅读更多...
Socket通信---Python发送数据给C++程序

Socket通信---Python发送数据给C++程序

0. Problems 很多时候实现某种功能&#xff0c;需要在不同进程间发送数据&#xff0c;目前有几种主流的方法&#xff0c;如 让python和C/C程序互相发送数据&#xff0c;其实有几种方法&#xff1a; 共享内存共享文件Socket通信 在这里只提供Socket通信的例程&#xff0c;共享…
阅读更多...
不要浪费

不要浪费

解法&#xff1a; 记录一下tle的代码 #include <iostream> #include <vector> #include <algorithm> using namespace std; #define endl \n bool check(vector<int>& a, int l,int k) {int sum 0;for (int i 0; i < a.size() && l…
阅读更多...
到底什么是CIDR（无类域间路由）？

到底什么是CIDR（无类域间路由）？

【摘要】 CIDR&#xff08;无类域间路由&#xff09;是一种用于对互联网IP地址进行聚合和分配的技术。它通过改变IP地址的分配方式&#xff0c;有效地解决了IPv4地址空间不足的问题。本文将详细介绍CIDR的原理、使用方法以及它对互联网的影响&#xff0c;还会针对CIDR出三道例题…
阅读更多...
在vue3中使用canvas实现雨滴效果

在vue3中使用canvas实现雨滴效果

在vue3中使用canvas实现雨滴效果 这是封装的一个组件DotAndRain&#xff08; &#xff09; <script setup> import { ref, onMounted } from "vue"; import { onUnmounted } from "vue";let animationFrameId null;const el ref(null); let canv…
阅读更多...
Day3 javaweb开发——登录认证

Day3 javaweb开发——登录认证

登录功能 没什么好写的&#xff0c;就是LoginController层里面要注入empService的对象 登录校验&#xff08;重点&#xff09; 没有校验的情况 没有登录之前&#xff0c;访问数据的网址需要跳转到登录页面。 http是无状态的&#xff0c;处理其他业务时没有判断他是否登录 …
阅读更多...
LINUX读取RTC实时时钟时间

LINUX读取RTC实时时钟时间

linux 读写RTC时间_linux rtc 读写-CSDN博客
阅读更多...
[newstarctf2023] --RE wp

[newstarctf2023] --RE wp

AndroGenshin: rc4加密表&#xff0c;base64换表&#xff1a; 脚本梭就行 python username b"genshinimpact" base64_table [125, 239, 101, 151, 77, 163, 163, 110, 58, 230, 186, 206, 84, 84, 189, 193, 30, 63, 104, 178, 130, 211,164, 94, 75, 16, 32, 33…
阅读更多...
anomalib1.0学习纪实-续4：做个小结

anomalib1.0学习纪实-续4：做个小结

我们就以padim为例。 一、主入口&#xff1a; 二、Padim类。 这个Padim类就在src\anomalib\models\image\padim文件夹下。 这个Padim类的父类就是 AnomalyModule&#xff0c;这个父类你不能改动了&#xff0c;里面的内容写死了。 这个Padim类&#xff0c;最重要的是&#xf…
阅读更多...
最新文章

Copyright @ 2022~2023