springboot注解失效

时间: 2024-09-07 21:05:10 浏览: 94

实现java自定义注解拦截器.docx

内容：拦截器的使用很简单，定义一个自己的拦截器，向配置中添加一下就可以使用。为了方便，之后又引入了注解。本文就将用简洁的代码构建一个springboot的拦截器。 假设需求：访问项目的controller是都要进行"token验证"，除了某些像登录之类的方法。 项目结构： oTokenInterceptor.java 自定义拦截器 oInterceptorConfig.java 添加拦截器进入项目 oNoNeedToken.java 自定义注解 ### 实现Java自定义注解拦截器 #### 概述本文主要介绍如何在Spring Boot项目中使用自定义注解来实现对特定方法的拦截功能。具体场景为：当访问项目中的控制器方法时，需要进行“token验证”，但登录等特殊方法除外。这通过创建自定义拦截器和自定义注解来实现。 #### 项目结构 - `TokenInterceptor.java`: 自定义拦截器类，用于执行拦截逻辑。 - `InterceptorConfig.java`: 配置类，用于将自定义拦截器注册到Spring容器中。 - `NoNeedToken.java`: 自定义注解，用于标记那些不需要进行token验证的方法。 - `TestController.java`: 测试接口目录，包含受拦截和不受拦截的方法。 #### 步骤详解 ### 1. 自定义拦截器在`TokenInterceptor.java`中实现拦截器逻辑： ```java import com.alibaba.fastjson.JSONObject; import org.springframework.lang.Nullable; import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.PrintWriter; import java.util.Arrays; import java.util.List; @Component public class TokenInterceptor implements HandlerInterceptor { // 假设现有的token列表 List<String> tokenList = Arrays.asList("111", "222", "333"); // 在访问接口之前执行的方法 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 设置返回格式为JSON，使用UTF-8编码 response.setCharacterEncoding("UTF-8"); response.setContentType("application/json;charset=utf-8"); String token = request.getHeader("token"); PrintWriter out; // 判断逻辑：验证token是否有效 if (token == null || !tokenList.contains(token)) { // 如果token无效，则返回错误信息 JSONObject res = new JSONObject(); res.put("state", "false"); res.put("msg", "token is null or wrong"); out = response.getWriter(); out.append(res.toString()); return false; // 不允许访问controller } // 否则允许访问controller return true; } // 处理完成后执行的方法 @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { // 这里可以实现处理完成后的逻辑 } // 请求结束后执行的方法 @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { // 这里可以实现请求结束后的清理工作 } } ``` ### 2. 载入拦截器在`InterceptorConfig.java`中配置拦截器： ```java 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 InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 注册自定义拦截器 registry.addInterceptor(new TokenInterceptor()) .addPathPatterns("/**") // 指定需要拦截的路径 .excludePathPatterns("/login"); // 指定排除的路径 } } ``` ### 3. 使用注解进行选择性拦截 #### 创建自定义注解在`NoNeedToken.java`中定义自定义注解： ```java import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface NoNeedToken { } ``` #### 应用自定义注解在`TestController.java`中应用自定义注解： ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { @GetMapping("/hello") public String hello() { return "Hello, World!"; } @GetMapping("/login") public String login() { return "Login Page"; } @GetMapping("/user") @NoNeedToken public String user() { return "User Page"; } } ``` ### 4. 测试成功 - **访问 `/hello`**：因为没有加`@NoNeedToken`注解，会被拦截并返回错误信息。 - **访问 `/login`**：因为被配置排除，可以直接访问。 - **访问 `/user`**：因为加了`@NoNeedToken`注解，可以直接访问。 ### 5. 常见问题 - **如何解决跨域问题？** - 可以在拦截器中增加对跨域的支持。 - **如何扩展拦截器的功能？** - 可以通过继承`HandlerInterceptor`并重写方法来实现。 - **如何避免注解被误用？** - 可以通过严格的代码审查流程或在注解中添加更多的约束条件来限制其使用场景。以上步骤展示了如何使用Spring Boot中的自定义拦截器和自定义注解来实现对特定方法的选择性拦截。这种机制可以非常灵活地控制哪些请求需要经过额外的验证或处理，对于构建安全可控的应用程序来说非常重要。

Spring Boot注解失效的问题可能由多种原因引起，一般可以按照以下几个方向进行排查： 1. 扫描路径配置错误：Spring Boot的注解扫描通常会通过`@SpringBootApplication`注解来指定，如果这个注解的位置不正确或者`scanBasePackages`属性指定的包路径没有包括相关的组件，注解可能就不会被正确扫描到。 2. Bean定义冲突：如果存在多个相同类型的Bean定义，Spring Boot启动时会根据特定的规则进行选择，有时候可能导致预期的Bean没有被使用，从而使得相关注解失效。 3. 依赖注入问题：在某些情况下，可能会因为循环依赖或者配置不当导致依赖注入失败，进而影响到注解的功能。 4. 激活环境配置不当：Spring Boot通过profile来区分不同的环境配置，如果激活的profile不包含相关的Bean定义，那么在该环境下对应的注解可能不会生效。 5. Bean生命周期问题：有些注解如`@PostConstruct`等，涉及到Bean的生命周期管理，在Bean初始化之前调用，如果Bean的初始化顺序有问题，这些注解的方法可能不会按预期执行。排查这类问题可以使用日志输出、调试工具或者查看Spring Boot的异常堆栈信息等方式来进行分析。确保相关的配置和代码逻辑正确无误是解决此类问题的关键。

阅读全文

springboot注解失效

相关推荐

SpringBoot整合Shiro实战代码案例分析

Springboot整合Kafka实现消息通信详解

springboot事务注解失效

@SpringBootApplication注解失效

springboot transactional失效

springboot项目失效

springboot @Transactional注解失效的情况

Springboot事务失效的原因

shardingsphere 读写分离导致springboot的@Transactional注解失效，为什么，怎么处理

springboot定时任务失效

springboot 事务的失效

Controller注解失效

全网最深分析SpringBoot MVC自动配置失效的原因

SpringBoot中事物失效的场景有哪些

SpringBoot JPA @UpdateTimestamp 失效

springboot web拦截器失效

springboot中@Transactional失效

springboot 多模块下 RestControllerAdvice 失效

springboot 跨域 session+cookie失效问题

最新推荐

SpringBoot2整合ElasticJob框架过程详解

IDEA中 Getter、Setter 注解不起作用的问题如何解决

SpringBoot发送邮件功能 验证码5分钟过期

详解SpringBoot中Session超时原理说明

数学建模拟合与插值.ppt

MATLAB实现小波阈值去噪：Visushrink硬软算法对比

管理建模和仿真的文件

【交互特征的影响】：分类问题中的深入探讨，如何正确应用交互特征

c语言从链式队列 中获取头部元素并返回其状态的函数怎么写

易语言实现画板图像缩放功能教程

SpringBoot发送邮件功能验证码5分钟过期

c语言从链式队列中获取头部元素并返回其状态的函数怎么写