【Spring Boot 源码学习】HttpEncodingAutoConfiguration 详解

news2024/9/23 1:36:10

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
	@ConditionalOnMissingBean
	public CharacterEncodingFilter characterEncodingFilter() {
		//  。。。
	}

	@Bean
	public 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 {
		// 。。。
		@NestedConfigurationProperty
		private 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】

	@Bean
	public LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {
		return new LocaleCharsetMappingsCustomizer(this.properties);
	}

	static class LocaleCharsetMappingsCustomizer
			implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>, Ordered {

		private final Encoding properties;

		LocaleCharsetMappingsCustomizer(Encoding properties) {
			this.properties = properties;
		}

		@Override
		public void customize(ConfigurableServletWebServerFactory factory) {
			if (this.properties.getMapping() != null) {
				factory.setLocaleCharsetMappings(this.properties.getMapping());
			}
		}

		@Override
		public 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.coloradmin.cn/o/1122081.html

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

相关文章

商品规格项数据的遍历以及添加

商品规格项数据的遍历以及添加

简介 今天在处理规格项的数据时遇到了一些问题&#xff0c;接下来就给大家分享一下 规格项数据设计 "specifications": [{"goodsSpecificationId": 6,"goodsSpecificationName": "网络类型","goodsTypeId": 24,"goods…
阅读更多...
【Acwing166】数独（dfs+剪枝+位运算）

【Acwing166】数独（dfs+剪枝+位运算）

本题思路来源于acwing算法提高课 题目描述 看本文需要准备的知识 1.dfs算法基本思想 2.位运算基础 3.对剪枝这个名词的大概了解 剪枝优化位运算优化 常见四种剪枝策略 首先考虑这道题的搜索顺序&#xff0c;很明显&#xff0c;可以随意选择一个空格子&#xff0c;分支为这…
阅读更多...
《广西开放大学电大搜题微信公众号——探索学习的新途径》

《广西开放大学电大搜题微信公众号——探索学习的新途径》

随着社会的发展&#xff0c;教育无疑成为了人们的基本需求之一。然而&#xff0c;对于许多忙碌的职场人士来说&#xff0c;时间和地点的限制使得他们无法像传统学生那样参加常规的大学教育。好在有着广西开放大学这样的学府&#xff0c;为那些繁忙而渴望知识更新的人们提供了学…
阅读更多...
好消息，终于可以获取到支付宝【支付交易投诉】的信息了。。。

好消息，终于可以获取到支付宝【支付交易投诉】的信息了。。。

大家好&#xff0c;我是小悟 若我拿出这个系统&#xff0c;阁下又该如何应对。 1、问题背景 之前以为从账单详情页中点击【投诉】 > 【举报中心】的投诉信息获取不到&#xff0c;经过不断尝试&#xff0c;终于能获取到了。 【支付宝支付交易投诉】&#xff0c;投诉入口是…
阅读更多...
​​​​​​​2022年上半年 软件设计师 上午试卷（1-32）

​​​​​​​2022年上半年 软件设计师 上午试卷（1-32）

以下关于冯诺依曼计算机的叙述中&#xff0c;不正确的是 &#xff08;1&#xff09; 。 &#xff08;1&#xff09; A. 程序指令和数据都采用二进制表示 B. 程序指令总是存储在主存中&#xff0c;而数据则存储在高速缓存中 C. 程序的功能都由中央处理器&#xff08;CPU&…
阅读更多...
深入解析docker内核网桥

深入解析docker内核网桥

今天做虚拟桌面&#xff0c;朋友问我&#xff0c;为什么vnc 连接另一个docker 容器一直超时&#xff0c;原因是在docker 启动的时候没有组网&#xff0c;那么接下来我就要解析下docker的内核网络。 我们思考几个问题&#xff0c;带你了解linux 中docker 网络实现的基本原理。 文…
阅读更多...
家庭燃气表微信抄表识别系统

家庭燃气表微信抄表识别系统

1.背景需求 目前家里燃气度数的读数上报&#xff0c;每个月在社区微信群里面将手机拍摄的燃气表读数截图&#xff08;加住址信息水印&#xff09;&#xff0c;发到群里给抄表员。 2.总体设计 设计目标 功能一&#xff1a;手机上随时可以远程采集读数图片&#xff08;自动加住…
阅读更多...
Jenkins环境部署与任务构建

Jenkins环境部署与任务构建

一、CI/CD 1、CI/CD 概念&#xff1a; CI/CD 是一种软件开发和交付方法&#xff0c;旨在加速应用程序的开发、测试和部署过程&#xff0c;以提高软件交付的质量和效率。 (1) 持续集成 (CI Continuous Integration): 持续集成是开发团队频繁集成其代码更改的过程。开发者将其…
阅读更多...
2023Jenkins连接k8s

2023Jenkins连接k8s

首先配置k8s config文件 1.方式获取k8s密钥 cat .kube/config 2.导出方式或者密钥 kubectl config view --raw > k8s-config-admin pipeline {agent {kubernetes {yaml apiVersion: v1kind: Podmetadata:labels:some-label: devopsspec:containers:- name: dockerimage: d…
阅读更多...
SpringBoot 第一个接口编写

SpringBoot 第一个接口编写

RestController //表示该类为请求处理类public class HttpDeal {RequestMapping("/login")//这个方法处理哪一个地址过来的请求public String hello(){return "返回给浏览器";}}
阅读更多...
【网络协议】聊聊网关 NAT机制

【网络协议】聊聊网关 NAT机制

再宿舍的时候&#xff0c;其实只能通过局域网进行处理&#xff0c;但是如果接入互联网&#xff0c;一般是配置路由器当然还有网关。 MAC头和IP头的细节 一旦配置了IP地址和网关&#xff0c;就可以制定目标地址进行访问。 MAC头主要信息目标和源MAC地址&#xff0c;以及协议类…
阅读更多...
二、BurpSuite Intruder暴力破解

二、BurpSuite Intruder暴力破解

一、介绍 解释&#xff1a; Burp Suite Intruder是一款功能强大的网络安全测试工具&#xff0c;它用于执行暴力破解攻击。它是Burp Suite套件的一部分&#xff0c;具有高度可定制的功能&#xff0c;能够自动化和批量化执行各种攻击&#xff0c;如密码破解、参数枚举和身份验证…
阅读更多...
031-第三代软件开发-屏幕保护

031-第三代软件开发-屏幕保护

第三代软件开发-屏幕保护 文章目录 第三代软件开发-屏幕保护项目介绍屏幕保护 关键字&#xff1a; Qt、 Qml、 MediaPlayer、 VideoOutput、 function 项目介绍 欢迎来到我们的 QML & C 项目&#xff01;这个项目结合了 QML&#xff08;Qt Meta-Object Language&#…
阅读更多...
SIEMENS S7-1200 汽车转弯灯程序 编程与分析

SIEMENS S7-1200 汽车转弯灯程序 编程与分析

公告 项目地址:https://github.com/MartinxMax/SIEMENS-1200-car_turn_signal 分析 题目: 画IO分配表 输入输出m3.0左转弯开关q0.0左闪灯m3.1右转弯开关q0.1右闪灯m3.2停止开关 博图V16配置 设置PLC的IP地址 允许远程通信访问 将HMI设备拖入 注意,我们这边选择的是HMI连接…
阅读更多...
Leetcode——二维数组及滚动数组练习

Leetcode——二维数组及滚动数组练习

118. 杨辉三角 class Solution { public:vector<vector<int>> generate(int numRows) {// 定义二维数组vector<vector<int>> num(numRows);for(int i0;i<numRows;i){//这里是给内层vector定义大小。默认是0,这里n是个数&#xff0c;不是值num[i].re…
阅读更多...
【Java基础面试四十二】、 static修饰的类能不能被继承？

【Java基础面试四十二】、 static修饰的类能不能被继承？

文章底部有个人公众号&#xff1a;热爱技术的小郑。主要分享开发知识、学习资料、毕业设计指导等。有兴趣的可以关注一下。为何分享&#xff1f; 踩过的坑没必要让别人在再踩&#xff0c;自己复盘也能加深记忆。利己利人、所谓双赢。 面试官&#xff1a; static修饰的类能不能被…
阅读更多...
物联网AI MicroPython传感器学习 之 RTC时钟模块

物联网AI MicroPython传感器学习 之 RTC时钟模块

学物联网&#xff0c;来万物简单IoT物联网&#xff01;&#xff01; 一、产品简介 DS1302 是DALLAS 公司推出的涓流充电时钟芯片&#xff0c;内含有一个实时时钟/日历和31字节静态RAM&#xff0c;实时时钟/日历电路提供秒、分、时、日、周、月、年的信息&#xff0c;每月的天数…
阅读更多...
驱动开发2 CoetexA7核 字符设备驱动（LED亮灯）（单独映射寄存器实现+封装结构体映射实现）

驱动开发2 CoetexA7核 字符设备驱动（LED亮灯）（单独映射寄存器实现+封装结构体映射实现）

一、单独映射寄存器实现 可参考arm点灯C语言 cortex-A7核 点LED灯 &#xff08;附 汇编实现、使用C语言 循环实现、使用C语言 封装函数实现【重要、常用】&#xff09;-CSDN博客 1 应用程序 test.c #include <stdio.h> #include <sys/types.h> #include <sys/s…
阅读更多...
云服务器搭建Hadoop分布式

云服务器搭建Hadoop分布式

文章目录 1.服务器配置2.Java环境3. 安装Hadoop4. 集群配置5. 编写集群的启动脚本 1.服务器配置 服务器主机名配置115.157.197.82s110核115.157.197.84s210核115.157.197.109s310核115.157.197.31s410核115.157.197.60gracal10核 所有的软件安装在/opt/module下&#xff0c;软…
阅读更多...
python生成的报告中绘制了多张图，但最后都混合到一起了

python生成的报告中绘制了多张图，但最后都混合到一起了

问题来源&#xff1a; 用python生成的报告中&#xff0c;存在三张图&#xff0c;第一个张图是正常的&#xff0c; 后面的图都是不正常的&#xff0c;全都是多张图混合而成的&#xff0c;这是为什么呢&#xff1f; 三段代码均是下述调用方式 import matplotlib.pyplot as plt pl…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023