#Spring Boot バリデーション実践入門

package dev.mikoto2000.springboot.validation.workshop.firststep.controller;

import org.hibernate.validator.constraints.Length;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import jakarta.validation.constraints.Pattern;

/**
 * EchoController
 */
@RestController
public class EchoController {

  /**
   * 引数を直接バリデーション。
   *
   * @param message 文字列
   *              - 必須ではない
   *              - デフォルト値は "0"
   *              - 1文字以上10文字以下
   *              - 数字のみ
   * @return 引数に改行文字を付与して返す
   */
  @GetMapping("/number-echo")
  public String numberEcho(
      @RequestParam(required = false, defaultValue = "0")
      // 文字列の長さは 1 から 10 とする
      @Length(min = 1, max = 10)
      // 文字は、正規表現 `[0-9]*` にマッチする
      @Pattern(regexp = "[0-9]*")
      String message) {
    return message + "\n";
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.controller;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import dev.mikoto2000.springboot.validation.workshop.firststep.bean.ValidationExampleBean;
import jakarta.validation.Valid;

/**
 * BeanEchoController
 */
@RestController
public class BeanEchoController {

  /**
   * Bean 定義でバリデーション。
   *
   * @param bean リクエストボディの JSON をマッピングした Bean
   *            - 各フィールドは null 不可(ValidationExampleBean の定義を参照)
   * @return 引数を Lombok の toString() で文字列化して改行文字を付与して返す
   */
  @PostMapping("/bean-echo")
  public String beanEcho(
      @Valid @RequestBody ValidationExampleBean bean) {
    return bean.toString() + "\n";
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.bean;

import jakarta.validation.constraints.NotNull;
import lombok.Data;

/**
 * ValidationExampleBean
 */
@Data
public class ValidationExampleBean {
  @NotNull
  private String stringValue;
  @NotNull
  private Integer integerValue;
  @NotNull
  private Double doubleValue;
}

package dev.mikoto2000.springboot.validation.workshop.firststep.bean;

import jakarta.validation.constraints.AssertTrue;
import jakarta.validation.constraints.NotNull;
import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * CalcInfo
 */
@AllArgsConstructor
@Data
public class CalcInfo {

  @NotNull
  private Double left;
  @NotNull
  private Double right;
  @NotNull
  private Operation operation;

  public enum Operation {
    ADD,
    SUBTRACT,
    MULTIPLY,
    DIVIDE
  }

  /**
   * 割り算はゼロ除算してはいけない。
   */
  @AssertTrue(message = "Division by zero is not allowed.")
  public boolean isValid() {
    // 割り算、かつ、右辺がゼロの場合は不正とする
    if (operation == Operation.DIVIDE && right == 0) {
      return false;
    }
    return true;
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.bean;

import dev.mikoto2000.springboot.validation.workshop.firststep.validation.constraints.RangeEx;
import jakarta.validation.constraints.NotNull;
import lombok.Data;

/**
 * BatteryStatus
 */
@Data
public class BatteryStatus {
  // バッテリー残量（0〜100の範囲, ただし、255 は不明とする）
  // 無理矢理感あるが、 IoT 機器とかの API でたまにこういうのがある
  @NotNull
  @RangeEx(min = 0, max = 100, others = {255})
  private Integer batteryLevel;
  // 充電中かどうか
  @NotNull
  private Boolean charging;
  // バッテリーの健康状態
  @NotNull
  private Health health;

  public static enum Health {
    GOOD,
    FAIR,
    POOR
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.validation.constraints;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import jakarta.validation.Constraint;
import jakarta.validation.OverridesAttribute;
import jakarta.validation.Payload;
import jakarta.validation.ReportAsSingleViolation;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import org.hibernate.validator.constraints.Range;

import dev.mikoto2000.springboot.validation.workshop.firststep.validation.validator.RangeExValidator;


/**
 * RangeEx。
 */
@Target({
    ElementType.FIELD,
    ElementType.METHOD,
    ElementType.PARAMETER,
    ElementType.ANNOTATION_TYPE,
    ElementType.TYPE_USE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = RangeExValidator.class)
@Documented
@Repeatable(RangeEx.List.class)
@Range
@ReportAsSingleViolation
public @interface RangeEx {

  /**
   * 最小値。
   */
  @OverridesAttribute(constraint = Min.class, name = "value")
  long min() default 0;

  /**
   * 最大値。
   */
  @OverridesAttribute(constraint = Max.class, name = "value")
  long max() default Integer.MAX_VALUE;

  String message() default "{dev.mikoto2000.springboot.validation.workshop.firststep.validation.constraints.RangeEx.message}";

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

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

  /**
   * 最大値と最小値範囲以外で許可する値のリスト。
   */
  long[] others();

  @Target({
      ElementType.FIELD,
      ElementType.METHOD,
      ElementType.PARAMETER,
      ElementType.ANNOTATION_TYPE })
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  @interface List {
    RangeEx[] value();
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.validation.validator;


import java.util.Arrays;

import dev.mikoto2000.springboot.validation.workshop.firststep.validation.constraints.RangeEx;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

/**
 * RangeExValidator
 */
public class RangeExValidator implements ConstraintValidator<RangeEx, Number> {

  private long min;
  private long max;
  private long[] others;

  @Override
  public void initialize(RangeEx rangeEx) {
    this.min = rangeEx.min();
    this.max = rangeEx.max();
    this.others = rangeEx.others();
  }

  @Override
  public boolean isValid(Number value, ConstraintValidatorContext context) {

    // others に存在しているか確認
    if (Arrays.stream(others).anyMatch(e -> e == value.longValue())) {
      // others に存在しているものは OK
      return true;
    } else {
      // others に存在していない場合、 min, max の範囲チェックを行う
      if (min <= value.longValue() && value.longValue() <= max) {
        // 範囲内であれば OK
        return true;
      } else {
        // 範囲外であれば NG
        return false;
      }
    }
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.controller;

import org.hibernate.validator.constraints.Length;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import jakarta.validation.constraints.Pattern;

/**
 * EchoController
 */
@RestController
public class EchoController {

  /**
   * 引数を直接バリデーション。
   *
   * @param message 文字列
   *              - 必須ではない
   *              - デフォルト値は "0"
   *              - 1文字以上10文字以下
   *              - 数字のみ
   * @return 引数に改行文字を付与して返す
   */
  @GetMapping("/number-echo")
  public String numberEcho(
      @RequestParam(required = false, defaultValue = "0")
      // 文字列の長さは 1 から 10 とする
      @Length(min = 1, max = 10, message = "1文字以上10文字以下で指定してください")
      // 文字は、正規表現 `[0-9]*` にマッチする
      @Pattern(regexp = "[0-9]*", message = "数字のみで指定してください")
      String message) {
    return message + "\n";
  }
}

package dev.mikoto2000.springboot.validation.workshop.firststep.controller.advice;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.HandlerMethodValidationException;

import dev.mikoto2000.springboot.validation.workshop.firststep.bean.ValidationError;
import dev.mikoto2000.springboot.validation.workshop.firststep.bean.ValidationErrors;
import lombok.extern.slf4j.Slf4j;

/**
 * ValidationExceptionHandler
 */
@Slf4j
@RestControllerAdvice
public class ValidationExceptionHandler {

  /**
   * メソッド引数の単純値のバリデーションエラーを処理するハンドラ。
   * @return ValidationErrors
   */
  @ExceptionHandler(HandlerMethodValidationException.class)
  @ResponseStatus(HttpStatus.BAD_REQUEST)
  public ValidationErrors handleMethodValidationException(HandlerMethodValidationException e) {

    log.info("handleMethodValidationException: {}", e);

    List<ValidationError> errors = new ArrayList<>();

    for (var error : e.getParameterValidationResults()) {
      String field = error.getMethodParameter().getParameterName();

      List<ValidationError> fieldErrors = error.getResolvableErrors().stream()
          .map(ve -> new ValidationError(field, ve.getDefaultMessage()))
          .toList();

      errors.addAll(fieldErrors);
    }

    return new ValidationErrors(errors);
  }

  /**
   * メソッド引数の bean のバリデーションエラーを処理するハンドラ。
   * @return ValidationErrors
   */
  @ExceptionHandler(MethodArgumentNotValidException.class)
  @ResponseStatus(HttpStatus.BAD_REQUEST)
  public ValidationErrors handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {

    log.info("handleMethodArgumentNotValidException: {}", e);

    List<ValidationError> errors = e.getFieldErrors().stream()
        .map((error) -> new ValidationError(error.getField(), error.getDefaultMessage()))
        .toList();

    return new ValidationErrors(errors);
  }

  /**
   * シンタックスエラーなど、そもそも正しくないリクエストだった場合に処理するハンドラ。
   * @return ValidationErrors
   */
  @ExceptionHandler(HttpMessageNotReadableException.class)
  @ResponseStatus(HttpStatus.BAD_REQUEST)
  public ValidationErrors handleMethodArgumentNotValidException(HttpMessageNotReadableException e) {
    log.info("handleMethodArgumentNotValidException: {}", e);

    List<ValidationError> errors = List.of(new ValidationError(null, e.getLocalizedMessage()));

    return new ValidationErrors(errors);
  }
}