Spring国际化和Validation详解

支佩珍

目录

• SpringBoot国际化和Validation融合
• 场景
• 实现原理
• 国际化配置‌
• ‌Validation配置‌
• 示例
• 引入依赖
• 国际化配置文件
• 配置MessageSource‌
• 配置LocalValidatorFactoryBean‌
• 使用校验
• 自定义校验
• Controller层异常处理
• 内部方法校验
• 注意点
• 代码中国际化使用
• Locale获取
• 总结

SpringBoot国际化和Validation融合

场景

在应用交互时，可能需要根据客户端得语言来返回不同的语言数据。

前端通过参数、请求头等往后端传入locale相关得参数，后端获取参数，根据不同得locale来获取不同得语言得文本信息返回给前端。

实现原理

SpringBoot支持国际化和Validation，主要通过MessageSource接口和Validator实现。

国际化配置‌

• 编写国际化配置文件，如
  1. messages_en_US.properties

  复制代码
  和
  1. messages_zh_CN.properties

  复制代码
  ，并置于
  1. resources/i18n

  复制代码
  目录下。
• 配置
  1. application.yml

  复制代码
  或
  1. application.properties

  复制代码
  以指定国际化文件的位置，例如
  1. spring.messages.basename=i18n/messages

  复制代码
  。
• 配置
  1. LocaleResolver

  复制代码
  以解析当前请求的locale，常用的实现是
  1. AcceptHeaderLocaleResolver

  复制代码
  ，它通过请求头
  1. accept-language

  复制代码
  获取当前的locale。

‌Validation配置‌

引入

1. spring-boot-starter-validation

复制代码

依赖以支持Validation功能

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-validation</artifactId>
4. </dependency>

复制代码

配置

1. LocalValidatorFactoryBean

复制代码

以使用国际化的校验消息，需注入

1. MessageSource

复制代码

示例

引入依赖

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-validation</artifactId>
4. </dependency>
6. <dependency>
7. <groupId>org.springframework.boot</groupId>
8. <artifactId>spring-boot-starter-web</artifactId>
9. </dependency>

复制代码

国际化配置文件

在

1. src/main/resources/i18n

复制代码

目录下创建两个文件：

1. messages_en_US.properties

复制代码

和

1. messages_zh_CN.properties

复制代码

。

1. #messages_en_US.properties
2. welcome.message=Welcome to our website!
4. #messages_zh_CN.properties
5. welcome.message=欢迎来到我们的网站！

复制代码

配置MessageSource‌

在Spring Boot的配置文件中（

1. application.properties

复制代码

或

1. application.yml

复制代码

），配置

1. MessageSource

复制代码

以指定国际化文件的位置。

如果你打算使用Validation的默认国际化文件，你实际上不需要为Validation单独指定文件，因为

1. LocalValidatorFactoryBean

复制代码

会自动查找

1. ValidationMessages.properties

复制代码

。

但是，你可以配置自己的国际化文件，并让

1. MessageSource

复制代码

同时服务于你的应用消息和Validation消息。

1. # 国际化文件被放置在src/main/resources/i18n目录下，并以messages为前缀
2. spring.messages.basename=i18n/messages,org.hibernate.validator.ValidationMessages
3. spring.messages.encoding=utf-8

复制代码

注意：上面的配置假设你的自定义消息文件位于

1. i18n/messages.properties

复制代码

，而Validation的默认消息文件是

1. org.hibernate.validator.ValidationMessages.properties

复制代码

。

实际上,

1. ValidationMessages.properties

复制代码

文件位于Hibernate Validator的jar包中，所以你不需要显式地将它包含在你的资源目录中。Spring Boot会自动从classpath中加载它。

配置LocalValidatorFactoryBean‌

在你的配置类中，创建一个

1. LocalValidatorFactoryBean

复制代码

的bean，并将

1. MessageSource

复制代码

注入到它中。

这样，

1. LocalValidatorFactoryBean

复制代码

就会使用Spring的

1. MessageSource

复制代码

来解析校验消息。

1. import org.hibernate.validator.HibernateValidator;
2. import org.springframework.context.MessageSource;
3. import org.springframework.context.annotation.Bean;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
7. import java.util.Properties;
9. @Configuration
10. public class ValidateConfig {
12. @Bean
13. public LocalValidatorFactoryBean validatorFactoryBean(MessageSource messageSource) {
14. LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
15. factoryBean.setValidationMessageSource(messageSource);
16. // 设置使用 HibernateValidator 校验器
17. factoryBean.setProviderClass(HibernateValidator.class);
18. // 设置 快速异常返回 只要有一个校验错误就立即返回失败，其他参数不在校验
19. Properties properties = new Properties();
20. properties.setProperty("hibernate.validator.fail_fast", "true");
21. factoryBean.setValidationProperties(properties);
22. // 加载配置
23. factoryBean.afterPropertiesSet();
24. return factoryBean;
25. }
26. }

复制代码

使用校验

1. import javax.validation.constraints.NotNull;
3. public class MyModel {
5. @NotNull(message = "{not.null.message}")
6. private String field;
8. // getters and setters
9. }

复制代码

1. messages.properties

复制代码

文件中，你可以添加

1. not.null.message=This field cannot be null.

复制代码

而在Hibernate Validator的

1. ValidationMessages.properties

复制代码

文件中，已经包含了默认的校验消息，如

1. {javax.validation.constraints.NotNull.message}

复制代码

的值。

自定义校验

• 定义约束注解:创建一个注解，用
  1. @Constraint

  复制代码
  标记，并定义
  1. message

  复制代码
  、
  1. groups

  复制代码
  和
  1. payload

  复制代码
  属性

1. import javax.validation.Constraint;
2. import javax.validation.Payload;
3. import java.lang.annotation.*;
6. @Documented
7. @Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.TYPE})
8. @Retention(RetentionPolicy.RUNTIME)
9. @Constraint(validatedBy = MyValidateContent.class)
10. public @interface MyValidate {
11. String message() default "";
12. Class<?>[] groups() default {};
13. Class<? extends Payload>[] payload() default {};
14. }

复制代码

• 实现约束验证器**:创建一个实现了
  1. ConstraintValidator

  复制代码
  接口的类，并重写
  1. isValid

  复制代码
  方法
• 在
  1. isValid

  复制代码
  方法中使用
  1. ConstraintValidatorContext

  复制代码
  **‌：如果验证失败，使用
  1. ConstraintValidatorContext

  复制代码
  的
  1. buildConstraintViolationWithTemplate

  复制代码
  方法来构建
  1. ConstraintViolation

  复制代码

1. import com.example.dto.ParamVo;
3. import javax.validation.ConstraintValidator;
4. import javax.validation.ConstraintValidatorContext;
7. public class MyValidateContent implements ConstraintValidator<MyValidate, ParamVo> {
8. @Override
9. public void initialize(MyConstraint constraintAnnotation) {
10. // 初始化代码（如果需要的话）
11. }
12. @Override
13. public boolean isValid(ParamVo paramVo, ConstraintValidatorContext constraintValidatorContext) {
14. if ("N".equals(paramVo.getSex())) {
15. if (paramVo.getAge() < 18) {
16. buildMessage(constraintValidatorContext, "template1");
17. return false;
18. }
19. } else {
20. if (paramVo.getAge() < 20) {
21. buildMessage(constraintValidatorContext, "template2");
22. return false;
23. }
24. }
25. return true;
26. }
28. private void buildMessage(ConstraintValidatorContext context, String key) {
29. String template = ('{'+key+'}').intern();
30. context.buildConstraintViolationWithTemplate(template)
31. .addConstraintViolation();
32. }
33. }

复制代码

在这个例子中，如果

1. sex

复制代码

是

1. N

复制代码

并且

1. age

复制代码

小于

1. 18

复制代码

，验证器将使用

1. ConstraintValidatorContext

复制代码

来构建一个带有错误消息的

1. ConstraintViolation

复制代码

。

消息模板

1. "{template1}"

复制代码

将会在验证失败时被解析，并替换为你在

1. MyValidate

复制代码

注解中定义的默认消息或你在

1. messages.properties

复制代码

文件中定义的国际化消息。

确保你的

1. MyValidate

复制代码

注解定义了一个

1. message

复制代码

属性，并且你在

1. messages.properties

复制代码

文件中有一个对应的条目例如：

1. template1=男性要大于18
2. template2=女性要大于20

复制代码

1. import com.example.validate.MyValidate;
2. import lombok.Getter;
3. import lombok.Setter;
4. import org.hibernate.validator.constraints.Length;
6. import javax.validation.constraints.NotBlank;
7. import javax.validation.constraints.NotNull;
9. @Getter
10. @Setter
11. @MyValidate
12. public class ParamVo {
13. @NotBlank(message = "{javax.validation.constraints.NotNull.message}")
14. private String sex;
15. @NotNull(message = "age 不能为空")
16. private Integer age;
17. @NotBlank(message = "{name.not.null}")
18. @Length(max = 3,message = "{name.length.max}")
19. private String name;
20. }

复制代码

Controller层异常处理

1. import org.springframework.http.HttpStatus;
2. import org.springframework.http.ResponseEntity;
3. import org.springframework.validation.BindingResult;
4. import org.springframework.validation.FieldError;
5. import org.springframework.web.bind.MethodArgumentNotValidException;
6. import org.springframework.web.bind.annotation.ExceptionHandler;
7. import org.springframework.web.bind.annotation.RestControllerAdvice;
9. import java.util.HashMap;
10. import java.util.Map;
13. @RestControllerAdvice
14. public class GlobalException {
15. @ExceptionHandler(MethodArgumentNotValidException.class)
16. public ResponseEntity<Object> handleValidationExceptions(MethodArgumentNotValidException ex) {
17. Map<String, String> errors = new HashMap<>();
18. BindingResult result = ex.getBindingResult();
19. for (FieldError error : result.getFieldErrors()) {
20. errors.put(error.getField(), error.getDefaultMessage());
21. }
22. // 这里可以根据实际需求定制返回的错误信息结构
23. Map<String, Object> response = new HashMap<>();
24. response.put("status", HttpStatus.BAD_REQUEST.value());
25. response.put("errors", errors);
26. return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
27. }
28. }

复制代码

内部方法校验

1. import org.springframework.validation.annotation.Validated;
2. import javax.validation.constraints.Min;
3. import javax.validation.constraints.NotNull;
4. //@Validated
5. @Validated
6. public interface ServiceIntface {
7. //校验返回值，校验入参
8. @NotNull Object hello(@NotNull @Min(10) Integer id, @NotNull String name);
9. }

复制代码

1. import lombok.extern.slf4j.Slf4j;
2. import org.springframework.stereotype.Service;
4. @Slf4j
5. @Service
6. public class ServiceImpl implements ServiceIntface {
7. @Override
8. public Object hello(Integer id, String name) {
9. return null;
10. }
11. }

复制代码

1. import org.springframework.http.HttpStatus;
2. import org.springframework.http.ResponseEntity;
3. import org.springframework.web.bind.annotation.ExceptionHandler;
4. import org.springframework.web.bind.annotation.RestControllerAdvice;
6. import javax.validation.ConstraintViolation;
7. import javax.validation.ConstraintViolationException;
8. import java.util.HashMap;
9. import java.util.Map;
10. import java.util.Set;
13. @RestControllerAdvice
14. public class GlobalException {
16. @ExceptionHandler(ConstraintViolationException.class)
17. public ResponseEntity<Object> handleValidationExceptions(ConstraintViolationException ex) {
18. Map<String, String> errors = new HashMap<>();
19. Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
20. for (ConstraintViolation<?> constraintViolation : constraintViolations) {
21. String key = constraintViolation.getPropertyPath().toString();
22. String message = constraintViolation.getMessage();
23. errors.put(key, message);
24. }
26. // 这里可以根据实际需求定制返回的错误信息结构
27. Map<String, Object> response = new HashMap<>();
28. response.put("status", HttpStatus.BAD_REQUEST.value());
29. response.put("errors", errors);
30. return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
31. }
32. }

复制代码

• 校验写在接口上的，抛出异常
  1. javax.validation.ConstraintViolationException

  复制代码
• 校验写在具体实现，抛出异常
  1. javax.validation.ConstraintDeclarationException

  复制代码

注意点

代码中国际化使用

代码里响应，手动获取使用MessageSource的getMessage方法即可，也就是spring容器中的getMessage()

1. # messages_en_US.properties
2. welcome.message=Welcome to our website!
4. # messages_zh_CN.properties
5. welcome.message=欢迎来到我们的网站！
7. #定义消息，并使用占位符{0}、{1}等表示参数位置
8. #welcome.message=欢迎{0}来到{1}

复制代码

1. //创建一个配置类来配置LocaleResolver，以便根据请求解析当前的语言环境：
2. import org.springframework.context.annotation.Bean;
3. import org.springframework.context.annotation.Configuration;
4. import org.springframework.web.servlet.LocaleResolver;
5. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
6. import org.springframework.web.servlet.i18n.SessionLocaleResolver;
8. import java.util.Locale;
10. @Configuration
11. public class WebConfig implements WebMvcConfigurer {
13. @Bean
14. public LocaleResolver localeResolver() {
15. SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver();
16. sessionLocaleResolver.setDefaultLocale(Locale.US); // 设置默认语言
17. return sessionLocaleResolver;
18. }
19. }

复制代码

1. //创建一个控制器来使用国际化的消息
2. import org.springframework.beans.factory.annotation.Autowired;
3. import org.springframework.context.MessageSource;
4. import org.springframework.web.bind.annotation.GetMapping;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RestController;
8. import javax.servlet.http.HttpServletRequest;
9. import java.util.Locale;
11. @RestController
12. @RequestMapping("/hello")
13. public class HelloController {
15. @Autowired
16. private MessageSource messageSource;
18. @GetMapping
19. public String hello(HttpServletRequest request) {
20. Locale locale = (Locale) request.getAttribute(org.springframework.web.servlet.LocaleResolver.LOCALE_RESOLVER_ATTRIBUTE);
21. //messageSource.getMessage("welcome.message", new Object[]{"张三", "中国"}, Locale.CHINA)。
22. return messageSource.getMessage("welcome.message", null, locale);
23. }
24. }

复制代码

Locale获取

默认情况下spring注册的messageSource对象为ResourceBundleMessageSource，会读取

1. spring.message

复制代码

配置。

请求中Locale的获取是通过

1. LocaleResolver

复制代码

进行处理，默认是

1. AcceptHeaderLocaleResolver

复制代码

，通过

1. WebMvcAutoConfiguration

复制代码

注入，从

1. Accept-Language

复制代码

请求头中获取locale信息。

此时前端可以在不同语言环境时传入不同的请求头Accept-Language即可达到切换语言的效果

1. Accept-Language: en-Us
2. Accept-Language: zh-CN

复制代码

默认情况下前端请求中的不用处理，如果约定其他信息传递Local，使用自定义的I18nLocaleResolver替换默认的

1. AcceptHeaderLocaleResolver

复制代码

，重写

1. resolveLocale

复制代码

方法就可以自定义Locale的解析逻辑。

1. import cn.hutool.core.util.StrUtil;
2. import org.springframework.context.annotation.Bean;
3. import org.springframework.context.annotation.Configuration;
4. import org.springframework.web.servlet.LocaleResolver;
6. import javax.servlet.http.HttpServletRequest;
7. import javax.servlet.http.HttpServletResponse;
8. import java.util.Locale;
10. /**
11. *
12. */
13. @Configuration
14. public class I18nConfig {
15. @Bean
16. public LocaleResolver localeResolver() {
17. return new I18nLocaleResolver();
18. }
20. /**
21. * 获取请求头国际化信息
22. * 使用自定义的I18nLocaleResolver替换默认的AcceptHeaderLocaleResolver，重写resolveLocale方法就可以自定义Locale的解析逻辑。
23. *
24. * 自定义后使用content-language传Locale信息，使用_划分语言个地区。
25. * content-language: en_US
26. * content-language: zh_CN
27. */
28. static class I18nLocaleResolver implements LocaleResolver {
30. @Override
31. public Locale resolveLocale(HttpServletRequest httpServletRequest) {
32. String language = httpServletRequest.getHeader("content-language");
33. Locale locale = Locale.getDefault();
34. if (StrUtil.isNotBlank(language)) {
35. String[] split = language.split("_");
36. locale = new Locale(split[0], split[1]);
37. }
38. return locale;
39. }
41. @Override
42. public void setLocale(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Locale locale) {
44. }
45. }
46. }

复制代码

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持晓枫资讯。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

柠檬薰衣草鸵

路过，支持一下

123457108

顶顶更健康！！！