java三大器Spring Boot (Filter)过滤器的实现

最新推荐文章于 2024-08-10 18:22:29 发布

一名技术极客

最新推荐文章于 2024-08-10 18:22:29 发布

阅读量3k

点赞数 1

分类专栏： java相关文章标签： java spring boot 过滤器

本文链接：https://blog.csdn.net/weixin_42081445/article/details/120136004

版权

java相关专栏收录该内容

19 篇文章 3 订阅

订阅专栏

本文详细介绍了如何在SpringBoot中实现过滤器Filter，包括注解方式(@WebFilter)和直接注入到Spring配置。过滤器的生命周期包括init()、doFilter()和destroy()方法。示例代码展示了如何定义和注册过滤器，以及在doFilter()中进行响应处理。此外，还讨论了在实际开发中如何通过过滤器返回自定义信息。

摘要由CSDN通过智能技术生成

Filter生命周期

程序启动调用Filter的init()方法(永远只调用一次)；
程序停止调用Filter的destroy()方法(永远只调用一次)；
doFilter()方法每次的访问请求如果符合拦截条件都会调用(程序第一次运行，会在servlet调用init()方法以后调用；
不管第几次，都在调用doGet(),doPost()方法之前)。

一、注解方式实现（`@WebFilter`）

@WebFilter(urlPatterns = "/api/*", filterName = "myFilter")
@Order(1)
public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        System.out.println("MyFilter,初始化了");

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String url = request.getRequestURI();
        String method = request.getMethod();
        System.out.println("请求的接口=" + url + "请求的方式=" + method);
        //该方法执行后直接运行至下一个过滤器
        filterChain.doFilter(servletRequest, servletResponse);

    }

    @Override
    public void destroy() {
        System.out.println("MyFilter,销毁了");

    }
}

filterChain.doFilter(servletRequest, servletResponse) 执行后当前过滤器执行完毕

@SpringBootApplication
@ServletComponentScan
public class SpringDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringDemoApplication.class, args);
    }

}

@RestController
@RequestMapping("/api")
public class ApiController {


    @GetMapping("/filter")
    public String getStr() {
        return "我被myFilter过滤器监控了";
    }
}

在这里插入图片描述

`@WebFilter`

@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )
在这里插入图片描述

`@Order(1)`

标识当前过滤器的执行顺序，值越小越靠前执行；

`@ServletComponentScan`

只有在springboot 启动类添加该注解时@WebFilter注解才会生效

扩展

SpringBootApplication 上使用 @ServletComponentScan 注解后
Servlet可以直接通过@WebServlet注解自动注册
Filter可以直接通过@WebFilter注解自动注册
Listener可以直接通过@WebListener 注解自动注册

二、直接注入到spring中

@Configuration
public class FilterConfig {

    @Bean
    public MyFilter myFilter() {
        return new MyFilter();
    }

    @Bean
    public FilterRegistrationBean getFilterRegistrationBean(MyFilter myFilter) {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(myFilter);
        filterRegistrationBean.setOrder(1);
        filterRegistrationBean.addUrlPatterns("/api/*");
        filterRegistrationBean.setName("myFilter");
        return filterRegistrationBean;
    }
}

也可以这样写

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<MyFilter> getFilterRegistrationBean() {
        FilterRegistrationBean<MyFilter> filterRegistrationBean = new FilterRegistrationBean<MyFilter>();
        filterRegistrationBean.setFilter(new MyFilter());
        filterRegistrationBean.setOrder(1);
        filterRegistrationBean.addUrlPatterns("/api/*");
        filterRegistrationBean.setName("myFilter");
        return filterRegistrationBean;
    }
}

过滤器中返回值

实际研发中我们可能通过过滤器来进行某些判断，条件不满足时需及时返回，我们可以这样做

doFilter方法中添加如下代码返回信息，具体返回信息格式按实际需求而变；

servletResponse.setCharacterEncoding("UTF-8");
servletResponse.setContentType("application/json; charset=utf-8");
PrintWriter out = servletResponse.getWriter();
JSONObject res = new JSONObject();
res.put("msg", "错误");
res.put("success", "false");
out.append(res.toString());