SpringBoot Rest API 中的数字验证：最佳实践及方法详解

2024-03-19 12:15:12

## SpringBoot Rest API 中的数字验证

引言

在构建 SpringBoot Rest API 时，数据验证是确保请求数据完整性和可靠性的关键一步。对于数字字段，如金额或数量，验证数字格式尤为重要。本文将深入探讨在 SpringBoot 中验证数字字段的最佳实践，探讨可用的方法并提供可行解决方案。

方法 1：使用 `@Valid` 和 `@NumberFormat` 注解

最初，尝试使用 @Valid 和 @NumberFormat 注解来验证数字格式。然而，这种方法无法抛出所需的异常，而是返回错误消息。

方法 2：使用自定义方法验证器

自定义方法验证器提供了一种更灵活的方法来验证数字。通过实现 ConstraintValidator 接口，我们可以定义自己的验证逻辑。

public class BigDecimalValidator implements ConstraintValidator<NumberFormat, BigDecimal> {

    @Override
    public void initialize(NumberFormat constraintAnnotation) {
        // ...
    }

    @Override
    public boolean isValid(BigDecimal value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        try {
            new BigDecimal(value.toString());
            return true;
        } catch (NumberFormatException e) {
            throw new IllegalArgumentException("Invalid amount format");
        }
    }
}

这种方法可以抛出所需的异常，但需要手动编写转换器。

方法 3：使用 Spring 的 ConversionService

Spring 提供了 ConversionService，它允许我们注册自定义转换器以将字符串转换为数字。通过实现 Converter 接口，我们可以定义自己的转换逻辑。

public class BigDecimalConverter implements Converter<String, BigDecimal> {

    @Override
    public BigDecimal convert(String source) {
        try {
            return new BigDecimal(source);
        } catch (NumberFormatException e) {
            throw new IllegalArgumentException("Invalid amount format");
        }
    }
}

这种方法可以抛出所需的异常，但需要手动编写转换器。

最佳实践：使用自定义方法验证器

经过一番探索，发现使用自定义方法验证器是实现所需行为的最佳方法。自定义方法验证器允许我们完全控制验证逻辑，并且可以轻松抛出所需的异常。

示例

以下是使用自定义方法验证器来验证金额字段的示例：

public class RequestDTO {

    @NumberFormat
    private BigDecimal amount;
    // ...
}

@PostMapping("/")
public ResponseEntity<String> create(@RequestBody @Valid RequestDTO requestDTO) {
    // ...
}