SpringBoot-web端国际化显示

在一些开发中可能会涉及到某些页面需要进行国际化显示的业务，此时通过SpringBoot可以很好的实现。

参考页面如下：

页面国际化可分为两种形态：

1.根据浏览器语言进行设置。

2.根据用户选择进行设置。

虽然两种形态，但是同样的实现方法。

开发环境：

IDEA：2019.3.1

SpringBoot:2.2.5

步骤一：引入相应的静态资源及thymeleaf模板引擎。

为了演示方便，我将静态资源全部引入项目，并且引入了模板引擎thymeleaf，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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.seegot</groupId>
    <artifactId>spring-boot-web-restful-01</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-web-restful-01</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <thymeleaf.version>3.0.11.RELEASE</thymeleaf.version>
        <!-- 布局功能的支持程序 thymeleaf3主程序  layout2以上版本-->
        <!--thymeleaf2 layout1-->
        <thymeleaf-layout-dialect.version>2.1.1</thymeleaf-layout-dialect.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--引入jquery-->
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>jquery</artifactId>
            <version>3.4.1</version>
        </dependency>
        <!--引入bootstrap-->
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>bootstrap</artifactId>
            <version>4.4.1-1</version>
        </dependency>
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>chartjs</artifactId>
            <version>26962ce-1</version>
        </dependency>
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>popper.js</artifactId>
            <version>2.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

静态文件目录

步骤二：编写国际化配置文件，抽取页面需要的国际化消息

从页面中我们可以看出需要进行国际化的字眼为：请登录、用户名、密码、记住我、登录。抽取完毕后去项目中进行设置。

在resources文件夹下创建i18n文件用来存放抽取出来的国际化模版配置。右键i18n文件夹选择New 创建Resource Bundle，根据提示填写及新增相关信息。

resouce bundle base name 是配置文件生成后的开头名称，locales toadd是要添加的模板语言。点击“➕”号创建相应信息，我的之前创建过，所以左侧会有相应提示。

添加完成后点击OK

系统自动生成国际配置

双击打开Resource Budle 'login'下的任意一个配置文件，选择Resource Bundle模式，进入之后点击“➕”号新增配置项，将抽取出来的相关信息按照中英文进行新增。

第三步：创建我们的视图解析器，我在component下创建了一个MyLocaleResolver类

package com.seegot.component;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

/**
 * @program: spring-boot-web-restful-01
 * @description:
 * @author: PP Zhang
 * @create: 2020-03-26 14:34
 */

public class MyLocaleResolver implements LocaleResolver {
    @Override
    public Locale resolveLocale(HttpServletRequest httpServletRequest) {
        String language = httpServletRequest.getParameter("lan");
        Locale locale = Locale.getDefault();
        if (!StringUtils.isEmpty(language)){
            String[] split = language.split("_");
            locale = new Locale(split[0],split[1]);
        }
        return locale;
    }

    @Override
    public void setLocale(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Locale locale) {

    }
}

第四步：创建我们的拦截器，目的是为了拦截前端的请求，将我们配置好的国际化配置展示给前端。

package com.seegot.config;

import com.seegot.component.MyLocaleResolver;
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;

// 使用WebMvcConfigurer可以扩展springMVC功能
// ctrl + o 打开重写列表
// springboot2.x之前 需要继承 WebMvcConfigurerAdapter来重写相关方法。
// springboot2.x之后，需要实现WebMvcConfigurer接口来重写相关方法。
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/seegot").setViewName("success");
    }
    @Bean
    public  WebMvcConfigurer webMvcConfigurer(){
        WebMvcConfigurer configurer = new WebMvcConfigurer() {
            @Override
            public void addViewControllers(ViewControllerRegistry registry) {
                registry.addViewController("/").setViewName("login");
                registry.addViewController("/index").setViewName("login");
                registry.addViewController("/index.html").setViewName("login");
            }
        };
        return configurer;
    }
    @Bean
    public LocaleResolver localeResolver(){
        return  new MyLocaleResolver();
    }
}

我们利用自己创建的MyMvcConfig中的localeResolver()方法拦截并返回了我们自己的视图解析器。

第五步：静态页面配置

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
        <meta name="description" content="">
        <meta name="author" content="">
        <title>Signin Template for Bootstrap</title>
        <!-- Bootstrap core CSS -->
        <link href="asserts/css/bootstrap.min.css" th:href="@{/webjars/bootstrap/4.4.1-1/css/bootstrap.css}" rel="stylesheet">
        <!-- Custom styles for this template -->
        <link href="asserts/css/signin.css" th:href="@{/asserts/css/signin.css}" rel="stylesheet">
    </head>

    <body class="text-center">
        <form class="form-signin" action="dashboard.html">
            <img class="mb-4" src="asserts/img/bootstrap-solid.svg" th:src="@{/asserts/img/bootstrap-solid.svg}"  alt="" width="72" height="72">
            <h1 class="h3 mb-3 font-weight-normal" th:text="#{login-tip}">Please sign in</h1>
            <label class="sr-only" th:text="#{login-username}">Username</label>
            <input type="text" class="form-control" placeholder="Username" th:placeholder="#{login-username}" required="" autofocus="">
            <label class="sr-only" th:text="#{login-password}">Password</label>
            <input type="password" class="form-control" placeholder="Password" th:placeholder="#{login-password}" required="">
            <div class="checkbox mb-3">
                <label>
          <input type="checkbox" value="remember-me"  >[[#{login-remember}]]
        </label>
            </div>
            <button class="btn btn-lg btn-primary btn-block" type="submit" th:text="#{login-btn}">Sign in</button>
            <p class="mt-5 mb-3 text-muted">© 2017-2018</p>
            <a class="btn btn-sm" th:href="@{/index.html(lan='zh_CN')}">中文</a>
            <a class="btn btn-sm" th:href="@{/index.html(lan='en_US')}">English</a>
        </form>

    </body>

</html>

这里主要需要注意的是thymeleaf的模版的引用和语法的用法就可以了。

第六步：效果图

中文下

英文下