java注解拦截_轻松实现java拦截器+自定义注解

java注解拦截_轻松实现java拦截器+自定义注解本文将用简洁的代码构建一个springboot的拦截器。拦截器的使用很简单,定义一个自己的拦截器,向配置中添加一下就可以使用。为了方便,之后又引入了注解。目录和概述概述假设需求:访问项目的controller是都要进行”token验证”,除了某些像登录之类的方法。项目结构:TokenInterceptor.java自定义拦截器InterceptorConfig.java添加拦截器进入项目NoN…

大家好,又见面了,我是你们的朋友全栈君。

本文将用简洁的代码构建一个springboot的拦截器。拦截器的使用很简单,定义一个自己的拦截器,向配置中添加一下就可以使用。为了方便,之后又引入了注解。

目录和概述

概述

假设需求:访问项目的controller是都要进行”token验证”,除了某些像登录之类的方法。

项目结构:

TokenInterceptor.java 自定义拦截器

InterceptorConfig.java 添加拦截器进入项目

NoNeedToken.java 自定义注解

TestController.java 测试接口

312118c9abad15c657fb660fea2b29d1.png

目录

1、自定义拦截器

在 TokenInterceptor.java 中输入以下代码,以下的代码将生成一个在请求到达controller前进行拦截的拦截器

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 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;

// 之后写你的判断逻辑:return true是通过拦截器,可以继续访问controller,return false是不通过

if (token == null || !tokenList.contains(token)) {

// 如果失败了返回{state:”false”, msg:”token is null or wrong”}

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;

}

// 否则返回true 进入controller

return true;

}

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

}

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

}

}

2、载入拦截器

将以下代码写在InterceptorConfig.java中 ,使用addInterceptors方法将我们定义的拦截器添加进入项目中

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.InterceptorRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration

public class InterceptorConfig implements WebMvcConfigurer {

@Resource

TokenInterceptor tokenInterceptor;

@Override

public void addInterceptors(InterceptorRegistry registry) {

// 设置所有的路径都要进行拦截,除了/test/login

registry.addInterceptor(tokenInterceptor).addPathPatterns(“/**”)

.excludePathPatterns(“/test/login”);

}

}

3、测试成功

将如下代码到TestController中,用于测试拦截器效果

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;

import java.util.Map;

@RestController

// canload用于检测拦截器是否正常工作

@RequestMapping(“/test”)

public class TestController {

@RequestMapping(value = “/canload”)

public Map canLoad(){

Map res = new HashMap<>();

res.put(“state”, “ok”);

res.put(“msg”, “you can load”);

return res;

}

// login模拟登录时token返回

@RequestMapping(value = “/login”)

public String login(){

return “111”;

}

}

可以看到如下结果

①直接登录成功

c8311f4b08bef979ade1557a2a4d3947.png

②直接访问canload失败

377e439e9cec1661b2f79bf85290b245.png

③使用postman,带上token进行访问成功

393b4dcd87aecb81e0212337dfb3af05.png

4、使用注解(Annotation)进行选择

你也可以使用注解来代替第三步配置中的excludePathPatterns(), 来实现对于指定方法和controller的免token访问,新建一个NoNeedToken.java注解,在拦截器里判断注解存在时,直接return true放行

NoNeedToken.java

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Target({ElementType.METHOD, ElementType.TYPE}) //注解的范围是类、接口、枚举的方法上

@Retention(RetentionPolicy.RUNTIME)//被虚拟机保存,可用反射机制读取

public @interface NoNeedToken {

}

响应的更改自定义拦截器的 preHandle方法,和拦截器配置

① 自定义拦截器

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

response.setCharacterEncoding(“UTF-8”);

response.setContentType(“application/json; charset=utf-8”);

String token = request.getHeader(“token”);

PrintWriter out;

// 对于注解的判断—————————————————

HandlerMethod handlerMethod = (HandlerMethod) handler;

if(handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null || handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)){

// 如果自己拥有NoNeedToken标注或者所属的class拥有NoNeedToken 就直接放行

return true;

}

//——————————————————————

if (token == null || !tokenList.contains(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;

}

return true;

}

② 去除拦截器配置中的去除项

public void addInterceptors(InterceptorRegistry registry) {

registry.addInterceptor(tokenInterceptor).addPathPatterns(“/**”);

// .excludePathPatterns(“/test/login”);

}

③ 在测试的login方法上添加注释

@RequestMapping(value = “/login”)

@NoNeedToken

public String login(){

return “111”;

}

修改完成之后效果和上面相同

5、常见问题

1.这个自定义注解的那些@Target,@Retention,@Documented是什么意思

https://blog.csdn.net/zt15732625878/article/details/100061528,这篇文章写的很详细了

2.为什么我的注解加了,还是被拦截了

一般出现这种情况是类与方法的获取注解方式不同,在本文中作者使用了下面的一句话来表述

handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null || handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)

其中handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null是对于方法的

而handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)是对于类的

结语:希望对大家有帮助

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/138537.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • powerdesigner 画出 C++ UML 增加const,static,virtual属性

    powerdesigner 画出 C++ UML 增加const,static,virtual属性

  • 怎么创建css样式表,怎样创建可反复使用的外部CSS样式表?[通俗易懂]

    怎么创建css样式表,怎样创建可反复使用的外部CSS样式表?[通俗易懂]创建可反复使用的外部CSS样式表用DreamWeaver在某网页中创建了一种CSS样式后,如果你要在另外的网页中应用该样式,你不必从新创建该CSS样式,只要你创建了外部CSS样式表文件(externalCSSstylesheet),你便可以在今后任意调用该样式表文件中的样式。为了便于管理,先在站点所在文件夹中,新建一个文件夹,取名为CSS,专门用于放置外部样式表文件(其扩展名为css)。1、在Do…

  • mapreduce编程初探[通俗易懂]

    mapreduce编程初探[通俗易懂]1.map和reduce1.1mapReduce处理逻辑在本系列文章的第一篇中,曾对MapReduce原理做过简单的描述,在这里再重述一遍。 首先我们有两个文件word1.txt和word2.txt 其中word1.txt的内容如下:aaaabbbbccccddddaaaaword2.txt的内容如下:aaaaccccddddeeeeaaaa这…

  • Windows server 2003 安装vs2005 sp1补丁包报1718错误的解决方法

    Windows server 2003 安装vs2005 sp1补丁包报1718错误的解决方法收藏于2012-03-30迁移自个人的百度空间——————————–解决步骤如下1.在控制面板中打开“管理工具“。2.双击“本地安全策略”。 3.单击“软件限制策略”。(注意:如果未列出软件限制,请右击“软件限制策略”,然后单击“新建策略”。)4.在“对象类型”下,双击“强制”。 5.单击“除本地管理员以外的所有用户”…

  • 关于二叉树的前序、中序、后序三种遍历

    二叉树遍历分为三种:前序、中序、后序,其中序遍历最为重要。为啥叫这个名字?是根据根节点的顺序命名的。比如上图正常的一个满节点,A:根节点、B:左节点、C:右节点,前序顺序是ABC(根节点排最先,然后同级先左后右);中序顺序是BAC(先左后根最后右);后序顺序是BCA(先左后右最后根)。    比如上图二叉树遍历结果   前序遍历:ABCDEFGHK    中序遍历:BDCAEHGKF    后序…

  • Oracle集群(RAC)及 jdbc 连接双机数据库

    Oracle集群(RAC)及 jdbc 连接双机数据库

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号