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)


相关推荐

  • MD5算法的Java实现

    MD5算法的Java实现一、算法原理概述MD5即Message-DigestAlgorithm5(信息-摘要算法5)MD4(1990)、MD5(1992,RFC1321)由RonRivest发明,是广泛使用的Hash算法,用于确保信息传输的完整性和一致性。MD5使用little-endian(小端模式),输入任意不定长度信息,以512-bit进行分组,生成四个32-bit数据,最后联…

  • springboot 之 使用jasypt加密解密插件[通俗易懂]

    springboot 之 使用jasypt加密解密插件[通俗易懂]简单使用jasypt是一个java实现的安全框架1、该工具支持注解方式开启jasypt功能,以及注解方式引入一个或多个需要处理的配置文件。 2、该工具同时支持properties与yml文件的解析处理。 3、该工具支持自定义加解密类型和复写加解密方法。引入插件<dependency> <groupId>com.github.ulisesbocchio&…

  • 深入理解linux内存管理_linux内存是如何划分的

    深入理解linux内存管理_linux内存是如何划分的摘要:本章首先以应用程序开发者的角度审视Linux的进程内存管理,在此基础上逐步深入到内核中讨论系统物理内存管理和内核内存的使用方法。力求从外到内、水到渠成地引导网友分析Linux的内存管理与使用。在本章最后,我们给出一个内存映射的实例,帮助网友们理解内核内存管理与用户内存管理之间的关系,希望大家最终能驾驭Linux内存管理。前言内存管理一向是所有操作系统书籍不惜笔墨重点讨论的内容,无论市

    2022年10月31日
  • spring in spring翻译_scipy官方文档中文版

    spring in spring翻译_scipy官方文档中文版Spring官方文档翻译

  • 制作initramfs镜像_原版镜像和引导镜像

    制作initramfs镜像_原版镜像和引导镜像Linuxkernel在自身初始化完成之后,需要能够找到并运行第一个用户程序(这个程序通常叫做“init”程序)。用户程序存在于文件系统之中,因此,内核必须找到并挂载一个文件系统才可以成功完成系统的引导过程。在grub中提供了一个选项“root=”用来指定第一个文件系统,但随着硬件的发展,很多情况下这个文件系统也许是存放在USB设备,SCSI设备等等多种多样的设备之上,如果需要正确引导,US

  • Python实现softmax函数「建议收藏」

    Python实现softmax函数:PS:为了避免求exp(x)出现溢出的情况,一般需要减去最大值。#-*-coding:utf-8-*-importtensorflowastfimportnumpyasnpdefsoftmax(x,axis=1):#计算每行的最大值row_max=x.max(axis=axis)…

发表回复

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

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