SpringBoot参数校验与国际化使用教程
作者:weisen 发布时间:2021-11-13 15:52:21
一、参数校验
springboot 使用校验框架validation校验方法的入参
SpringBoot的Web组件内部集成了hibernate-validator,所以我们这里并不需要额外的为验证再导入其他的包。
1、bean 中添加标签
标签需要加在属性上,@NotEmpty标签String的参数不能为空
@Data
public class DemoDto {
@NotEmpty(message = "名称不能为空")
private String name;
@Length(min = 5, max = 25, message = "key的长度为5-25")
private String key;
@Pattern(regexp = "[012]", message = "无效的状态标志")
private String state;
}
2、Controller中开启验证
在Controller 中 请求参数上添加@Validated 标签开启验证
@RequestMapping("test")
public String test(@Valid @RequestBody DemoDto dto){
System.out.println("test....................");
return "test.........................";
}
测试返回结果
{
"timestamp": "2020-01-14 13:30:03",
"status": 400,
"error": "Bad Request",
"errors": [
{
"codes": [
"Length.demoDto.key",
"Length.key",
"Length.java.lang.String",
"Length"
],
"arguments": [
{
"codes": [
"demoDto.key",
"key"
],
"arguments": null,
"defaultMessage": "key",
"code": "key"
},
25,
5
],
"defaultMessage": "key的长度为5-25",
"objectName": "demoDto",
"field": "key",
"rejectedValue": "11",
"bindingFailure": false,
"code": "Length"
},
{...},
{...}
],
"message": "Validation failed for object='demoDto'. Error count: 3",
"path": "/test"
}
返回的错误信息比较乱,需要统一整理,这个时候可以使用全局异常处理的方法
3、异常处理,捕获错误信息
当验证不通过时会抛异常出来。在异常处理器中捕获异常信息(因为验证不通过的项可能是多个所以统一捕获处理),并抛给前端。(此处是前后端分离开发)
@RequestMapping("test")
public ResultBean test(@Valid @RequestBody DemoDto dto){
System.out.println("test....................");
return new ResultBean("test.........................");
}
这里统一返回一个自定义的ResultBean类型
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public ResultBean methodArgumentNotValid(HttpServletRequest req, MethodArgumentNotValidException ex) {
ResultBean result = ResultBean.FAIL;
List<ObjectError> errors =ex.getBindingResult().getAllErrors();
StringBuffer errorMsg=new StringBuffer();
errors.stream().forEach(x -> errorMsg.append(x.getDefaultMessage()).append(";"));
log.error("---MethodArgumentNotValidException Handler--- ERROR: {}", errorMsg.toString());
result.setMsg(errorMsg.toString());
return result;
}
}
此时的返回结果为:
{
"code": 500,
"msg": "无效的状态标志;key的长度为5-25;名称不能为空;",
"content": null
}
二、分组校验
有时候需要在不同的方法中对同一个bean中的参数进行校验
1、在dto中添加groups
@Data
public class DemoDto {
public interface Default {
}
public interface Update {
}
@NotEmpty(message = "名称不能为空")
private String name;
@Length(min = 5, max = 25, message = "key的长度为5-25" ,groups = Default.class )
private String key;
@Pattern(regexp = "[012]", message = "无效的状态标志",groups = {Default.class,Update.class} )
private String state;
}
2、在controller中需要用到@Validated来校验
@RequestMapping("test2")
public String test2(@Validated(value = DemoDto.Default.class) @RequestBody DemoDto dto){
System.out.println("test....................");
return "test.........................";
}
@RequestMapping("test4")
public String test4(@Validated(value = {DemoDto.Default.class,DemoDto.Update.class}) @RequestBody DemoDto dto){
System.out.println("test....................");
return "test.........................";
}
三、国际化返回配置文件的信息
1. 在Resource下添加properties文件
文件中添加需要打印的消息,如:
demo.key.null=demo的key不能为空
start.ge.end = 开始日期{0}必须小于结束日期{1}!
demo.key.length=demo的key长度不正确
2. 在application.yml中添加配置
spring:
messages:
encoding: UTF-8
basename: message/messages_zh
3. 使用方法
在类中直接注入,即可使用
@Autowired
private MessageSource messageSource;
@RequestMapping("getMessageByKey")
public ResultBean getMessageByKey(@Valid @RequestBody DemoDto dto){
String key = dto.getKey();
String [] param = {"2019-8-8", "2019-9-9"};
return new ResultBean(messageSource.getMessage(key, param, Locale.CHINA));
}
测试调用和返回结果,返回的数据和预期相符合
三、国际化参数校验
根据上面的修改
1、bean 中添加标签
标签需要加在属性上,@NotEmpty标签String的参数不能为空
@Data
public class DemoDto {
@NotEmpty(message = "{demo.key.null}")
@Length(min = 5, max = 25, message = "{demo.key.length}")
private String key;
}
2、添加上ValidationMessages文件
国际化配置文件必须放在classpath的根目录下,即src/java/resources的根目录下。
国际化配置文件必须以ValidationMessages开头,比如ValidationMessages.properties 或者 ValidationMessages_en.properties。
在/resources的根目录下添加上ValidationMessages.properties文件
demo.key.null=demo的key不能为空,这里是validationMessage
demo.key.length=demo的key长度不正确
3、返回结果
{
"code": 500,
"msg": "demo的key不能为空,这里是validationMessage;",
"content": null
}
自定义properties文件
SpringBoot 国际化验证 @Validated 的 message 国际化资源文件默认必须放在 resources/ValidationMessages.properties 中。
现在我想把资源文件放到 resources/message/messages_zh.properties 中
若要自定义文件位置或名称则需要重写WebMvcConfigurerAdapter 的 getValidator 方法,但WebMvcConfigurerAdapter在springboot2中已经废弃了,可以改为使用WebMvcConfigurationSupport
在一的基础上修改:
@Configuration
public class ValidatorConfiguration extends WebMvcConfigurationSupport {
@Autowired
private MessageSource messageSource;
@Override
public Validator getValidator() {
return validator();
}
@Bean
public Validator validator() {
LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
validator.setValidationMessageSource(messageSource);
return validator;
}
}
最后得到结果为:
{
"code": 500,
"msg": "demo的key不能为空ID:{0};",
"content": null
}
参考文章:
spring boot国际化——MessageSource的使用
来源:https://www.jianshu.com/p/46eda1f96abe
猜你喜欢
- 1. Mybatis JdbcType与Oracle、MySql数据类型对应列表MybatisJdbcTypeOracleMySqlJdbc
- 前言在一个 Web 请求中,参数我们无非就是放在地址栏或者请求体中,个别请求可能放在请求头中。放在地址栏中,我们可以通过如下方式获取参数:S
- 今天我们来讨论如何在项目开发中优雅地使用RocketMQ。本文分为三部分,第一部分实现SpringBoot与RocketMQ的整合,第二部分
- java jdbc连接和使用jdbc导入驱动//jar是已经打包好的class文件集,可以引用到其他工程中 //Build Pa
- 本文实例为大家分享了java微信公众号支付示例代码,供大家参考,具体内容如下开始之前,先准备好:appid、商家号、商户密匙。工具类:MD5
- Java 和 Groovy 中的映射map都是非常通用的,它允许关键字key和值value为任意类型,只要继承了 Object&n
- 一、说明Boost.MPI 提供了 MPI 标准(消息传递接口)的接口。该标准简化了并发执行任务的程序的开发。您可以使用线程或通过共享内存或
- 配置文件<!-- 文件上传 --> <bean id="multipartResolver" clas
- 从功能上说,可以分为两部分,分布式功能和数据功能。分布式功能主要是节点集群及集群附属功能如restful借口、集群性能检测功能等,数据功能主
- 安装hbase首先下载hbase的最新稳定版本 http://www.apache.org/dyn/closer.cgi/hbas
- 1 起因在实际业务开发中, 我们经常会遇到需要临时创建一个数组的情况, 今天我们就来讲一下Java中ArrayList初始化的方法2 解决方
- 当键盘敲下后退键(Backspace)后1、禁止浏览器自动后退2、但不影响密码、单行文本、多行文本输入框等的回退操作<script t
- Android 微信摇一摇功能实现,最近学习传感器,就想实现摇一摇的功能,上网查了些资料,就整理下。如有错误,还请指正。开发环境Androi
- 前言在一些开源的框架的源码当中时不时都可以看到volatile这个关键字,最近特意学习一下volatile关键字的使用方法。volatile
- 错误处理到目前为止,我们都没怎么介绍onComplete()和onError()函数。这两个函数用来通知订阅者,被观察的对象将停止发送数据以
- 本文主要记录JAVA中对象的初始化过程,包括实例变量的初始化和类变量的初始化以及final关键字对初始化的影响。另外,还讨论了由于继承原因,
- HTTP请求:如果需要Json格式的自己转下,度娘上N种姿势…//处理http请求 requestUrl为请求地址 requestMetho
- 重复参数 Scala在定义函数时允许指定最后一个参数可以重复(变长参数),从而允许函数调用者使用变长参数列表来调用该函数,Scala中使用“
- Java为什么不浪(long)学而时习之不亦说乎,继续温习Java。今天使用switch时,不小心写了如下代码,报错如下。 public s
- 1、问题描述几种代码写法会有不同的ID返回值,下面我们一一分析。2、问题分析 首先一种插入写法,源码如下:SysUser .java/**