springboot配置i18n国际化

原创已于 2022-10-29 14:54:06 修改 · 2.1k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #i18n #国际化

于 2022-10-29 14:53:41 首次发布

springboot2 专栏收录该内容

6 篇文章

订阅专栏

本文介绍了使用Spring Boot实现i18n国际化的方法。无需引入其他jar包，只需配置即可。通过添加properties文件存储返回数据，在配置文件中添加i18n文件路径，编写配置类根据请求头设置返回语言，最后写工具类调用获取返回值，修改请求头即可切换语言。

springboot实现i18n国际化，无需引入其他jar包，springboot已经内置了，只需要配置即可。

国际化主要是根据不同的国际语言来决定返回数据的语言。

添加properties文件，作为返回数据的具体内容，key-value形式，key为代码中的返回值，value为实际返回值

messages.properties（默认，必须有，内容可以为空）

messages_zh_CN.properties（中文的数据）

messages_en_US.properties（英文的数据）

结构为：

在 application.properties/application.yml中添加i18n文件路径：

spring.messages.basename=i18n/messages （messages为文件前缀，这样写就行）

接下来就是写配置类来根据每次request请求header里面的Accept-Language来设置返回语言

import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.LocaleResolver;

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

@Configuration
public class LanguageLocalConfig implements LocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        Locale locale = Locale.CHINA;
        String language = request.getHeader("Accept-Language");
        if (StringUtils.isNotBlank(language)) {
            String[] splitLanguage = language.split("_");
            if (splitLanguage.length > 1) {
                locale = new Locale(splitLanguage[0], splitLanguage[1]);
            }
        }
        return locale;
    }

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

    @Bean
    public LocaleResolver localeResolver() {
        return new LanguageLocalConfig();
    }
}

最后写个工具类来调用，获取对应语言的返回值

import org.springframework.context.MessageSource;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.stereotype.Component;

@Component
public class MessageUtils {
    private static MessageSource messageSource;

    public MessageUtils(MessageSource messageSource) {
        MessageUtils.messageSource = messageSource;
    }

    public static String getMessage(String key) {
        try {
            return messageSource.getMessage(
                    key,
                    null,
                    LocaleContextHolder.getLocale());
        } catch (Exception e) {
            return key;
        }
    }
}

至此，i18n的配置就全部完成了，通过修改header里面的Accept-Language即可完成语言切换。

下面是测试截图