Spring：项目国际化

快来打我* 2022-04-23 11:54 177阅读 0赞

## 前言 ##

>         在我们开发 javaWEB 项目的时候，项目可能涉及到在国外部署或者应用，也有可能会有国外的用户对项目进行访问 ，那么在这种项目中，为客户展现的页面或者操作的信息就需要使用不同的语言，这就是我们所说的项目国际化（internationalization：也称为**i18n**，据说是因为internationalization(国际化)这个单词从i到n之间有18个英文字母）。

### 一、项目国际化的分类 ###

根据数据的类型不同，国际化分为2类：静态数据国际化和动态数据的国际化。

1.   **静态数据国际化**：静态数据是项目中固定使用的文本元素，例如菜单栏、导航条等中使用的文本元素、或错误提示信息，状态信息等，需要根据来访者的地区和国家，选择不同语言的文本为之服务。
2.  **动态数据国际化**：动态数据是指在程序动态产生的数据，例如(日期，货币等)，项目应能根据当前所在的国家或地区的文化习惯进行显示。

### 二、静态数据国际化  ###

**2.1 国际化消息源**

对于国际化，Spring MVC提供了国际化消息源机制，那就是MessageSource接口体系。它的作用是装载国际化信息，如下图所示：

![这里写图片描述][20160620221332031]

其中MessageSource的接口源码如下：

public interface MessageSource {
    
         //code表示国际化资源中的属性名
         //args用于传递格式化串占位符所用的运行期参数，当在资源找不到对应属性名时，会返回 defaultMessage 参数所指定的默认信息。
         //locale表示本地化对象；
        String getMessage(String code, Object[] args, String defaultMessage, Locale locale);
    
        //与上面的方法类似，只不过在找不到资源中对应的属性名时，直接抛出NoSuchMessageException异常。
        String getMessage(String code, Object[] args, Locale locale) throws NoSuchMessageException;
    
        //MessageSourceResolvable 封装了属性名、参数数组以及默认信息的大类。
        //将属性名、参数数组以及默认信息封装起来，它的功能和第一个接口方法相同。
        String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException;
    
    }

<table> 
 <tbody> 
  <tr> 
   <td><strong>类</strong></td> 
   <td><strong>描述</strong></td> 
  </tr> 
  <tr> 
   <td>ReloadableResourceBundleMessageSource</td> 
   <td>提供了定时刷新功能，允许在不重启系统的情况下，更新资源信息 。</td> 
  </tr> 
  <tr> 
   <td>StaticMessageSource</td> 
   <td>主要用于程序测试，它允许通过编程的方式来提供国际化信息 。</td> 
  </tr> 
  <tr> 
   <td>DelegatingMessageSource</td> 
   <td>是为了方便操作父 MessageSource 而提供的代理类 。</td> 
  </tr> 
  <tr> 
   <td> <p>ResourceBundleMessageSource</p> </td> 
   <td>允许用户通过 beanName 来指定一个资源名（包含类路径的全限定资源名），或通过 beanNames 指定一组资源名。</td> 
  </tr> 
 </tbody> 
</table>

在大多数情况下，是使用JDK的ResourceBundle处理国际化信息的，为此这里主要使用ResourceBundleMessageSource这个国际化消息源。

为了更方便地使用Spring MVC的国际化，SpringBoot提供了如下的配置项：

#设置国际化消息是否总是采用格式化，默认是false
    spring.messages.always-use-message-format=false
    #设置国际化属性名称，如果有多个可以使用逗号分隔，默认为messages
    spring.messages.basename=messages
    #设置国际化消息缓存超时秒数，默认为永远不过期，如果为0表示每次都重新加载
    spring.messages.cache-duration=
    #国际化消息编码
    spring.messages.encoding=UTF-8
    #如果没有找到特定区域设置的文件，则设置是否返回系统区域设置
    spring.messages.fallback-to-system-locale=true
    #是否使用消息编码作为默认的响应消息，而非抛出NoSuchMessageException
    spring.messages.use-code-as-default-message=false

**2.2 国际化解析器**

对于国际化，还需要确定用户是使用哪个国际区域。为此，Spring MVC提供了LocaleResolver接口来确定用户的国际化区域。以下是4种国际化解析器的实现类。

1.  AcceptHeaderLocaleResolver：使用浏览器头请求的信息去实现国际化区域，是默认的国际化解析器。
2.  FixedLocaleResolver：固定的国际化区域。只能选择一种，不能变化，所以用处不大。
3.  CookieLocaleResolver：将国际化信息设置在浏览器Cookie中，这样使得系统可以从Cookie中读取国际化信息来确定用户的国际化区域。但是对于用于来说，他可以禁止浏览器使用Cookie，这样就会读取Cookie失败。当失败后会使用默认的国际化区域，默认的国际化区域可从浏览器头请求读出，也可以通过服务端由开发者设置。
4.  SessionLocaleResolver：类似于CookieLocaleResolver，只是将国际化信息设置在Session中，这样就能读取Session中的信息去确定用户的国际化区域，常用。

**2.3 国际化实战：SessionLocaleResolver**

2.3.1  因为本例中是使用jsp视图来进行展示的，所以需要在pom.xml中加入jsp的依赖包

<dependency>
                <groupId>org.apache.tomcat.embed</groupId>
                <artifactId>tomcat-embed-jasper</artifactId>
                <version>8.5.31</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>jstl</artifactId>
                <version>1.2</version>
                <scope>provided</scope>
            </dependency>

2.3.2  在application.properties中配置国际化消息源

#配置jsp视图
    spring:
      mvc:
        view:
          prefix: /WEB-INF/jsp/
          suffix: .jsp
    #配置国际化消息源
      messages:
        encoding: UTF-8
        basename: international
        cache-duration: 3600s

注意，配置项spring.messages.basename的值为international，因此我们的国际化消息的配置文件名称为international.properties，international\_zh\_CN.properties，international\_en\_US.properties（命名规则：  基础名\_语言简称\_国家简称.properties）

2.3.3  创建国际化文件

在resources目录下创建3个国际化文件

international.properties（必不可少，否则SpringBoot将不会生成国际化消息机制）

msg=Spring MVC\u56FD\u9645\u5316

international\_zh\_CN.properties

msg=Spring MVC\u56FD\u9645\u5316

international\_en\_US.properties

msg=Spring MVC internationalization

这样Spring MVC就会使用MessageResource读取这些国际化消息文件。

2.3.4  配置国际化解析器和拦截器

package com.scb.mongodemo.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.LocaleResolver;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
    import org.springframework.web.servlet.i18n.SessionLocaleResolver;
    
    import java.util.Locale;
    
    @Configuration
    public class InternationalizationConfig implements WebMvcConfigurer {
    
        //配置国际化解析器
        @Bean
        public LocaleResolver localeResolver(){
            SessionLocaleResolver localeResolver=new SessionLocaleResolver();
            //默认国际化区域
            localeResolver.setDefaultLocale(Locale.SIMPLIFIED_CHINESE);
            return localeResolver;
        }
    
        //配置国际化拦截器
        @Bean
        public LocaleChangeInterceptor localeChangeInterceptor(){
            LocaleChangeInterceptor lci=new LocaleChangeInterceptor();
            //设置参数名
            lci.setParamName("language");
            return lci;
        }
    
        //给处理器添加国际化拦截器
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(localeChangeInterceptor());
        }
    }

在Spring MVC中，它提供了一个拦截器LocaleChangeInterceptor，可以在处理器前处理相关的逻辑，也就是拦截器的preHandle方法的作用。这个拦截器可以拦截一个请求参数，通过此参数确定国际化信息，并且将国际化信息保存到Session中。

2.3.5  国际化控制器

package com.scb.mongodemo.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.MessageSource;
    import org.springframework.context.i18n.LocaleContextHolder;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    import javax.servlet.http.HttpServletRequest;
    import java.util.Locale;
    
    @Controller
    @RequestMapping("/i18n")
    public class InternationalizationController {
        //注入国际化消息接口对象
        @Autowired
        private MessageSource messageSource;
    
        //后台获取国际化信息和打开国际化视图
        @GetMapping("/page")
        public String page(HttpServletRequest request){
            //后台获取国际化区域
            Locale locale= LocaleContextHolder.getLocale();
            //获取国际化消息
            String msg=messageSource.getMessage("msg",null,locale);
            System.out.println("msg="+msg);
            //返回视图
            return "internationalization";
        }
    }

2.3.6  视图

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
    <%@taglib prefix="form" uri="http://www.springframework.org/tags/form"%>
    <%@taglib prefix="spring" uri="http://www.springframework.org/tags"%>
    <!DOCTYPE html>
    <html>
    <head>
        <meta http-equiv="Content-Type" content="text/html;  charset=UTF-8">
        <title>Spring MVC 国际化</title>
    </head>
    <body>
        <a href="./page?language=zh_CN">简体中文</a>
        <a href="./page?language=en_US">美国英文</a>
        <h2><spring:message code="msg"></spring:message> </h2>
        Locale: ${pageContext.response.locale}
    </body>
    </html>

2.3.7  运行结果

访问[http://localhost:8080/i18n/page][http_localhost_8080_i18n_page]

![20190218160006676.png][]

点击“美国英文”时，网页将切换到英文环境。

![20190218160100644.png][]

查看控制台输出如下：

![20190218160212314.png][]

### 三、动态数据国际化  ###

数值，货币，时间，日期等数据由于可能在程序运行时动态产生，所以无法像文字一样简单地将它们从应用程序中分离出来，而是需要特殊处理。Java 中提供了解决这些问题的 API 类(位于 java.util 包和 java.text 包中)

**1、Locale 类**

Locale 实例对象代表一个特定的地理，政治、文化区域。  
　　一个 Locale 对象本身不会验证它代表的语言和国家地区信息是否正确，只是向本地敏感的类提供国家地区信息，与国际化相关的格式化和解析任务由本地敏感的类去完成。(**若JDK中的某个类在运行时需要根据 Locale 对象来调整其功能，这个类就称为本地敏感类**)

详细阅读：[详解Java中用于国际化的locale类][Java_locale]

**2、DateFormat类**

DateFormat 类可以将一个日期/时间对象格式化为表示某个国家地区的日期/时间字符串。  
　　DateFormat 类除了可按国家地区格式化输出日期外，它还定义了一些用于描述日期/时间的显示模式的 int 型的常量，包括FULL, LONG, MEDIUM, DEFAULT, SHORT，实例化DateFormat对象时，可以使用这些常量，控制日期/时间的显示长度。

详细阅读：[国际化之DateFormat、NumberFormat][DateFormat_NumberFormat]

例子：DateFormatTest

package com.scb.mongodemo;
    
    import java.text.DateFormat;
    import java.util.Date;
    import java.util.Locale;
    
    public class DateFormatTest {
        public static void main(String[] args) {
            // 当前这一刻的时间（日期、时间）
            Date date = new Date();
            // 输出日期部分
            DateFormat df1 = DateFormat.getDateInstance(DateFormat.FULL, Locale.SIMPLIFIED_CHINESE);
            String result1 = df1.format(date);
            System.out.println(result1);
    
            DateFormat df2 = DateFormat.getDateInstance(DateFormat.FULL, Locale.ENGLISH);
            String result2 = df2.format(date);
            System.out.println(result2);
        }
    }

![20190218162114647.png][]

**3、NumberFormat类**

NumberFormat类可以将一个数值格式化为符合某个国家地区习惯的数值字符串，也可以将符合某个国家地区习惯的数值字符串解析为对应的数值。

**4、MessageFormat类**

如果一个字符串中包含了多个与国际化相关的数据，可以使用MessageFormat类对这些数据进行批量处理。  
　　例如：At 12:30 pm on jul 3,1998, a hurricance destroyed 99 houses and caused $1000000 of damage  
　　以上字符串中包含了时间、数字、货币等多个与国际化相关的数据，对于这种字符串，可以使用MessageFormat类对其国际化相关的数据进行批量处理。  
　　MessageFormat 类如何进行批量处理呢？  
　　1、MessageFormat类允许开发人员用占位符替换掉字符串中的敏感数据（即国际化相关的数据）。  
　　2、MessageFormat类在格式化输出包含占位符的文本时，messageFormat类可以接收一个参数数组，以替换文本中的每一个占位符。

At \{0\} on \{1\},a destroyed \{2\} houses and caused \{3\} of damage

字符串中的\{0\}、\{1\}、\{2\}、\{3\}就是占位符

例子：MessageFormatTest

package com.scb.mongodemo;
    
    import java.text.MessageFormat;
    import java.util.Date;
    import java.util.Locale;
    
    public class MessageFormatTest {
        public static void main(String[] args) {
            //模式字符串
            String pattern = "On {0}, a hurricance destroyed {1} houses and caused {2} of damage.";
            //实例化MessageFormat对象，并装载相应的模式字符串
            MessageFormat format = new MessageFormat(pattern, Locale.CHINA);
            Object arr[] = {new Date(), 99, 100000000};
            //格式化模式字符串，参数数组中指定占位符相应的替换对象
            String result = format.format(arr);
            System.out.println(result);
        }
    }

![2019021816240557.png][]

[20160620221332031]: /images/20220319/a3119a68bbc5405e84e5e1daf697c473.png
[http_localhost_8080_i18n_page]: http://localhost:8080/i18n/page
[20190218160006676.png]: /images/20220319/aa76a4bdf53844a2a1b1147d8260b306.png
[20190218160100644.png]: /images/20220319/156e0710927147dcb5ecc3e73461bafa.png
[20190218160212314.png]: /images/20220319/9cfb763379604af59a5ac4c9f0459e3e.png
[Java_locale]: https://www.jb51.net/article/85858.htm
[DateFormat_NumberFormat]: https://www.cnblogs.com/fjdingsd/p/5143583.html
[20190218162114647.png]: /images/20220319/296ab539db51471ca04c303ada50d56e.png
[2019021816240557.png]: /images/20220319/bd79538b772f4104b17dd44e4b08cd3c.png