欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

hibernate 自定义注解参数校验

程序员文章站 2022-04-12 20:32:01
...

1.导入依赖

<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>6.0.1.Final</version>
</dependency>

2.创建自定义注解

package com.iflytek.edu.hnezxjgl.common.config;

import com.iflytek.edu.hnezxjgl.common.base.ScoresConstraintValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ScoresConstraintValidator.class)
public @interface Scores {

    String message() default "分数填写格式有误!整数部分最多三位.保留一位小数!";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

}

@Target用于指定使用范围,该处限定只能在字段上使用
@Retention(RetentionPolicy.RUNTIME)表示注解在运行时可以通过反射获取到
@Constraint(validatedBy = xxx.class)指定该注解校验逻辑类

3.创建自定义异常逻辑处理类

package com.iflytek.edu.hnezxjgl.common.base;

import com.iflytek.edu.hnezxjgl.common.config.Scores;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * @version 1.0
 * @description
 * @create 2020/07/27 09:25
 */
public class ScoresConstraintValidator  implements ConstraintValidator<Scores,Double> {
    @Override
    public boolean isValid(Double scores, ConstraintValidatorContext constraintValidatorContext) {
        if(scores!=null){
            String str = scores.toString();
            String regexp="^[1-9]\\d{0,2}(\\.\\d{1,1})?$|^0(\\.\\d{1,1})?$";
            return this.match(regexp, str);
        }
        return true;
    }

    /**
     * @param regex
     * 正则表达式字符串
     * @param str
     * 要匹配的字符串
     * @return 如果str 符合 regex的正则表达式格式,返回true, 否则返回 false;
     */
    public boolean match(String regex, String str) {
        Pattern pattern = Pattern.compile(regex);
        Matcher matcher = pattern.matcher(str);
        return matcher.matches();
    }
}

4.控制类的方法对象前添加@Valid注解

	@PostMapping("/saveOrUpdateOneStudent")
    public ResultVO saveOrUpdateOneStudent(HttpSession session,@Valid 	@RequestBody OneStudentModel oneStudentModel){
        return  oneStudentService.saveOrUpdateOneStudent(session,oneStudentModel);
    }

5.实体类要验证的字段加上 @Scores自定义注解

package com.iflytek.edu.hnezxjgl.model;

import com.iflytek.edu.hnezxjgl.common.config.Scores;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.validation.constraints.Pattern;
import javax.validation.constraints.PositiveOrZero;

/**
 * @version 1.0
 * @description
 * @create 2020/07/16 17:51
 */
@ApiModel(value = "XjglStudentEntranceInfo",description = "中考信息模型")
@AllArgsConstructor
@NoArgsConstructor
@Data
public class XjglStudentEntranceInfo {
    /** 自增id **/
    @ApiModelProperty("中考自增主键")
    private Integer id;
    /** 学生表的 业务id **/
    @ApiModelProperty("学生编号")
    private String studentBid;
    /** 中考考号 **/
    @ApiModelProperty("中考考号")
    @Pattern(regexp = "^\\d{12}$",message = "中考证只能填写12位纯数字!")
    private String examinationNumber;
    /** 初中毕业学校 **/
    @ApiModelProperty("初中毕业学校")
    private String midSchool;
    /** 中考总分 **/
    @ApiModelProperty("中考总分")
    @Scores
    private Double totalScore;
    /** 语文分数 **/
    @ApiModelProperty("语文分数")
    @Scores
    private Double ywScore;
    /** 数学分数 **/
    @ApiModelProperty("数学分数")
    @Scores
    private Double sxScore;
    /** 英语分数 **/
    @ApiModelProperty("英语分数")
    @Scores
    private Double yyScore;
    /** 道德法制分数 **/
    @ApiModelProperty("道德法制分数")
    @Scores
    private Double ddfzScore;
    /** 历史分数 **/
    @ApiModelProperty("历史分数")
    @Scores
    private Double lsScore;
    /** 地理分数 **/
    @ApiModelProperty("地理分数")
    @Scores
    private Double dlScore;
    /** 物理分数 **/
    @ApiModelProperty("物理分数")
    @Scores
    private Double wlScore;
    /** 化学分数 **/
    @ApiModelProperty("化学分数")
    @Scores
    private Double hxScore;
    /** 信息技术分数 **/
    @ApiModelProperty("信息技术分数")
    @Scores
    private Double xxjsScore;
    /** 生物分数 **/
    @ApiModelProperty("生物分数")
    @Scores
    private Double swScore;
    /** 理科实验分数 **/
    @ApiModelProperty("理科实验分数")
    @Scores
    private Double lksyScore;
    /** 体育分数 **/
    @ApiModelProperty("体育分数")
    @Scores
    private Double tyScore;
    /** 省考七科分数 **/
    @ApiModelProperty("省考七科分数")
    @Scores
    private Double skqkScore;
}

6.自定义全局异常捕捉类

package com.iflytek.edu.hnezxjgl.common.base;

import com.iflytek.edu.hnezxjgl.common.enums.ResponseCodeEnum;
import com.iflytek.edu.hnezxjgl.vo.ResultVO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.Set;

/**
 * @description 全局异常处理类
 * @create 2020/06/18 15:44
 * @version 1.0
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    protected Logger logger = LoggerFactory.getLogger(getClass());
    
    /**
     * @description 对前端传到后端的对象封装的参数进行验证异常
     * @param e 异常
     * @return ResultVO
     */
    @ExceptionHandler({MethodArgumentNotValidException .class})    //申明捕获那个异常类
    public ResultVO methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException  e) {
        ResultVO result=new ResultVO(null,null,null);
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        if(allErrors!=null&&allErrors.size()>0){
            result.setCode(400);
            result.setMessage(allErrors.get(0).getDefaultMessage());
        }
        return result;
    }
}

7.postman测试出错结果

{
    "code": 400,
    "message": "分数填写格式有误!整数部分最多三位.保留一位小数!",
    "data": null
}