25. 如何在Spring Boot中实现国际化？`MessageSource`如何配置和使用？

PangHu大约 4 分钟

在Spring Boot中，实现国际化（i18n）可以使应用程序支持多语言，提供更好的用户体验。Spring Boot提供了简单且灵活的国际化支持，主要通过MessageSource来加载国际化资源文件，并在应用程序中使用这些资源文件进行语言切换。下面详细介绍如何配置和使用国际化功能。

1. 配置国际化资源文件

1.1 创建国际化资源文件

首先，需要在src/main/resources目录下创建国际化资源文件。这些文件通常以messages开头，后缀根据语言和地区命名。例如：

messages.properties（默认文件）
messages_en.properties（英文）
messages_fr.properties（法语）
messages_zh_CN.properties（简体中文）

每个文件包含键值对，其中键是国际化资源的标识符，值是该语言对应的翻译文本。

示例：messages.properties（默认）

greeting=Hello
farewell=Goodbye

示例：messages_zh_CN.properties（中文）

greeting=你好
farewell=再见

2. 配置`MessageSource`

MessageSource是Spring用于加载国际化资源文件的接口。Spring Boot会自动配置一个MessageSource Bean，但你可以通过在配置类中自定义MessageSource来调整加载方式。

2.1 自定义`MessageSource`

在Spring Boot应用中，你可以在配置类中配置MessageSource。

import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;

@Configuration
public class InternationalizationConfig {

    @Bean
    public MessageSource messageSource() {
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        messageSource.setBasename("classpath:messages");
        messageSource.setDefaultEncoding("UTF-8");
        messageSource.setCacheSeconds(3600); // 缓存时间，以秒为单位
        return messageSource;
    }
}

setBasename：设置基础名，即资源文件的路径和前缀名。例如classpath:messages表示资源文件名以messages开头。
setDefaultEncoding：设置文件的编码，通常使用UTF-8。
setCacheSeconds：设置缓存时间，默认是无限缓存，如果设置为0表示不缓存，文件会实时重新加载。

3. 使用国际化资源

3.1 在Controller中使用

在Spring MVC的控制器中，可以通过注入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.RequestHeader;
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 getGreeting(@RequestParam(name = "lang", required = false) String lang) {
        Locale locale = lang != null ? new Locale(lang) : Locale.getDefault();
        return messageSource.getMessage("greeting", null, locale);
    }
}

在这个示例中，根据请求参数lang的值来选择语言环境，并返回对应语言的greeting消息。

3.2 在Thymeleaf模板中使用

如果使用Thymeleaf作为模板引擎，可以直接在模板中使用国际化消息。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Internationalization Example</title>
</head>
<body>
    <h1 th:text="#{greeting}">Hello</h1>
    <p th:text="#{farewell}">Goodbye</p>
</body>
</html>

在这个示例中，#{greeting}和#{farewell}会被替换为当前语言环境对应的消息。

4. 自动检测客户端语言

Spring Boot支持根据请求头中的Accept-Language自动选择语言。可以通过配置LocaleResolver来实现这一点。

4.1 配置`LocaleResolver`

在配置类中配置LocaleResolver，使应用能够自动根据客户端语言设置Locale。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver;

import javax.servlet.http.HttpServletRequest;
import java.util.Locale;

@Configuration
public class LocaleConfig extends AcceptHeaderLocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        String headerLang = request.getHeader("Accept-Language");
        return headerLang == null || headerLang.isEmpty()
                ? Locale.getDefault()
                : Locale.forLanguageTag(headerLang);
    }

    @Bean
    public LocaleResolver localeResolver() {
        return new AcceptHeaderLocaleResolver();
    }
}

AcceptHeaderLocaleResolver会根据Accept-Language请求头来决定使用哪种语言。

5. 更改语言环境

可以通过自定义LocaleChangeInterceptor来允许在请求中通过参数更改语言环境。

5.1 配置`LocaleChangeInterceptor`

配置一个拦截器，允许通过请求参数（例如lang）来改变语言环境。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Bean
    public LocaleChangeInterceptor localeChangeInterceptor() {
        LocaleChangeInterceptor interceptor = new LocaleChangeInterceptor();
        interceptor.setParamName("lang");
        return interceptor;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(localeChangeInterceptor());
    }
}

通过这个配置，客户端可以通过添加?lang=zh_CN或?lang=en等参数来切换语言。

6. 总结

在Spring Boot中，实现国际化（i18n）相对简单，主要步骤包括：

创建国际化资源文件：如messages.properties、messages_zh_CN.properties等。
配置MessageSource：通过配置类自定义MessageSource加载资源文件。
使用国际化资源：在控制器或Thymeleaf模板中使用MessageSource或消息代码。
自动检测和切换语言：通过配置LocaleResolver和LocaleChangeInterceptor来支持自动检测客户端语言和手动切换语言。

通过这些配置，Spring Boot应用可以轻松地支持多语言，提升用户的使用体验。