百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

过滤器、拦截器、AOP、ControllerAdvcie的使用对比、执行顺序...

ztj100 2024-12-15 18:00 44 浏览 0 评论

前言

本文适合有一定基础的同学,在已有的认识基础上对这四块的知识做一个总体的对比。

本文基于SpringBoot项目进行讲解,所有的代码都是在已经搭好SpringBoot的基础上进行编写的,SpringBoot版本为2.7.3。

该项目所有的代码都已经上传到我的GitHub仓库:github.com/stick-i/Fil…

过滤器Filter

简介

  • 来自J2EE中的Servlet技术
  • 实现原理:基于servlet的函数回调实现
  • 只可以获取到请求中的request和response,无法获取到响应方法的信息
  • 可以拦截所有请求
  • 支持使用xml配置和注解配置
  • 应用场景:权限认证、敏感词检测、访问日志记录等

使用方法

  1. 实现 Filter 接口,重写 doFilter 方法;
  2. 放行请求时调用chain.doFilter()方法;
  3. 启用该过滤器,有三种方式,一种是比较原始的xml配置,这我就不写了,需要的同学请查看其它人的文章。
  4. 第二种是使用注解 @WebFilter() ,并在启动类上添加@ServletComponentScan注解使用。
  5. 第三种是直接使用@Component注解,这样的话@WebFilter配置的路径会失效,因为@WebFilter根本就没生效,不信自己去试试。
  6. 下面我使用的是第二种方式,更灵活
  7. 设置拦截路径,就是要拦截的那个url路径。

代码实现

过滤器代码

@Slf4j
@WebFilter(value = "/name") //这里我们只拦截name请求,记得要在启动类配ServletComponentScan
public class MyFilter implements Filter {

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
		log.info("before filter");
		// 请求放行
		chain.doFilter(request, response);
		log.info("after filter");
	}

}
复制代码

Controller代码

@Slf4j
@RestController
public class MyController {

	@GetMapping("/name")
	public String getName() {
		log.info("getName");
		return "sticki";
	}

}
复制代码

测试

发送请求

查看控制台,可以观察到执行的顺序是按照我们代码中的前后顺序来执行的。

拦截器Interceptor

简介

  • 来自Spring,不依赖于servlet容器,但依赖于Spring
  • 实现原理:通过反射机制,动态代理实现
  • 可以获取到Spring中存在的Bean,通过注入的方式
  • 只对action请求起作用,并可以获取到action请求的上下文
  • 应用场景:访问日志、权限管理等(场景这块感觉跟过滤器差不多)

使用方法

  1. 实现 HandlerInterceptor 接口 或 继承 HandlerInterceptorAdapter 类,建议使用接口;
  2. 实现 preHandle 方法(在处理请求前运行),实现 postHandle 方法(在处理请求完毕后运行);
  3. 再新建一个类,继承 WebMvcConfigurer 接口,再实现addInterceptors方法,并在方法中注册该拦截器、配置拦截路径(不配置默认拦截所有请求);

代码实现

拦截器代码

@Slf4j
public class MyInterceptor implements HandlerInterceptor {

	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
		log.info("before interceptor");
		return true;
	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
		log.info("after interceptor");
	}

}
复制代码

配置类代码

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

	@Override
	public void addInterceptors(InterceptorRegistry registry) {
        // 只拦截 age 的请求
		registry.addInterceptor(new MyInterceptor()).addPathPatterns("/age");
	}

}
复制代码

Controller代码,还是刚刚那个Controller,不过我添加了一个新的请求 /age

	@GetMapping("/age")
	public Integer getAge() {
		log.info("getAge");
		return 22;
	}
复制代码

测试

发送请求

查看控制台

ControllerAdvice

简介

  • 来自Spring,依赖于Spring
  • 应用场景:全局异常处理(配合自定义异常效果更佳)、数据绑定、数据预处理
  • 可以使用注解@ControllerAdvice,实现 ResponseBodyAdvice、RequestBodyAdvice 等接口,用于web项目的返回数据加强。

使用方法

  1. 创建一个类,给类加上注解@RestControllerAdvice
  2. 写一个方法,给方法加上注解 @ExceptionHandler(Exception.class) ,括号里写要拦截的异常,方法的参数也是这个异常或者这个异常的父类
  3. 在方法中写对该异常的处理

ps:这里我只写了全局异常处理的代码,需要的同学可以去查一查其他的使用方法噢,也可以看一下这个:www.cnblogs.com/tiancai/p/1… ,写的挺全的。

代码实现

ControllerAdvice

@Slf4j
@RestControllerAdvice
public class ExceptionAdvice {

	@ExceptionHandler(Exception.class)
	public String allExceptionHandler(Exception e) {
		log.warn(e.getMessage()); // 捕获之后打印异常信息
		return "系统异常,请稍后再试";
	}

}
复制代码

Controller代码,也是新加了一个请求 /exception

	@GetMapping("/exception")
	public String getException() {
		log.info("getException");
		throw new RuntimeException("报错啦");
	}
复制代码

测试

发送请求,可以看到这里的信息是返回的 ControllerAdvice 里面的,而不是Controller里面的。

查看控制台

AOP

简介

  • AOP是一种面向切面编程的实现,实现的方式还挺多的,有SpringAOP,也有AspectJ、CGLIB等
  • 实现原理:基于动态代理或静态代理
  • 细粒度的拦截,可以获取到切入方法的参数等上下文数据,配合注解使用非常的舒服
  • 应用场景:一般用于方法的加强,比如方法级别的权限控制、日志输出、读取写入缓存、方法调用次数限制等

使用方法

  1. 创建一个类,给类加上@Aspect 和 @Component注解
  2. 定义切入点 @Pointcut() ,可以定义在注解上(使用注解的类或方法即切入点),也可以直接指定切入的范围
  3. 根据需要定义 @Before("pointcut()") 和 @After("pointcut()"),然后在内部写处理逻辑

ps:这里我只写了spring aop的使用,需要的同学自己去百度找其他的使用方法噢

代码实现

AOP代码

@Slf4j
@Aspect
@Component
public class MyAop {

	/**
	 * 仅匹配getAop这一个方法
	 */
	@Pointcut("execution(* cn.sticki.test.controller.MyController.getAop())")
	public void pointcut() {

	}

	@Before("pointcut()")
	public void before() {
		log.info("aop before");
	}

	@After("pointcut()")
	public void after() {
		log.info("aop after");
	}

}
复制代码

最左边会有个小符号

Controller代码,添加一个新的方法

	@GetMapping("/aop")
	public String getAop() {
		log.info("getAop");
		return "aop";
	}
复制代码

测试

发送请求

查看控制台

完全没问题

四者的执行顺序

好,既然我们四个都写完了,那就再加一点东西,让他们四个同时处理到一个方法上,那我们就可以测试出四者的执行顺序了。

添加了几个方法,这里直接给大家截图了,需要的同学可以去仓库拿代码。

Controller代码

AOP代码

Filter配置加了一条

Interceptor配置也加一条

最后Advice是不用加的


准备完毕,然后就可以去测试了。

发送请求:

控制台:

结论

可以看到,执行顺序是:Filter过滤器 > Interceptor拦截器 > ControllerAdvice > AOP。

解释:Filter和Interceptor的执行顺序是可以直接看出来的,AOP、ControllerAdvice 的执行顺序得看getAll的后面,getAll是controller输出的内容嘛,它的下一条是aop,然后才是异常被捕获,反方向先执行,说明 ControllerAdvice 是在 AOP 外面一层的。

这里也可以看出来,当抛出的异常被 ControllerAdvice 捕获之后, Interceptor 拦截器不会再有后置处理了,但是Filter过滤器还是有后置处理的

这里画了张图便于大家理解:

总结

这四者其实都是面向切面编程思想的一种实现。具体使用选择的话建议根据项目需要,参考它们的特性及执行顺序,选择最合适的一个或多个进行使用。

作者:阿杆
链接:https://juejin.cn/post/7153055158610427934

相关推荐

Sublime Text 4 稳定版 Build 4113 发布

IT之家7月18日消息知名编辑器SublimeText4近日发布了Build4113版本,是SublimeText4的第二个稳定版。IT之家了解到,SublimeTe...

【小白课程】openKylin便签贴的设计与实现

openKylin便签贴作为侧边栏的一个小插件,提供便捷的文本记录和灵活的页面展示。openKylin便签贴分为两个部分:便签列表...

“告别 Neovim!为什么我投奔了刚开源的 Zed 编辑器?”

...

壹啦罐罐 Android 手机里的 Xposed 都装了啥

这是少数派推出的系列专题,叫做「我的手机里都装了啥」。这个系列将邀请到不同的玩家,从他们各自的角度介绍手机中最爱的或是日常使用最频繁的App。文章将以「每周一篇」的频率更新,内容范围会包括iOS、...

电气自动化专业词汇中英文对照表(电气自动化专业英语单词)

专业词汇中英文对照表...

Python界面设计Tkinter模块的核心组件

我们使用一个模块,我们要熟悉这个模块的主要元件。如我们设计一个窗口,我们可以用Tk()来完成创建;一些交互元素,按钮、标签、编辑框用到控件;怎么去布局你的界面,我们可以用到pack()、grid()...

以色列发现“死海古卷”新残片(死海古卷是真的吗)

编译|陈家琦据艺术新闻网(artnews.com)报道,3月16日,以色列考古学家发现了死海古卷(DeadSeaScrolls)新残片。新出土的羊皮纸残片中包括以希腊文书写的《十二先知书》段落,这...

鸿蒙Next仓颉语言开发实战教程:订单列表

大家上午好,最近不断有友友反馈仓颉语言和ArkTs很像,所以要注意不要混淆。今天要分享的是仓颉语言开发商城应用的订单列表页。首先来分析一下这个页面,它分为三大部分,分别是导航栏、订单类型和订单列表部分...

哪些模块可以用在 Xposed for Lollipop 上?Xposed 模块兼容性解答

虽然已经有了XposedforLollipop的安装教程,但由于其还处在alpha阶段,一些Xposed模块能不能依赖其正常工作还未可知。为了解决大家对于模块兼容性的疑惑,笔者尽可能多...

利用 Fluid 自制 Mac 版 Overcast 应用

我喜爱收听播客,健身、上/下班途中,工作中,甚至是忙着做家务时。大多数情况下我会用MarcoArment开发的Overcast(Freemium)在iPhone上收听,这是我目前最喜爱的Po...

Avalonia日志组件实现与优化指南(ar日志表扣)

...

浅色Al云食堂APP代码(三)(手机云食堂)

以下是进一步优化完善后的浅色AI云食堂APP完整代码,新增了数据可视化、用户反馈、智能推荐等功能,并优化了代码结构和性能。项目结构...

实战PyQt5: 121-使用QImage实现一个看图应用

QImage简介QImage类提供了独立于硬件的图像表示形式,该图像表示形式可以直接访问像素数据,并且可以用作绘制设备。QImage是QPaintDevice子类,因此可以使用QPainter直接在图...

滚动条隐藏及美化(滚动条隐藏但是可以滚动)

1、滚动条隐藏背景/场景:在移动端,滑动的时候,会显示默认滚动条,如图1://隐藏代码:/*隐藏滚轮*/.ul-scrool-box::-webkit-scrollbar,.ul-scrool...

浅色AI云食堂APP完整代码(二)(ai 食堂)

以下是整合后的浅色AI云食堂APP完整代码,包含后端核心功能、前端界面以及优化增强功能。项目采用Django框架开发,支持库存管理、订单处理、财务管理等核心功能,并包含库存预警、数据导出、权限管理等增...

取消回复欢迎 发表评论: