使用 Spring Boot 实现国际化（i18n）模块

在现代应用程序中，支持多语言国际化（i18n）是非常重要的，特别是在全球化日益增强的今天。本文将指导你如何在 Spring Boot 应用中实现国际化模块。以下是整个流程的概述。

步骤 说明
步骤 1 创建 Spring Boot 项目
步骤 2 配置消息源
步骤 3 创建消息资源文件
步骤 4 使用国际化消息资源
步骤 5 测试国际化功能

步骤 1：创建 Spring Boot 项目

首先，使用 Spring Initializr 创建一个新项目。在你的浏览器中打开 [Spring Initializr]( Spring Web 和 Spring Boot DevTools，然后生成项目并下载。

步骤 2：配置消息源

在 application.properties 文件中配置消息源。我们需要指定默认语言和其他语言的配置。

# 设置默认语言为中文
spring.messages.basename=messages
spring.messages.cache-duration=3600
spring.messages.fallback-to-system-locale=false
  • spring.messages.basename：指定消息资源文件的基本名称。
  • spring.messages.cache-duration：消息的缓存持续时间。
  • spring.messages.fallback-to-system-locale：是否回退到系统本地化。

步骤 3：创建消息资源文件

在 src/main/resources 目录下创建一个名为 messages.properties 的文件，添加以下内容：

greeting=你好
farewell=再见

同时，为了支持英语，再创建一个 messages_en.properties 文件：

greeting=Hello
farewell=Goodbye

这些文件包含不同语言的文本内容。

步骤 4：使用国际化消息资源

接下来，我们将在控制器中使用国际化消息。创建一个 REST 控制器 GreetingController：

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.RequestHeader;
import org.springframework.web.bind.annotation.RestController;

import java.util.Locale;

@RestController
public class GreetingController {

    @Autowired
    private MessageSource messageSource;

    @GetMapping("/greet")
    public String greet(@RequestHeader(name = "Accept-Language", required = false) Locale locale) {
        // 使用消息源获取国际化消息
        String greeting = messageSource.getMessage("greeting", null, locale);
        return greeting;
    }
}
  • MessageSource：用于访问国际化资源文件。
  • @RequestHeader：注解用于获取请求头中的语言信息。

步骤 5：测试国际化功能

最后，你可以通过 Postman 或浏览器测试国际化功能。请求 URL 为：

  • 中文: http://localhost:8080/greet （默认）
  • 英文: http://localhost:8080/greet，同时在请求头中添加 Accept-Language: en。

序列图

sequenceDiagram
    participant Client
    participant Controller
    participant MessageSource

    Client->>Controller: GET /greet
    Controller->>MessageSource: 获取消息
    MessageSource-->>Controller: 返回消息
    Controller-->>Client: 返回 greeting

状态图

stateDiagram
    [*] --> 收到请求
    收到请求 --> 处理请求
    处理请求 --> 获取语言
    获取语言 --> 获取国际化消息
    获取国际化消息 --> 返回消息
    返回消息 --> [*]

结尾

至此，你已经成功在 Spring Boot 项目中实现了国际化模块。通过创建消息资源文件和使用 MessageSource，你可以轻松地为应用添加多语言支持。这不仅能增强用户体验，还能扩大你的应用覆盖面。希望这篇文章对你有帮助，加油！如果有任何问题，欢迎随时提问。