SpringBoot+Hibernate實(shí)現(xiàn)自定義數(shù)據(jù)驗(yàn)證及異常處理

更新時(shí)間：2022年04月22日 16:00:06 作者：花傷情猶在

這篇文章主要為大家介紹了SpringBoot如何整合Hibernate自定義數(shù)據(jù)驗(yàn)證及多種方式異常處理，文中的示例代碼講解詳細(xì)，感興趣的可以了解一下

前言

在進(jìn)行 SpringBoot 項(xiàng)目開(kāi)發(fā)中，經(jīng)常會(huì)碰到屬性合法性問(wèn)題，而面對(duì)這個(gè)問(wèn)題通常的解決辦法就是通過(guò)大量的 if 和 else 判斷來(lái)解決的，例如：

@PostMapping("/verify")
    @ResponseBody
    public Object verify(@Valid User user){
        if (StringUtils.isEmpty(user.getName())){
            return "姓名不能為空";
        }
        if (StringUtils.isEmpty(user.getAge())){
            return "姓名不能為空";
        }
        if (!StringUtils.isEmpty(user.getSex())&&user.getSex().equals("男")&&user.getSex().equals("女")){
            return "性別有誤";
        }
        return user;
    }

這種代碼寫(xiě)法十分麻煩，試想一下如果你有10個(gè)、20個(gè)字段屬性，你也要跟著寫(xiě)十幾二十幾個(gè) if 和 else 判斷？

So，本文講解一下使用Hibernate框架來(lái)去驗(yàn)證字段屬性，使用相應(yīng)的注解即可實(shí)現(xiàn)字段合法性校驗(yàn)，以及如何自定義注解進(jìn)行校驗(yàn)，包括出現(xiàn)異常的幾種處理方式。

Hibernate實(shí)現(xiàn)字段校驗(yàn)

Maven依賴(lài)

<dependency>
    <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

常用的校驗(yàn)注解

注解	釋義
@Null	必須為null
@NotNull	不能為null
@AssertTrue	必須為true
@AssertFalse	必須為false
@Min	必須為數(shù)字，其值大于或等于指定的最小值
@Max	必須為數(shù)字，其值小于或等于指定的最大值
@DecimalMin	必須為數(shù)字，其值大于或等于指定的最小值
@DecimalMax	必須為數(shù)字，其值小于或等于指定的最大值
@Size	集合的長(zhǎng)度
@Digits	必須為數(shù)字，其值必須再可接受的范圍內(nèi)
@Past	必須是過(guò)去的日期
@Future	必須是將來(lái)的日期
@Pattern	必須符合正則表達(dá)式
@Email	必須是郵箱格式
@Length	長(zhǎng)度范圍
@NotEmpty	不能為null，長(zhǎng)度大于0
@Range	元素的大小范圍
@NotBlank	不能為null，字符串長(zhǎng)度大于0(限字符串)

定義User實(shí)體類(lèi)

@Data
public class User {
    @NotBlank(message = "姓名不能為空")
    private String name;
    @NotBlank(message = "年齡不能為空")
    private String age;
}

定義UserController

@Controller
public class UserController {

    @PostMapping("/verify")
    @ResponseBody
    public Object verify(@Valid User user, BindingResult result){
    	//字段校驗(yàn)有錯(cuò)誤
        if (result.hasErrors()){
        	//獲取錯(cuò)誤字段信息
            List<FieldError> fieldErrors = result.getFieldErrors();
            if (fieldErrors!=null){
            	//創(chuàng)建一個(gè)map用來(lái)封裝字段錯(cuò)誤信息
                HashMap<String, String> map = new HashMap<>();
                //遍歷錯(cuò)誤字段
                fieldErrors.forEach(x->{
                	//獲取字段名稱(chēng)
                    String field = x.getField();
                    //獲取字段錯(cuò)誤提示信息
                    String msg = x.getDefaultMessage();
                    //存入map
                    map.put(field, msg);
                });
                return map;
            }
        }
        return user;
    }

}

啟動(dòng)項(xiàng)目進(jìn)行測(cè)試

可以看到name和age的錯(cuò)誤信息已經(jīng)封裝好傳回來(lái)了

自定義校驗(yàn)注解

自定義一個(gè)校驗(yàn)性別的注解Sex

/**
 * 性別約束
 * @Target用于指定使用范圍，該處限定只能在字段上使用
 * @Retention(RetentionPolicy.RUNTIME)表示注解在運(yùn)行時(shí)可以通過(guò)反射獲取到
 * @Constraint(validatedBy = xxx.class)指定該注解校驗(yàn)邏輯
 */
@Target({ ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = SexConstraintValidator.class)
public @interface Sex {

    String message() default "性別有誤";

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

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

創(chuàng)建SexConstraintValidator校驗(yàn)邏輯類(lèi)

/**
 * 性別約束邏輯判斷
 */
public class SexConstraintValidator implements ConstraintValidator<Sex, String> {

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && (value.equals("男") || value.equals("女"));
    }

}

修改User實(shí)體類(lèi)

@Data
public class User {
    @NotBlank(message = "姓名不能為空")
    private String name;
    @NotBlank(message = "年齡不能為空")
    private String age;
    @Sex(message = "性別不能為空或有誤")
    private String sex;
}

重啟項(xiàng)目測(cè)試效果

使用AOP處理校驗(yàn)異常

Maven依賴(lài)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

這里我們用注解作為AOP的切入點(diǎn)，新建一個(gè)注解 BindingResultAnnotation

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BindingResultAnnotation {
}

定義參數(shù)校驗(yàn)切面類(lèi)

/**
 * 參數(shù)校驗(yàn)切面類(lèi)
 */
@Aspect
@Component
public class BindingResultAspect {

    /**
     * 校驗(yàn)切入點(diǎn)
     */
    @Pointcut("@annotation(com.hsqyz.hibernate.config.aop.BindingResultAnnotation)")
    public void BindingResult() {
    }

    /**
     * 環(huán)繞通知
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @Around("BindingResult()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("參數(shù)校驗(yàn)切面...");
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if (arg instanceof BindingResult) {
                BindingResult result = (BindingResult) arg;
                if (result.hasErrors()){
                    List<FieldError> fieldErrors = result.getFieldErrors();
                    if (fieldErrors!=null){
                        HashMap<String, String> map = new HashMap<>();
                        fieldErrors.forEach(x->{
                            String field = x.getField();
                            String msg = x.getDefaultMessage();
                            map.put(field, msg);
                        });
                        return map;
                    }
                }

            }
        }
        return joinPoint.proceed();
    }


}

修改UserController

注意：這里將新建的切面注解添加到方法上@BindingResultAnnotation，必須攜帶BindingResult result在參數(shù)后面，否則AOP無(wú)法獲取錯(cuò)誤信息，導(dǎo)致AOP無(wú)法處理異常。

@Controller
public class UserController {

    @PostMapping("/verify")
    @ResponseBody
    @BindingResultAnnotation
    public Object verify(@Valid User user, BindingResult result) {
        return user;
    }

}

重啟項(xiàng)目查看效果

全局異常類(lèi)處理異常

創(chuàng)建GlobelExceptionHandler來(lái)處理全局異常，使用@ExceptionHandle來(lái)攔截指定異常，由于參數(shù)校驗(yàn)拋出的異常是BindException，所以我們需要攔截BindException異常，而B(niǎo)indException內(nèi)部封裝這錯(cuò)誤信息，這樣就可以用全局異常處理類(lèi)來(lái)封裝字段錯(cuò)誤信息返回。

/**
 * 全局異常處理
 */
@ControllerAdvice
public class GlobelExceptionHandler {

    /**
     * 參數(shù)驗(yàn)證異常處理
     * @param result
     * @return
     */
    @ResponseBody
    @ExceptionHandler(BindException.class)
    public Object bindExceptionHandler(BindingResult result) {
        System.out.println("參數(shù)驗(yàn)證異常處理...");
        if (result.hasErrors()){
            List<FieldError> fieldErrors = result.getFieldErrors();
            if (fieldErrors!=null){
                HashMap<String, String> map = new HashMap<>();
                fieldErrors.forEach(x->{
                    String field = x.getField();
                    String msg = x.getDefaultMessage();
                    map.put(field, msg);
                });
                return map;
            }
        }
        return result.getAllErrors();
    }


}

修改UserController

注意：這個(gè)時(shí)候我們就需要去掉verify()方法中的BindingResult result參數(shù)，因?yàn)椴蝗サ舻脑挘霈F(xiàn)錯(cuò)誤信息不會(huì)拋出異常，會(huì)被收集起來(lái)封裝到BindingResult中去，所以要想使用全局異常處理類(lèi)來(lái)處理校驗(yàn)異常，就必須去掉BindingResult參數(shù)，讓其拋出異常，我們?cè)偈褂萌之惓Ｌ幚眍?lèi)進(jìn)行異常處理，封裝異常信息并返回。

@Controller
public class UserController {

    @PostMapping("/verify")
    @ResponseBody
    public Object verify(@Valid User user) {
        return user;
    }

}

重啟項(xiàng)目查看運(yùn)行效果

到此這篇關(guān)于SpringBoot+Hibernate實(shí)現(xiàn)自定義數(shù)據(jù)驗(yàn)證及異常處理的文章就介紹到這了,更多相關(guān)SpringBoot Hibernate數(shù)據(jù)驗(yàn)證異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: