java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot内置过滤器

SpringBoot中9个内置过滤器用法的完整指南

作者:小马不敲代码

这篇文章主要为大家详细介绍了SpringBoot中9个内置过滤器用法的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一

Spring Boot - 内置的9个过滤器用法

01CharacterEncodingFilter —— 乱码终结者

关键词:UTF-8、forceEncoding、Ordered.HIGHEST_PRECEDENCE

只要出现中文、emoji、阿拉伯文,就用它!

@Bean
public FilterRegistrationBean<CharacterEncodingFilter> characterEncodingFilter() {
    CharacterEncodingFilter filter = new CharacterEncodingFilter();
    filter.setEncoding("UTF-8");              // ① 指定编码
    filter.setForceEncoding(true);            // ② 强制覆盖已有编码
    FilterRegistrationBean<CharacterEncodingFilter> bean = new FilterRegistrationBean<>(filter);
    bean.addUrlPatterns("/*");                // ③ 拦截所有请求
    bean.setOrder(Ordered.HIGHEST_PRECEDENCE);// ④ 最先执行,防止其他过滤器捣蛋
    return bean;
}

注解:

02HiddenHttpMethodFilter —— 把 POST 伪装成 PUT/DELETE

关键词:RESTful、_method、HTML 表单

<form action="/books/7" method="post">
  <input type="hidden" name="_method" value="DELETE"/>
  <button type="submit">删除图书</button>
</form>

spring.mvc.hiddenmethod.filter.enabled=true # application.yml 一行搞定

注解:

03FormContentFilter —— PUT/PATCH 也能玩表单

关键词:application/x-www-form-urlencoded、非 POST 表单

spring.mvc.formcontent.filter.enabled: true # 同样一行配置

场景:老项目前端不会发 application/json,但接口想用 PUT 更新。

@PutMapping("/users/{id}")
public String updateUser(@PathVariable Long id, UserForm form) {
    // 表单字段自动封装进 UserForm
    userService.update(id, form);
    return "redirect:/users";
}

注解:

04RequestContextFilter —— 随时随地拿 Request

关键词:RequestContextHolder、非 Controller 取 IP

@Service
public class ClientInfoService {
    public String whoami() {
        ServletRequestAttributes attrs = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest req = attrs.getRequest();
        return String.format("IP: %s, UA: %s",
                             req.getRemoteAddr(),
                             req.getHeader("User-Agent"));
    }
}

注解:

05CorsFilter —— 跨域通行证

关键词:Access-Control-Allow-Origin、Credentials、预检

@Bean
public CorsFilter corsFilter() {
    CorsConfiguration cfg = new CorsConfiguration();
    cfg.setAllowCredentials(true);                // ① 允许携带 Cookie
    cfg.addAllowedOrigin("https://spa.xxx.com");  // ② 白名单域名
    cfg.addAllowedHeader("*");                    // ③ 任意请求头
    cfg.addAllowedMethod("*");                    // ④ 任意方法
    UrlBasedCorsConfigurationSource src = new UrlBasedCorsConfigurationSource();
    src.registerCorsConfiguration("/api/**", cfg);
    return new CorsFilter(src);
}

注解:

06ShallowEtagHeaderFilter —— 让 304 飞起来

关键词:ETag、缓存、节省带宽

@Bean
public FilterRegistrationBean<ShallowEtagHeaderFilter> etag() {
    FilterRegistrationBean<ShallowEtagHeaderFilter> bean = new FilterRegistrationBean<>();
    bean.setFilter(new ShallowEtagHeaderFilter());
    bean.addUrlPatterns("/static/*", "/api/report/*");
    return bean;
}

第一次 200 + ETag,第二次 304,直接省 80% 流量!

注解:

07ForwardedHeaderFilter —— 反向代理小棉袄

关键词:X-Forwarded-Proto、Nginx、ELB、HTTPS

@Bean
public FilterRegistrationBean<ForwardedHeaderFilter> forwarded() {
    FilterRegistrationBean<ForwardedHeaderFilter> bean = new FilterRegistrationBean<>();
    bean.setFilter(new ForwardedHeaderFilter());
    bean.setOrder(Ordered.HIGHEST_PRECEDENCE);   // 越早越好
    return bean;
}

注解:

08OrderedRequestContextFilter —— 顺序可控的 RequestContext

如果你写了 10+ 个自定义 Filter,谁先谁后就是生命线。

默认优先级:REQUEST_WRAPPER_FILTER_MAX_ORDER - 10000

想插队?直接实现 Ordered 接口

09ResourceUrlEncodingFilter —— 静态资源“带版本号”

关键词:缓存破坏、内容哈希、Thymeleaf 自动替换

@Configuration
public class WebCfg implements WebMvcConfigurer {
    @Bean
    public ResourceUrlEncodingFilter resourceUrlEncodingFilter() {
        return new ResourceUrlEncodingFilter();
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/")
                .setCacheControl(CacheControl.maxAge(365, TimeUnit.DAYS))
                .resourceChain(true)
                .addResolver(new VersionResourceResolver()
                        .addContentVersionStrategy("/**")); // ① 哈希指纹
    }
}

Thymeleaf 模板:

<link rel="stylesheet" th:href="@{/static/css/app.css}" rel="external nofollow"  />
<!-- 实际输出:/static/css/app-8a9b2c3.css -->

注解:

到此这篇关于SpringBoot中9个内置过滤器用法的完整指南的文章就介绍到这了,更多相关SpringBoot内置过滤器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文