SpringBoot+Hibernate实现自定义数据验证及异常处理

下面将为您讲解“SpringBoot+Hibernate实现自定义数据验证及异常处理”的完整攻略。

一、概述

在一个Web应用中，对用户提交的数据进行数据验证和异常处理是非常重要的。本文将介绍如何使用SpringBoot和Hibernate实现自定义的数据验证及异常处理。

二、自定义数据验证

1. Hibernate validator

在SpringBoot中，默认使用Hibernate Validator来实现数据验证。Hibernate Validator是一个开源的，基于JSR 303规范的验证框架，它可以很方便地实现数据验证。

2. 自定义Validator

如果项目中需要实现额外的数据验证，可以通过自定义Validator来实现。自定义Validator需要实现Hibernate Validator的ConstraintValidator接口。

下面是一个自定义的数据验证器示例：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface Phone {

    String message() default "invalid phone number";

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

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

public class PhoneValidator implements ConstraintValidator<Phone, String> {

    @Override
    public void initialize(Phone phone) {
    }

    @Override
    public boolean isValid(String phoneField, ConstraintValidatorContext cxt) {
        if (phoneField == null) {
            return false;
        }
        return phoneField.matches("[0-9()-]*");
    }

}

上面的示例中，我们定义了一个名为Phone的自定义数据验证注解。注解的具体实现是PhoneValidator类。PhoneValidator类需要实现ConstraintValidator接口，并override两个方法：

• initialize()方法，用于初始化注解
• isValid()方法，用于做具体的验证实现，返回true或false

3. 使用自定义Validator

使用自定义Validator很简单，只需要在需要验证的字段上添加对应的注解即可。例如，在一个User实体类中，添加了一个名为phone的字段，需要验证该字段：

public class User {

    @NotEmpty(message = "用户名不能为空")
    private String name;

    @NotEmpty(message = "密码不能为空")
    private String password;

    @Phone(message = "手机号不合法")
    private String phone;

    // ...
}

在上面的示例中，我们使用了自定义的Phone注解来验证phone字段。

三、自定义异常处理

在Web应用中，异常处理是一个必不可少的部分。SpringBoot提供了方便的异常处理机制，使得我们可以很容易地处理不同类型的异常。

1. 自定义异常类

要处理自定义的异常，首先需要定义一个继承自RuntimeException或Exception的自定义异常类。例如，我们定义了一个名为UserNotFoundException的异常类：

public class UserNotFoundException extends RuntimeException {

    public UserNotFoundException(String message) {
        super(message);
    }

}

2. 统一异常处理

在SpringBoot中，可以使用@ControllerAdvice和@ExceptionHandler注解来实现异常统一处理。在@ControllerAdvice注解中，可以定义统一处理的异常类型，例如下面的示例：

@ControllerAdvice
public class ExceptionController {

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleException(UserNotFoundException e) {
        return e.getMessage();
    }

}

在上面的示例中，我们定义了一个名为ExceptionController的类，并使用@ControllerAdvice注解标注该类。在该类中，我们使用@ExceptionHandler注解来处理UserNotFoundException类型的异常，并返回异常的具体信息。

3. 抛出自定义异常

当需要抛出自定义异常时，只需要实例化自定义异常类，并将异常信息作为构造函数参数传递即可。例如，在UserService中，如果不能找到指定的用户，我们可以抛出UserNotFoundException异常：

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public User findOne(Long id) {
        User user = userRepository.findOne(id);
        if (user == null) {
            throw new UserNotFoundException("User not found");
        }
        return user;
    }

}

在上面的示例中，我们定义了一个名为UserService的类，并注入了一个UserRepository类型的对象。在findOne方法中，如果找不到指定的用户，将会抛出UserNotFoundException异常。

四、示例

下面是一个使用自定义数据验证和异常处理的示例。在该示例中，我们定义了一个名为User的实体类，使用自定义的Phone注解验证phone字段，并在UserService中使用@Valid注解验证参数。当UserService中findOne方法找不到指定的用户时，将会抛出UserNotFoundException异常，并由ExceptionController类处理。

1. User实体类

public class User {

    @NotEmpty(message = "用户名不能为空")
    private String name;

    @NotEmpty(message = "密码不能为空")
    private String password;

    @Phone(message = "手机号不合法")
    private String phone;

    // ...
}

2. 自定义数据验证

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface Phone {

    String message() default "invalid phone number";

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

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

public class PhoneValidator implements ConstraintValidator<Phone, String> {

    @Override
    public void initialize(Phone phone) {
    }

    @Override
    public boolean isValid(String phoneField, ConstraintValidatorContext cxt) {
        if (phoneField == null) {
            return false;
        }
        return phoneField.matches("[0-9()-]*");
    }

}

3. UserService类

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public User findOne(@Valid Long id) {
        User user = userRepository.findOne(id);
        if (user == null) {
            throw new UserNotFoundException("User not found");
        }
        return user;
    }

}

4. ExceptionController类

@ControllerAdvice
public class ExceptionController {

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleException(UserNotFoundException e) {
        return e.getMessage();
    }

}

五、总结

本文中，我们介绍了如何使用SpringBoot和Hibernate实现自定义的数据验证及异常处理。通过自定义数据验证和异常处理，可以方便地处理不同类型的数据验证和异常情况，提高Web应用的稳定性和安全性。