RESTful 服务的国际化

2025 年 1 月 17 日 | 阅读 5 分钟

在本节中，我们将讨论 RESTful Web 服务的国际化。

国际化

国际化是指设计 Web 应用程序或服务，使其能够自动支持不同的国家和语言，而无需更改应用程序。它也称为 I18N，因为 internationalization 这个词共有 18 个字符，从 I 开始到 N 结束。

本地化是通过添加特定区域设置的组件（如翻译文本、描述特定区域设置行为的数据等）来执行的。它支持与提供语言或文化相关功能的类和包的完全集成。

Java 为桌面和服务器应用程序的国际化提供了基础。以下是重要的国际化功能领域。

文本表示：Java 基于 Unicode 字符集，并且有多个库实现了 Unicode 标准。
区域设置标识和本地化：Java 中的区域设置是标识符，可用于在不同功能领域请求特定区域设置的行为。ResourceBundle 类支持本地化。该类提供对特定于区域设置的对象（包括字符串）的访问。
日期和时间处理：Java 提供了各种日历。它支持与日历无关的 Date 对象之间的转换。Java 支持世界上所有时区。
文本处理：它包括字符分析、大小写映射、字符串比较、将文本分解成单词、将数字、日期和时间值格式化为字符串，或将它们从字符串解析回来。这些功能大多数都与区域设置相关。
字符编码：在从流读取传入文本或向流写入传出文本时，它支持 Unicode 与其他字符编码之间的文本转换。

我们需要配置两件事来使服务国际化。

LocaleResolver
ResourceBundleMessageSource

默认区域设置为 Locale.US。如果有人未指定区域设置，则返回默认区域设置。我们还需要自定义 ResourceBundle。它有一个要国际化的属性列表。我们将把属性存储在 ResourceBundle 中。ResourceBundleMessageSource 是 Spring MVC 中用于处理属性的概念。之后，我们将使用 MessageSource 和一个名为 Accept-Language 的请求头。

让我们配置国际化。

步骤 1：打开 RestfulWebServicesApplication.java 文件。

步骤 2：为默认区域设置配置一个 Bean。

@Bean
public  LocaleResolver localeResolver()
{
SessionLocaleResolver localeResolver = new SessionLocaleResolver();
localeResolver.setDefaultLocale(Locale.US);
return localeResolver;
}

注意：导入 import org.springframework.web.servlet.LocaleResolver 包，同时导入 LocaleResolver。

步骤 3：现在，我们将把属性存储在一个名为 messages.properties 的特定文件中。

右键单击 src/main/resources 文件夹 -> 新建 -> 文件 -> 提供文件名：messages.properties。它包含默认区域设置的消息。

messages.properties

步骤 4：创建一个名为 messages_fr.properties 的另一个属性文件，用于法语区域设置。它包含一条法语区域设置的消息。

messages_fr.properties

步骤 5：读取属性并根据输入的 Accept-Language 请求头进行自定义。打开 RestfulWebServicesApplication.java 并为 ResourceBundle 配置另一个 Bean。

//configuring ResourceBundle
@Bean
public ResourceBundleMessageSource bundleMessageSource()
{
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
messageSource.setBasename("messages");
return messageSource;
}

RestfulWebServicesApplication.java

package com.javatpoint.server.main;
import java.util.Locale;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.i18n.SessionLocaleResolver;
@SpringBootApplication
public class RestfulWebServicesApplication 
{
public static void main(String[] args) 
{
SpringApplication.run(RestfulWebServicesApplication.class, args);
}
//configuring default locale
@Bean
public  LocaleResolver localeResolver()
{
SessionLocaleResolver localeResolver = new SessionLocaleResolver();
localeResolver.setDefaultLocale(Locale.US);
return localeResolver;
}
//configuring ResourceBundle
@Bean
public ResourceBundleMessageSource messageSource()
{
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
messageSource.setBasename("messages");
return messageSource;
}
}

步骤 6：更新服务以使用这些源。打开 HelloWorldController.java 并自动装配 MessageSource。

@Autowired 
private MessageSource messageSource;

HelloWorldController.java

package com.javatpoint.server.main.helloworld;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;
import java.util.Locale;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Configuration;
@Configuration
//Controller
@RestController
public class HelloWorldController 
{
@Autowired 
private MessageSource messageSource;
//using get method and hello-world URI
@GetMapping(path="/hello-world")
public String helloWorld()
{
return "Hello World";
}
@GetMapping(path="/hello-world-bean")
//method- which returns "Hello World"
public HelloWorldBean helloWorldBean()
{
return new HelloWorldBean("Hello World");//constructor of HelloWorldBean
}
//passing a path variable 
//hello-world/path-variable/javatpoint
@GetMapping(path="/hello-world/path-variable/{name}")
public HelloWorldBean helloWorldPathVariable(@PathVariable String name)
{
return new HelloWorldBean(String.format("Hello World, %s",name));	//%s replace the name
}
//internationalization
@GetMapping(path="/hello-world-internationalized")
public String helloWorldInternationalized(@RequestHeader(name="Accept-Language", required=false) Locale locale)
{
return messageSource.getMessage("good.morning.message", null, locale);
}
}

步骤 7：打开 REST 客户端 Postman 并执行以下更改

选择 GET 请求。
输入 URI https://:8080/hello-world-internationalized
点击 Headers 选项卡并输入

Internationalization of RESTful Services

点击 Send 按钮。

它返回美国区域设置的消息 Good Morning。

现在我们更改 RequestHeader us 为 fr 并再次发送 GET 请求。

它返回法语区域设置的消息 Bonjour。

再次，将 RequestHeader fr 更改为其他 RequestHeader，例如 nl。它返回默认区域设置（美国）的消息 Good Morning。

让我们为 RequestHeader nl 创建一个属性文件 message_nl.properties。它包含 荷兰语 的消息 Goede Morgen。

messages_nl.properties

再次发送 GET 请求，它返回消息 Goede Morgen。

简化国际化

现在我们将简化上面完成的国际化实现。在之前的实现中，我们已将区域设置（RequestHeader）作为参数传递给 REST 控制器方法。如果我们将此添加到每个需要国际化的方法中，成本会增加。Spring 提供了一种从 LocaleContextHolder 获取它的替代方法。

让我们实现 LocaleContextHolder 而不是 RequestHeader。

步骤 1：打开 HelloWorldController.java 并更改 helloWorldInternationalized() 方法的返回类型。

return messageSource.getMessage("good.morning.message", null, LocaleContextHolder.getLocale());

HelloWorldController.java

package com.javatpoint.server.main.helloworld;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;
import java.util.Locale;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.i18n.LocaleContextHolder;
@Configuration
//Controller
@RestController
public class HelloWorldController 
{
@Autowired 
private MessageSource messageSource;
//using get method and hello-world URI
@GetMapping(path="/hello-world")
public String helloWorld()
{
return "Hello World";
}
@GetMapping(path="/hello-world-bean")
//method- which returns "Hello World"
public HelloWorldBean helloWorldBean()
{
return new HelloWorldBean("Hello World");//constructor of HelloWorldBean
}
//passing a path variable 
//hello-world/path-variable/javatpoint
@GetMapping(path="/hello-world/path-variable/{name}")
public HelloWorldBean helloWorldPathVariable(@PathVariable String name)
{
return new HelloWorldBean(String.format("Hello World, %s",name));	//%s replace the name
}
//internationalization
@GetMapping(path="/hello-world-internationalized")
public String helloWorldInternationalized(@RequestHeader(name="Accept-Language", required=false) Locale locale)
{
return messageSource.getMessage("good.morning.message", null, LocaleContextHolder.getLocale());
}
}

步骤 2：打开 RestfulWebServicesApplication.java 并将 SessionLocaleResolver 更改为 AcceptHeaderLocaleResolver。LocaleResolver 实现使用 HTTP 请求的“accept-language”头中指定的主要区域设置（客户端浏览器发送的区域设置）。

RestfulWebServicesApplication.java

package com.javatpoint.server.main;
import java.util.Locale;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver;
import org.springframework.web.servlet.i18n.SessionLocaleResolver;
@SpringBootApplication
public class RestfulWebServicesApplication 
{
public static void main(String[] args) 
{
SpringApplication.run(RestfulWebServicesApplication.class, args);
}
//configuring default locale
@Bean
public  LocaleResolver localeResolver()
{
AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver();
localeResolver.setDefaultLocale(Locale.US);
return localeResolver;
}
//configuring ResourceBundle
@Bean
public ResourceBundleMessageSource messageSource()
{
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
messageSource.setBasename("messages");
return messageSource;
}
}

AcceptHeaderLocaleResolver 的优点是，我们无需将请求头配置为每个控制器方法中的参数。

步骤 3：打开 REST 客户端 Postman 并通过设置键为 Accept-Language，值为 fr 来发送 GET 请求。它返回消息 Bonjour。

现在取消选中 RequestHeader，将值 fr 更改为 en。它返回默认区域设置（美国）的消息 Good Morning。

步骤 4：转到 RestfulWebServicesApplication.java。删除 ResourceBundleMessageSource() 方法，并将其配置在 application.properties 文件中。

步骤 5：打开 application.properties 文件，配置消息基础名称，而不是在 RestfulWebServicesApplication.java 中创建单独的 Bean。

application.properties

logging.level.org.springframework=info
spring.messages.basename=messages

步骤 6：重复步骤 3。

点击此处下载 RESTful 服务国际化项目

点击此处下载移除 ResourceBundleMessageSource 之前项目

点击此处下载移除 ResourceBundleMessageSource 之后项目

下一主题内容协商实现 XML 支持

RESTful 服务的国际化

国际化

注意：导入 import org.springframework.web.servlet.LocaleResolver 包，同时导入 LocaleResolver。

简化国际化

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Spring Boot 教程

创建项目

项目组件

Tool Suite

Spring Boot AOP

Spring Boot 数据库

Spring Boot 视图

SB 缓存

Spring Boot 其他

Spring Boot - RESTful

Spring 教程

Spring Cloud

Spring 微服务

面试题

RESTful 服务的国际化

国际化

注意：导入 import org.springframework.web.servlet.LocaleResolver 包，同时导入 LocaleResolver。

简化国际化

相关帖子

Richardson 成熟度模型

实现一个 GET 服务来检索用户的所有 Post

使用自定义注解增强 Swagger 文档

Swagger 文档格式简介

RESTful Web 服务版本控制 - 使用 URI 的基本方法

更新 UserResource 上的 POST 和 DELETE 方法以使用 JPA

使用 Spring Boot Actuator 监控 API

实现 POST 服务以创建用户的 Post

使用 Spring Security 实现基本身份验证

创建 Post 实体以及与 User 实体的一对多关系

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器