Spring Boot 国际化
国际化是使我们的应用程序适应不同语言和地区的过程,而无需对源代码进行工程更改。 换句话说,国际化是本地化的准备。
在本章中,我们将详细了解如何在 Spring Boot 中实现国际化。
依赖项
我们需要 Spring Boot Starter Web 和 Spring Boot Starter Thymeleaf 依赖项来在 Spring Boot 中开发 Web 应用程序。
Maven
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
Gradle
compile('org.springframework.boot:spring-boot-starter-web')
compile group: 'org.springframework.boot', name: 'spring-boot-starter-thymeleaf'
LocaleResolver
我们需要确的应用程序的默认语言环境。 我们需要在 Spring Boot 应用程序中添加 LocaleResolver
bean。
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver();
sessionLocaleResolver.setDefaultLocale(Locale.US);
return sessionLocaleResolver;
}
LocaleChangeInterceptor
LocaleChangeInterceptor
用于根据添加到请求的语言参数的值更改新的 Locale。
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor();
localeChangeInterceptor.setParamName("language");
return localeChangeInterceptor;
}
要实现此效果,我们需要将 LocaleChangeInterceptor
添加到应用程序的注册表拦截器中。 配置类应该继承 WebMvcConfigurerAdapter
类并覆盖 addInterceptors()
方法。
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}
消息来源
默认情况下,Spring Boot 应用程序从 classpath 下的 src/main/resources
文件夹中获取消息源。 默认区域设置消息文件名应为 message.properties
,每个区域设置的文件应命名为 messages_XX.properties
。 “XX”代表地区代码。
所有消息属性都应用作密钥对值。 如果在语言环境中找不到任何属性,应用程序将使用 messages.properties 文件中的默认属性。
默认的 messages.properties
将如下所示
welcome.text=Hi Welcome to Everyone
中文 messages_cn.properties
将如下所示
welcome.text=欢迎访问迹忆客 Spring Boot 教程
注意
- 消息源文件应保存为“UTF-8”文件格式。
HTML 文件
在 HTML 文件中,使用语法 #{key}
显示来自属性文件的消息。
<h1 th:text = "#{welcome.text}"></h1>
完整的代码如下
Maven – pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.spring</groupId> <artifactId>springBootProject</artifactId> <version>1.0-SNAPSHOT</version> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.6.6</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
Gradle – build.gradle
buildscript { ext { springBootVersion = '1.5.8.RELEASE' } repositories { mavenCentral() } dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") } } apply plugin: 'java' apply plugin: 'eclipse' apply plugin: 'org.springframework.boot' group = 'com.study' version = '0.0.1-SNAPSHOT' sourceCompatibility = 1.8 repositories { mavenCentral() } dependencies { compile('org.springframework.boot:spring-boot-starter-web') compile group: 'org.springframework.boot', name: 'spring-boot-starter-thymeleaf' testCompile('org.springframework.boot:spring-boot-starter-test') }
下面给出了主要的 Spring Boot 应用程序类文件
package com.study;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author jiyik.com
*/
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
控制器类文件如下
package com.study.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @author jiyik.com
*/
@Controller
public class ViewController {
@RequestMapping("/locale")
public String locale() {
return "locale";
}
}
支持国际化的配置类
package com.study;
import jdk.vm.ci.meta.Local;
import org.springframework.context.annotation.Bean;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
import org.springframework.web.servlet.i18n.SessionLocaleResolver;
import java.util.Locale;
public class Internationalization extends WebMvcConfigurerAdapter {
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver();
sessionLocaleResolver.setDefaultLocale(Locale.US);
return sessionLocaleResolver;
}
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor();
localeChangeInterceptor.setParamName("language");
return localeChangeInterceptor;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}
}
消息来源——messages.properties 如下所示
welcome.text = Hi Welcome to Everyone
message_cn.properties 如下所示
welcome.text = Salut Bienvenue à tous
HTML 文件 locale.html 应放置在 classpath 上的 templates 目录下,如下所示
<!DOCTYPE html>
<html>
<head>
<meta charset = "ISO-8859-1"/>
<title>迹忆客(jiyik.com) - Spring Boot 国际化</title>
</head>
<body>
<h1 th:text = "#{welcome.text}"></h1>
</body>
</html>
这里我们使用 IDEA 来启动服务(读者也可以使用 mvn clean install
或者 gradle clean build
生成可执行jar包)
现在使用浏览器访问 URL http://localhost:8080/locale
,我们可以看到以下输出
访问 URL http://localhost:8080/locale?language=cn
将输出如下内容