簡介
過濾器實(shí)際上就是對web資源進(jìn)行攔截撞牢,做一些處理后再交給下一個(gè)過濾器或servlet處理
通常都是用來攔截request進(jìn)行處理的撼泛,也可以對返回的response進(jìn)行攔截處理乒躺。
本教程使用注解來自定義一個(gè)Filter科展,使用到的注解:
@WebFilter、@Order
耶堪旧,是的数焊,步驟走起》》》
1、新建一個(gè)Class并實(shí)現(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
//后面再詳解下面兩個(gè)注解
@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進(jìn)入過濾器操作方法芹助。堂湖。。");
chain.doFilter(request, response);
// 請求返回可在這里做一些操作
log.info("doFilter準(zhǔn)備離開過濾器操作状土。无蜂。。");
}
@Override
public void destroy() {
// 該過濾器銷毀前可在這里做一些操作
log.info("準(zhǔn)備銷毀過濾器操蒙谓。斥季。。");
}
}
嘻嘻,到此已經(jīng)完成一大半了酣倾。舵揭。
2、在啟動(dòng)類上躁锡,開啟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,新建一個(gè)測試接口類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("進(jìn)入接口箱叁。。惕医。");
return "Hello greetings...";
}
}
4耕漱、OK,啟動(dòng)程序抬伺,驗(yàn)證螟够。
啟動(dòng)程序時(shí),會初始化過濾器:
看過濾器啟用成功了:(注意看日志的順序)
至此峡钓,自定義過濾器實(shí)現(xiàn)成功<梭稀!能岩!
5寞宫、注解詳解
@WebFilter
使用該注解的類,必須實(shí)現(xiàn)Filter接口拉鹃,
常用屬性:
filterName :字符串辈赋,命名過濾器名稱,默認(rèn)是該過濾器類名膏燕;
urlPatterns:路徑表達(dá)式钥屈,指定需要過濾的請求路徑,與value屬性相同坝辫,二者必選其一篷就;
value:同urlPatterns;
servletNames:指定需要過濾的接口類近忙,
@Order
只有一個(gè)屬性value竭业,指定該過濾器的優(yōu)先級,值越小及舍,優(yōu)先級越高永品,即越優(yōu)先執(zhí)行。
@ServletComponentScan
用于掃描servlet3.0相關(guān)的注解击纬,必須使用鼎姐,其相關(guān)注解才能生效,它就三個(gè)屬性:
value與basePackages,作用相同炕桨,可接受一個(gè)字符串?dāng)?shù)組饭尝,用于指定需要掃描的包;
basePackageClasses献宫,接受一個(gè)Class數(shù)組钥平,用于指定需要掃描的Java類,例如本教程所示姊途。
OK涉瘾,至此自定義Filter實(shí)現(xiàn)了,若您覺得文章還不錯(cuò)捷兰,記得點(diǎn)贊評論加關(guān)注哦A⑴选!贡茅!