58.2 Spring Boot国际化（i18n）

原创

悟空学院 2021-07-13 15:02:36 ©著作权

文章标签 SpringBoot 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者悟空学院的原创作品，请联系作者获取转载授权，否则将追究法律责任

(6)修改默认messages配置前缀；

我们在上面说了，默认的文件名称前缀是messages_xx.properties，那么如何修改这个名称和路径呢？

这个也很简单，只需要修改application.properties文件即可加入如下配置：

########################################################

### i18n setting.

########################################################

#指定message的basename，多个以逗号分隔，如果不加包名的话，默认从classpath路径开始，默认: messages

spring.messages.basename=i18n/messages

#设定加载的资源文件缓存失效时间，-1的话为永不过期，默认为-1

spring.messages.cache-seconds= 3600

#设定Message bundles的编码，默认: UTF-8

#spring.messages.encoding=UTF-8

上面各个参数都注释很清楚了，这里不多说了，那么我们这里是把文件放到了i18n下，那么我们在resources下新建目录i18n，然后复制我们创建的messages_xxx.properties文件到此目录下。为了区分这是读取了新的文件，我们可以在每个文件中—i18n以进行区分。

重新访问http://127.0.0.1:8080/hello 可以看到最新的效果了。

英文：

welcome to login to alibabawebsite(English-en)--i18n

中文：

欢迎你登录到阿里巴巴网站（中文）--i18n

(7) 代码中如何获取国际化信息；

以上讲的是在模板文件进行国际化，那么在代码中如何获取到welcome呢，这个比较简单，只要在需要的地方注入类：

@Autowired

privateMessageSource messageSource;

需要注意的是messageSource是

org.springframework.context.MessageSource

下的类。

那么怎么使用了，在使用前我们需要先知道一个知识点，如何得到当前请求的Locale

那么怎么获取呢，有两种获取方式：

第一种方式是：

Locale locale = LocaleContextHolder.getLocale();

第二种方式是：

Localelocale1= RequestContextUtils.getLocale(request);

个人喜好第一种方式，因为不需要什么参数就可以获取到，第二种方式依赖于当前的request请求对象。

有了当前请求的Locale剩下的就简单了：

String msg = messageSource.getMessage("welcome", null,locale);

Stringmsg2= messageSource.getMessage("welcome", null,locale1);

通过以上代码的其中一种方式就可以获取到messages_xxx.properties文件配置的welcome属性值了。切换区域获取的信息也是不一样的，打印信息如下：

msg=欢迎你登录到阿里巴巴网站（中文）--i18n

msg2欢迎你登录到阿里巴巴网站（中文）--i18n

msg=welcome to login to alibabawebsite(English-en)--i18n

msg2welcometo login to alibaba website(English-en)--i18n

(8) 优化代码获取国际化信息；

学习是永无止境的，活到老学到老。查看上面的代码你会发现这个是实际中使用起来的时候还是不是很方面，ok,没有关系，这个小节我们就对上面的代码优化下，

自定义我们自己的MessageSource，具体代码如下：

package com.kfit.base.service;

import java.util.Locale;

importjavax.annotation.Resource;

importorg.springframework.context.MessageSource;

importorg.springframework.context.i18n.LocaleContextHolder;

importorg.springframework.stereotype.Component;

/**

* 国际化工具类

* @author Angel --守护天使

* @version v.0.1

* @date 2016年8月5日下午2:44:03

@Component

publicclassLocaleMessageSourceService {

@Resource

private MessageSource messageSource;

/**

* @param code ：对应messages配置的key.

* @return

public StringgetMessage(String code){

returnthis.getMessage(code,new Object[]{});

}

public StringgetMessage(String code,String defaultMessage){

returnthis.getMessage(code, null,defaultMessage);

}

public StringgetMessage(String code,String defaultMessage,Locale locale){

returnthis.getMessage(code, null,defaultMessage,locale);

}

public StringgetMessage(String code,Locale locale){

returnthis.getMessage(code,null,"",locale);

}

/**

* @param code ：对应messages配置的key.

* @param args : 数组参数.

* @return

public StringgetMessage(String code,Object[] args){

returnthis.getMessage(code, args,"");

}

public StringgetMessage(String code,Object[] args,Locale locale){

returnthis.getMessage(code, args,"",locale);

}

/**

* @param code ：对应messages配置的key.

* @param args : 数组参数.

* @param defaultMessage : 没有设置key的时候的默认值.

* @return

public StringgetMessage(String code,Object[] args,String defaultMessage){

//这里使用比较方便的方法，不依赖request.

Locale locale =LocaleContextHolder.getLocale();

returnthis.getMessage(code, args, defaultMessage, locale);

}

/**

* 指定语言.

* @param code

* @param args

* @param defaultMessage

* @param locale

* @return

public StringgetMessage(String code,Object[]args,String defaultMessage,Locale locale){

returnmessageSource.getMessage(code, args, defaultMessage,locale);

}

在这个代码中我封装了3个常用的方法，那么应该怎么调用呢？也很简单，在需要的地方使用如下代码进行注入：

@Resource

privateLocaleMessageSourceService localeMessageSourceService;

在需要的地方使用如下代码进行调用：

Stringmsg3 = localeMessageSourceService.getMessage("welcome");

这个代码比之前的代码使用起来爽多了，还有很多神妙之处，大家自己发现吧。

(9) 区域解析器之AcceptHeaderLocaleResolver；

看到上面，大家会认为国际化也就到此了，但是我告诉大家这之后才是spring的强大之处呢，考虑的多么周到呢。

我们在之前说过，我们只所以可以看到国际化的效果是因为有一个区域解析器在进行处理。默认的区域解析器就是AcceptHeaderLocaleResolver。我们简单说明这个解析器：

Spring采用的默认区域解析器是AcceptHeaderLocaleResolver。它通过检验HTTP请求的accept-language头部来解析区域。这个头部是由用户的web浏览器根据底层操作系统的区域设置进行设定。请注意，这个区域解析器无法改变用户的区域，因为它无法修改用户操作系统的区域设置。

好了，这个默认的介绍到这里，因为这个我们无法改变，所以这种默认的设置在实际中使用的比较少。所以你如果看到当前还无法满足的需求的话，那么接着往下看，博主已经帮你都想到了。

(10) 会话区域解析器之SessionLocaleResolver；

会话区域解析器也就是说，你设置完只针对当前的会话有效，session失效，还原为默认状态。那么这个具体怎么操作呢？具体操作起来也是很简单的，我们需要在我们的启动类App.java（按你的实际情况进行修改）配置区域解析器为SessionLocaleResolver，具体代码如下：

@Bean

public LocaleResolverlocaleResolver() {

SessionLocaleResolver slr = new SessionLocaleResolver();

//设置默认区域,

slr.setDefaultLocale(Locale.CHINA);

returnslr;

}

其实到这里我们就完事了，你可以通过setDefaultLocale()设置默认的语言，启动就访问http://127.0.0.1:8080/hello 进行查看，是不是已经实现国际化了。

到这里当然还不是很完美，还需要在进一步的优化了，那么怎么在页面中进行切换呢？那么假设页面上有两个按钮【切换为中文】、【切换为英文】就可以进行切换了。接下来一起来实现下：在hello.html添加如下代码：

<button>切换为中文</button>

</form>

<button>切换为英文</button>

</form>

这里就是两个表单，切换语言，那么/changeSessionLanauage怎么编写呢，看如下代码：

@RequestMapping("/changeSessionLanauage")

public StringchangeSessionLanauage(HttpServletRequest request,String lang){

System.out.println(lang);

if("zh".equals(lang)){

//代码中即可通过以下方法进行语言设置

request.getSession().setAttribute(SessionLocaleResolver.LOCALE_SESSION_ATTRIBUTE_NAME, new Locale("zh", "CN"));

}elseif("en".equals(lang)){

//代码中即可通过以下方法进行语言设置

request.getSession().setAttribute(SessionLocaleResolver.LOCALE_SESSION_ATTRIBUTE_NAME, new Locale("en", "US"));

}

return"redirect:/hello";

}

这部分代码最核心的部分就是如何设置会话的区域，也就是如下代码：

request.getSession().setAttribute(SessionLocaleResolver.LOCALE_SESSION_ATTRIBUTE_NAME, new Locale("en", "US"));

这个代码就可以把当前会话的区域进行切换了，是不是很简单。以上代码你会发现只针对会话的设置，我们在这里在优化下，针对下面讲的Cookie也会作用到，这样这个代码就很智能了，代码修改为如下：

@RequestMapping("/changeSessionLanauage")

public StringchangeSessionLanauage(HttpServletRequest request,HttpServletResponse response,String lang){

System.out.println(lang);

LocaleResolver localeResolver =RequestContextUtils.getLocaleResolver(request);

if("zh".equals(lang)){

localeResolver.setLocale(request, response, new Locale("zh", "CN"));

}elseif("en".equals(lang)){

localeResolver.setLocale(request, response, new Locale("en", "US"));

}

return"redirect:/hello";

}

在这里使用:

LocaleResolverlocaleResolver = RequestContextUtils.getLocaleResolver(request);

获取当前使用的区域解析器LocaleResolver 调用里面的方法

setLocale设置即可，这样的代码就是不管是会话还是cookie区域解析器都是一样的代码了。

(11)Cookie区域解析器之CookieLocaleResolver；

Cookie区域解析器也就是说，你设置完针对cookie生效，session失效。那么这个具体怎么操作呢？我们需要在我们的启动类App.java（按你的实际情况进行修改）配置区域解析器为CookieLocaleResolver（SessionLocaleResolver部分请注释掉），具体代码如下：

@Bean

public LocaleResolverlocaleResolver() {

CookieLocaleResolverslr = newCookieLocaleResolver();

//设置默认区域,

slr.setDefaultLocale(Locale.CHINA);

slr.setCookieMaxAge(3600);//设置cookie有效期.

returnslr;

}

其实到这里我们就完事了，你可以通过setDefaultLocale()设置默认的语言，启动就访问http://127.0.0.1:8080/hello 进行查看，是不是已经实现国际化了。

到这里当然还不是很完美，还需要在进一步的优化了，那么怎么在页面中进行切换呢？

这里主要是用到了，这个部分我们在(10)中已经进行配置了，所以到这里已近是可以进行使用了，点击页面中的按钮进行体验。

(12)固定的区域解析器之FixedLocaleResolver ；

一直使用固定的Local, 改变Local 是不支持的。既然无法改变，那么不…好了，还是简单介绍下如何使用吧，还是在App.java进行编码：

/**

* cookie区域解析器;

* @return

@Bean

public LocaleResolverlocaleResolver() {

FixedLocaleResolver slr = newFixedLocaleResolver ();

//设置默认区域,

slr.setDefaultLocale(Locale.US);

returnslr;

}

好了，这个就这么简单，没有别的知识了。

(13)使用参数修改用户的区域；

除了显式调用LocaleResolver.setLocale()来修改用户的区域之外，还可以将LocaleChangeInterceptor拦截器应用到处理程序映射中，它会发现当前HTTP请求中出现的特殊参数。其中的参数名称可以通过拦截器的paramName属性进行自定义。如果这种参数出现在当前请求中，拦截器就会根据参数值来改变用户的区域。

只需要在App.java中加入：

@Bean

public LocaleChangeInterceptor localeChangeInterceptor() {

LocaleChangeInterceptor lci = newLocaleChangeInterceptor();

// 设置请求地址的参数,默认为：locale

// lci.setParamName(LocaleChangeInterceptor.DEFAULT_PARAM_NAME);

returnlci;

}

@Override

publicvoid addInterceptors(InterceptorRegistry registry) {

registry.addInterceptor(localeChangeInterceptor());

}