代码人生|在Spring Boot中的实现国际化（i18n）

1.什么是国际化（i18n）？

国际化（Internationalization，简称i18n）是指在软件应用中支持多种语言和文化的能力。通过国际化，应用可以根据用户的语言和地区设置，动态地显示不同的文本内容。本文将介绍如何在Spring Boot应用中实现国际化，并提供完整的代码示例。

2.代码工程

在Spring Boot中实现国际化（i18n）可以通过以下步骤完成。我们将使用Spring的消息源（MessageSource）功能来支持多语言文本。

步骤 1: 创建项目

首先，创建一个新的Spring Boot项目。可以使用Spring Initializr（start.spring.io/）来生成项目，选择以下…

Spring Web

Spring Boot DevTools（可选，用于热重载）

springboot-demo com.et 1.0-SNAPSHOT 4.0.0


xml
 代码解读
复制代码
<artifactId>i18nartifactId>

<properties>
    <maven.compiler.source>8maven.compiler.source>
    <maven.compiler.target>8maven.compiler.target>
properties>
<dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>

    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-autoconfigureartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-testartifactId>
        <scope>testscope>
    dependency>
dependencies>

步骤 2: 创建国际化资源文件

在src/main/resources目录下，创建一个名为messages的文件夹，并在其中创建不同语言的资源文件。例如：

messages.properties（默认语言，通常是英语）
messages_zh.properties（中文）
messages_fr.properties（法语）

每个文件的内容如下：

messages.properties（默认语言）


ini
 代码解读
复制代码
greeting=Hello!
farewell=Goodbye!

messages_zh.properties（中文）


ini
 代码解读
复制代码
greeting=你好!
farewell=再见!

messages_fr.properties（法语）


ini
 代码解读
复制代码
greeting=Bonjour!
farewell=Au revoir!

步骤 3: 配置MessageSource

在Spring Boot中，默认会自动配置MessageSource，但你可以自定义配置。创建一个配置类，例如MessageConfig：


kotlin
 代码解读
复制代码
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;

@Configuration
public class MessageConfig {

    @Bean
    public ReloadableResourceBundleMessageSource messageSource() {
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        messageSource.setBasename("classpath:messages/messages");
        messageSource.setDefaultEncoding("UTF-8");
        return messageSource;
    }
}

步骤 4: 创建Controller

创建一个控制器来处理请求并返回国际化的消息：


kotlin
 代码解读
复制代码
package com.et.controller;

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 org.springframework.web.servlet.LocaleResolver;

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

@RestController
public class GreetingController {

    @Autowired
    private MessageSource messageSource;

    @Autowired
    private LocaleResolver localeResolver;

    @GetMapping("/greeting")
    public String greeting(HttpServletRequest request, @RequestHeader(value = "Accept-Language", required = false) String acceptLanguage) {
        Locale locale = localeResolver.resolveLocale(request);
        
        // set language by Accept-Language
        if (acceptLanguage != null && !acceptLanguage.isEmpty()) {
            String[] languages = acceptLanguage.split(",");
            String language = languages[0].split(";")[0]; // get the first language
            language = language.trim();
            locale = Locale.forLanguageTag(language);
        }

        return messageSource.getMessage("greeting", null, locale);
    }
}

步骤 5: 前端实现

如果你有前端页面，可以通过AJAX请求获取国际化文本。例如，使用JavaScript：


xml
 代码解读
复制代码
html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Internationalization Exampletitle>
    <style>
        body {
            font-family: Arial, sans-serif;
            background-color: #f0f0f0;
            color: #333;
            padding: 20px;
        }
        select {
            margin-bottom: 20px;
        }
    style>
head>
<body>
<h1 id="greeting">h1>

<label for="language-select">Choose a language:label>
<select id="language-select">
    <option value="en">Englishoption>
    <option value="zh">中文option>
    <option value="fr">Françaisoption>
select>

<script>
        function fetchGreeting(lang) {
            fetch('/greeting', {
                method: 'GET',
                headers: {
                    'Accept-Language': lang
                }
            })
            .then(response => response.text())
            .then(data => {
                document.getElementById('greeting').innerText = data;
            });


        }

        // Fetch greeting based on selected language
        document.getElementById('language-select').addEventListener('change', function() {
            const selectedLang = this.value;
            fetchGreeting(selectedLang);
        });

        // Initial fetch in English
        fetchGreeting('en');
    script>
body>
html>

以上只是一些关键代码，所有代码请参见下面代码仓库

代码仓库

github.com/Harries/spr…(i18n)

3.测试

启动Spring Boot应用，访问http://127.0.0.1:8088/index.html。效果如下图

4.总结

通过以上步骤，你可以在Spring Boot应用中实现国际化。你可以根据用户的语言偏好动态地返回不同的文本内容。根据需要，你可以扩展更多语言和消息，并在前端实现语言切换功能。