【Spring Boot 源码学习】HttpEncodingAutoConfiguration 详解

Spring Boot 源码学习系列

在这里插入图片描述

HttpEncodingAutoConfiguration 详解

  • 引言
  • 往期内容
  • 主要内容
    • 1. CharacterEncodingFilter
    • 2. HttpEncodingAutoConfiguration
      • 2.1 加载自动配置组件
      • 2.2 过滤自动配置组件
        • 2.2.1 涉及注解
        • 2.2.2 characterEncodingFilter 方法
        • 2.2.3 localeCharsetMappingsCustomizer 方法
  • 总结

引言

前面的博文，我们从源码角度介绍了自动装配流程。虽然带大家从整体上有了清晰的认识，但是我们还不能熟练地运用。本篇就以 Spring Boot 内置的 http 编码功能为例，来带大家分析一下 HttpEncodingAutoConfiguration 的整个自动配置的过程。

在这里插入图片描述

往期内容

在开始本篇的内容介绍之前，我们先来看看往期的系列文章【有需要的朋友，欢迎关注系列专栏】：

Spring Boot 源码学习
Spring Boot 项目介绍
Spring Boot 核心运行原理介绍
【Spring Boot 源码学习】@EnableAutoConfiguration 注解
【Spring Boot 源码学习】@SpringBootApplication 注解
【Spring Boot 源码学习】走近 AutoConfigurationImportSelector
【Spring Boot 源码学习】自动装配流程源码解析（上）
【Spring Boot 源码学习】自动装配流程源码解析（下）
【Spring Boot 源码学习】深入 FilteringSpringBootCondition
【Spring Boot 源码学习】OnClassCondition 详解
【Spring Boot 源码学习】OnBeanCondition 详解
【Spring Boot 源码学习】OnWebApplicationCondition 详解
【Spring Boot 源码学习】@Conditional 条件注解

主要内容

1. CharacterEncodingFilter

在传统的 web 项目中，Spring 为 web 开发提供的一个过滤器【即 org.springframework.web.filter.CharacterEncodingFilter 】，用来防止 web 开发中出现的乱码问题，它是 Spring 通过在 web 请求中定义 request 和 response 的编码来实现。

在 web.xml 中的配置示例如下：

	<filter>  <filter-name>encodingFilter</filter-name>  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  <init-param>  <param-name>encoding</param-name>  <param-value>UTF-8</param-value>  </init-param>  <init-param>  <param-name>forceEncoding</param-name>  <param-value>true</param-value>  </init-param>  </filter>

2. HttpEncodingAutoConfiguration

那么在 Spring Boot 是如何实现的呢？

Spring Boot 是通过内置的 HttpEncodingAutoConfiguration 配置类来完成这一功能。下面我们具体分析一下：

注意： 以下涉及 Spring Boot 源码 均来自版本 2.7.9，其他版本有所出入，可自行查看源码。

2.1 加载自动配置组件

从之前的《【Spring Boot 源码学习】自动装配流程源码解析（上）》中，我们知道 Spring Boot 内部针对自动配置类，会读取如下两个配置文件：

  • META-INF/spring.factories
  • META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

在这里插入图片描述

实际上 在 Spring Boot 2.7.9 版本中， Spring Boot 自己内部的 META-INF/spring.factories 中有关自动配置的注册类的配置信息已经被去除掉了，不过其他外围的 jar 中可能有自己的 META-INF/spring.factories 文件，它里面也有关于自动配置注册类的配置信息；

而 Spring Boot 内置的 HttpEncodingAutoConfiguration 配置类，则是配置在上述的第二个配置文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 中。

在这里插入图片描述

2.2 过滤自动配置组件

上述自动配置加载完之后，就来到了 《【Spring Boot 源码学习】自动装配流程源码解析（下）》 介绍的 过滤自动配置组件 逻辑。

这部分数据对应的配置内容在 META-INF/spring-autoconfigure-metadata.properties 文件中：

org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration=
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration.ConditionalOnClass=org.springframework.web.filter.CharacterEncodingFilter
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration.ConditionalOnWebApplication=SERVLET

显然这里涉及到了 ConditionalOnClass 和 ConditionalOnWebApplication 注解，我们翻看 HttpEncodingAutoConfiguration 配置类的源码，如下：

@AutoConfiguration
@EnableConfigurationProperties(ServerProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {private final Encoding properties;public HttpEncodingAutoConfiguration(ServerProperties properties) {this.properties = properties.getServlet().getEncoding();}@Bean@ConditionalOnMissingBeanpublic CharacterEncodingFilter characterEncodingFilter() {//  。。。}@Beanpublic LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {// 。。。}// ...
}
2.2.1 涉及注解

我们先来看看上述 HttpEncodingAutoConfiguration 配置类涉及到的注解，如下：

  • @AutoConfiguration : 该类是一个自动配置类，Spring Boot 会根据项目中的依赖自动配置这个类的实例。
  • @EnableConfigurationProperties(ServerProperties.class) ：启用 ServerProperties 类的配置属性，这样在配置文件中就可以使用 server.servlet.encoding 属性来配置字符编码。
  • @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) ：该配置类只有在基于 servlet 的 web 应用程序中才会被实例化。
  • @ConditionalOnClass(CharacterEncodingFilter.class) ：只有在项目中存在 CharacterEncodingFilter 类时才会生效。
  • @ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true) ：只有在配置文件中 server.servlet.encoding 属性的值为 "enabled" 时才会生效；当然如果配置文件中没有这个属性，也默认会生效。
  • @Bean ：用于声明一个方法创建的对象是一个 Spring 管理的 Bean。Spring 容器会自动管理这个 Bean 的生命周期，包括依赖注入、初始化和销毁等。
  • @ConditionalOnMissingBean ：只有在当前 Spring 容器中不存在指定类型的 Bean 时，才会执行被注解的方法。这样可以用于确保在需要的时候才创建某个 Bean，避免重复创建。

其中 ServerProperties 类的属性值对应着 application.yml 或 application.properties 中的配置，通过注解@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true) 实现的属性注入。

有关属性注入的内容后续笔者会另外介绍，我们先来看看ServerProperties 类相关的部分源码 和 对应的配置参数：

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {// 。。。private final Servlet servlet = new Servlet();// 。。。public static class Servlet {// 。。。@NestedConfigurationPropertyprivate final Encoding encoding = new Encoding();// 。。。}// 。。。
}public class Encoding {// 默认的HTTP编码，用于Servlet应用程序。public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;// HTTP请求和响应的字符集。如果未显式设置，将添加到"Content-Type"头中private Charset charset = DEFAULT_CHARSET;// 是否强制在HTTP请求和响应上使用配置的字符集的标志private Boolean force;// 是否强制在HTTP请求上使用配置的字符集的标志。当"force"未指定时，默认为true。private Boolean forceRequest;// 是否强制在HTTP响应上使用配置的字符集的标志。private Boolean forceResponse;// 将区域设置映射到字符集以进行响应编码的映射。private Map<Locale, Charset> mapping;// 。。。
}

当然在 application.properties 中，我们就可以添加如下的配置：

server.servlet.encoding.force=true
server.servlet.encoding.charset=UTF-8
# server.servlet.encoding.force-request=true 
# ...其他配置省略

注意： server.servlet.encoding.force=true 和 server.servlet.encoding.force-request=true 这两个配置项实际上具有相同的功能，它们都决定是否强制对客户端请求进行字符编码。当这些配置项设置为 true时，服务器将要求客户端发送的请求内容使用指定的字符集进行编码。
另外，从 Spring Boot 2.3.5 版本开始，server.servlet.encoding.enabled 配置项已被弃用。因此，推荐的做法是直接设置 server.servlet.encoding.charset 来指定字符集，然后通过设置server.servlet.encoding.force=true 来开启对请求/响应的编码集强制控制。

2.2.2 characterEncodingFilter 方法

先来看看 characterEncodingFilter 方法的源码【】：

public CharacterEncodingFilter characterEncodingFilter() {CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();filter.setEncoding(this.properties.getCharset().name());filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));return filter;
}

上述逻辑很好理解：

  • 首先，新建一个 CharacterEncodingFilter 的实例对象 filter 。

  • 然后，设置 filter 的 encoding 属性，即编码属性。其中 this.properties.getCharset().name() 就是上述 application.properties 中的 server.servlet.encoding.charset=UTF-8；如果没有配置，则默认是 UTF-8【可查看上述 Encoding 类】。

  • 接着，设置 filter 的 forceRequestEncoding 和 forceResponseEncoding 属性。我们来直接查 Encoding 类的 shouldForce 即可：

    public boolean shouldForce(Type type) {// Http请求，则取 server.servlet.encoding.force-request 配置// Http响应，则取 server.servlet.encoding.force-response 配置Boolean force = (type != Type.REQUEST) ? this.forceResponse : this.forceRequest;// 如果上述配置都没有if (force == null) {// 取 server.servlet.encoding.force 配置force = this.force;}if (force == null) {// 当 server.servlet.encoding.force 配置也未指定时，// 默认 强制在HTTP请求上使用配置的字符集。force = (type == Type.REQUEST);}return force;
}
2.2.3 localeCharsetMappingsCustomizer 方法

话不多说，直接来看相关的源码【Spring Boot 2.7.9】

	@Beanpublic LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {return new LocaleCharsetMappingsCustomizer(this.properties);}static class LocaleCharsetMappingsCustomizerimplements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>, Ordered {private final Encoding properties;LocaleCharsetMappingsCustomizer(Encoding properties) {this.properties = properties;}@Overridepublic void customize(ConfigurableServletWebServerFactory factory) {if (this.properties.getMapping() != null) {factory.setLocaleCharsetMappings(this.properties.getMapping());}}@Overridepublic int getOrder() {return 0;}}

上述 LocaleCharsetMappingsCustomizer 静态内部类实现了 WebServerFactoryCustomizer 接口，该接口用于自定义 Web 服务器工厂的策略接口。此类类型的任何 bean 将在服务器本身启动之前获得与服务器工厂的回调，因此您可以设置端口、地址、错误页面等。

注意：对此类接口的调用通常由WebServerFactoryCustomizerBeanPostProcessor 执行，它是一个BeanPostProcessor（在 ApplicationContext 生命周期中非常早期）。可能更安全的做法是在包含 BeanFactory 中延迟查找依赖项，而不是使用@Autowired 注入它们。

而 LocaleCharsetMappingsCustomizer 类实现的 customize 方法，则用于设置自定义字符编码映射，这就不得不提 server.servlet.encoding.mapping 配置属性。

默认情况下，Spring Boot 会根据请求头的 Accept-Charset 来设置响应的字符编码。但是，有时候我们可能需要根据不同的请求路径或请求参数来进行不同的字符编码映射。这时，就可以使用 server.servlet.encoding.mapping 来实现自定义的字符编码映射。

# 当请求路径以 /en/ 开头时，将字符编码设置为 UTF-8；当请求路径以 /zh/ 开头时，将字符编码设置为 GBK。
server.servlet.encoding.mapping=/en/**=UTF-8,/zh/**=GBK

注意： server.servlet.encoding.mapping 的配置优先级高于 server.servlet.encoding.charset 和 server.servlet.encoding.force。因此，如果同时存在多个配置项，server.servlet.encoding.mapping 会覆盖其他配置项。

总结

本篇我们以 Spring Boot 内置的 http 编码功能为例来分析一下整个自动配置的过程，深入讲解了 HttpEncodingAutoConfiguration 配置类的相关内容。相信大家后续在看其他配置类，也能知其所以然了。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/144735.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

四、网络请求与路由

四、网络请求与路由

一、网络请求 1、Axios请求 Axios是一个基于promise的网络请求库 &#xff08;1&#xff09;安装 npm install --save axios&#xff08;2&#xff09;引入 import axios from "axios"全局引入 import axios from "axios" import { createApp } from …
阅读更多...
STM32，我想看单片机上的外设时钟，我怎么看？

STM32，我想看单片机上的外设时钟，我怎么看？

一&#xff1a;在工程中加入rcc文件 首先需要加载我们的时钟函数的文件 stm32f10x_rcc.h 和 stm32f10x_rcc.c 文件 二&#xff1a;查看文件 在h头文件 尾部&#xff0c;有我们这个总线的函数 在函数体内&#xff0c;有我们这个宏定义的 外设时钟&#xff0c;我们拿就行了 APB2_…
阅读更多...
多版本并发控制MVCC

多版本并发控制MVCC

什么是MVCC MVCC &#xff08;Multiversion Concurrency Control&#xff09;&#xff0c;多版本并发控制。顾名思义&#xff0c;MVCC 是通过数据行的多个版本管理来实现数据库的并发控制。这项技术使得在InnoDB的事务隔离级别下执行一致性读操作有了保证。换言之&#xff0c;…
阅读更多...
观察者模式-对象间的联动

观察者模式-对象间的联动

有个商城小程序&#xff0c;用户希望当有新品上市的时候能通知他们。这样用户就可以不要时刻盯着小程序了。在这个场景中&#xff0c;用户向小程序订阅了一个服务——发送新品短信。小程序在有新品上线时负责向订阅客户发出这个消息。 这就是发布-订阅模式&#xff0c;也称观察…
阅读更多...
为什么不建议使用Python自带的logging？

为什么不建议使用Python自带的logging？

B站|公众号&#xff1a;啥都会一点的研究生 包括我在内的大多数人&#xff0c;当编写小型脚本时&#xff0c;习惯使用print来debug&#xff0c;肥肠方便&#xff0c;这没问题&#xff0c;但随着代码不断完善&#xff0c;日志功能一定是不可或缺的&#xff0c;极大程度方便问题…
阅读更多...
2023-10-17 LeetCode每日一题（倍数求和）

2023-10-17 LeetCode每日一题（倍数求和）

2023-10-17每日一题 一、题目编号 2652. 倍数求和二、题目链接 点击跳转到题目位置 三、题目描述 给你一个正整数 n &#xff0c;请你计算在 [1&#xff0c;n] 范围内能被 3、5、7 整除的所有整数之和。 返回一个整数&#xff0c;用于表示给定范围内所有满足约束条件的数…
阅读更多...
10_集成学习方法：随机森林、Boosting

10_集成学习方法：随机森林、Boosting

文章目录 1 集成学习&#xff08;Ensemble Learning)1.1 集成学习1.2 Why need Ensemble Learning?1.3 Bagging方法 2 随机森林(Random Forest)2.1 随机森林的优点2.2 随机森林算法案例2.3 随机森林的思考&#xff08;--->提升学习&#xff09; 3 随机森林&#xff08;RF&a…
阅读更多...
经典链表问题：解析链表中的关键挑战

经典链表问题：解析链表中的关键挑战

这里写目录标题 公共子节点采用集合或者哈希采用栈拼接两个字符串差和双指针 旋转链表 公共子节点 例如这样一道题&#xff1a;给定两个链表&#xff0c;找出它们的第一个公共节点。 具体的题目描述我们来看看牛客的一道题&#xff1a; 这里我们有四种解决办法&#xff1a; …
阅读更多...
跟随光标圆形文本旋转

跟随光标圆形文本旋转

今天给大家带来的是光标变成圆形字符串环绕 不多说先上效果图 原理呢,也很简单 就是先把文本 <h2>大威天龙 - 世尊地藏 - 般若诸佛 - 般若巴嘛哄 -</h2>然后使用js将文本处理成每个字符一个span,并且让他们旋转 let text document.querySelector(h2)text.innerH…
阅读更多...
第 368 场 LeetCode 周赛题解

第 368 场 LeetCode 周赛题解

A 元素和最小的山形三元组 I 前后缀操作&#xff1a;求出前后缀上的最小值数组&#xff0c;然后枚举 j j j class Solution { public:int minimumSum(vector<int> &nums) {int n nums.size();vector<int> l(n), r(n);//l[i]min{nums[0],...,nums[i]}, r[i]mi…
阅读更多...
自然语言处理---Self Attention自注意力机制

自然语言处理---Self Attention自注意力机制

Self-attention介绍 Self-attention是一种特殊的attention&#xff0c;是应用在transformer中最重要的结构之一。attention机制&#xff0c;它能够帮助找到子序列和全局的attention的关系&#xff0c;也就是找到权重值wi。Self-attention相对于attention的变化&#xff0c;其实…
阅读更多...
数字孪生智慧建筑可视化系统，提高施工效率和建造质量

数字孪生智慧建筑可视化系统，提高施工效率和建造质量

随着科技的不断进步和数字化的快速发展&#xff0c;数字孪生成为了建筑行业的一个重要的概念&#xff0c;被广泛应用于智能化建筑的开发与管理中。数字孪生是将现实世界的实体与数字世界的虚拟模型进行连接和同步&#xff0c;从而实现实时的数据交互和模拟仿真。数字孪生在建筑…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023