springBoot国际化的一种方式

引言：

        当我们的应用面向不同国家用户时，根据不同的locale返回不同的语言信息的国际化功能就显得有必要了。一般来说国际化主要表现在前端用户界面上，在现在前后端分离的背景下，前端页面的国际化交由前端代码独立完成；少部分表现在后端上，后端主要表现在一些固定的信息的国际化，比如异常提示信息。但无论是前端还是后端，所要制作国际化的部分都是程序中固定不变的、非用户填写信息。

 好了，废话少说，开整。

本次所实现的功能有两种：

1）根据key直接翻译

2）springValidator校验信息的国际化

3）javax的validator国际化（暂时不会）

功能实现的两个核心逻辑点：1、获取客户端语言 2、根据语言到不同的文件查找数据

一、根据key直接翻译

1、实现 LocaleResolver接口并重写resolveLocale方法

类似代码如下：

/**
 * TestLocaleResolver
 * <p>
 *  自定义localResolver解析客户端的locale。
 *  这里是采用类扫描的形式，也可以使用@Bean配置一个对象，但名字也必须是localResolver
 * </p>
 */
@Slf4j
@Component(value = "localeResolver")
public class TestLocaleResolver implements LocaleResolver {


    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        try {
            final String acceptLanguage = request.getHeader("Accept-Language2");
            if (StringUtils.isEmpty(acceptLanguage)){
                return Locale.getDefault();
            }
            String language = acceptLanguage.split(",")[0];
            final String[] split = language.split("-");

            return new Locale(split[0],split[1]);
        }catch (Exception e){
            log.error(e.getMessage());
            return Locale.getDefault();
        }

    }

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

    }
}

注意：为了避免springBoot自动配置localResolver，bean的名称必须是 localeResolver

之后就可以使用  LocaleContextHolder.getLocale()   获取到刚才设置的 Locale对象。

2、设置国家化资源文件

默认是类路径下的 messages.properties文件，可以通过spring提供的配置自定义文件位置，如下

#国际化文件位置
spring:
  messages:
    basename: i18n/message

然后在设置的类路径下书写不同语言的文件了，如下所示：

 message.properties是默认的文件，当客户端语言无法匹配时从这里获取。

message_zh_CN.properties

error.noUser=用户不存在!
error.params=参数{0}不能为空!
userConfig.module=所属模块不能为空!

message_en_US.properties

error.noUser=user not exist!
error.params=param {0} can't be null!
userConfig.module=belong module can't be null!

有Locale了，有国际化资源文件了，怎么根据语言获取配置的数据呢？

        如果要自己写的话可能就要写个方法，接收语言和key参数，然后判断从不同的语言文件中获取对应的变量数据。对于.properties文件java也提供Properties类方便读写，为了性能还要把.properties文件的内容读取到内存中。

        但是spring也想到了这一点，给我们提供了一个 MessageSource接口(在I18n中其实现类是ResourceBundleMessageSource，并且实现了其自动配置，我们可以直接注入MessageSource然后调用他的方法即可，例如：

public String getMessage(String key){
    return messageSource.getMessage(key,null,LocaleContextHolder.getLocale());
}

2、springValidator校验信息的国际化

1、设置用来校验的validator

    @Autowired
    private MessageSource messageSource;

    /**
     * spring用来国际化的validator
     * ps：javax的validator
     * @return
     */
    @Bean
    public Validator validator() {
        LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
        // 设置validator的资源文件管理者
        validator.setValidationMessageSource(messageSource);
        return validator;
    }

2、bean的校验message设置成变量的形式

@NotEmpty(message = "{userConfig.module}",groups = {AddCheck.class)
@TableField(value = "module")
private String module;

3、controller入参添加spring的@Validated注解

 @PostMapping("/test2")
    public ResultVO<Object> test2(@Validated(AddCheck.class) PersonManage personManage){

        return Result.success();
    }

工作过程是：

        当该方法被执行时，springMVC会执行上面的TestLocaleResolver 的resolveLocale方法解析出当前请求的Locale，然后根据bean属性的message的变量名，调用 ResourceBundleMessageSource 的方法从对应的语言文件中解析出变量值，然后抛出一个 MethodArgumentNotValidException异常，我们可以用SpringMVC的异常处理器，解析异常并按照统一的格式返回，异常处理器如下：

   /**
     * 处理bean的验证异常信息
     */
    @ExceptionHandler({
            BindException.class,
            MethodArgumentNotValidException.class,
    })
    public ResultVO<Map<String, String>> handleBindException(Exception ex) {
        BindingResult result = null;
        if (ex instanceof BindException){
            BindException exception = (BindException) ex;
            result = exception.getBindingResult();
        }else {
            MethodArgumentNotValidException exception = (MethodArgumentNotValidException) ex;
            result = exception.getBindingResult();
        }

        Map<String, String> errorInfoMap= new HashMap<>();
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            for (ObjectError error : errors) {
                FieldError fieldError = (FieldError) error;
                errorInfoMap.put(fieldError.getField(), fieldError.getDefaultMessage());
            }
        }
        return Result.error(ErrorStatus.PARAM_VALIDATE_FAIL, errorInfoMap);
    }

总结：

        涉及的东西有SpringMVC的localResolver组件、MessageSource接口、spring的Validator接口，总之搞清楚所使用的的框架还是很有用的，搞清楚之后，这些代码就是你的小兵了。