Springboot简易实战-页面国际化

Springboot简易实战-页面国际化

二、页面国际化

页面国际化可以让页面的语言自由切换成各国语言；

多语言配置：

1、保证idea的配置(setting-Editor-FileEncodings)为utf-8:

2、在resources包下创建一个i18n目录，存放国际化配置文件,目录下创建三个配置文件：login.properties(默认)，login_en_US.properties(英文),login_zh_CN.properties（中文）;

3、在三个文件中分别配置首页的文本内容(可以点击配置文件下方的” Resource Bundle “进行可视化配置，2021.2版本需要添加一个Resource Bundlle Editor插件！！）：

login.properties：

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

login_en_US.properties：

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

login_zh_CN.properties：

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

4、SpringBoot对国际化的自动配置，这里涉及一个类：MessageSourceAutoConfiguration；

里面有一个方法，这里发现SpringBoot已经自动配置好了管理我们国际化资源文件的组件 ResourceBundleMessageSource：

// 获取 properties 传递过来的值进行判断
@Bean
public MessageSource messageSource(MessageSourceProperties properties) {
    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
    if (StringUtils.hasText(properties.getBasename())) {
        // 设置国际化文件的基础名（去掉语言国家代码的）
        messageSource.setBasenames(
            StringUtils.commaDelimitedListToStringArray(
                                       StringUtils.trimAllWhitespace(properties.getBasename())));
    }
    if (properties.getEncoding() != null) {
        messageSource.setDefaultEncoding(properties.getEncoding().name());
    }
    messageSource.setFallbackToSystemLocale(properties.isFallbackToSystemLocale());
    Duration cacheDuration = properties.getCacheDuration();
    if (cacheDuration != null) {
        messageSource.setCacheMillis(cacheDuration.toMillis());
    }
    messageSource.setAlwaysUseMessageFormat(properties.isAlwaysUseMessageFormat());
    messageSource.setUseCodeAsDefaultMessage(properties.isUseCodeAsDefaultMessage());
    return messageSource;
}

我们的配置文件是放在i18n目录下，我们在application.properties中配置一下真实路径：

# 配置文件的真实目录
spring.messages.basename=i18n.login

5、前端页面获取国际化的值，message取值操作为：#{…}：

<form class="form-signin" action="dashboard.html">
			<img class="mb-4" src="/img/bootstrap-solid.svg" alt="" width="72" height="72">
    
    
    		<!--这里使用th:text="#{login.tip}"取到国际化的值-->
			<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" th:placeholder="#{login.username}" required="" autofocus="">
			<label class="sr-only" th:text="#{login.password}">Password</label>
			<input type="password" class="form-control" 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(l='zh_CN')}">中文</a>
			<a class="btn btn-sm" th:href="@{/index(l='en_US')}">English</a>
		</form>

启动项目可以看到页面的文本已经设置为中文了！！

6、配置国际化解析

在Spring中有一个国际化的Locale （区域信息对象）；里面有一个叫做LocaleResolver （获取区域信息对象）的解析器！

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "spring.mvc", name = "locale")
public LocaleResolver localeResolver() {
    // 容器中没有就自己配，有的话就用用户配置的
    if (this.mvcProperties.getLocaleResolver() == WebMvcProperties.LocaleResolver.FIXED) {
        return new FixedLocaleResolver(this.mvcProperties.getLocale());
    }
    // 接收头国际化分解
    AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver();
    localeResolver.setDefaultLocale(this.mvcProperties.getLocale());
    return localeResolver;
}

AcceptHeaderLocaleResolver 这个类中有一个方法

public Locale resolveLocale(HttpServletRequest request) {
    Locale defaultLocale = this.getDefaultLocale();
    // 默认的就是根据请求头带来的区域信息获取Locale进行国际化
    if (defaultLocale != null && request.getHeader("Accept-Language") == null) {
        return defaultLocale;
    } else {
        Locale requestLocale = request.getLocale();
        List<Locale> supportedLocales = this.getSupportedLocales();
        if (!supportedLocales.isEmpty() && !supportedLocales.contains(requestLocale)) {
            Locale supportedLocale = this.findSupportedLocale(request, supportedLocales);
            if (supportedLocale != null) {
                return supportedLocale;
            } else {
                return defaultLocale != null ? defaultLocale : requestLocale;
            }
        } else {
            return requestLocale;
        }
    }
}

那假如我们现在想点击链接让我们的国际化资源生效，就需要让我们自己的Locale生效！

我们去自己写一个自己的LocaleResolver，可以在链接上携带区域信息！

修改前端页面的跳转按钮：

<a class="btn btn-sm" th:href="@{/index(l='zh_CN')}">中文</a>
<a class="btn btn-sm" th:href="@{/index(l='en_US')}">English</a>

在项目下创建一个config包，在包下创建我们的LocaleResolver组件类(实现LocaleResolver接口）：

public class MyLocaleResolver implements LocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        //获取请求中的语言参数
        String language = request.getParameter("l");
        System.out.println("language:"+language);
        //如果没有就使用默认
        Locale locale = Locale.getDefault();
        //如果请求的链接携带了国际化参数
        if(!StringUtils.isEmpty(language)){
            //zh_CH,通过"_"分割
            String[] split = language.split("_");
            //语言，国家
            locale = new Locale(split[0],split[1]);
        }
        return locale;
    }

    @Override
    public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {

    }
}

在config包下的MyMvcConfig类中配置组件：

@Bean
//方法名必须为localeResolver；因为@Bean会默认注入一个id=方法名的对象
public LocaleResolver localeResolver(){
    return new MyLocaleResolver();
}

启动项目,点击按钮，语言切换成功！！