springboot實現過濾器的示例代碼

更新時間：2024年10月25日 10:43:37 作者：麥芽糖0219

JavaWeb開發(fā)中,過濾器Filter是三大組件之一,主要用于請求攔截和響應處理,如權限校驗、日志記錄、請求過濾等,本文就來介紹一下springboot實現過濾器的示例代碼,感興趣的可以了解一下

一過濾器介紹

1.1 過濾器概念

過濾器，即filter，它是javaWeb三大組件之一（Servlet程序、Listener監(jiān)聽器、Filter過濾器）

作用：既可以對請求進行攔截，也可以對響應進行處理。常用于做權限檢查，記錄日志操作、攔截過濾請求、對請求字符設置編碼等。

1.2 過濾器生命周期

SpringBoot定義一個過濾器很簡單，只需要實現Filter類，然后重寫它的3個方法即可。

init方法：程序啟動調用Filter的init()方法，永遠只調用一次；在容器中創(chuàng)建當前過濾器的時候自動調用這個方法。
destory方法：程序停止調用Filter的destroy()方法，永遠只調用一次；在容器中銷毀當前過濾器的時候自動調用這個方法。
doFilter方法：每次的訪問請求如果符合攔截條件都會調用doFilter()方法，程序第一次運行，會在servlet調用init()方法以后調用doFilter()方法；不管第幾次請求，都是在調用servlet的doGet(),doPost()方法之前調用。這個方法有3個參數，分別是ServletRequest、ServletResponse和FilterChain，可以從這些參數中獲取HttpServletReguest和HttpServletResponse對象進行相應的處理操作。

二 SpringBoot中過濾器的兩種實現方式

2.1 注解方式實現過濾器

首先需要在啟動類加 @ServletComponentScan 注解，啟動類如下

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@MapperScan("com.ts.myt.dao")
@ServletComponentScan // 過濾器
public class MytApplication {
    public static void main(String[] args) {
        SpringApplication.run(MytApplication.class, args);
    }
}

編寫過濾器，實現Filter接口

import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 使用注解方式實現過濾器（@WebFilter）
 */
@WebFilter(urlPatterns = "/user/*", filterName = "filter1")
public class MyFilter implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(MyFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
//        Filter.super.init(filterConfig);
        logger.info("MyFilterInit1");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException, IOException {
        logger.info("doFilter");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String token = request.getHeader("token");
        logger.info("token值：{}", token);

        if (token != null) {
            //該方法執(zhí)行后直接運行至下一個過濾器
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            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());
        }
    }

    @Override
    public void destroy() {
//        Filter.super.destroy();
        logger.info("destroy");
    }
}

上邊對請求頭header做了過濾，即請求頭里必須含有key為token的值，才能繼續(xù)訪問具體接口，否則該請求就終止訪問接口了

2.2 非注解方式實現過濾器（直接注入到spring中）

定義過濾器，同樣實現Filter接口

import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 過濾器實現方式二：使用非注解方式實現過濾器（直接注入到spring中）
 */
public class MyFilter2 implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(MyFilter2.class);
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        logger.info("MyFilterInit2");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException, IOException {
        System.out.println("doFilter");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String token = request.getHeader("token");
        System.out.println(token);
        //該方法執(zhí)行后直接運行至下一個過濾器
        if(token!=null){
            filterChain.doFilter(servletRequest, servletResponse);
        }else{
            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());
        }
    }

    @Override
    public void destroy() {
        System.out.println("destroy");
    }
}

編寫過濾器配置類

import com.ts.myt.filter.MyFilter2;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 方式二的過濾器配置文件
 */
@Configuration
public class MyFilter2Config {
    // Filter代碼類
    @Bean
    public MyFilter2 myFilter2() {
        return new MyFilter2();
    }

    @Bean
    public FilterRegistrationBean getFilterRegistrationBean(MyFilter2 myFilter2) {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(myFilter2);
        filterRegistrationBean.setOrder(2);
        filterRegistrationBean.addUrlPatterns("/user/*");
        filterRegistrationBean.setName("tokenFilter2");
        return filterRegistrationBean;
    }
}

效果與方式一一樣。

到此這篇關于springboot實現過濾器的示例代碼的文章就介紹到這了,更多相關springboot 過濾器內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: