理解 Spring Data JPA 中的错误类型

在深入探讨最佳实践之前，有必要对 Spring Data JPA 中的常见错误类型进行分类：

• • 验证错误：数据完整性违规，例如空约束或长度违规。
• • 数据库错误：SQL 语法错误、连接问题或约束违规。
• • 应用程序逻辑错误：服务层或存储库层中的问题，例如处理不存在的实体。

使用 Bean 验证

Spring Data JPA 与 Hibernate Validator（JSR 380 的参考实现）无缝集成。Bean 验证确保在持久化实体之前，它们符合定义的约束。

示例：注解实体字段

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @NotNull(message = "Username cannot be null")
    @Size(min = 3, max = 50, message = "Username must be between 3 and 50 characters")
    private String username;

    @Email(message = "Email should be valid")
    @NotNull(message = "Email cannot be null")
    private String email;

    @Past(message = "Date of birth must be in the past")
    private LocalDate dateOfBirth;

    // Getters and Setters
}

在服务层进行验证

@Service
public class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public User createUser(@Valid User user) {
        return userRepository.save(user);
    }
}

自定义验证消息

你可以在 messages.properties 文件中自定义验证消息。

username.notnull=Username is required
email.invalid=Please provide a valid email address

将此添加到 application.properties 中：

spring.messages.basename=messages

使用 @ControllerAdvice 处理异常

使用全局异常处理程序一致地处理验证错误和数据库异常。

示例：全局异常处理

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> 
            errors.put(error.getField(), error.getDefaultMessage()));
        return ResponseEntity.badRequest().body(errors);
    }

    @ExceptionHandler(DataIntegrityViolationException.class)
    public ResponseEntity<String> handleDataIntegrityViolation(DataIntegrityViolationException ex) {
        return ResponseEntity.status(HttpStatus.CONFLICT).body("Database error: " + ex.getMostSpecificCause().getMessage());
    }
}

事务错误处理

Spring 的 @Transactional 注解可用于在发生错误时回滚事务。

示例：异常回滚

@Service
public class ProductService {

    @Transactional(rollbackFor = Exception.class)
    public Product createProduct(Product product) {
        // Perform multiple operations
        productRepository.save(product);
        updateInventory(product);
        return product;
    }

    private void updateInventory(Product product) {
        // Simulate an error
        if (product.getStock() < 0) {
            throw new IllegalArgumentException("Stock cannot be negative");
        }
    }
}

使用自定义异常

自定义异常提供了更有意义的错误消息，并封装了特定的应用程序逻辑错误。

示例：实体未找到的自定义异常

public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

示例：抛出和处理异常

@Service
public class UserService {

    public User getUserById(Long id) {
        return userRepository.findById(id)
                .orElseThrow(() -> new UserNotFoundException("User with ID " + id + " not found"));
    }
}

@RestControllerAdvice
public class UserExceptionHandler {

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

数据库约束处理

优雅地处理数据库约束，例如唯一约束。

示例：唯一约束处理

@ExceptionHandler(DataIntegrityViolationException.class)
public ResponseEntity<String> handleUniqueConstraintViolation(DataIntegrityViolationException ex) {
    if (ex.getMostSpecificCause().getMessage().contains("unique constraint")) {
        return ResponseEntity.status(HttpStatus.CONFLICT).body("Duplicate entry detected");
    }
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("An unexpected error occurred");
}

错误日志

始终记录错误以便排查问题，同时确保排除敏感数据。

示例：使用 SLF4J 记录日志

@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleGeneralException(Exception ex) {
    log.error("An error occurred: {}", ex.getMessage());
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("An error occurred");
}

自定义查询中的验证

在执行存储库方法之前验证查询参数。

示例：验证存储库方法中的参数

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {

    @Query("SELECT p FROM Product p WHERE p.price BETWEEN :minPrice AND :maxPrice")
    List<Product> findByPriceRange(@Param("minPrice") BigDecimal minPrice, @Param("maxPrice") BigDecimal maxPrice);
}

服务层中的验证

public List<Product> getProductsByPriceRange(BigDecimal minPrice, BigDecimal maxPrice) {
    if (minPrice.compareTo(BigDecimal.ZERO) < 0 || maxPrice.compareTo(minPrice) < 0) {
        throw new IllegalArgumentException("Invalid price range");
    }
    return productRepository.findByPriceRange(minPrice, maxPrice);
}

使用验证组

利用验证组进行条件验证。

示例：创建和更新的验证组

public interface CreateGroup {}
public interface UpdateGroup {}

@Entity
public class Product {

    @NotNull(groups = CreateGroup.class, message = "Name is required for creation")
    private String name;

    @NotNull(groups = UpdateGroup.class, message = "Price is required for updates")
    private BigDecimal price;
}

异步错误处理

对于 @Async 方法，使用自定义的 AsyncUncaughtExceptionHandler。

示例：异步异常处理

@Configuration
public class AsyncConfig implements AsyncConfigurer {

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return (ex, method, params) -> log.error("Exception in method {} with params {}", method, params, ex);
    }
}

总结

Spring Data JPA 中的错误处理和验证对于构建弹性应用程序至关重要。通过遵循这些最佳实践并利用 Spring 的强大功能，你可以确保为用户提供无缝且可靠的体验。始终验证输入，优雅地处理异常，并为用户提供有意义的反馈。