Spring Boot 国际化踩坑指南

小灰灰 2023-07-11 11:05 22阅读 0赞

国际化，也叫 i18n，为啥叫这个名字呢？因为国际化英文是 internationalization ，在 i 和 n 之间有 18 个字母，所以叫 i18n。我们的应用如果做了国际化就可以在不同的语言环境下，方便的进行切换，最常见的就是中文和英文之间的切换，国际化这个功能也是相当的常见。

在 Spring 中，就通过 AcceptHeaderLocaleResolver 对国际化提供了支持，开发者通过简单配置，就可以在项目中直接使用国际化功能了。

这一支持，在 Spring Boot 中得到进一步的简化，在 Spring Boot 中，我们也可以通过寥寥数行代码就能方便的实现国际化功能，接下来松哥就来和大家说一说 Spring Boot 中的国际化。

首先，需要给大家先说明一点，项目中的国际化我们往往需要多方面的支持，例如后端做国际化、前端页面也要做国际化，共同搭配，才能真正实现国际化的功能。本文我先来和各位小伙伴们介绍 Spring Boot 中的国际化，后面我们再来介绍 Vue 的国际化，最后，再把这两个结合应用到我们的 vhr 项目中，所以前后一共可能有三篇文章，本文是第一篇。

## 1.基本使用 ##

Spring Boot 和 Spring 一脉相承，对于国际化的支持，默认是通过 AcceptHeaderLocaleResolver 解析器来完成的，这个解析器，默认是通过请求头的 Accept-Language 字段来判断当前请求所属的环境的，进而给出合适的响应。

所以在 Spring Boot 中做国际化，这一块我们可以不用配置，直接就开搞。

首先创建一个普通的 Spring Boot 项目，添加 web 依赖即可。项目创建成功后，默认的国际化配置文件放在 resources 目录下，所以我们直接在该目录下创建四个测试文件，如下：

![format_png][]

*  我们的 message 文件是直接创建在 resources 目录下的，IDEA 在展示的时候，会多出一个 Resource Bundle，这个大家不用管，千万别手动去创建这个目录。
 *  messages.properties 这个是默认的配置，其他的则是不同语言环境下的配置，en\_US 是英语(美国)，zh\_CN 是中文简体，zh\_TW 是中文繁体（文末附录里边有一个完整的语言简称表格）。

四个文件创建好之后，第一个默认的我们可以先空着，另外三个分别填入以下内容：

messages\_zh\_CN.properties

user.name=江南一点雨

messages\_zh\_TW.properties

user.name=江南壹點雨

messages\_en\_US.properties

user.name=javaboy

配置完成后，我们就可以直接开始使用了。在需要使用值的地方，直接注入 MessageSource 实例即可。

> 在 Spring 中需要配置的 MessageSource 现在不用配置了，Spring Boot 会通过 `org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration` 自动帮我们配置一个 MessageSource 实例。

创建一个 HelloController ，内容如下：

@RestController
    public class HelloController { 
        @Autowired
        MessageSource messageSource;
        @GetMapping("/hello")
        public String hello() { 
            return messageSource.getMessage("user.name", null, LocaleContextHolder.getLocale());
        }
    }

在 HelloController 中我们可以直接注入 MessageSource 实例，然后调用该实例中的 getMessage 方法去获取变量的值，第一个参数是要获取变量的 key，第二个参数是如果 value 中有占位符，可以从这里传递参数进去，第三个参数传递一个 Locale 实例即可，这相当于当前的语言环境。

接下来我们就可以直接去调用这个接口了。

默认情况下，在接口调用时，通过请求头的 Accept-Language 来配置当前的环境，我这里通过 POSTMAN 来进行测试，结果如下：

![format_png 1][]

小伙伴们看到，我在请求头中设置了 Accept-Language 为 zh-CN，所以拿到的就是简体中文；如果我设置了 zh-TW，就会拿到繁体中文：

![format_png 2][]

是不是很 Easy？

## 2.自定义切换 ##

有的小伙伴觉得切换参数放在请求头里边好像不太方便，那么也可以自定义解析方式。例如参数可以当成普通参数放在地址栏上，通过如下配置可以实现我们的需求。

@Configuration
    public class WebConfig implements WebMvcConfigurer { 
        @Override
        public void addInterceptors(InterceptorRegistry registry) { 
            LocaleChangeInterceptor interceptor = new LocaleChangeInterceptor();
            interceptor.setParamName("lang");
            registry.addInterceptor(interceptor);
        }
        @Bean
        LocaleResolver localeResolver() { 
            SessionLocaleResolver localeResolver = new SessionLocaleResolver();
            localeResolver.setDefaultLocale(Locale.SIMPLIFIED_CHINESE);
            return localeResolver;
        }
    }

在这段配置中，我们首先提供了一个 SessionLocaleResolver 实例，这个实例会替换掉默认的 AcceptHeaderLocaleResolver，不同于 AcceptHeaderLocaleResolver 通过请求头来判断当前的环境信息，SessionLocaleResolver 将客户端的 Locale 保存到 HttpSession 对象中，并且可以进行修改（这意味着当前环境信息，前端给浏览器发送一次即可记住，只要 session 有效，浏览器就不必再次告诉服务端当前的环境信息）。

另外我们还配置了一个拦截器，这个拦截器会拦截请求中 key 为 lang 的参数（不配置的话是 locale），这个参数则指定了当前的环境信息。

好了，配置完成后，启动项目，访问方式如下：

![format_png 3][]

我们通过在请求中添加 lang 来指定当前环境信息。这个指定只需要一次即可，也就是说，在 session 不变的情况下，下次请求可以不必带上 lang 参数，服务端已经知道当前的环境信息了。

## 3.其他自定义 ##

默认情况下，我们的配置文件放在 resources 目录下，如果大家想自定义，也是可以的，例如定义在 resources/i18n 目录下：

![format_png 4][]

但是这种定义方式系统就不知道去哪里加载配置文件了，此时还需要 application.properties 中进行额外配置(注意这是一个相对路径)：

spring.messages.basename=i18n/messages

另外还有一些编码格式的配置等，内容如下：

spring.messages.cache-duration=3600
    spring.messages.encoding=UTF-8
    spring.messages.fallback-to-system-locale=true

spring.messages.cache-duration 表示 messages 文件的缓存失效时间，如果不配置则缓存一直有效。

spring.messages.fallback-to-system-locale 属性则略显神奇，网上竟然看不到一个明确的答案，后来翻了一会源码才看出端倪。

这个属性的作用在 `org.springframework.context.support.AbstractResourceBasedMessageSource#getDefaultLocale` 方法中生效：

protected Locale getDefaultLocale() { 
    	if (this.defaultLocale != null) { 
    		return this.defaultLocale;
    	}
    	if (this.fallbackToSystemLocale) { 
    		return Locale.getDefault();
    	}
    	return null;
    }

从这段代码可以看出，在找不到当前系统对应的资源文件时，如果该属性为 true，则会默认查找当前系统对应的资源文件，否则就返回 null，返回 null 之后，最终又会调用到系统默认的 messages.properties 文件。

## 4.附录 ##

搜刮了一个语言简称表，分享给各位小伙伴：

<table> 
 <thead> 
  <tr> 
   <th align="left">语言</th> 
   <th align="left">简称</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">简体中文(中国)</td> 
   <td align="left">zh_CN</td> 
  </tr> 
  <tr> 
   <td align="left">繁体中文(中国台湾)</td> 
   <td align="left">zh_TW</td> 
  </tr> 
  <tr> 
   <td align="left">繁体中文(中国香港)</td> 
   <td align="left">zh_HK</td> 
  </tr> 
  <tr> 
   <td align="left">英语(中国香港)</td> 
   <td align="left">en_HK</td> 
  </tr> 
  <tr> 
   <td align="left">英语(美国)</td> 
   <td align="left">en_US</td> 
  </tr> 
  <tr> 
   <td align="left">英语(英国)</td> 
   <td align="left">en_GB</td> 
  </tr> 
  <tr> 
   <td align="left">英语(全球)</td> 
   <td align="left">en_WW</td> 
  </tr> 
  <tr> 
   <td align="left">英语(加拿大)</td> 
   <td align="left">en_CA</td> 
  </tr> 
  <tr> 
   <td align="left">英语(澳大利亚)</td> 
   <td align="left">en_AU</td> 
  </tr> 
  <tr> 
   <td align="left">英语(爱尔兰)</td> 
   <td align="left">en_IE</td> 
  </tr> 
  <tr> 
   <td align="left">英语(芬兰)</td> 
   <td align="left">en_FI</td> 
  </tr> 
  <tr> 
   <td align="left">芬兰语(芬兰)</td> 
   <td align="left">fi_FI</td> 
  </tr> 
  <tr> 
   <td align="left">英语(丹麦)</td> 
   <td align="left">en_DK</td> 
  </tr> 
  <tr> 
   <td align="left">丹麦语(丹麦)</td> 
   <td align="left">da_DK</td> 
  </tr> 
  <tr> 
   <td align="left">英语(以色列)</td> 
   <td align="left">en_IL</td> 
  </tr> 
  <tr> 
   <td align="left">希伯来语(以色列)</td> 
   <td align="left">he_IL</td> 
  </tr> 
  <tr> 
   <td align="left">英语(南非)</td> 
   <td align="left">en_ZA</td> 
  </tr> 
  <tr> 
   <td align="left">英语(印度)</td> 
   <td align="left">en_IN</td> 
  </tr> 
  <tr> 
   <td align="left">英语(挪威)</td> 
   <td align="left">en_NO</td> 
  </tr> 
  <tr> 
   <td align="left">英语(新加坡)</td> 
   <td align="left">en_SG</td> 
  </tr> 
  <tr> 
   <td align="left">英语(新西兰)</td> 
   <td align="left">en_NZ</td> 
  </tr> 
  <tr> 
   <td align="left">英语(印度尼西亚)</td> 
   <td align="left">en_ID</td> 
  </tr> 
  <tr> 
   <td align="left">英语(菲律宾)</td> 
   <td align="left">en_PH</td> 
  </tr> 
  <tr> 
   <td align="left">英语(泰国)</td> 
   <td align="left">en_TH</td> 
  </tr> 
  <tr> 
   <td align="left">英语(马来西亚)</td> 
   <td align="left">en_MY</td> 
  </tr> 
  <tr> 
   <td align="left">英语(阿拉伯)</td> 
   <td align="left">en_XA</td> 
  </tr> 
  <tr> 
   <td align="left">韩文(韩国)</td> 
   <td align="left">ko_KR</td> 
  </tr> 
  <tr> 
   <td align="left">日语(日本)</td> 
   <td align="left">ja_JP</td> 
  </tr> 
  <tr> 
   <td align="left">荷兰语(荷兰)</td> 
   <td align="left">nl_NL</td> 
  </tr> 
  <tr> 
   <td align="left">荷兰语(比利时)</td> 
   <td align="left">nl_BE</td> 
  </tr> 
  <tr> 
   <td align="left">葡萄牙语(葡萄牙)</td> 
   <td align="left">pt_PT</td> 
  </tr> 
  <tr> 
   <td align="left">葡萄牙语(巴西)</td> 
   <td align="left">pt_BR</td> 
  </tr> 
  <tr> 
   <td align="left">法语(法国)</td> 
   <td align="left">fr_FR</td> 
  </tr> 
  <tr> 
   <td align="left">法语(卢森堡)</td> 
   <td align="left">fr_LU</td> 
  </tr> 
  <tr> 
   <td align="left">法语(瑞士)</td> 
   <td align="left">fr_CH</td> 
  </tr> 
  <tr> 
   <td align="left">法语(比利时)</td> 
   <td align="left">fr_BE</td> 
  </tr> 
  <tr> 
   <td align="left">法语(加拿大)</td> 
   <td align="left">fr_CA</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(拉丁美洲)</td> 
   <td align="left">es_LA</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(西班牙)</td> 
   <td align="left">es_ES</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(阿根廷)</td> 
   <td align="left">es_AR</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(美国)</td> 
   <td align="left">es_US</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(墨西哥)</td> 
   <td align="left">es_MX</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(哥伦比亚)</td> 
   <td align="left">es_CO</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(波多黎各)</td> 
   <td align="left">es_PR</td> 
  </tr> 
  <tr> 
   <td align="left">德语(德国)</td> 
   <td align="left">de_DE</td> 
  </tr> 
  <tr> 
   <td align="left">德语(奥地利)</td> 
   <td align="left">de_AT</td> 
  </tr> 
  <tr> 
   <td align="left">德语(瑞士)</td> 
   <td align="left">de_CH</td> 
  </tr> 
  <tr> 
   <td align="left">俄语(俄罗斯)</td> 
   <td align="left">ru_RU</td> 
  </tr> 
  <tr> 
   <td align="left">意大利语(意大利)</td> 
   <td align="left">it_IT</td> 
  </tr> 
  <tr> 
   <td align="left">希腊语(希腊)</td> 
   <td align="left">el_GR</td> 
  </tr> 
  <tr> 
   <td align="left">挪威语(挪威)</td> 
   <td align="left">no_NO</td> 
  </tr> 
  <tr> 
   <td align="left">匈牙利语(匈牙利)</td> 
   <td align="left">hu_HU</td> 
  </tr> 
  <tr> 
   <td align="left">土耳其语(土耳其)</td> 
   <td align="left">tr_TR</td> 
  </tr> 
  <tr> 
   <td align="left">捷克语(捷克共和国)</td> 
   <td align="left">cs_CZ</td> 
  </tr> 
  <tr> 
   <td align="left">斯洛文尼亚语</td> 
   <td align="left">sl_SL</td> 
  </tr> 
  <tr> 
   <td align="left">波兰语(波兰)</td> 
   <td align="left">pl_PL</td> 
  </tr> 
  <tr> 
   <td align="left">瑞典语(瑞典)</td> 
   <td align="left">sv_SE</td> 
  </tr> 
  <tr> 
   <td align="left">西班牙语(智利)</td> 
   <td align="left">es_CL</td> 
  </tr> 
 </tbody> 
</table>

[format_png]: https://imgconvert.csdnimg.cn/aHR0cDovL2ltZy5pdGJveWh1Yi5jb20vMjAyMC8wMy9pMThuLTEucG5n?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cDovL2ltZy5pdGJveWh1Yi5jb20vMjAyMC8wMy9pMThuLTIucG5n?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cDovL2ltZy5pdGJveWh1Yi5jb20vMjAyMC8wMy9pMThuLTMucG5n?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cDovL2ltZy5pdGJveWh1Yi5jb20vMjAyMC8wMy9pMThuLTQucG5n?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cDovL2ltZy5pdGJveWh1Yi5jb20vMjAyMC8wMy9pMThuLTUucG5n?x-oss-process=image/format,png