MessageSource学习

简介

MessageSource 是 Spring 框架中的一个接口，它负责提供对国际化（i18n）和本地化（l10n）消息的支持。MessageSource 接口定义了一组方法，允许应用程序根据指定的消息代码和参数来获取本地化的消息字符串。

MessageSource 接口的主要方法包括：

• getMessage(String code, Object[] args, String defaultMessage, Locale locale): 这是获取消息的主要方法。它接受一个消息代码（code），一组参数（args），一个默认消息（defaultMessage）以及一个地区信息（locale）。如果找到了与给定代码和地区信息匹配的本地化消息，它将返回该消息。如果没有找到匹配的本地化消息，它将返回默认消息。
• getMessage(MessageSourceResolvable resolvable, Locale locale): 这是一个更灵活的方法，它接受一个 MessageSourceResolvable 对象和一个地区信息作为参数。MessageSourceResolvable 允许你以更复杂的方式指定消息代码和参数。

在 Spring 中，你可以通过配置一个 MessageSource 的实现类（如 ReloadableResourceBundleMessageSource 或 StaticMessageSource）来提供消息源。这些实现类通常加载并缓存外部资源文件（如属性文件或 XML 文件），这些资源文件包含了不同语言环境下的消息定义。

源码

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;

}

示例

<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">  
    <property name="basenames">  
        <list>  
            <value>classpath:messages</value>  
            <value>classpath:messages_en</value>  
        </list>  
    </property>  
    <property name="defaultEncoding" value="UTF-8"/>  
</bean>

在这个例子中，ReloadableResourceBundleMessageSource 被配置为加载名为 messages 和 messages_en 的属性文件。这些文件应该位于类路径（classpath）下，并包含不同语言环境下的消息定义。

一旦你配置了一个 MessageSource，你就可以在你的应用程序中通过 MessageSource 的实例来获取本地化的消息。这通常在控制器、服务层或视图模板中完成，以便根据用户的地区偏好显示相应的消息。

实现类ResourceBundleMessageSource

简介

ResourceBundleMessageSource 是 Spring 框架中 MessageSource 接口的一个实现类。它用于从 Java 的 ResourceBundle 加载本地化消息。ResourceBundle 通常用于存储与特定区域设置（Locale）相关的键值对，这些键值对可以代表应用程序中的文本消息。

ResourceBundleMessageSource 会根据提供的区域设置（Locale）来查找适当的 ResourceBundle，并从中检索消息。如果没有找到与特定区域设置匹配的资源束，它会回退到默认的区域设置（通常是基础名称，没有区域设置后缀）。

以下是 ResourceBundleMessageSource 的一些关键特性：

• 基名（Basenames）: 你需要为 ResourceBundleMessageSource 提供基名，这通常是资源束的基础名称。例如，对于英语，你可能有一个名为 messages_en 的资源束，而对于中文，你可能有一个名为 messages_zh 的资源束。
• 默认编码（Default Encoding）: 你可以指定资源束的默认字符编码，以确保在读取资源文件时使用正确的编码。
• 缓存（Caching）: ResourceBundleMessageSource 默认会缓存加载的资源束，以提高性能。这意味着一旦资源束被加载，它就不会再次被加载，除非它被明确地刷新或重新加载。
• 使用回退（Fallback）: 如果没有找到与特定区域设置匹配的资源束，ResourceBundleMessageSource 可以配置为回退到默认的资源束或回退到父级区域设置。

示例

<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">  
    <property name="basenames">  
        <list>  
            <value>classpath:messages</value>  
        </list>  
    </property>  
    <property name="defaultEncoding" value="UTF-8"/>  
</bean>

在这个例子中，ResourceBundleMessageSource 被配置为从类路径下的 messages 资源束中加载消息。defaultEncoding 属性被设置为 UTF-8，以确保使用正确的字符编码读取资源文件。

@Autowired  
private MessageSource messageSource;  
  
public String getLocalizedMessage(String code, Locale locale) {  
    return messageSource.getMessage(code, null, locale);  
}

在这个例子中，getLocalizedMessage 方法使用 MessageSource 来获取与给定代码和区域设置匹配的本地化消息。

记住，ResourceBundleMessageSource 依赖于 Java 的标准 ResourceBundle 机制，这意味着你需要按照 Java 的 ResourceBundle 命名约定来命名和组织你的资源文件。例如，对于英语，你可能会有一个名为 messages_en.properties 的文件，而对于法语，你可能会有一个名为 messages_fr.properties 的文件。