“status”: 500,
“message”: “test3.email: 不是一个合法的电子邮件地址”,
“data”: null,
“timestamp”: 1628239281022
}
通过加入 Validator
校验框架可以帮助我们自动实现参数的校验。
虽然我们之前定义了全局异常拦截器,也看到了拦截器确实生效了,但是 Validator
校验框架返回的错误提示太臃肿了,不便于阅读,为了方便前端提示,我们需要将其简化一下。
直接修改之前定义的 RestExceptionHandler
,单独拦截参数校验的三个异常:javax.validation.ConstraintViolationException
,org.springframework.validation.BindException
,org.springframework.web.bind.MethodArgumentNotValidException
,代码如下:
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseEntity<ResultData> handleValidatedException(Exception e) {
ResultData resp = null;
if (e instanceof MethodArgumentNotValidException) {
// BeanValidation exception
MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getBindingResult().getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof ConstraintViolationException) {
// BeanValidation GET simple param
ConstraintViolationException ex = (ConstraintViolationException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getConstraintViolations().stream()
.map(ConstraintViolation::getMessage)
.collect(Collectors.joining("; "))
);
} else if (e instanceof BindException) {
// BeanValidation GET object param
BindException ex = (BindException) e;
resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
ex.getAllErrors().stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.joining("; "))
);
}
return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
}
体验效果
POST http://localhost:8080/valid/test1
Content-Type: application/json
{
“id”: 1,
“level”: “12”,
“email”: “47693899”,
“appId”: “ab1c”
}
{
“status”: 400,
“message”: “名字为必填项; 不是一个合法的电子邮件地址; appId长度必须位于6到12之间”,
“data”: null,
“timestamp”: 1628435116680
}
是不是感觉清爽多了?
虽然Spring Validation 提供的注解基本上够用,但是面对复杂的定义,我们还是需要自己定义相关注解来实现自动校验。
比如上面实体类中的sex性别属性,只允许前端传递传 M,F 这2个枚举值,如何实现呢?
第一步,创建自定义注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑
public @interface EnumString {
String message() default “value not in enum values.”;
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
- @return date must in this value array
*/
String[] value();
/**
-
Defines several {@link EnumString} annotations on the same element.
-
@see EnumString
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@interface List {
EnumString[] value();
}
}
第二步,自定义校验逻辑
public class EnumStringValidator implements ConstraintValidator<EnumString, String> {
private List enumStringList;
@Override
public void initialize(EnumString constraintAnnotation) {
enumStringList = Arrays.asList(constraintAnnotation.value());
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if(value == null){
return true;
}
return enumStringList.contains(value);
}
}
第三步,在字段上增加注解
@ApiModelProperty(value = “性别”)
@EnumString(value = {“F”,“M”}, message=“性别只允许为F或M”)
private String sex;
第四步,体验效果
POST http://localhost:8080/valid/test2
Content-Type: application/x-www-form-urlencoded
id=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N
{
“status”: 400,
“message”: “性别只允许为F或M”,
“data”: null,
“timestamp”: 1628435243723
}
一个VO对象在新增的时候某些字段为必填,在更新的时候又非必填。如上面的 ValidVO
中 id 和 appId 属性在新增操作时都是非必填,而在编辑操作时都为必填,name在新增操作时为必填,面对这种场景你会怎么处理呢?
在实际开发中我见到很多同学都是建立两个VO对象,ValidCreateVO
,ValidEditVO
来处理这种场景,这样确实也能实现效果,但是会造成类膨胀,而且极其容易被开发老鸟们嘲笑。
其实 Validator
校验框架已经考虑到了这种场景并且提供了解决方案,就是分组校验,只不过很多同学不知道而已。要使用分组校验,只需要三个步骤:
第一步:定义分组接口
public interface ValidGroup extends Default {
interface Crud extends ValidGroup{
interface Create extends Crud{
}
interface Update extends Crud{
}
interface Query extends Crud{
}
interface Delete extends Crud{
}
}
}
这里我们定义一个分组接口ValidGroup让其继承 javax.validation.groups.Default
,再在分组接口中定义出多个不同的操作类型,Create,Update,Query,Delete。至于为什么需要继承Default我们稍后再说。
第二步,在模型中给参数分配分组
@Data
@ApiModel(value = “参数校验类”)
public class ValidVO {
@ApiModelProperty(“ID”)
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = “应用ID不能为空”)
private String id;
@Null(groups = ValidGroup.Crud.Create.class)
@NotNull(groups = ValidGroup.Crud.Update.class, message = “应用ID不能为空”)
@ApiModelProperty(value = “应用ID”,example = “cloud”)
private String appId;
@ApiModelProperty(value = “名字”)
@NotBlank(groups = ValidGroup.Crud.Create.class,message = “名字为必填项”)
private String name;
@ApiModelProperty(value = “邮箱”)
@Email(message = “请填写正取的邮箱地址”)
privte String email;
…
}
给参数指定分组,对于未指定分组的则使用的是默认分组。
第三步,给需要参数校验的方法指定分组
@RestController
@Api(“参数校验”)
@Slf4j
@Validated
public class ValidController {
@ApiOperation(“新增”)
@PostMapping(value = “/valid/add”)
public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){
log.info(“validEntity is {}”, validVO);
return “test3 valid success”;
}
@ApiOperation(“更新”)
@PostMapping(value = “/valid/update”)
public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){
log.info(“validEntity is {}”, validVO);
return “test4 valid success”;
}
}
这里我们通过 value
属性给 add()
和 update()
方法分别指定Create和Update分组。
第四步,体验效果
POST http://localhost:8080/valid/add
Content-Type: application/x-www-form-urlencoded
name=javadaily&level=12&email=476938977@qq.com&sex=F
在Create时我们没有传递id和appId参数,校验通过。
当我们使用同样的参数调用update方法时则提示参数校验错误。
{
“status”: 400,
“message”: “ID不能为空; 应用ID不能为空”,
“data”: null,
“timestamp”: 1628492514313
}
由于email属于默认分组,而我们的分组接口 ValidGroup
已经继承了 Default
分组,所以也是可以对email字段作参数校验的。如:
POST http://localhost:8080/valid/add
Content-Type: application/x-www-form-urlencoded
name=javadaily&level=12&email=476938977&sex=F
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
最后总结
ActiveMQ+Kafka+RabbitMQ学习笔记PDF
关于分布式,限流+缓存+缓存,这三大技术(包含:ZooKeeper+Nginx+MongoDB+memcached+Redis+ActiveMQ+Kafka+RabbitMQ)等等。这些相关的面试也好,还有手写以及学习的笔记PDF,都是啃透分布式技术必不可少的宝藏。以上的每一个专题每一个小分类都有相关的介绍,并且小编也已经将其整理成PDF啦
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
71a72faed303032d36.jpg" alt=“img” style=“zoom: 33%;” />
最后总结
ActiveMQ+Kafka+RabbitMQ学习笔记PDF
[外链图片转存中…(img-CBvF38RY-1712680413961)]
[外链图片转存中…(img-M6jpMQyW-1712680413962)]
[外链图片转存中…(img-tWr4F9E0-1712680413962)]
[外链图片转存中…(img-uRCkh0ge-1712680413963)]
关于分布式,限流+缓存+缓存,这三大技术(包含:ZooKeeper+Nginx+MongoDB+memcached+Redis+ActiveMQ+Kafka+RabbitMQ)等等。这些相关的面试也好,还有手写以及学习的笔记PDF,都是啃透分布式技术必不可少的宝藏。以上的每一个专题每一个小分类都有相关的介绍,并且小编也已经将其整理成PDF啦
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!