SpringBoot的国际化使用

短命女 2022-05-28 02:44 160阅读 0赞

在项目中，很多时候需要国际化的支持，这篇文章要介绍一下springboot项目中国际化的使用。

在这个项目中前端页面使用的thymeleaf，另外加入了nekohtml去掉html严格校验，如果不了解springboot和thymeleaf的使用，可以去看我的上一篇文章[《SpringBoot集成Thymeleaf》][SpringBoot_Thymeleaf]。

新建一个springboot项目，pom文件代码如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    
    	<groupId>com.dalaoyang</groupId>
    	<artifactId>springboot_internationalization</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>springboot_internationalization</name>
    	<description>springboot_internationalization</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.10.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-devtools</artifactId>
    			<scope>runtime</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-thymeleaf</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>net.sourceforge.nekohtml</groupId>
    			<artifactId>nekohtml</artifactId>
    			<version>1.9.15</version>
    		</dependency>
    	</dependencies>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    
    </project>

从上面可以看出，其实和之前结合thymeleaf的时候一样。接下来给大家看一下application.propertie配置：

##端口号
    server.port=8888
    
    
    ##去除thymeleaf的html严格校验
    spring.thymeleaf.mode=LEGACYHTML5
    
    #设定thymeleaf文件路径 默认为src/main/resources/templates
    spring.freemarker.template-loader-path=classpath:/templates

新建IndexController

@Controller
    public class IndexController {
    
        @RequestMapping("/")
        public String hello(Model model){
            return "index";
        }
    }

到这里可以看出来，其实和整合thymeleaf一样。

接下来我们要加入国际化的关键，在resources里面新建messages.properties（默认配置），messages\_en\_US.properties（英文），messages\_zh\_CN.properties（中文）

其中messages.properties里面加入：

message = 欢迎使用国际化（默认）

messages\_en\_US.properties里面加入：

message = Welcome to internationalization (English)

messages\_zh\_CN.properties里面加入

message = \u6b22\u8fce\u4f7f\u7528\u56fd\u9645\u5316\uff08\u4e2d\u6587\uff09

然后在templates下新建index.html，代码如下：

<!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
    
    <a href="/?lang=en_US">English(US)</a>
    <a href="/?lang=zh_CN">简体中文</a></br>
    <p><label th:text="#{message}"></label></p>
    
    
    </body>
    </html>

创建国际化配置文件，I18Config 代码如下:

package com.dalaoyang.config;
    
    import java.util.Locale;
    
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    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.WebMvcConfigurerAdapter;
    import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
    import org.springframework.web.servlet.i18n.SessionLocaleResolver;
    
    @Configuration
    @EnableAutoConfiguration
    @ComponentScan
    /**
     * @author dalaoyang
     * @Description
     * @project springboot_learn
     * @package com.dalaoyang.config
     * @email 397600342@qq.com
     * @date 2018/3/28
     */
    public class I18Config extends WebMvcConfigurerAdapter{
        @Bean
        public LocaleResolver localeResolver() {
            SessionLocaleResolver slr = new SessionLocaleResolver();
            // 默认语言
            slr.setDefaultLocale(Locale.US);
            return slr;
        }
    
        @Bean
        public LocaleChangeInterceptor localeChangeInterceptor() {
            LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
            // 参数名
            lci.setParamName("lang");
            return lci;
        }
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(localeChangeInterceptor());
        }
    }

最后修改IndexController，修改成如下：

package com.dalaoyang.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import java.util.Locale;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.MessageSource;
    import org.springframework.context.i18n.LocaleContextHolder;
    import org.springframework.ui.Model;
    /**
     * @author dalaoyang
     * @Description
     * @project springboot_learn
     * @package com.dalaoyang.controller
     * @email 397600342@qq.com
     * @date 2018/3/28
     */
    @Controller
    public class IndexController {
    
        @Autowired
        private MessageSource messageSource;
    
        @RequestMapping("/")
        public String hello(Model model){
            Locale locale = LocaleContextHolder.getLocale();
            model.addAttribute("message", messageSource.getMessage("message", null, locale));
            return "index";
        }
    }

现在启动项目，访问http://localhost:8888/

然后点击中文或者English就可以自由切换语言了。

[SpringBoot_Thymeleaf]: https://juejin.im/post/5aa8ce8ff265da23a404836f