spring boot 注解實現(xiàn)自定義Filter

簡介

過濾器實際上就是對web資源進行攔截,做一些處理后再交給下一個過濾器或servlet處理
通常都是用來攔截request進行處理的,也可以對返回的response進行攔截處理。

本教程使用注解來自定義一個Filter,使用到的注解:
@WebFilter、@Order
耶,是的,步驟走起》》》

1、新建一個Class并實現(xiàn)Filter接口

注意,是javax.servlet.Filter接口。

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.annotation.Order;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
//打印日志的注解,無須關(guān)心
@Slf4j
//后面再詳解下面兩個注解
@WebFilter(filterName = "myFilter", urlPatterns = "/*", servletNames = "*")
@Order(1)
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
      log.info("初始化我的過濾器。。。。。。。。");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
throws IOException, ServletException {
        //放行前可在這里做一些操作
        log.info("doFilter進入過濾器操作方法。。。");
        chain.doFilter(request, response);
        // 請求返回可在這里做一些操作
        log.info("doFilter準(zhǔn)備離開過濾器操作。。。");
    }

    @Override
    public void destroy() {
        // 該過濾器銷毀前可在這里做一些操作
        log.info("準(zhǔn)備銷毀過濾器操。。。");
    }
}

嘻嘻,到此已經(jīng)完成一大半了。。

2、在啟動類上,開啟Servlet相關(guān)注解的掃描

import com.example.demo.config.MyFilter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
//后面講解該注解
@ServletComponentScan(basePackageClasses = {MyFilter.class})
public class SpringbootLogbackAsyncApplication {

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

3、OK,新建一個測試接口類InitRest。

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class InitRest {

    @GetMapping("/hello")
    public String hello() {
        log.info("進入接口。。。");
        return "Hello greetings...";
    }
}

4、OK,啟動程序,驗證。

啟動程序時,會初始化過濾器:


初始化過濾器
接口正常返回值

看過濾器啟用成功了:(注意看日志的順序)


過濾器打印的日志

至此,自定義過濾器實現(xiàn)成功!??!

5、注解詳解

@WebFilter

使用該注解的類,必須實現(xiàn)Filter接口,
常用屬性:
filterName :字符串,命名過濾器名稱,默認(rèn)是該過濾器類名;
urlPatterns:路徑表達式,指定需要過濾的請求路徑,與value屬性相同,二者必選其一;
value:同urlPatterns;
servletNames:指定需要過濾的接口類,

@Order

只有一個屬性value,指定該過濾器的優(yōu)先級,值越小,優(yōu)先級越高,即越優(yōu)先執(zhí)行。

@ServletComponentScan

用于掃描servlet3.0相關(guān)的注解,必須使用,其相關(guān)注解才能生效,它就三個屬性:
value與basePackages,作用相同,可接受一個字符串?dāng)?shù)組,用于指定需要掃描的包;
basePackageClasses,接受一個Class數(shù)組,用于指定需要掃描的Java類,例如本教程所示。

OK,至此自定義Filter實現(xiàn)了,若您覺得文章還不錯,記得點贊評論加關(guān)注哦!?。?/em>

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容