【源码】关于 Spring 国际化 MessageSource

最新推荐文章于 2025-02-21 22:00:04 发布
最新推荐文章于 2025-02-21 22:00:04 发布
阅读量2.4k 收藏 3
点赞数 6
分类专栏： Spring 文章标签： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42189048/article/details/110699516
版权

【源码】关于 Spring 国际化 MessageSource

前言

容器类顶层接口 ApplicationContext 同时也是一个 MessageSource，MessageSource 便是所谓的 国际化 接口，它的 getMessage 方法允许我们根据不同的 Locale 返回不同的信息结果

本章节集合部分源码解读其原理，并给出 SpringBoot 的实现和使用示例

版本

Spring Framework：5.2.x

MessageSource

public interface MessageSource {

	@Nullable
	String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale);

	String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException;

	String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException;

}

顶层接口，提供了 getMessage 的三个重载方法：

  • String code：待解析的字符串
  • Object[] args：待解析字符串的参数，可以基于 MessageFormat 解析带有 占位符 的字符串
  • String defaultMessage：读取不到 国际化 信息时依据此默认值进行处理
  • MessageSourceResolvable resolvable，对上述几个参数的封装，默认实现类 DefaultMessageSourceResolvable
  • Locale locale：国际化定位，如 Locale.CHINA 代表中国

HierarchicalMessageSource

public interface HierarchicalMessageSource extends MessageSource {

	void setParentMessageSource(@Nullable MessageSource parent);

	@Nullable
	MessageSource getParentMessageSource();

}

拓展了 MessageSource 的层级关系

DelegatingMessageSource

Spring 容器启动时，如果容器中不存在对应的 Bean 实例，则容器中默认创建的 MessageSource 实例类型为 DelegatingMessageSource

具体源码参考 AbstractApplicationContext#initMessageSource 方法

该类的主要作用是试图将 国际化 处理委托给父级 MessageSource，否则降级处理：处理成默认字符串或者抛出异常

public class DelegatingMessageSource extends MessageSourceSupport implements HierarchicalMessageSource {

	@Nullable
	private MessageSource parentMessageSource;

	@Override
	public void setParentMessageSource(@Nullable MessageSource parent) {
		this.parentMessageSource = parent;
	}

	@Override
	@Nullable
	public MessageSource getParentMessageSource() {
		return this.parentMessageSource;
	}
	
	@Override
	@Nullable
	public String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale) {
		/**
		 * 由 parentMessageSource 处理
		 */
		if (this.parentMessageSource != null) {
			return this.parentMessageSource.getMessage(code, args, defaultMessage, locale);
		}
		
		// 依据 defaultMessage 继续处理
		else if (defaultMessage != null) {
			return renderDefaultMessage(defaultMessage, args, locale);
		}
		else {
			return null;
		}
	}

	@Override
	public String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException {
		if (this.parentMessageSource != null) {
			return this.parentMessageSource.getMessage(code, args, locale);
		}
		// 抛出异常
		else {
			throw new NoSuchMessageException(code, locale);
		}
	}

	// ...

}

AbstractMessageSource

核心抽象类，实现 配置化解析国际化信息 的关键类，我们从 getMessage 方法的实现入手

getMessage

	@Override
	public final String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale) {
		/**
		 * code 的国际化处理
		 */
		String msg = getMessageInternal(code, args, locale);
		if (msg != null) {
			return msg;
		}

		/**
		 * 如果处理结果为 null，且不提供 defaultMessage
		 * 		则根据属性 useCodeAsDefaultMessage
		 * 		决定原样返回，还是抛出异常，默认抛出异常
		 */
		if (defaultMessage == null) {
			return getDefaultMessage(code);
		}

		// 依据 defaultMessage 处理
		return renderDefaultMessage(defaultMessage, args, locale);
	}
  • getMessageInternal 方法处理信息解析
  • useCodeAsDefaultMessage 属性决定解析无结果的信息是原样返回还是抛出异常，默认抛出异常
  • renderDefaultMessage 即依据 defaultMessage 解析信息解析

重点关注 getMessageInternal 方法

getMessageInternal

	protected String getMessageInternal(@Nullable String code, @Nullable Object[] args, @Nullable Locale locale) {
		if (code == null) {
			return null;
		}
		if (locale == null) {
			locale = Locale.getDefault();
		}
		Object[] argsToUse = args;

		if (!isAlwaysUseMessageFormat() && ObjectUtils.isEmpty(args)) {
			/**
			 * 无参信息的处理
			 * 本质是直接映射对应 Locale 的配置文件
			 * 方法由子类复写
			 */
			String message = resolveCodeWithoutArguments(code, locale);
			if (message != null) {
				return message;
			}
		}

		else {
			argsToUse = resolveArguments(args, locale);

			/**
			 * 有参信息的处理
			 * 本质是基于 MessageFormat 进行处理，
			 * 		同时缓存对应的 MessageFormat
			 * 方法由子类复写	
			 */
			MessageFormat messageFormat = resolveCode(code, locale);
			if (messageFormat != null) {
				synchronized (messageFormat) {
					return messageFormat.format(argsToUse);
				}
			}
		}

		// 基于 commonMessages 处理信息
		Properties commonMessages = getCommonMessages();
		if (commonMessages != null) {
			String commonMessage = commonMessages.getProperty(code);
			if (commonMessage != null) {
				return formatMessage(commonMessage, args, locale);
			}
		}

		// 最后，尝试交给父级处理
		return getMessageFromParent(code, argsToUse, locale);
	}
  • 对于无参信息交给 resolveCodeWithoutArguments 方法处理，其本质就是读取对应 Locale 的配置文件，具体由子类实现
  • 对于有参信息交给 resolveCode 方法处理，其本质是读取对应 Locale 的配置文件后，基于 MessageFormat 和对应的参数进行处理，同时进行缓存，具体由子类实现
  • 之后，会尝试基于 commonMessages 进行处理
  • 最后，尝试交给父级处理

重点关注子类对 resolveCodeWithoutArguments 和 resolveCode 方法的实现

AbstractResourceBasedMessageSource

public abstract class AbstractResourceBasedMessageSource extends AbstractMessageSource {

	// 配置文件路径名
	private final Set<String> basenameSet = new LinkedHashSet<>(4);

	// 字符集
	@Nullable
	private String defaultEncoding;

	private boolean fallbackToSystemLocale = true;

	// 默认 Locale
	@Nullable
	private Locale defaultLocale;

	// 缓存时间，默认永久
	private long cacheMillis = -1;

	// ... getter & setter

}

在 AbstractMessageSource 的基础上，拓展了配置文件相关属性的管理

ResourceBundleMessageSource

核心实现类，也是 SpringBoot 提供的默认实现，我们重点关注其对上述提到的 resolveCodeWithoutArguments 和 resolveCode 方法的实现

resolveCodeWithoutArguments

	@Override
	protected String resolveCodeWithoutArguments(String code, Locale locale) {
		/**
		 * 根据不同的 Locale 加载对应的 ResourceBundle
		 * 		因为没有参数，就相当于单纯的配置文件映射
		 * 基于 basenameSet 加载对应路径的配置文件
		 * 		基于 ResourceBundle 类来管理配置文件
		 */
		Set<String> basenames = getBasenameSet();
		for (String basename : basenames) {
			ResourceBundle bundle = getResourceBundle(basename, locale);
			if (bundle != null) {
				String result = getStringOrNull(bundle, code);
				if (result != null) {
					return result;
				}
			}
		}
		return null;
	}
  • 基于 basenameSet 属性和 Locale 定位对应的配置文件
  • 配置文件由 ResourceBundle 类管理
  • 直接读取对应的 key 即可
  • 因此使用 ResourceBundleMessageSource 时我们需要定义具体的 basenameSet，SpringBoot 给出的默认实现中，basenameSet 默认为 messages，可以由 spring.messages.basename 属性自定义，后文会给出示例

resolveCode

	@Override
	@Nullable
	protected MessageFormat resolveCode(String code, Locale locale) {
		Set<String> basenames = getBasenameSet();
		for (String basename : basenames) {
			ResourceBundle bundle = getResourceBundle(basename, locale);
			if (bundle != null) {
				/**
				 * 由对应的 bundle code locale 创建对应的
				 * 		MessageFormat 缓存后返回
				 * 缓存数据结构 Map<String, Map<Locale, MessageFormat>>
				 */
				MessageFormat messageFormat = getMessageFormat(bundle, code, locale);
				if (messageFormat != null) {
					return messageFormat;
				}
			}
		}
		return null;
	}
  • 同样的，基于 basenameSet 属性和 Locale 定位对应的配置文件
  • 配置文件由 ResourceBundle 类管理
  • 基于 bundle code locale 创建对应的 MessageFormat 并缓存起来，其数据结构为 Map<String, Map<Locale, MessageFormat>>
  • 默认创建的 MessageFormat 为 new MessageFormat(msg, locale)，这基本就够用了，如果需要，也可以自行复写 MessageSourceSupport#createMessageFormat 方法

示例

此处我们给出 SpringBoot 中使用 ResourceBundleMessageSource 的示例，首先，SpringBoot 默认 自动装配 的 MessageSource 即就是 ResourceBundleMessageSource

详情参考类 MessageSourceAutoConfiguration

因此，我们仅需要简单地配置即可使用：

application.yaml

spring:
  messages:
    basename: i18n/messages
    encoding: UTF-8

配置文件路径设置为 i18n/messages，编码为 UTF-8

i18n/messages

类路径下创建配置文件 messages.properties，同时再创建一个 messages_zh_CN.properties 用于匹配示例中的 LocaleCHINA，如图：
messages

demo

@SpringBootApplication
public class MsApplication {

	@Autowired
	MessageSource messageSource;

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

	@Component
	class test implements CommandLineRunner {

		@Override
		public void run(String... args) throws Exception {
			// 无参信息处理
			System.out.println(
					messageSource.getMessage("hello", null, Locale.CHINA));

			// 有参信息处理
			System.out.println(
					messageSource.getMessage("time", new Object[]{ new Date() }, Locale.CHINA));
		}
	}

ReloadableResourceBundleMessageSource

还有另一个实现类 ReloadableResourceBundleMessageSource，同时支持对 xml 配置文件的解析，且它结合 basename 属性和 Locale 对配置文件的路径进行匹配

在 SpringBoot 中，它的使用与 ResourceBundleMessageSource 基本相似，但是如果要使用 ReloadableResourceBundleMessageSource，需要单独创建对应的 Bean实例，如下示例

示例

@SpringBootApplication
public class MsApplication {

	@Autowired
	MessageSource messageSource;

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

	@Component
	class test implements CommandLineRunner {

		@Override
		public void run(String... args) throws Exception {
			// 无参解析
			System.out.println(
					messageSource.getMessage("hello", null, Locale.CHINA));

			// 有参解析
			System.out.println(
					messageSource.getMessage("time", new Object[]{ new Date() }, Locale.CHINA));

		}
	}

	/**
	 * 此处避免循环依赖，创建在静态内部类中
	 * 当然，一般情况单独由配置类管理
	 */
	@Configuration
	static class MessageSourceCofiguration {

		/**
		 * 声明 MessageSource 的 bean 实例为
		 * 		ReloadableResourceBundleMessageSource 
		 */
		@Bean
		public MessageSource messageSource() {
			ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource
					= new ReloadableResourceBundleMessageSource();
			reloadableResourceBundleMessageSource.setBasename("i18n/messages");
			reloadableResourceBundleMessageSource.setDefaultEncoding("UTF-8");
			reloadableResourceBundleMessageSource.setCacheMillis(2000);
			return reloadableResourceBundleMessageSource;
		}
	}
}

其他代码、配置文件如出一辙，无需改变

总结

以上，就是对 Spring 国际化的介绍，主要介绍了 MessageSource 体系下的各类，以及对 SpringBoot 中的使用方式进行了具体的示范

【Spring源码】13. 国际化处理initMessageSource()源码解析
aqin1012的博客
08-12 534
负责这块功能的就是下图中红框框圈中的方法～
SpringBoot中使用MessageSource的getMessage获取i18n资源文件中的消息
BADAO_LIUMANG_QIZHI的博客
09-03 9662
场景 springboot默认就支持国际化的，而且不需要你过多的做什么配置，只需要在resources/下创建国际化配置文件即可，注意名称必须以messages开始。 messages.properties （默认的语言配置文件，当找不到其他语言的配置的时候，使用该文件进行展示）。 比如在resoure下新建i18n目录，在此目录下新建message.properties 在此资源文件中配置一些消息的映射，这样在需要使用的代码中统一使用左边的code进行获取，在显示时会显示右边的消息。 那么如.
Springboot使用MessageSource读取资源文件
HiterCoder
10-25 3184
1、项目开发过程中的提示文字信息可以在资源文件中进行定义，而且资源文件是实现国际化技术的主要手段。如果想在SpringBoot里面进行资源文件的配置，只需要做一些简单的application.yml配置即可，而且所有注入的资源文件都可以像最初的Spring处理那样，直接使用MessageSource进行读取。 首先，在src/main/resources源文件夹下创建一个i18n的子目录...
【Spring4揭秘 基础4】国际化--MessageSource
要啥自行车
06-01 9081
假设我们正在开发一个支持多国语言的Web应用程序，要求系统能够根据客户端的系统的语言类型返回对应的界面：英文的操作系统返回英文界面，而中文的操作系统则返回中文界面——这便是典型的i18n国际化问题。对于有国际化要求的应用系统，我们不能简单地采用硬编码的方式编写用户界面信息、报错信息等内容，而必须为这些需要国际化的信息进行特殊处理。简单来说，就是为每种语言提供一套相应的资源文件，并以规范化命名的方式保
Spring系列学习之Spring Messaging消息支持
最新发布
m0_74825466的博客
02-21 939
Spring Framework为与消息传递系统的集成提供了广泛的支持，从使用JmsTemplate简化JMS API的使用到异步接收消息的完整基础结构。Spring AMQP为高级消息队列协议提供了类似的功能集。Spring Boot还为RabbitTemplate和RabbitMQ提供自动配置选项。Spring WebSocket本身包含对STOMP消息传递的支持，Spring Boot通过启动器和少量自动配置支持它。Spring Boot也支持Apache Kafka。
Spring基本使用（消息源MessageSource的使用/国际化）
在巴黎铁塔 :-)
07-04 5185
0. 使用 spring 提供的消息源，简单示例 资源包路径结构如下（项目结构）（资源包文件编码统一为 UTF-8 编码，这里仅仅使用 language-code 作为资源文件划分） 1.1 文件 my_message_source_zh.properties 和 my_message_source_en.properties 的内容分别为： // zh版本（中文版） 文件的内容 app...
【Spring源码】MessageSource接口实现国际化
weixin_43476824的博客
06-19 530
获取多语言配置文件配置属性
使用MessageSource 实现国际化 [i18n]
weixin_34378969的博客
02-23 345
2019独角兽企业重金招聘Python工程师标准>>> ...
SpringBoot实战：国际化组件MessageSource的执行逻辑与源码
沉潜飞动
08-07 2551
掌握 MessageSource 的原理，我们才能更好的扩展。
【最佳实践】配置类封装-国际化MessageSource
界王拳十倍
09-14 1339
注解的作用主要是控制是否使用CGLIB代理来代理@Bean方法。当设置为true时，被@Bean标识的方法会被 CGLIB 代理，同时也会遵循 Spring 容器的一些生命周期行为，比如和@Destroy。如果这些@Bean方法返回的是单例 Bean，那么在同一个配置类中多次调用这些方法，得到的都是同一个 Bean 实例，因为该 Bean 只会被初始化一次。当设置为false时，被@Bean标识的方法不会被拦截以进行 CGLIB 代理，也不会遵循 Spring 容器中的生命周期行为。
Spring（21）——国际化MessageSource
Elim的博客
09-08 6331
21 国际化MessageSourceSpring中定义了一个MessageSource接口，以用于支持信息的国际化和包含参数的信息的替换。MessageSource接口的定义如下，对应的方法说明已经在方法上注释了。public interface MessageSource { /** * 解析code对应的信息进行返回，如果对应的code不能被解析则返回默认信息defaultMessa
spring源码中英文注释
01-12
9. **国际化与本地化**：Spring提供了`MessageSource`接口来支持多语言环境。源码中会涉及资源文件的加载和消息的查找。 10. **SpEL（Spring Expression Language）**：Spring的表达式语言用于在运行时查询和操作...
SpringBoot 实战：国际化组件 MessageSource 的执行逻辑与源码
Q54665642ljf的博客
08-09 547
null) {= null) {}}}= null) {}}复制代码第一个getMessage方法，是可以传入默认值的，也就是当所有 basename 的配置文件中不存在 code 指定的值，就会使用值进行格式化返回。
spring boot 国际化MessageSource
weixin_30273175的博客
07-11 383
转自：https://blog.csdn.net/flowingflying/article/details/76358970 spring中ResourceBundleMessageSource的配置使用方法 https://blog.csdn.net/qq_31230529/article/details/48436873 一般性了解 我们在JSTL fmt[1]中已经接触过国际化i1...
spring boot国际化——MessageSource的使用
热门推荐
Tina的博客
05-14 3万+
修改properties文件的目录：在application.yml或者application.properties中配置 spring.message.basenamespring: application: name: test-worklog messages: basename: i18n/messages encoding:...
SpringIOC之support模块DefaultMessageSourceResolvable
qq_57756904的博客
01-04 1325
这个对象通常用于与 MessageSource 接口一起工作，以查找并返回国际化消息。通过提供消息代码、参数和默认消息，可以在不同的语言环境下获取适当的消息文本。
Spring消息代码理解
05-20 4068
一、简介 1、Spring消息体系的定义： ①消息取得接口：MessageSource、HierarchicalMessageSource ②消息参数接口：MessageSourceResolvable 2、Spring消息体系的实现： ①消息取得：AbstractMessageSource、ResourceBundleMessageSource、ReloadableReso
Spring MVC源码解析 - MessageSource、MessageSourceResolvable、DefaultMessageSourceResolvable
The Secret
01-09 3488
一. MessageSource /** * 解析消息的策略接口，支持于消息的参数话和国际化 * * Spring提供了两种开箱即用的实现类: * {@link org.springframework.context.support.ResourceBundleMessageSource}: * 建立在{@link java.util.ResourceBundle}上面, 共享...
SpringIOC之AbstractResourceBasedMessageSource
qq_57756904的博客
12-24 959
通过使用 AbstractResourceBasedMessageSource 或其具体的子类，您可以轻松实现消息的国际化和本地化，以根据用户的首选语言和区域提供不同的消息内容。这对于多语言应用程序非常有用。
餐饮管理系统源码：Spring国际化与本地化实践
Spring通过MessageSource接口和相关的实现类（如ReloadableResourceBundleMessageSource），支持了在Spring管理的应用中轻松实现国际化和本地化。Spring的这一特性，使得开发人员可以集中精力处理业务逻辑，而将国际...
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值