Spring Boot的国际化与本地化支持

什么是国际化与本地化

在当今全球化的时代，软件应用需要面向不同地区、不同语言的用户群体。国际化（Internationalization，通常简称为 i18n，因为 “Internationalization” 这个单词除去首末字母，中间有18个字母）是指设计和开发软件应用，使其能够适应不同语言、地区和文化的过程。本地化（Localization，简称为 l10n，原因同 i18n）则是将国际化的软件应用针对特定语言、地区和文化进行定制的过程。

在Java开发中，Spring Boot 为国际化和本地化提供了强大且便捷的支持。通过Spring Boot的相关特性，开发者可以轻松地为应用添加多语言支持，根据用户所在地区或语言偏好，动态地展示不同语言的界面和消息。

Spring Boot中的国际化配置

Spring Boot对国际化的支持主要基于Java标准的 ResourceBundle 机制。要开启国际化支持，首先需要在 src/main/resources 目录下创建 messages.properties 文件，这个文件将作为默认的消息资源文件。例如，如果应用需要支持英文和中文，还需要创建 messages_en.properties（英文）和 messages_zh.properties（中文）文件。

创建消息资源文件

默认消息资源文件（messages.properties） 在 messages.properties 文件中，可以定义一些通用的消息键值对，这些键值对会在没有匹配到特定语言的消息时作为备用。例如：

greeting=Hello, {0}!

这里的 {0} 是占位符，后续可以根据实际情况替换为具体的值。

英文消息资源文件（messages_en.properties）

greeting=Hello, {0}!

由于英文是默认语言的一种常见情况，这里可以与默认文件内容相同，当然也可以根据具体需求进行差异化定义。

中文消息资源文件（messages_zh.properties）

greeting=你好, {0}!

这样就定义了针对中文用户的问候语。

配置Spring Boot以使用国际化资源

在Spring Boot的 application.properties 文件中，需要进行一些配置来告诉Spring Boot如何加载和使用国际化资源。

spring.messages.basename=messages
spring.messages.encoding=UTF - 8

spring.messages.basename 指定了消息资源文件的基础名称，这里是 messages，Spring Boot会自动在 src/main/resources 目录下查找 messages.properties 及其语言特定的变体文件。spring.messages.encoding 设置了消息资源文件的编码为UTF - 8，以确保支持各种语言的字符。

在Controller中使用国际化消息

配置好国际化资源后，就可以在Spring Boot的Controller中使用这些消息了。Spring Boot提供了 MessageSource 接口来获取国际化消息。

注入MessageSource

首先，在Controller类中注入 MessageSource：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.Locale;

@RestController
public class GreetingController {

    @Autowired
    private MessageSource messageSource;

    @GetMapping("/greeting")
    public String greeting(@RequestParam(required = false, defaultValue = "World") String name,
                           Locale locale) {
        return messageSource.getMessage("greeting", new Object[]{name}, locale);
    }
}

在上述代码中，通过 @Autowired 注入了 MessageSource。在 greeting 方法中，@RequestParam 获取请求参数 name，默认值为 “World”。Locale 是Spring Boot自动解析的用户地区信息，它根据用户请求的语言环境来确定。

获取国际化消息

messageSource.getMessage("greeting", new Object[]{name}, locale) 方法用于获取国际化消息。第一个参数 “greeting” 是消息键，在之前定义的消息资源文件中可以找到对应的消息内容。第二个参数 new Object[]{name} 是用于替换消息中占位符 {0} 的实际值。第三个参数 locale 则决定了从哪个语言特定的消息资源文件中获取消息。

例如，如果用户请求的语言环境是英文（Locale.ENGLISH），则会从 messages_en.properties 中获取 “greeting” 对应的消息，并将 name 的值替换占位符，返回 “Hello, World!”。如果是中文环境（Locale.SIMPLIFIED_CHINESE），则会从 messages_zh.properties 中获取消息，返回 “你好, World!”。

前端国际化

Spring Boot应用的前端部分同样需要支持国际化。常见的前端框架如Thymeleaf、Vue.js等都有相应的国际化解决方案。以Thymeleaf为例，它与Spring Boot集成得非常好，能够方便地获取和显示国际化消息。

在Thymeleaf模板中使用国际化消息

引入Thymeleaf依赖 如果项目中还没有引入Thymeleaf，需要在 pom.xml 文件中添加依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

创建Thymeleaf模板文件 在 src/main/resources/templates 目录下创建 greeting.html 文件：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>国际化示例</title>
</head>
<body>
    <p th:text="#{greeting(${name})}">默认问候语</p>
</body>
</html>

在上述模板中，th:text="#{greeting(${name})}" 表示从国际化消息资源中获取键为 “greeting” 的消息，并将 name 的值作为参数传递给消息，用于替换占位符。

Controller与Thymeleaf模板结合

修改之前的 GreetingController，使其返回Thymeleaf视图：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Locale;

@Controller
public class GreetingController {

    @Autowired
    private MessageSource messageSource;

    @GetMapping("/greeting")
    public String greeting(@RequestParam(required = false, defaultValue = "World") String name,
                           Locale locale, Model model) {
        model.addAttribute("name", name);
        return "greeting";
    }
}

这里将 @RestController 改为 @Controller，并使用 Model 对象将 name 传递给Thymeleaf模板。当用户访问 /greeting 时，Thymeleaf会根据用户的语言环境，从国际化消息资源中获取相应的问候语并显示。

动态切换语言

在实际应用中，用户可能希望能够动态切换语言，而不是依赖于系统或浏览器默认的语言设置。Spring Boot提供了一些机制来实现这一功能。

创建语言切换的Controller

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Locale;

@Controller
public class LanguageController {

    @Autowired
    private MessageSource messageSource;

    @GetMapping("/switchLanguage")
    public String switchLanguage(@RequestParam String lang, Model model) {
        Locale locale = new Locale(lang);
        LocaleContextHolder.setLocale(locale);
        return "redirect:/greeting";
    }
}

在上述代码中，switchLanguage 方法接收一个 lang 参数，该参数表示用户想要切换到的语言代码（如 “en” 表示英文，“zh” 表示中文）。通过创建一个新的 Locale 对象，并使用 LocaleContextHolder.setLocale(locale) 方法来设置当前线程的语言环境。最后通过 redirect:/greeting 重定向到问候页面，这样页面就会根据新的语言环境显示相应的消息。

在前端添加语言切换链接

在 greeting.html 模板中添加语言切换链接：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>国际化示例</title>
</head>
<body>
    <p th:text="#{greeting(${name})}">默认问候语</p>
    <a href="/switchLanguage?lang=en">切换到英文</a>
    <a href="/switchLanguage?lang=zh">切换到中文</a>
</body>
</html>

这样用户在页面上点击相应的链接，就可以动态切换语言，实现本地化的定制需求。

处理日期和数字的本地化

除了文本消息的国际化，日期和数字的显示也需要根据用户的地区进行本地化。Spring Boot提供了方便的机制来处理这些情况。

日期的本地化

配置日期格式 在 application.properties 文件中配置日期格式：

spring.jackson.date - format=yyyy - MM - dd
spring.jackson.time - zone=GMT+8

这里设置了日期格式为 “yyyy - MM - dd”，时区为东八区。

在Controller中处理日期

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

import java.util.Date;
import java.util.Locale;

@Controller
public class DateController {

    @GetMapping("/date")
    public String date(Locale locale, Model model) {
        Date now = new Date();
        model.addAttribute("now", now);
        return "date";
    }
}

在上述代码中，获取当前日期并传递给Thymeleaf模板。

在Thymeleaf模板中显示本地化日期 在 src/main/resources/templates/date.html 文件中：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>本地化日期示例</title>
</head>
<body>
    <p>本地化日期: <span th:text="${#dates.format(now, 'default', locale)}"></span></p>
</body>
</html>

${#dates.format(now, 'default', locale)} 使用Thymeleaf的 dates 工具类，根据当前语言环境 locale 格式化日期。

数字的本地化

在Thymeleaf模板中显示本地化数字 在 src/main/resources/templates/number.html 文件中：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>本地化数字示例</title>
</head>
<body>
    <p>本地化数字: <span th:text="${#numbers.formatDecimal(12345.678, 1, 3, locale)}"></span></p>
</body>
</html>

${#numbers.formatDecimal(12345.678, 1, 3, locale)} 使用Thymeleaf的 numbers 工具类，根据当前语言环境 locale 格式化数字。第一个参数是要格式化的数字，第二个参数是最小整数位数，第三个参数是最大小数位数。

深入Spring Boot国际化原理

Spring Boot的国际化功能是基于Java的 ResourceBundle 机制。ResourceBundle 是Java提供的用于管理本地化资源的类。Spring Boot通过 MessageSource 接口来抽象对 ResourceBundle 的访问。

MessageSource接口

MessageSource 接口定义了获取国际化消息的方法。Spring Boot提供了多种实现类，其中最常用的是 ReloadableResourceBundleMessageSource。这个实现类支持热加载消息资源文件，即在应用运行过程中修改消息资源文件，不需要重启应用就可以生效。

消息查找过程

当调用 messageSource.getMessage 方法时，Spring Boot会按照以下顺序查找消息：

首先根据当前语言环境查找特定语言的消息资源文件（如 messages_en.properties）。
如果在特定语言的文件中没有找到，会查找默认的消息资源文件（messages.properties）。
如果在默认文件中也没有找到，并且设置了默认消息（messageSource.getMessage("greeting", new Object[]{name}, "Default Greeting", locale) 中的 “Default Greeting”），则返回默认消息。

本地化解析策略

Spring Boot使用 LocaleResolver 来解析用户的语言环境。默认情况下，Spring Boot使用 AcceptHeaderLocaleResolver，它根据HTTP请求头中的 Accept - Language 字段来解析用户的语言环境。如果需要自定义解析策略，可以实现 LocaleResolver 接口并注册到Spring容器中。例如，可以实现一个基于用户会话或数据库设置的语言环境解析器。

国际化与本地化的最佳实践

消息键的命名规范 消息键应该具有清晰的含义，并且尽量遵循一定的命名规范。例如，可以使用模块名 + 功能名 + 消息含义的方式命名，如 “user.login.success” 表示用户登录成功的消息。这样在维护大量消息资源文件时，更容易查找和管理。
测试国际化功能 在开发过程中，要对国际化功能进行充分的测试。可以编写单元测试来验证 MessageSource 获取消息的正确性，以及集成测试来验证前端页面根据不同语言环境显示正确的消息。同时，要测试日期和数字的本地化显示是否符合预期。
考虑性能 虽然 ReloadableResourceBundleMessageSource 支持热加载，但频繁读取文件会影响性能。在生产环境中，可以考虑适当调整加载频率，或者使用缓存机制来提高性能。例如，可以配置 ReloadableResourceBundleMessageSource 的 cacheSeconds 属性，设置消息资源文件的缓存时间。
多语言支持的扩展性 随着应用的发展，可能需要支持更多的语言。在设计消息资源文件结构和代码逻辑时，要考虑扩展性。例如，消息资源文件的命名和组织方式应该便于添加新的语言，并且代码中获取消息的逻辑应该通用，不依赖于特定的语言数量。

总结

Spring Boot为国际化和本地化提供了丰富且强大的支持，通过合理配置消息资源文件、使用 MessageSource 以及结合前端框架的国际化功能，可以轻松地为应用添加多语言支持，满足全球不同用户群体的需求。同时，深入理解其原理和遵循最佳实践，能够使应用在国际化方面更加健壮和高效。无论是简单的Web应用还是复杂的企业级系统，Spring Boot的国际化与本地化支持都能帮助开发者快速实现本地化定制，提升用户体验。