SpringBoot国际化教程

Posted on | In |

在这个教程中，我们将看看如何将国际化添加到Spring Boot应用程序。

LocaleResolver

为了让我们的应用程序能够确定当前正在使用的语言环境，我们需要在自己的WebMvcConfig类中添加一个LocaleResolver bean：

1
2
3
4
5
6
7
8
    @Bean
    public LocaleResolver localeResolver() {
        CookieLocaleResolver cookieLocaleResolver = new CookieLocaleResolver();
        cookieLocaleResolver.setDefaultLocale(Locale.US);
        cookieLocaleResolver.setCookieName("lang");
        cookieLocaleResolver.setCookieMaxAge(-1);
        return cookieLocaleResolver;
    }

LocaleResolver接口能根据会话，Cookie，Accept-Language头或固定值确定当前语言环境。 在我们的例子中，我们使用了基于Cookie的解析器CookieLocaleResolver并设置了一个值为US的默认语言环境。

LocaleChangeInterceptor

接下来，我们需要添加一个拦截器bean，该bean将根据Cookie中的lang的值切换到新的区域设置：

1
2
3
4
5
6
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
    LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
    lci.setParamName("lang");
    return lci;
}

这个bean需要被添加到应用程序的拦截器注册表中。

1
2
3
4
@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(localeChangeInterceptor());
}

定义MessageSources

默认情况下，Spring Boot应用程序将在src/main/resources文件夹中查找包含国际化键和值的消息文件。 缺省语言环境的文件名称为messages.properties，并且每个语言环境的文件将被命名为messages_XX.properties，其中XX是语言环境代码。 要进行本地化的值的键必须在每个文件中都是相同的，其值应与其对应的语言相适应。

如果某个键在某个请求的语言环境中不存在，则应用程序将回退到默认语言环境值。定义如下3个消息文件：

messages.properties

1
2
greeting=hello!
lang.change=language

messages_en_US.properties

1
2
greeting=Welcome!
lang.change=language

messages_zh_CN.properties

1
2
greeting=欢迎！
lang.change=语言

ReloadableResourceBundleMessageSource

使用MessageSource来管理国际资源文件

1
2
3
4
5
6
7
@Bean
public ReloadableResourceBundleMessageSource messageSource() {
    ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
    messageSource.setBasename("classpath:messages");
    messageSource.setDefaultEncoding("UTF-8");
    return messageSource;
}

测试

写一个controller和一个简单的HTML页面，来测试结果：

1
2
3
4
5
6
7
8
@Controller
public class TestController {

    @GetMapping("/test")
    public String test() {
        return "index";
    }
}

使用thymeleaf写一个简单网页

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
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
    <script src="https://cdn.bootcss.com/jquery/1.10.2/jquery.min.js"></script>
</head>
<body>
  <span th:text="#{lang.change}"></span>:
  <select id="locales">
      <option value=""></option>
      <option value="en_US" th:text="英语"></option>
      <option value="zh_CN" th:text="中文"></option>
  </select>
  <p th:text="#{greeting}"></p>
</body>

<script type="text/javascript">
    $(document).ready(function() {
        $("#locales").change(function () {
            var selectedOption = $('#locales').val();
            if (selectedOption != ''){
                window.location.replace('/user/test?lang=' + selectedOption);
            }
        });
    });
</script>
</html>

访问 http://localhost:8080/test ，切换语言就能看到效果了。