SpringBoot增加自定义过滤器Filter

GitHub: link. 欢迎star

一、SpringBoot启动类

• 添加@ServletComponentScan注解，项目启动自动扫描Servlet组件（Filter属于Servlet组件）。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@ServletComponentScan
@SpringBootApplication
public class CoinMarketTechnicalAnalysisIndicatorsAlgorithmApplication {

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

}

二、自定义过滤器

1. 实现Filter接口。
2. 通过@WebFilter注解，注册过滤器（“urlPatterns”：需要被过滤的请求路径，“filterName”：过滤器名称）。

import lombok.extern.slf4j.Slf4j;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * @author Andon
 * 2021/11/10
 */
@Slf4j
@WebFilter(urlPatterns = "/*", filterName = "securityFilter")
public class SecurityFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        log.info("X-Real-IP:{} remoteHost:{} method:{} uri:{}", httpServletRequest.getHeader("X-Real-IP"), httpServletRequest.getRemoteHost(), httpServletRequest.getMethod(), httpServletRequest.getRequestURI());
        if (httpServletRequest.getRequestURI().equals("/filter")) {
            httpServletRequest.setAttribute("code", 403);
            httpServletRequest.setAttribute("message", "没有权限!!");
            httpServletRequest.setAttribute("uri", httpServletRequest.getRequestURI());
            // 请求转发到自定义403接口处理响应
            httpServletRequest.getRequestDispatcher("/403").forward(servletRequest, servletResponse);
        } else {
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

    @Override
    public void destroy() {

    }
}

三、过滤器中请求转发到自定义接口处理响应

import com.andon.springbootutil.domain.ResponseStandard;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Andon
 * 2021/11/10
 */
@Slf4j
@RestController
public class FilterController {

    /**
     * 自定义403接口处理响应
     */
    @RequestMapping(value = "/403")
    public ResponseStandard<String> filter() {
        ResponseStandard<String> response = ResponseStandard.failureResponse(null);
        try {
            HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
            int code = (int) request.getAttribute("code");
            String message = String.valueOf(request.getAttribute("message"));
            String uri = String.valueOf(request.getAttribute("uri"));
            response.setCode(code);
            response.setMessage(message);
            log.warn("X-Real-IP:{} remoteHost:{} method:{} uri:{}", request.getHeader("X-Real-IP"), request.getRemoteHost(), request.getMethod(), uri);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return response;
    }
}

GitHub: link. 欢迎star