Spring Boot REST國際化的實現代碼

本文我們將討論如何在現有的Spring Boot項目中添加國際化。只需幾個簡單的步驟即可實現Spring Boot應用的國際化,具有一定的參考價值,感興趣的小夥伴們可以參考一下

本指南將向您展示如何輕鬆只需幾個簡單的步驟即可實現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

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章