SpringBoot | 第四十六章：SpringBoot集成i18n国际化配置

一、概述

      软件的国际化：软件开发时，要使它能同时应对世界不同地区和国家的访问，并针对不同地区和国家的访问，提供相应的、符合来访者阅读习惯的页面或数据。
国际化(internationalization)又称为i18n(读法为i18n，据说是因为internationalization(国际化)这个单词从i到n之间有18个英文字母，i18n的名字由此而来)

二、什么是合格的国际化软件

软件实现国际化，需具备以下两个特征：

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

三、国际化的应用地方

 对于软件中的菜单栏、导航条、错误提示信息、状态信息等这些固定不变的文本信息，可以把它们写在一个properties文件中，并根据不同的国家编写不同的properties文件。这一组properties文件称之为一个资源包。

四、创建资源包和资源文件规则

        一个资源包中的每个资源文件都必须拥有共同的基名。除了基名，每个资源文件的名称中还必须有标识其本地信息的附加部分。例如，一个资源包的基名是“login”，则与中文、英文环境相对应的资源文件名则为“login_zh_CN.properties”和“login_en_US.properties”。

 

注意：每个资源包都应有一个默认资源文件，这个文件不带有标识本地信息的附加部分。若login对象在资源包中找不到与用户匹配的资源文件，它将选择该资源包中与用户最相近的资源文件，如果再找不到，则使用默认资源文件。例如login.properties。

五、创建SpringBoot项目springboot-i18n

  1.引入依赖

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.1.7.RELEASE
         
    
    com.thinkingcao
    springboot-i18n
    0.0.1-SNAPSHOT
    springboot-i18n
    springboot-i18n project for Spring Boot

    
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter-web
        

        
            org.springframework.boot
            spring-boot-configuration-processor
            true
        
        
            org.projectlombok
            lombok
            true
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

 2.实现LocaleResolver接口

import org.springframework.util.StringUtils;
import org.springframework.web.servlet.LocaleResolver;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;
 
public class I18nLocaleResolver implements LocaleResolver {
    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        String l = request.getParameter("l");
        Locale locale = Locale.getDefault();
        if(!StringUtils.isEmpty(l)){
            String[] split = l.split("_");
            locale = new Locale(split[0],split[1]);
        }
        return locale;
    }
 
    @Override
    public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
 
    }
}

3.实现WebMvcConfigurer

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.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 使用WebMvcConfigurerAdapter可以扩展SpringMvc的功能，包括拦截器，转换器等@EnableWebMvc //设置@EnableWebMvc为完全接管SpringMvc，但一般不要设置完全接管SpringMvc
 * @desc: 实现WebMvcConfigurer接口，支持国际化i18n
 * @auth: cao_wencao
 * @date: 2019/8/27 18:08
 */
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //设置对“/”的请求映射到login
        //如果没有数据返回到页面，没有必要用控制器方法对请求进行映射
        registry.addViewController("/").setViewName("login");
    }


    /**
     * @desc: 注册我们自定义的区域解析器，一旦将我们的区域解析器注册到Spring容器中则SpingBoot默认提供的区域解析器将不会自动注册
     * @auth: cao_wencao
     * @date: 2019/8/28 13:59
     */
    @Bean
    public LocaleResolver localeResolver() {
        return new I18nLocaleResolver();
    }

}

4.resource路径下新建i18n文件夹，i18n文件夹下新建login.properties、login_en_US.properties、login_zh_CN.properties

   1）、login.properties 默认国际化文件

            

login.btn=登录
login.password=密码
login.remember=记住我
login.tip=请登录~
login.username=用户名

   1）、login_en_US.properties 英文国际化文件

   

login.btn=Sign in
login.password=Password
login.remember=remember-me
login.tip=Please sign in
login.username=UserName

    

   1）、login_zh_CN.properties 中文国际化文件

login.btn=登录
login.password=密码
login.remember=记住我
login.tip=请登录
login.username=用户名

5. resource路径下新建application.yml文件

#国际化i18n支持
spring:
  messages:
    basename: i18n.login
    encoding: UTF-8
    fallback-to-system-locale: false
  mvc:
    view:
      prefix: classpath:/templates/
      suffix: .html
  thymeleaf:
    cache: false
server:
  port: 8888

 

六、在WEB应用中实现固定文本的国际化

 1)、新建login.html页面

	
		
		
		
		
		
		s
		
		
		
	

	
		

			
			
Please sign in
			Username
			
			Password
			
			

				
            [[#{login.remember}]]
        
			
			Sign in
			
© 2017-2018
			中文
			English
		
	

 2)、static目录下引入JS、CSS文件，支持上述html页面效果，由于JS文件无法贴出来，后面会贴出GitHub源码地址

 

3)、运行SpringBoot主程序

package com.thinkingcao.springbooti18n;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringbootI18nApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootI18nApplication.class, args);
    }

}

访问：http://127.0.0.1:8888/login

a. 默认效果：

b.切换英文效果：

 

c.切换中文效果

GitHub源码地址：https://github.com/Thinkingcao/SpringBootLearning/tree/master/springboot-i18n