Spring Boot 页面国际化

本文最后更新于：2024年9月8日 晚上

Spring Boot 页面国际化

编写配置文件

  1. 在resources资源文件下新建一个i18n目录，存放国际化配置文件。
  2. 建立一个login.properties文件和一个login_zh_CN.properties文件：IDEA自动识别了我们要做国际化操作，将多个配置文件绑定到一起。
image-20201117164343291
  1. 可以直接邮件Resource Bundle新建其他语言的配置文件。
image-20201117164407986
  1. 通过Resource Bundle，点击+号可以直接添加属性了。
    • 新建一个login.tip，可以看到边上有三个文件框可以输入，填写页面属性的多语言内容。
image-20201117164501630
  1. 查看自动生成的配置文件。
    • login.properties：默认。
1
2
3
4
5
login.btn=登录。
login.password=密码。
login.remember=记住我。
login.tip=请登录。
login.username=用户名。
  • login_en_US.properties：英文/美国。
1
2
3
4
5
login.btn=Sign in
login.password=Password
login.remember=Remember me
login.tip=Please sign in
login.username=Username
  • login_zh_CN.properties：中文/中国。
1
2
3
4
5
login.btn=登录。
login.password=密码。
login.remember=记住我。
login.tip=请登录。
login.username=用户名。

注册自定义国际化配置文件

分析源码

  • SpringBoot对国际化的自动配置涉及到一个类：MessageSourceAutoConfiguration
  • 该类中有如下一个方法，发现SpringBoot已经自动配置好了管理国际化资源文件的组件ResourceBundleMessageSource
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@Bean
@ConfigurationProperties(prefix = "spring.messages")
public MessageSourceProperties messageSourceProperties() {
    return new MessageSourceProperties();
}

@Bean
public MessageSource messageSource(MessageSourceProperties properties) {
    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
    if (StringUtils.hasText(properties.getBasename())) {
        // 设置国际化文件的基础名（去掉语言国家代码的）
        messageSource.setBasenames(
            StringUtils.commaDelimitedListToStringArray(
                //getBeasename方法获得MessageSourceProperties类中的basename属性。
                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;
}

注册国际化配置文件

  • 在主配置文件中指定自定义国际化配置文件的位置。
1
spring.messages.basename=i18n.login
  • 测试。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<form class="form-signin" th:action="@{/user/login}">
    <h1 class="h3 mb-3 font-weight-normal" th:text="#{login.tip}">Please sign in</h1>
    <label class="sr-only">Username</label>
    <input type="text" class="form-control" name="username" th:placeholder="#{login.username}" required="" autofocus="">
    <label class="sr-only">Password</label>
    <input type="password" class="form-control" name="password" th:placeholder="#{login.password}" required="">
    <div class="checkbox mb-3">
        <label>
            <input type="checkbox" value="remember-me" th:text="#{login.remember}">
        </label>
    </div>
    <button class="btn btn-lg btn-primary btn-block" type="submit" th:text="#{login.btn}">Sign in</button>
    <!--切换语言环境-->
    <a class="btn btn-sm" th:href="@{/index.html(l='zh_CN')}">中文</a>
    <a class="btn btn-sm" th:href="@{/index.html(l='en_US')}">English</a>
</form>
  • 此时，页面中用表达式显示的文本会随浏览器的语言环境变化。

手动切换语言环境

分析源码

  • 在Spring中有一个国际化的Locale（区域信息对象）,Locale中有一个叫做LocaleResolver （获取区域信息对象）的解析器。
  • 在WebMvcAutoConfiguration中有如下方法。
1
2
3
4
5
6
7
8
9
10
11
12
13
@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类中有一个方法。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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;
        }
    }
}
  • 假如现在希望点击链接使自定义的国际化资源生效，就需要自定义LocaleResolver

自定义LocaleResolver

  • 通过链接上携带区域信息，切换语言环境。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class MyLocaleResolver implements LocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest request) {

        String language = request.getParameter("l");
        // 如果没有获取到就使用系统默认的。
        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) {

    }
}
  • 将自定义LocaleResolver注册到配置类中。
1
2
3
4
5
6
7
8
@Configuration
public class DemoMvcConfig implements WebMvcConfigurer {
    // 自定义的国际化组件。
    @Bean
    public LocaleResolver localeResolver() {
        return new DemoLocaleResolver();
    }
}
  • 测试。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<form class="form-signin" th:action="@{/user/login}">
    <h1 class="h3 mb-3 font-weight-normal" th:text="#{login.tip}">Please sign in</h1>
    <label class="sr-only">Username</label>
    <input type="text" class="form-control" name="username" th:placeholder="#{login.username}" required="" autofocus="">
    <label class="sr-only">Password</label>
    <input type="password" class="form-control" name="password" th:placeholder="#{login.password}" required="">
    <div class="checkbox mb-3">
        <label>
            <input type="checkbox" value="remember-me" th:text="#{login.remember}">
        </label>
    </div>
    <button class="btn btn-lg btn-primary btn-block" type="submit" th:text="#{login.btn}">Sign in</button>
    <!--切换语言环境-->
    <a class="btn btn-sm" th:href="@{/index.html(l='zh_CN')}">中文</a>
    <a class="btn btn-sm" th:href="@{/index.html(l='en_US')}">English</a>
</form>
Software Language Java SpringFramework 实例

本博客所有文章除特别声明外，均采用 CC BY-SA 4.0 协议 ，转载请注明出处！