快捷導(dǎo)航

Java中使用Filter過(guò)濾器的方法

更新時(shí)間：2021年06月28日 11:16:43 作者：紅旗下的小兵

Filter過(guò)濾器是javaWeb層面的,它跟Servlet類(lèi)似,每次前端請(qǐng)求,首先進(jìn)入的是過(guò)濾器,我們必須實(shí)現(xiàn)Filter接口,重寫(xiě)三個(gè)方法,才能使用Filter過(guò)濾器,需要的朋友可以參考下

Filter過(guò)濾器

著重記錄下 public void doFilter(){} 方法參數(shù)：

（1） ServletRequest servletRequest

請(qǐng)求reqeust；

（2）ServletResponse servletResponse

響應(yīng)response；

（3）FilterChain filterChain

參數(shù) filterChain，有一個(gè)doFilter() 方法，調(diào)用這個(gè)方法，可以使程序繼續(xù)往下走，執(zhí)行后續(xù)代碼，如果有多個(gè)過(guò)濾器，它會(huì)繼續(xù)執(zhí)行下一個(gè)過(guò)濾器邏輯（開(kāi)發(fā)中會(huì)出現(xiàn)多個(gè)過(guò)濾器情況）。

例子（下邊例子是在springboot項(xiàng)目中的）

使用過(guò)濾器，日志輸出接口的響應(yīng)時(shí)間
filter -> FilterLog.java

package com.lxc.springboot.filter;
 
 
/**
 * 這個(gè)過(guò)濾器其實(shí)是給容器（tomcat）使用的
 *  public void doFilter(){} 方法參數(shù)：
 *
 * ServletRequest servletRequest ： 請(qǐng)求reqeust
 * ServletResponse servletResponse ： 響應(yīng)response
 * FilterChain filterChain ： filterChain.doFilter() 可以使用多個(gè)過(guò)濾器，繼續(xù)調(diào)用下一個(gè)過(guò)濾器
 *
 * IDEA: 格式化代碼 -> ctrl + alt + l
 * 添加 @Component 注解， spring會(huì)掃描這個(gè)類(lèi)
 */
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
 
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
 
@Component
public class FilterLog implements Filter {
    // 使用指定類(lèi) - 初始化日志對(duì)象
    private static final Logger LOG = LoggerFactory.getLogger(FilterLog.class);
 
    // 初始化方法
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }
 
    /**
     * 下邊就是一個(gè)servlet，servlet - 就是我們的請(qǐng)求、響應(yīng)，所以我們會(huì)拿到 request 和 response
     *
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        /**
         * request 可以拿到所有的請(qǐng)求信息?。?！
         */
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        LOG.info("【全局過(guò)濾器】");
        LOG.info("--------- FilterLog日志開(kāi)始 --------- ");
        LOG.info("- 請(qǐng)求地址: {}, 方法: {}", request.getRequestURL().toString(), request.getMethod());
        LOG.info("- 遠(yuǎn)程地址: {}, 域名: {}, 端口: {}", request.getRemoteAddr(), request.getRemoteHost(), request.getRemotePort());
        long startTime = System.currentTimeMillis(); // 13位 時(shí)間戳（毫秒）
        // 繼續(xù)往后執(zhí)行，是否有別的過(guò)濾器，沒(méi)有 -> 進(jìn)入應(yīng)用，執(zhí)行邏輯
        filterChain.doFilter(servletRequest, servletResponse);
        LOG.info(" --------- FilterLog 結(jié)束，耗時(shí): {} ms --------- ", System.currentTimeMillis() - startTime);
    }
 
    // web服務(wù)器關(guān)閉時(shí)，F(xiàn)ilter會(huì)銷(xiāo)毀
    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

輸出如下：