【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.mzph.cn/news/114824.shtml

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

相关文章

会声会影2024有哪些新功能？好不好用

会声会影2024有哪些新功能？好不好用

比如会声会影视频编辑软件&#xff0c;既加入光影、动态特效的滤镜效果&#xff0c;也提供了与色彩调整相关的LUT配置文件滤镜&#xff0c;可选择性大&#xff0c;运用起来更显灵活。会声会影在用户的陪伴下走过20余载&#xff0c;经过上百个版本的优化迭代&#xff0c;已将操作…
阅读更多...
html列表

html列表

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>列表名称</title> </head> <body> <!--有序列表--> <ol><li>java</li><li>python</li><li…
阅读更多...
centos 7.9 源码安装htop

centos 7.9 源码安装htop

1.下载源码 wget http://sourceforge.net/projects/htop/files/latest/download 2.上传到tmp目录&#xff0c;并解压 tar xvzf htop-1.0.2.tar.gz mv htop-1.0.2 /opt/ 进入到 cd /opt/htop-1.0.2/ 3.编译并安装 ./configure && make && make install 4.…
阅读更多...
Ubuntu docker安装mysql

Ubuntu docker安装mysql

本文介绍如何在docker中安装mysql&#xff0c;之前有尝试过先在docker中安装一个ubuntu到镜像&#xff0c;然后进去再去安装mysql相关的东西&#xff0c;发现不行&#xff0c;这边整理一下一个可行的方式。 在下载镜像的时候&#xff0c;直接下载mysql镜像。 1.搜索镜像 doc…
阅读更多...
redis怎么设计一个高性能hash表

redis怎么设计一个高性能hash表

问题 redis 怎么解决的hash冲突问题 &#xff1f;redis 对于扩容rehash有什么优秀的设计&#xff1f; hash 目标是解决hash冲突&#xff0c;那什么是hash冲突呢&#xff1f; 实际上&#xff0c;一个最简单的 Hash 表就是一个数组&#xff0c;数组里的每个元素是一个哈希桶&…
阅读更多...
实现Linux下Word转PDF、Java调用命令方式

实现Linux下Word转PDF、Java调用命令方式

使用 LibreOffice 实现 Word 转 PDF 和 Java 调用命令 1、 安装 LibreOffice 外网安装 # 一键安装 yum install -y libreoffice # 验证版本 libreoffice --version # Warning: -version is deprecated. Use --version instead. # LibreOffice 7.5.6.2 f654817fb68d6d4600d7…
阅读更多...
蓝桥杯 （年号字串 C++）

蓝桥杯 （年号字串 C++）

思路&#xff1a; 1、看成10进制转化成26进制 。 2、A表示1、B表示2。以此类推&#xff0c;Z表示26. 代码&#xff1a; #include <iostream> using namespace std; int main() {char str[10]; int sum 2019, n, i 0; while (sum > 0) {str[i] sum % 26 64;sum / …
阅读更多...
Java面试——RPC协议

Java面试——RPC协议

涉及到分布式方面知识的话&#xff0c;RPC协议是逃不开的&#xff0c;所以在此记录一下RPC协议。 什么是RPC协议 RPC协议&#xff08;Remote Procedure Call&#xff09;远程过程调用&#xff0c;简单的来说&#xff1a;RPC协议是一种通过网络从远程计算机程序获取服务的协议…
阅读更多...
【Qt】消息机制和事件

【Qt】消息机制和事件

文章目录 事件event()事件过滤器案例&#xff1a;检测鼠标事件案例&#xff1a;定时器 事件 事件&#xff08;event&#xff09;是由系统或者 Qt 本身在不同的时刻发出的。当用户按下鼠标、敲下键盘&#xff0c;或者是窗口需要重新绘制的时候&#xff0c;都会发出一个相应的事…
阅读更多...
序列解包和生成器表达式

序列解包和生成器表达式

序列解包 可以使用序列解包功能对多个变量同时赋值 (1) x, y, z 1, 2, 3 print(x, y, z)必须一一对应 x, y, z 1, 2 会抛出异常 (2) 括号可加可不加 v_tuple (False, 3.5, abc) (x, y, z) v_tuple # 等价于x, y, z v_tuple print(x, y, z)可以对range对象进行解包 …
阅读更多...
联邦学习的梯度重构

联邦学习的梯度重构

梯度泄露的攻击方法&#xff1a;深度泄露梯度&#xff08;DLG&#xff09;——>在高度压缩的场景下是失效的 原因&#xff1a;梯度压缩&#xff08;可减小通信开销&#xff09;——>存在信息损失<——从而DLG方法效果有限 但是这本身存在的信息损失怎么解决呢&#x…
阅读更多...
深入解析docker内核网桥

深入解析docker内核网桥

今天做虚拟桌面&#xff0c;朋友问我&#xff0c;为什么vnc 连接另一个docker 容器一直超时&#xff0c;原因是在docker 启动的时候没有组网&#xff0c;那么接下来我就要解析下docker的内核网络。 我们思考几个问题&#xff0c;带你了解linux 中docker 网络实现的基本原理。 文…
阅读更多...
【Java基础面试四十六】、 List＜? super T＞和List＜? extends T＞有什么区别？

【Java基础面试四十六】、 List＜? super T＞和List＜? extends T＞有什么区别？

文章底部有个人公众号&#xff1a;热爱技术的小郑。主要分享开发知识、学习资料、毕业设计指导等。有兴趣的可以关注一下。为何分享&#xff1f; 踩过的坑没必要让别人在再踩&#xff0c;自己复盘也能加深记忆。利己利人、所谓双赢。 面试官&#xff1a;问题 参考答案&#x…
阅读更多...
计算机算法分析与设计（15）---贪心算法(虚拟汽车加油问题和最优分解问题)

计算机算法分析与设计（15）---贪心算法(虚拟汽车加油问题和最优分解问题)

文章目录 一、虚拟汽车加油问题1.1 问题描述1.2 思路分析1.3 代码编写 二、最优分解问题2.1 问题描述2.2 思路分析2.3 代码编写 一、虚拟汽车加油问题 1.1 问题描述 一辆虚拟汽车加满油后可行驶 n n n km。旅途中有若干加油站。设计一个有效算法&#xff0c;指出应在哪些加油…
阅读更多...
MyBatisPlus实现连表操作、批量处理

MyBatisPlus实现连表操作、批量处理

1、实现连表查询 正常来说单靠mybatisplus无法实现连表查询&#xff0c;只能靠单表sql然后进行拼接形成连表查询&#xff0c;或者使用xml文件去编写sql语句来实现连表查询。但他又给我们提供了一个插件MyBatis-Plus-Join&#xff0c;用来弥补mybatisplus再连表上的不足&#…
阅读更多...
Apache Jmeter测压工具快速入门

Apache Jmeter测压工具快速入门

Jmeter测压工具快速入门 一、Jmeter介绍二、Jmeter On Mac2.1 下载2.2 安装2.2.1 环境配置2.2.2 初始化设置 2.3 测试2.3.1 创建JDBC Connection Configuration2.3.2 创建线程组2.3.3 创建JDBC Request2.3.4 创建结果监控2.3.5 运行结果 2.4 问题记录2.4.1 VM option UseG1GC异…
阅读更多...
【C语言】每日一题（旋转数组）

【C语言】每日一题（旋转数组）

旋转数组&#xff0c;链接奉上 目录 方法:创建额外的数组&#xff1a;整体思路&#xff1a;代码实现&#xff1a; 数组反转&#xff1a;整体思路&#xff1a;代码实现&#xff1a;小插曲&#xff1a; 方法: 创建额外的数组&#xff1a; 整体思路&#xff1a; 创建一个额外的…
阅读更多...
oracle实现搜索不区分大小写

oracle实现搜索不区分大小写

<if test"code ! null and code ! ">and upper(code) like upper(%${code}%) </if>关键字upper
阅读更多...
51单片机的时钟系统

51单片机的时钟系统

1.简介 51内置的时钟系统可以用来计时&#xff0c;与主程序分割开来&#xff0c;在计时过程中不会终端主程序&#xff0c;还可以通过开启时钟中断来执行相应的操作。 2.单片机工作方式 单片机内部有两个十六位的定时器T0和T1。每个定时器有两种工作方式选择&#xff0c;分别…
阅读更多...
Redis-Sentinel高可用架构学习

Redis-Sentinel高可用架构学习

Redis-Sentinel高可用架构 Redis主从复制过程&#xff1a; 主从同步原理 Redis Sentinel&#xff08;哨兵&#xff09;高可用集群方案&#xff1a;Redis-Sentinel是Redis官方推荐的高可用性(HA)解决方案。 当用Redis做Master-slave的高可用方案时&#xff0c;假如master宕机了…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023