i18n 国际化 多语言 SpringBoot 整合

1.项目结构新增国际化资源文件

在resources文件下新建i18n文件，并新建国际化资源文件。

点击新增Resource Bundle文件。

在Resource bundle base name处填写国际化文件的名称，此处填“messages”。

并点击中间偏右的“+”号，新增国际化语言，此处新增两个语言“zh_CN”，“en_US”。

添加好后，结构如图:

分别在两个文件中添加数据

zh_CN

lin.test = ceshi
lin.demo = xiaoyang

en_US

lin.test = test
lin.demo = demo

2.application.yml添加配置文件

spring:
  messages:
    basename: i18n/messages

注意：此处的basename填的messages是填Resource bundle base name时填的值。

添加配置类

MyLocaleResolver.class

package com.joker.cloud.linserver.conf.i18n;

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

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

/**
 * MyLocaleResolver
 *
 * @author joker
 * @version 1.0
 * 2022/8/30 13:54
 **/

public class MyLocaleResolver implements LocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest httpServletRequest) {
        //获取前端传来的数据
        String language = httpServletRequest.getHeader("lang");
        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) {

    }
}

LocaleConfig.class

package com.joker.cloud.linserver.conf.i18n;

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.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;


/**
 * LocaleConfig
 *
 * @author joker
 * @version 1.0
 * 2022/8/30 9:51
 **/
@Configuration
public class LocaleConfig implements WebMvcConfigurer {

    /**
     * 默认解析器 其中locale表示默认语言,当请求中未包含语种信息，则设置默认语种
     * 当前默认为CHINA,zh_CN
     */
    @Bean
    public LocaleResolver localeResolver() {
        return new MyLocaleResolver();
    }


    /**
     * 默认拦截器 其中lang表示切换语言的参数名
     * 拦截请求，获取请求参数lang种包含的语种信息并重新注册语种信息
     */
    @Bean
    public LocaleChangeInterceptor localeChangeInterceptor() {
        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
        // 参数名
        lci.setParamName("lang");
        return lci;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(localeChangeInterceptor());
    }


}

添加i18n工具类

MessageUtils.class

package com.joker.cloud.linserver.conf.i18n;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.MessageSource;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.stereotype.Component;

import java.util.Locale;

/**
 * MessageUtils
 *
 * @author joker
 * @version 1.0
 * 2022/8/30 9:46
 **/
@Slf4j
@Component
public class MessageUtils {

    private static MessageSource messageSource;


    public MessageUtils(MessageSource messageSource) {
        if (log.isInfoEnabled()) {
            log.info("MessageUtils construction success");
        }
        MessageUtils.messageSource = messageSource;
    }

    /**
     * 获取单个国际化翻译值
     */
    public static String get(String msgKey) {
        Locale locale = LocaleContextHolder.getLocale();
        try {
            return messageSource.getMessage(msgKey, null, locale);
        } catch (Exception e) {
            log.error("msgKey:{},locale:{},MessageUtils.get Exception:{}", msgKey, locale, e.getMessage());
            return messageSource.getMessage(msgKey, null, Locale.US);
        }
    }

    /**
     * 获取指定语言的单个国际化翻译值
     */
    public static String get(String msgKey, String language) {
        try {
            //线上直接new Locale(language),会是小写en_us,调用本地方法读取资源的时候会识别不到，因为配置文件是大写的后缀en_US
            //所以这里拆分，然后拼装为大写的Locale的en_US
            String[] s = StringUtils.split(language, "_");
            Locale locale = new Locale(s[0], s[1]);
            if (log.isInfoEnabled()) {
                log.info("get,msgKey:{},language:{},locale:{}", msgKey, language, locale);
            }
            return messageSource.getMessage(msgKey, null, locale);
        } catch (Exception e) {
            log.error("msgKey:{},language:{},MessageUtils.get Exception:{}", msgKey, language, e.getMessage());
            return messageSource.getMessage(msgKey, null, Locale.US);
        }
    }


}

3.接口测试

package com.joker.cloud.linserver.controller;

import com.joker.cloud.linserver.conf.i18n.MessageUtils;
import com.joker.common.message.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * I18NController
 *
 * @author joker
 * @version 1.0
 * 2022/8/30 9:49
 **/
@Slf4j
@RestController
@CrossOrigin
@Api(tags = "i18n国际化")
public class I18NController {

    @ApiOperation("i18n国际化测试")
    @GetMapping("/i18nTest")
    public Result<String> i18nTest(){
        String s = MessageUtils.get("lin.test");
        log.info("s:"+s);
        return Result.success(s);
    }
}

因为此处截取的是请求头的lang参数，那么我们在请求的时候添加一个lang参数。

lang 传入 en_US

lang 传入 zh_CN

场景，可以根据业务空间系统配置语言不同，返回不同语言的响应，如多语言邮件，多语言短信，以及提示等