Spring Boot REST国际化

18-10-30 banq
    

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

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

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

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

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

@Configuration
public class CustomLocaleResolver 
             extends AcceptHeaderLocaleResolver 
             implements WebMvcConfigurer {

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

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

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

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

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

@Component
public class Translator {

   private static ResourceBundleMessageSource messageSource;

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

   public static String toLocale(String msgCode) {
      Locale locale = LocaleContextHolder.getLocale();
      return messageSource.getMessage(msg, null, 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”)
public class MainController {

@GetMapping()
public String getMessage(@RequestParam(“msg”)String msg){
return 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