本文主要是介绍javax 自定义注解校验 或者与hibernate联合使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
(1)javax自定义注解使用
自定义一个注解
package com.macro.mall.demo.validator;import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;/*** 用户验证状态是否在指定范围内的注解*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.PARAMETER})
@Constraint(validatedBy = FlagValidatorClass.class)
public @interface FlagValidator {String[] value() default {};String message() default "flag is not found";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};
}
package com.macro.mall.demo.validator;import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;/*** 状态标记校验器*/
public class FlagValidatorClass implements ConstraintValidator<FlagValidator,Integer> {private String[] values;@Overridepublic void initialize(FlagValidator flagValidator) {this.values = flagValidator.value();}@Overridepublic boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {boolean isValid = false;for(int i=0;i<values.length;i++){if(values[i].equals(String.valueOf(value))){isValid = true;break;}}return isValid;}
}
package com.macro.mall.demo.dto;import com.macro.mall.demo.validator.FlagValidator;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;/*** 品牌传递参数*/
@ApiModel(value = "PmsBrandDto")
public class PmsBrandDto {@ApiModelProperty(value = "品牌名称",required = true)@NotNull(message = "名称不能为空")private String name;@ApiModelProperty(value = "品牌首字母",required = true)@NotNull(message = "首字母不能为空")private String firstLetter;@ApiModelProperty(value = "排序字段")@Min(value = 0, message = "排序最小为0")private Integer sort;@ApiModelProperty(value = "是否为厂家制造商")@FlagValidator(value = {"0","1"}, message = "厂家状态不正确")private Integer factoryStatus;@ApiModelProperty(value = "是否进行显示")@FlagValidator(value = {"0","1"}, message = "显示状态不正确")private Integer showStatus;@ApiModelProperty(value = "品牌logo")private String logo;@ApiModelProperty(value = "品牌大图")private String bigPic;@ApiModelProperty(value = "品牌故事")private String brandStory;public String getName() {return name;}public void setName(String name) {this.name = name;}public String getFirstLetter() {return firstLetter;}public void setFirstLetter(String firstLetter) {this.firstLetter = firstLetter;}public Integer getSort() {return sort;}public void setSort(Integer sort) {this.sort = sort;}public Integer getFactoryStatus() {return factoryStatus;}public void setFactoryStatus(Integer factoryStatus) {this.factoryStatus = factoryStatus;}public Integer getShowStatus() {return showStatus;}public void setShowStatus(Integer showStatus) {this.showStatus = showStatus;}public String getLogo() {return logo;}public void setLogo(String logo) {this.logo = logo;}public String getBigPic() {return bigPic;}public void setBigPic(String bigPic) {this.bigPic = bigPic;}public String getBrandStory() {return brandStory;}public void setBrandStory(String brandStory) {this.brandStory = brandStory;}
}
这个类中,使用FlagValidator 这个注解 进行被校验然后使用最下面的那个文档进行统一注解的处理
也可以使用一个注解开启
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*; @ApiOperation(value = "添加品牌")@RequestMapping(value = "/brand/create", method = RequestMethod.POST)@ResponseBodypublic CommonResult createBrand(@Validated @RequestBody PmsBrandDto pmsBrand) {CommonResult commonResult;int count = demoService.createBrand(pmsBrand);if (count == 1) {commonResult = CommonResult.success(pmsBrand);LOGGER.debug("createBrand success:{}", pmsBrand);} else {commonResult = CommonResult.failed("操作失败");LOGGER.debug("createBrand failed:{}", pmsBrand);}return commonResult;}
2021-09-27 11:10:51.909 WARN 67416 --- [nio-8082-exec-7] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.macro.mall.common.api.CommonResult com.macro.mall.demo.controller.DemoController.createBrand(com.macro.mall.demo.dto.PmsBrandDto): [Field error in object 'pmsBrandDto' on field 'showStatus': rejected value [10]; codes [FlagValidator.pmsBrandDto.showStatus,FlagValidator.showStatus,FlagValidator.java.lang.Integer,FlagValidator]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [pmsBrandDto.showStatus,showStatus]; arguments []; default message [showStatus],[Ljava.lang.String;@1f156699]; default message [显示状态不正确]] ]
因此需要统一捕获异常,统一返回response 可以使用
在valid校验中,如果校验不通过,会产生BindException异常,捕捉到异常后可以获取到defaultMessage也就是自定义注解中定义的内容,具体实现如下:
BindException ex = (BindException)e;List<ObjectError> errors = ex.getAllErrors();ObjectError error = errors.get(0);String msg = error.getDefaultMessage();
其它的注解比如 Min,NotNULL。都可以直接引入hibernate进行校验,可以参考以前的一篇文章
使用javax的validation和hibernate-validator框架对pojo类的属性进行校验以及扩展_红豆和绿豆的博客-CSDN博客
这篇关于javax 自定义注解校验 或者与hibernate联合使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!