聊聊国际化MessageSource

前言

Spring对国际化这一块支持还是蛮友好的,上手也是蛮简单,但是加载流程还是需要大家掌握的,不然会少定义一个资源文件会让你莫名其妙的出现一些bug。接下来主要分享一下关于这一块的基本知识。


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;

}

顶层接口一共提供了三个获取信息的方法:

  • 提供默认值defaultMessage参数,当根据code无法从相应的ResourceBundle中查询出数据时,会将defaultMessage的值返回。
  • 当根据code无法从相应的ResourceBundle中查询出数据时,直接抛出NoSuchMessageException异常。
  • 通过自定义MessageSourceResolvable解析器去获取信息,MessageSourceResolvable也就是封装了code,args,defaultMessage三个参数,用法上并没有什么不同。只不过code参数为String[]数组形式,通过遍历调用的方式去获取信息,只要其中一个code能够获取到值,便直接返回。查询不出数据时且defaultMessage为空时,直接抛出NoSuchMessageException异常。

在获取对应信息时,里面还有些许流程,我下面将会结合例子来进行说明,得先熟悉下该接口的主要实现类。

从类图结构中可以看出,顶层接口MessageSource下面有个抽象类AbstractMessageSource,三个基本实现类ResourceBundleMessageSource,ReloadableResourceBundleMessageSource,StaticMessageSource

  • ResourceBundleMessageSource:支持对.properties的解析,解析完成后也是用map进行封装,最后数据存储在PropertyResourceBundle的成员变量private Map<String,Object> lookup;中。
  • ReloadableResourceBundleMessageSource:可以解析.properties.xml文件,解析完成利用PropertiesHolder进行封装,底层还是Properties结构。
  • StaticMessageSource:这个相对来说最容易理解,内部就是直接用map封装了咱们需要的信息。

以上三个实现类均可以对返回信息做格式化处理。

下面我将拿ResourceBundleMessageSource这个类进行分析,先对其几个属性值进行分析一下:

  • alwaysUseMessageFormat:默认值为false,即默认不对返回信息做格式化处理。
  • useCodeAsDefaultMessage:默认值为false,设置成true时,当无法通过code参数返回信息时,会默认将code的值进行返回。
  • fallbackToSystemLocale:默认值为true,当根据codelocale参数无法获取对应的ResourceBundle时,会根据当前的环境设置获取defaultLocale,然后获取对应的ResourceBundle

注入spring容器:

可以选择配置文件或者注解的方式进行配置到spring容器中,例如下方的注解方式:

@Bean
MessageSource messageSource() {
    ResourceBundleMessageSource resourceBundleMessageSource = new ResourceBundleMessageSource();
    resourceBundleMessageSource.setBasename("exception");
    resourceBundleMessageSource.setDefaultEncoding("UTF-8");
    return resourceBundleMessageSource;
}

而spring 容器在初始化时,会在refresh方法中调用initMessageSource方法:

protected void initMessageSource() {
    ConfigurableListableBeanFactory beanFactory = getBeanFactory();
    if (beanFactory.containsLocalBean(MESSAGE_SOURCE_BEAN_NAME)) {
        //从容器中获取name为 "messageSource",类型为MessageSource的bean
        this.messageSource = beanFactory.getBean(MESSAGE_SOURCE_BEAN_NAME, MessageSource.class);
        if (this.parent != null && this.messageSource instanceof HierarchicalMessageSource) {
            HierarchicalMessageSource hms = (HierarchicalMessageSource) this.messageSource;
            if (hms.getParentMessageSource() == null) {
                hms.setParentMessageSource(getInternalParentMessageSource());
            }
        }
        if (logger.isTraceEnabled()) {
            logger.trace("Using MessageSource [" + this.messageSource + "]");
        }
    }
    else {
        DelegatingMessageSource dms = new DelegatingMessageSource();
        dms.setParentMessageSource(getInternalParentMessageSource());
        this.messageSource = dms;
        beanFactory.registerSingleton(MESSAGE_SOURCE_BEAN_NAME, this.messageSource);
        if (logger.isTraceEnabled()) {
            logger.trace("No '" + MESSAGE_SOURCE_BEAN_NAME + "' bean, using [" + this.messageSource + "]");
        }
    }
}

上面这段代码逻辑很清晰,先判断当前是否有该bean的BeanDefinition,若存在,则对MessageSource进行初始化并赋值给其成员变量messageSource。如果不存在该bean的BeanDefinition,则赋值一个空的MessageSource,也就是DelegatingMessageSource,以便能够正常的进行getMessage方法的调用。


具体使用:

有以下两种方式可以获取到容器中的MessageResource:

//方式一:  
@Autowired
private MessageSource messageSource;

//方式二:
@Component
public class MessageResourceConfiguration implements MessageSourceAware {

    private MessageSource messageSource;

    @Override
    public void setMessageSource(MessageSource messageSource) {
        this.messageSource = messageSource;
    }
}

PS:其实用ApplicationContext也可以,ApplicationContext实现了MessageSource接口,并且在refresh方法中也对messageSource进行了注入,不熟悉的可以回顾下上面的注入spring容器环节。

使用案例:

如下图所示先定义好这三个配置文件(文件名需要和上面定义MessageSource的baseName属性值一致):

exception.properties我们称之为基类文件,它可以作为exception_en.propertiesexception_zh.properties两种配置文件的父类,联想一下spring的子父容器的概率,相信不难理解。

1.String app = messageSource.getMessage("0000", null, Locale.ENGLISH); //en_exception
2.String app = messageSource.getMessage("0001", null, Locale.ENGLISH); //base_exception
3.String app = messageSource.getMessage("0000", null, Locale.CHINESE); //zh_exception
4.String app = messageSource.getMessage("0000", null, Locale.JAPAN);   //zh_exception

分别执行这四句代码,出现这个四个结果:

  1. 能够从exception_en.properties中获取”0000“对应的值:en_exception。
  2. 无法从exception_en.properties中获取”0001“对应的值,在其父类exception.properties中获取对应的值:base_exception。
  3. 能够从exception_zh.properties中获取”0000“对应的值:zh_exception。
  4. 无法获取Locale.JAPAN对应的ResourceBundle,但由于fallbackToSystemLocale值默认是true,所以会根据环境设置获取defaultLocale,然后获取对应的ResourceBundle。当前环境通过System.getProperty("user.language")去获取,目前是该值是zh,所以会从exception_zh.properties中获取”0000“对应的值:zh_exception。

假设在注入bean时将fallbackToSystemLocale改成false:

运行上面的代码,会发现前面三个结果一致,但是最后一个结果有些许变化:

String app = messageSource.getMessage("0000", null, Locale.JAPAN);   //exception

由于没有匹配到对应国家的ResourceBundle,直接从基类文件中获取结果。其实这里直接将exception_zh.properties配置文件移除也会获取相同的结果,都会从基类文件中获取。

假设在注入bean时将useCodeAsDefaultMessage改成true:

运行代码:

String app = messageSource.getMessage("0003", null, Locale.CHINESE); //0003

返回结果为“0003”,正是查询时用的code参数。“0003”不存在于咱们的exception_zh.propertiesexception.properties文件对应的ResourceBundle中,所以直接将code作为默认结果进行返回了。


总结:

对上面的基本流程进行简单的总结,可以分为三步:

  1. 检测是否有对应locale的配置,有的话则从当前locale配置中读取信息,并且可以追踪到基类文件中。
  2. 若没有对应locale的配置,如果fallbackToSystemLocaletrue,则获取默认defaultLocale的配置,并且可以追踪到基类文件中。
  3. 如果fallbackToSystemLocalefalse,则直接到基类文件中获取信息。

目前只是接触到根据不同的国家响应不同的异常状态码,后面会对页面这一块的国际化进行分享一下,SpringMVC也提供有对国际化这一块的支持。测试案例均在github中。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容