文章目录
表单校验&自定义校验器
前端校验
firstLetter: [
// { required: true, message: "检索首字母不能为空", trigger: "blur" }
{
validator: (rule, value, callback) => {
if (value == "") {
callback(new Error("首字母必须填写"));
} else if (!/^[a-zA-Z]$/.test(value)) {
callback(new Error("首字母必须a-z或者A-Z之间"));
} else {
callback();
}
},
trigger: "blur"
}
],
sort: [
// { required: true, message: "排序不能为空", trigger: "blur" }
{
validator: (rule, value, callback) => {
if (value == "") {
callback(new Error("排序字段必须填写"));
} else if (!Number.isInteger(value) || value < 0) {
callback(new Error("排序必须是一个大于等于0的整数"));
} else {
callback();
}
},
trigger: "blur"
}
]
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
后端校验
JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。学习
项目使用
1、校验注解
给Bean添加校验注解
/**
* 品牌名
*/
@NotEmpty
private String name;
- 1
- 2
- 3
- 4
- 5
2、@Valid
告诉SpringMvc字段需要校验 @Valid
/** * 保存 */ @RequestMapping("/save") public R save(@Valid @RequestBody BrandEntity brand) { brandService.save(brand);<span class="token keyword">return</span> <span class="token constant">R</span><span class="token punctuation">.</span><span class="token function">ok</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
3、测试
4、自定义错误信息
/**
* 品牌名
*/
@NotEmpty(message = "品牌名必须提交")
private String name;
- 1
- 2
- 3
- 4
- 5
5、获取校验结果
给校验的bean后紧跟一个BindingResult，就可以获取到校验的结果
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {
if (result.hasErrors()) {
Map<String, String> map = new HashMap<>();
//1、获取校验的错误结果
result.getFieldErrors().forEach((item) -> {
//FieldError 获取到错误提示
String message = item.getDefaultMessage();
//获取错误的属性的名字
String field = item.getField();
map.put(field, message);
});
return R.error(400, "提交的数据不合法").put("data", map);
} else {
brandService.save(brand);
}
return R.ok();
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
6、统一异常处理
1）、编写异常处理类，使用@ControllerAdvice
2）、使用@ExceptionHandler标注方法可以处理的异常
/** * @description: 集中处理所有异常 * @author: DAIHAO * @created: 2020/04/27 23:46 */ @Slf4j @RestControllerAdvice(basePackages = "指定controller路径") public class MallExceptionControllerAdvice {@<span class="token function">ExceptionHandler</span><span class="token punctuation">(</span>value <span class="token operator">=</span> MethodArgumentNotValidException<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">)</span> <span class="token keyword">public</span> <span class="token constant">R</span> <span class="token function">handleVaildException</span><span class="token punctuation">(</span>MethodArgumentNotValidException e<span class="token punctuation">)</span> <span class="token punctuation">{</span> log<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span><span class="token string">"数据校验出现问题{}，异常类型：{}"</span><span class="token punctuation">,</span> e<span class="token punctuation">.</span><span class="token function">getMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> e<span class="token punctuation">.</span><span class="token function">getClass</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> BindingResult bindingResult <span class="token operator">=</span> e<span class="token punctuation">.</span><span class="token function">getBindingResult</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> Map<span class="token operator"><</span>String<span class="token punctuation">,</span> String<span class="token operator">></span> errorMap <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">HashMap</span><span class="token operator"><</span><span class="token operator">></span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> bindingResult<span class="token punctuation">.</span><span class="token function">getFieldErrors</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">forEach</span><span class="token punctuation">(</span><span class="token punctuation">(</span>fieldError<span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span> <span class="token punctuation">{</span> errorMap<span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span>fieldError<span class="token punctuation">.</span><span class="token function">getField</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> fieldError<span class="token punctuation">.</span><span class="token function">getDefaultMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">return</span> <span class="token constant">R</span><span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>BizCodeEnume<span class="token punctuation">.</span><span class="token constant">VAILD_EXCEPTION</span><span class="token punctuation">.</span><span class="token function">getCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> BizCodeEnume<span class="token punctuation">.</span><span class="token constant">VAILD_EXCEPTION</span><span class="token punctuation">.</span><span class="token function">getMsg</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> errorMap<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> @<span class="token function">ExceptionHandler</span><span class="token punctuation">(</span>value <span class="token operator">=</span> Throwable<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">)</span> <span class="token keyword">public</span> <span class="token constant">R</span> <span class="token function">handleException</span><span class="token punctuation">(</span>Throwable throwable<span class="token punctuation">)</span> <span class="token punctuation">{</span> log<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span><span class="token string">"错误："</span><span class="token punctuation">,</span> throwable<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">return</span> <span class="token constant">R</span><span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>BizCodeEnume<span class="token punctuation">.</span><span class="token constant">UNKNOW_EXCEPTION</span><span class="token punctuation">.</span><span class="token function">getCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> BizCodeEnume<span class="token punctuation">.</span><span class="token constant">UNKNOW_EXCEPTION</span><span class="token punctuation">.</span><span class="token function">getMsg</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span>
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
7、错误码和错误信息枚举类
/*** * 错误码和错误信息定义类 * 1. 错误码定义规则为5为数字 * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常 * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式 * 错误码列表： * 10: 通用 * 001：参数格式校验 * 11: 商品 * 12: 订单 * 13: 购物车 * 14: 物流 */ public enum BizCodeEnume { UNKNOW_EXCEPTION(10000,"系统未知异常"), VAILD_EXCEPTION(10001,"参数格式校验失败");<span class="token keyword">private</span> int code<span class="token punctuation">;</span> <span class="token keyword">private</span> String msg<span class="token punctuation">;</span> <span class="token function">BizCodeEnume</span><span class="token punctuation">(</span>int code<span class="token punctuation">,</span>String msg<span class="token punctuation">)</span><span class="token punctuation">{</span> <span class="token keyword">this</span><span class="token punctuation">.</span>code <span class="token operator">=</span> code<span class="token punctuation">;</span> <span class="token keyword">this</span><span class="token punctuation">.</span>msg <span class="token operator">=</span> msg<span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token keyword">public</span> int <span class="token function">getCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">return</span> code<span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token keyword">public</span> String <span class="token function">getMsg</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">return</span> msg<span class="token punctuation">;</span> <span class="token punctuation">}</span>
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
controller
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Validated @RequestBody BrandEntity brand) {
brandService.save(brand);
return R.ok();
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
8、分组校验(多场景的复杂校验)
1)、 @NotBlank(message = “品牌名必须提交”,groups = {AddGroup.class,UpdateGroup.class})给校验注解标注什么情况需要进行校验
2)、@Validated({AddGroup.class})
3)、默认没有指定分组的校验注解@NotBlank，在分组校验情况@Validated({AddGroup.class})下不生效，只会在@Validated生效；
8.1、BrandEntity添加注解
public class BrandEntity implements Serializable { private static final long serialVersionUID = 1L;<span class="token comment">/** * 品牌id */</span> @<span class="token function">NotNull</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"修改必须指定品牌id"</span><span class="token punctuation">,</span>groups <span class="token operator">=</span> <span class="token punctuation">{</span>UpdateGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">}</span><span class="token punctuation">)</span> @<span class="token function">Null</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"新增不能指定id"</span><span class="token punctuation">,</span>groups <span class="token operator">=</span> <span class="token punctuation">{</span>AddGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">}</span><span class="token punctuation">)</span> @TableId <span class="token keyword">private</span> Long brandId<span class="token punctuation">;</span> <span class="token comment">/** * 品牌名 */</span> @<span class="token function">NotBlank</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"品牌名必须提交"</span><span class="token punctuation">,</span>groups <span class="token operator">=</span> <span class="token punctuation">{</span>AddGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">,</span>UpdateGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">}</span><span class="token punctuation">)</span> <span class="token keyword">private</span> String name<span class="token punctuation">;</span> <span class="token comment">/** * 品牌logo地址 */</span> @<span class="token function">NotBlank</span><span class="token punctuation">(</span>groups <span class="token operator">=</span> <span class="token punctuation">{</span>AddGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">}</span><span class="token punctuation">)</span> @<span class="token constant">URL</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"logo必须是一个合法的url地址"</span><span class="token punctuation">,</span>groups<span class="token operator">=</span><span class="token punctuation">{</span>AddGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">,</span>UpdateGroup<span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">}</span><span class="token punctuation">)</span> <span class="token keyword">private</span> String logo<span class="token punctuation">;</span> <span class="token comment">/** * 介绍 */</span> <span class="token keyword">private</span> String descript<span class="token punctuation">;</span> <span class="token comment">/** * 显示状态[0-不显示；1-显示] */</span>
//@Pattern()
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
/**
* 检索首字母
/
@NotEmpty(groups={AddGroup.class})
@Pattern(regexp="1$",message = “检索首字母必须是一个字母”,groups={AddGroup.class, UpdateGroup.class})
private String firstLetter;
/*
* 排序
*/
@NotNull(groups={AddGroup.class})
@Min(value = 0,message = “排序必须大于等于0”,groups={AddGroup.class,UpdateGroup.class})
private Integer sort;
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
8.2、分组接口
只需要是一个接口，一个标识
/**
* 添加分组
*/
public interface AddGroup {
}
- 1
- 2
- 3
- 4
- 5
/**
* 修改分组
*/
public interface UpdateGroup {
}
- 1
- 2
- 3
- 4
- 5
- 6
8.3、Controller分组注解
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) {
brandService.save(brand);
return R.ok();
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
8.4、自定义校验
1）、编写一个自定义的校验注解 例 @ListValue
/**
* 显示状态[0-不显示；1-显示]
*/
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
- 1
- 2
- 3
- 4
- 5
- 6
2）、编写一个自定义的校验器 ConstraintValidator （实现ConstraintValidator接口）
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {<span class="token keyword">private</span> Set<span class="token operator"><</span>Integer<span class="token operator">></span> <span class="token keyword">set</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">HashSet</span><span class="token operator"><</span><span class="token operator">></span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">//初始化方法</span> @Override <span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">initialize</span><span class="token punctuation">(</span>ListValue constraintAnnotation<span class="token punctuation">)</span> <span class="token punctuation">{</span> int<span class="token punctuation">[</span><span class="token punctuation">]</span> vals <span class="token operator">=</span> constraintAnnotation<span class="token punctuation">.</span><span class="token function">vals</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">for</span> <span class="token punctuation">(</span>int val <span class="token punctuation">:</span> vals<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">set</span><span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span>val<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token comment">//判断是否校验成功</span> <span class="token comment">/** * * @param value 需要校验的值 * @param context * @return */</span> @Override <span class="token keyword">public</span> boolean <span class="token function">isValid</span><span class="token punctuation">(</span>Integer value<span class="token punctuation">,</span> ConstraintValidatorContext context<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">return</span> <span class="token keyword">set</span><span class="token punctuation">.</span><span class="token function">contains</span><span class="token punctuation">(</span>value<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span>
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
3）、关联自定义的校验器和自定义的校验注解
@Documented @Constraint(validatedBy = { ListValueConstraintValidator.class }) @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) @Retention(RUNTIME) public @interface ListValue { String message() default "{显示状态只能为[0-不显示；1-显示]}";Class<span class="token operator"><</span><span class="token operator">?</span><span class="token operator">></span><span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token function">groups</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">default</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> Class<span class="token operator"><</span><span class="token operator">?</span> <span class="token keyword">extends</span> <span class="token class-name">Payload</span><span class="token operator">></span><span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token function">payload</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">default</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> int<span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token function">vals</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">default</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">;</span>
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
4)、使用
/** * 修改状态 */ @RequestMapping("/update/status") public R updateStatus(@Validated(UpdateStatusGroup.class) @RequestBody BrandEntity brand){ brandService.updateById(brand);<span class="token keyword">return</span> <span class="token constant">R</span><span class="token punctuation">.</span><span class="token function">ok</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
5）、测试
</div>
<link href="https://csdnimg.cn/release/phoenix/mdeditor/markdown_views-60ecaf1f42.css" rel="stylesheet">
</div>
a-zA-Z ↩︎
1232
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
