Spring Boot REST国际化的实现代码

本指南将向您展示如何轻松只需几个简单的步骤即可实现Spring Boot应用的国际化,从而总是在一个地方处理语言环境问题。

我们将讨论如何在现有的Spring Boot项目中添加国际化。当您处理应该为来自不同国家/地区的用户提供不同语言服务的项目时,app国际化的问题变得很常见。比如,你需要向中国用户提供中文回复信息,并向法国用户提供法语信息,那么让我们来看看如何在Spring Boot中实现它。

让我们使用Spring Initializer创建项目 ,这使得项目的创建更容易。选择Web,Security,JPA,Actuator,Devtools等模块。

下载项目后,解压缩,并用打开IntelliJ IDEA打开。

第一件事是创建CustomLocaleResolver类,它将负责定义用户的语言环境。

@Configuration
<b>public</b> <b>class</b> CustomLocaleResolver
       <b>extends</b> AcceptHeaderLocaleResolver
       implements WebMvcConfigurer {

  List<Locale> LOCALES = Arrays.asList(
     <b>new</b> Locale(<font>"en"</font><font>),
     <b>new</b> Locale(</font><font>"fr"</font><font>));

  @Override
  <b>public</b> Locale resolveLocale(HttpServletRequest request) {
   String headerLang = request.getHeader(</font><font>"Accept-Language"</font><font>);
   <b>return</b> headerLang == <b>null</b> || headerLang.isEmpty()
      ? Locale.getDefault()
      : Locale.lookup(Locale.LanguageRange.parse(headerLang), LOCALES);
  }

  @Bean
  <b>public</b> ResourceBundleMessageSource messageSource() {
   ResourceBundleMessageSource rs = <b>new</b> ResourceBundleMessageSource();
   rs.setBasename(</font><font>"messages"</font><font>);
   rs.setDefaultEncoding(</font><font>"UTF-8"</font><font>);
   rs.setUseCodeAsDefaultMessage(<b>true</b>);
   <b>return</b> rs;
  }
}
</font>

这里告诉我们项目中支持2个语言环境:en和fr。在名为“ Accept-Language ” 的http的Header中传递语言环境。因此,如果Header存在这个变量名且它不为空,我们将使用它的语言环境,否则 - 我们将使用默认语言环境,即en。

接下来让我们创建一个类,负责根据指定的语言环境选择正确的语言信息。我将其称为Translator,它将有一个单独的方法,它将接受应翻译的信息代码。

@Component
<b>public</b> <b>class</b> Translator {

  <b>private</b> <b>static</b> ResourceBundleMessageSource messageSource;

  @Autowired
  Translator(ResourceBundleMessageSource messageSource) {
   Translator.messageSource = messageSource;
  }

  <b>public</b> <b>static</b> String toLocale(String msgCode) {
   Locale locale = LocaleContextHolder.getLocale();
   <b>return</b> messageSource.getMessage(msg, <b>null</b>, locale);
  }
}

messageSource.getMessage(...)接受入参“msg”。但这并不是应该翻译的信息,它只是信息代码。现在我们还没有任何信息代码定义,所以现在定义信息代码。

在resources文件夹下,创建两个文件:messages.properties和messages_fr.properties。

这是messages.properties的内容:

hello=Hello World!

welcome=Welcome to this guide!

这里是messages_fr.properties的内容:

hello=Bonjour le Monde!

welcome=Bienvenue dans ce guide!

在这里我们已经定义了我们的消息代码。他们是“ hellp ”和“ welcome ”。现在你可以指导我们应该将哪些代码传递给toLocale(String msgCode)方法,这样才能根据用户的语言环境获取适当的消息。

可能最后一步是创建简单的控制器,让我们将它命名为MainController,它只有一个端点,它将接受消息代码,我们将其作为请求参数传递给HTTP请求。

@RestController
@RequestMapping(value =“/ api”)
<b>public</b> <b>class</b> MainController {

@GetMapping()
<b>public</b> String getMessage(@RequestParam(“msg”)String msg){
<b>return</b> Translator。toLocale(msg) ;
}
}

现在已经完成!

使用CURL发出简单的请求:

curl -X GET -H "Accept-Language: fr" 'http://localhost:8080/api?msg-welcome'

这个将返回法语的welcome信息:

Bienvenue dans ce guide!

再发出请求:

curl -X GET -H "Accept-Language: en" 'http://localhost:8080/api?msg-welcome'

这个将返回英语的welcome信息:

welcome to this guide!

正如你看到:响应会根据请求中传递的“ Accept-Language ”标头的值而有所不同。这样,我们不需要检查每个控制器方法中请求中传递的内容,然后将其进一步传递给服务层。我们现在可以在一个单独的地方执行此操作,即CustomLocaleResolver类。

源码: GitHub

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • springboot+thymeleaf国际化之LocaleResolver接口的示例

    springboot中大部分有默认配置所以开发起项目来非常迅速,仅对需求项做单独配置覆盖即可 spring采用的默认区域解析器是AcceptHeaderLocaleResolver,根据request header中的accept-language值来解析locale,并且是不可变的. 那么想要实现国际化,就要使用SessionLocaleResolver或者CookieLocaleResolver.正如类的名字所示,是按session或cookie中储存的locale值来解析locale. 我

  • 自己动手在Spring-Boot上加强国际化功能的示例

    前言 公司将项目由Struts2转到Springmvc了,由于公司业务是境外服务,所以对国际化功能需求很高.Struts2自带的国际化功能相对Springmvc来说更加完善,不过spring很大的特性就是可定定制化性强,所以在公司项目移植的到Springmvc的时候增加了其国际化的功能.特此整理记录并且完善了一下. 本文主要实现的功能: 从文件夹中直接加载多个国际化文件后台设置前端页面显示国际化信息的文件利用拦截器和注解自动设置前端页面显示国际化信息的文件 注:本文不详细介绍怎么配置国际化,区域

  • Spring Boot REST国际化的实现代码

    本指南将向您展示如何轻松只需几个简单的步骤即可实现Spring Boot应用的国际化,从而总是在一个地方处理语言环境问题. 我们将讨论如何在现有的Spring Boot项目中添加国际化.当您处理应该为来自不同国家/地区的用户提供不同语言服务的项目时,app国际化的问题变得很常见.比如,你需要向中国用户提供中文回复信息,并向法国用户提供法语信息,那么让我们来看看如何在Spring Boot中实现它. 让我们使用Spring Initializer创建项目 ,这使得项目的创建更容易.选择Web,Se

  • spring boot aop 记录方法执行时间代码示例

    本文研究的主要是spring boot aop 记录方法执行时间的实现代码,具体如下. 为了性能调优,需要先统计出来每个方法的执行时间,直接在方法前后log输出太麻烦,可以用AOP来加入时间统计 添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency&

  • spring boot application properties配置实例代码详解

    废话不多说了,直接给大家贴代码了,具体代码如下所示: # =================================================================== # COMMON SPRING BOOT PROPERTIES # # This sample file is provided as a guideline. Do NOT copy it in its # entirety to your own application. ^^^ # ========

  • Spring Boot定时任务的使用实例代码

    Spring Boot中配置定时任务极其简单......下面看下实例代码: import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableScheduling; import org.springframework.scheduling.annotation.Scheduled; import java.text.SimpleD

  • Angular+Bootstrap+Spring Boot实现分页功能实例代码

    需要用到的js angular.js(用angular.min.js会导致分页控件不显示) ui-bootstrap-tpls.min.js angular-animate.js 需要用到的css bootstrap.min.css 由于本项目使用了路由,所以讲js以及css文件的应用都放在一个主html,请同学们在html页面中添加以上文件 在开始之前,我先简单介绍下分页的原理. 分页的实质其实就是一条sql语句, 比如查找第二页,即第16到第30条数据 在MySQL中是select * fr

  • Spring Boot整合mybatis(一)实例代码

    sprig-boot是一个微服务架构,加快了spring工程快速开发,以及简便了配置.接下来开始spring-boot与mybatis的整合. 1.创建一个maven工程命名为spring-boot-entity,pom.xml文件配置如下: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:s

  • spring boot整合Swagger2的示例代码

    Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 1.代码示例 1).在pom.xml文件中引入Swagger2 <dependency> <groupId>io.springfox</groupId> <artifa

  • Spring Boot集成Mybatis的实例代码(简洁版)

    概述 现在互联网应用中,大部分还是使用Mybatis来操作数据库的,本文介绍一下Spring Boot中如何集成Mybatis. 上篇介绍了Spring Boot 直接用jar运行项目的方法,需要的朋友点击查看. 创建Spring Boot工程 在 Spring Boot 开篇-创建和运行 一文中有一个小节介绍了如何使用Spring Boot的组件来创建工程.如果要集成Mybatis,只需要把Mysql和Mybatis这两个组件勾选一下即可. 当然也可以不通过这种方式,直接在POM.xml文件中

  • Spring Boot集成Kafka的示例代码

    本文介绍了Spring Boot集成Kafka的示例代码,分享给大家,也给自己留个笔记 系统环境 使用远程服务器上搭建的kafka服务 Ubuntu 16.04 LTS kafka_2.12-0.11.0.0.tgz zookeeper-3.5.2-alpha.tar.gz 集成过程 1.创建spring boot工程,添加相关依赖: <?xml version="1.0" encoding="UTF-8"?> <project xmlns=&qu

  • spring boot多数据源动态切换代码实例

    这篇文章主要介绍了spring boot多数据源动态切换代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 当项目中存在多数据源时,就涉及到数据源的动态切换,通过研究,特此记录一下. 1.maven依赖 <!--数据库连接--> <dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> &

随机推荐