SpringBoot 整合JWT实现基于自定义注解的-登录请求验证拦截(保姆级教学,附:源码)2

简介: SpringBoot 整合JWT实现基于自定义注解的-登录请求验证拦截

上述准备工作以及完成

6:pojo 实体类

@Data
public class Users {
    private String id;
    private String username;
    private String password;
}

7: annotation 自定义注解

/**
 * @author xia
 * @version 1.0
 * @Data 用来跳过验证的 PassToken
 * @date 2023/2/13 16:16
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
    boolean required() default true;
}
/**
 * @author xia
 * @version 1.0
 * @DATA  用于登录后才能操作的token
 * @date 2023/2/13 16:16
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface UserLoginToken {
    boolean required() default true;
}

8:拦截器

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(jwtInterceptor())
                .excludePathPatterns("/user/**")
                .addPathPatterns("/**");
    }
    @Bean
    public JWTInterceptor jwtInterceptor() {
        return new JWTInterceptor();
    }
}
@Component
@SuppressWarnings("all")
public class JWTInterceptor implements HandlerInterceptor {
    @Autowired
    User user;
    // 请求前到达之前拦截
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object object)
            throws Exception {
        // 从请求头获取 token
        String token = request.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;
            }
        }
        // token 验证失败后的返回信息
        if (method.isAnnotationPresent(UserLoginToken.class)) {
            UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);
            if (userLoginToken.required()) {
                if (StrUtil.isBlank(token)) {
                    throw new RuntimeException( "无token,请重新登录");
                }
                // 获取 token 中的 user id
                int userId;
                try {
                    DecodedJWT decode = JWT.decode(token);
                    String id = decode.getClaim("id").asString();
                    userId = Integer.parseInt(id);
                } catch (JWTDecodeException j) {
                    throw new RuntimeException("401");
                }
                System.out.println(userId);
                Users users = user.findUserById(userId);
                if (users == null) {
                    throw new RuntimeException("用户不存在,请重新登录");
                }
                try {
                    // JWT 工具包验证 token
                    JWTUtils.verify(token);
                    return true;
                } catch (TokenExpiredException e) {
                    throw new RuntimeException("Token已经过期!!!");
                } catch (SignatureVerificationException e){
                    throw new RuntimeException("签名错误!!!");
                } catch (AlgorithmMismatchException e){
                    throw new RuntimeException("加密算法不匹配!!!");
                } catch (Exception e) {
                    e.printStackTrace();
                    throw new RuntimeException("无效token~~");
                }
            }
        }
        return true;
    }
}

9:controller 层

@RestController
@Slf4j
@SuppressWarnings("all")
public class JwtController {
    @Resource
    private UsersMapper mapper;
    // 认证
    @PassToken
    @PostMapping("/user/login")
    public Result login(@RequestBody Users user) {
        System.out.println("前端传来的用户数据:"+user);
        try {
            // 查询数据库
            QueryWrapper<Users> queryWrapper = new QueryWrapper<>();
            HashMap<String, Object> queryMap = new HashMap<>();
            queryMap.put("username", user.getUsername());
            queryMap.put("password", user.getPassword());
            queryWrapper.allEq(queryMap);
            Users userDb = mapper.selectOne(queryWrapper);
            // 认证失败
            if(userDb == null) {
                throw new RuntimeException("没有此用户。请重新登录");
            }
            // 认证成功
            Map<String, String> tokenClaimsMap = new HashMap<>(); //用来存放payload
            tokenClaimsMap.put("id",userDb.getId());
            tokenClaimsMap.put("username", userDb.getUsername());
            String token = JWTUtils.getToken(tokenClaimsMap);
            // 返回的数据
           return new Result(ResultCode.SUCCESS,token);
        } catch (Exception e) {
            // 认证失败,返回的数据
            e.printStackTrace();
            return new Result(ResultCode.ERROR,e);
        }
    }
  @UserLoginToken
    @GetMapping("/private/info")
    public String info(HttpServletRequest request){
        String token = request.getHeader("token");
        DecodedJWT tokenJWT = JWTUtils.getToken(token);
        System.out.println(tokenJWT.getClaim("username").asString());
        System.out.println(tokenJWT.getClaim("userId").asInt());
        return "这是一段私人信息。只有登录才能显示";
    }
    @UserLoginToken
    @GetMapping("/private/Test")
    public Result info(){
        String code = "这是一段私人信息。只有登录才能显示";
        return new Result(ResultCode.SUCCESS,code);
    }
    @PassToken()
    @PostMapping("/private/Test2")
    public Result info2(){
        String code = "这是一段普通信息。不登录也能显示";
        return new Result(ResultCode.SUCCESS,code);
    }
}

10: service 以及实现类

@Service
public interface User {
    Users findUserById(int userId);
}
@Service
public class UserService implements User{
    @Resource
    private UsersMapper mapper;
    @Override
    public Users findUserById(int userId) {
        Users users = mapper.selectById(userId);
        System.out.println("------------>"+ users);
        return users;
    }
}

11: mapper层

@Mapper
public interface UsersMapper extends BaseMapper<Users> {
}

启动项目,演示效果如下:

1:账号登录成功生成Token (登录请求,使用@PassToken() 注解 跳过token验证)

@PassToken
    @PostMapping("/user/login")
    public Result login(@RequestBody Users user) {
        System.out.println("前端传来的用户数据:"+user);
        try {
            // 查询数据库
            QueryWrapper<Users> queryWrapper = new QueryWrapper<>();
            HashMap<String, Object> queryMap = new HashMap<>();
            queryMap.put("username", user.getUsername());
            queryMap.put("password", user.getPassword());
            queryWrapper.allEq(queryMap);
            Users userDb = mapper.selectOne(queryWrapper);
            // 认证失败
            if(userDb == null) {
                throw new RuntimeException("没有此用户。请重新登录");
            }
            // 认证成功
            Map<String, String> tokenClaimsMap = new HashMap<>(); //用来存放payload
            tokenClaimsMap.put("id",userDb.getId());
            tokenClaimsMap.put("username", userDb.getUsername());
            String token = JWTUtils.getToken(tokenClaimsMap);
            // 返回的数据
           return new Result(ResultCode.SUCCESS,token);
        } catch (Exception e) {
            // 认证失败,返回的数据
            e.printStackTrace();
            return new Result(ResultCode.ERROR,e);
        }

4bb5a4f78076420e9ff592cf5372d0d6.png

2:使用这个注解 :@UserLoginToken(登录需要验证)

@UserLoginToken
    @GetMapping("/private/info")
    public String info(HttpServletRequest request){
        String token = request.getHeader("token");
        DecodedJWT tokenJWT = JWTUtils.getToken(token);
        System.out.println(tokenJWT.getClaim("username").asString());
        System.out.println(tokenJWT.getClaim("userId").asInt());
        return "这是一段私人信息。只有登录才能显示";
    }
    @UserLoginToken
    @GetMapping("/private/Test")
    public Result info(){
        String code = "这是一段私人信息。只有登录才能显示";
        return new Result(ResultCode.SUCCESS,code);
    }

88c76b09c9c7403ca9e008bdbefd5f1c.png

不携带Token 打印结果:

845390cd1dd949d7855ea84876c9ca80.png

beae14d722224a13bd38180bcf6b83ed.png

Token 错误:

608030470fd44dc5ab9b5bb75666c851.png

3: 使用@PassToken() 放行请求 ,即不需要Token 也可登录

@PassToken()
    @PostMapping("/private/Test2")
    public Result info2(){
        String code = "这是一段普通信息。不登录也能显示";
        return new Result(ResultCode.SUCCESS,code);
    }

61d7ffc24da54258bac2006337893a12.png

源码地址如下:

SpringBoot 整合 jwt: 学习token的1111

目录
相关文章
|
10月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
844 0
|
10月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1489 128
|
10月前
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
478 126
|
11月前
|
XML JSON Java
Spring框架中常见注解的使用规则与最佳实践
本文介绍了Spring框架中常见注解的使用规则与最佳实践,重点对比了URL参数与表单参数的区别,并详细说明了@RequestParam、@PathVariable、@RequestBody等注解的应用场景。同时通过表格和案例分析,帮助开发者正确选择参数绑定方式,避免常见误区,提升代码的可读性与安全性。
|
10月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1083 1
使用Spring的@Retryable注解进行自动重试
|
9月前
|
XML JSON Java
【SpringBoot(三)】从请求到响应再到视图解析与模板引擎,本文带你领悟SpringBoot请求接收全流程!
Springboot专栏第三章,从请求的接收到视图解析,再到thymeleaf模板引擎的使用! 本文带你领悟SpringBoot请求接收到渲染的使用全流程!
615 3
|
9月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
771 2
|
10月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
642 12
|
10月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
535 0
探索Spring Boot的@Conditional注解的上下文配置