访问接口:8081/v3/banner?id=12&pos=33后,看到我们控制台的输出提示输入不能超过10,这里的这个message不是我写的哈,这是java国际化后的效果能够根据你所在地区决定显示什么语言。
当然这里我们也可以自定义错误的message:
@GetMapping("/v3/banner") public Map<String, Object> getBannerDetailV2(@RequestParam Integer id, @RequestParam @Max(value = 10, message = "超过10了,赶紧看看哇") Integer pos){ Map<String, Object> body = new HashMap<>(); body.put("id", id); body.put("pos", pos); return body; }还是上面的请求路径,看看控制台输出:
可以看到控制台输出了我们自定义的内容。这里有一点要注意,要想使得校验生效,比如在Controller上方打上@Validated注解,至于为什么我们后面分解。
上面的验证都是比较基础的数据类型,但是如果现在要有验证更加复杂一点的java对象呢,又该如何操作,那接下来我们再看看这部分的内容。
java对象进行验证 单个对象还是用上面的BannerResponseDto来进行演示
import org.hibernate.validator.constraints.Length; @Setter @Getter public class BannerCreateDto { @Length(min = 2, max = 4, message = "banner名称必须是2-10个字符") private String name; private Integer pos; }对于这些基础类型的成员变量仍然使用这些基础注解进行校验定义,上面我们使用了 @Length注解来定义banner名称的字符长度范围,并定义发生错误时提示的message,这里还需要在Controller里额外的处理一下:
@PostMapping("/v3/banner/create") public BannerResponseDto createBanner(@RequestBody @Validated BannerCreateDto dto){ return BannerResponseDto.builder() .id(500) .name(dto.getName()) .pos(dto.getPos()) .build(); }@Validated BannerCreateDto这里必须要加@Validated注解,否则无法触发校验机制。
嵌套如果某个类的成员变量也是一个自定义对象,那校验该是什么样的呢,下面我们来看一下。
先定义一个新的对象,用来接收banner到的素材信息
@Getter @Setter public class MaterialDto { @Length(min = 2, max = 5, message = "素材的名称长度范围必须在2-5之内") private String name; }然后banner对象增加一个成员变量
@Setter @Getter public class BannerCreateDto { @Length(min = 2, max = 4, message = "banner名称必须是2-10个字符") private String name; private Integer pos; @Valid private MaterialDto materialDto; }这里有一点,要想使得这种级联的关系能够触发校验机制,必须 @Valid注解进行标记,我们来请求一下url看看效果
可以看到校验没通过,再看看控制台输出内容:
输出了我们定义的错误信息。
总结本篇文章主要介绍了里面lombok的使用,以及校验规范介绍和校验框架基本注解的使用,还有自定义对象校验,下篇文章我们将通过自定义注解来实现更加个性化的校验规则,敬请期待。