質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.10%

SpringValidatorでチェックした結果メッセージをRESTコントローラで返したい

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 20K+

score 13

いつもお世話になっています。

 問題点・質問

SpringBootの@RestControllerを使って、WebAPIを提供するシステムを作成しています。

コントローラにおいて、ドメインに次の2つの入力チェックを行おうとしています

  1. 桁数チェック(アノテーション)
  2. 必須チェック(Spring Validator)

エラーが発生した時(@ExceptionHandler(MethodArgumentNotValidException.class)にて)、BindingResult.getDefaultMessageによって、エラーメッセージを取得しようとしています。しかし、

  1. の桁数チェック(アノテーション)ではメッセージプロパティに定義した文章が取得できますが、
  2. の必須チェック(Spring Validator)では取得結果がnullになってしまいます。

Spring Validatorを使ったチェックでも、メッセージプロパティに定義した文章を取得したいです。
MessageSourceからメッセージを取得するタイミングが無いのだと思いますが、どのように実装するのがよいか、お教え頂ければと思います。

 コード

  • ドメイン
public class MyFormSpringValidation {

    @Size(min = 6, max = 20)
    private String name;

・・・
  • バリデータ
import org.springframework.validation.Validator;

@Component
public class MyFormSpringValidator implements Validator{

・・・

    @Override
    public void validate(Object target, Errors errors) {

        MyFormSpringValidation form = (MyFormSpringValidation) target;
        String name = form.getName();

        if(StringUtils.isEmpty(name)) {
            errors.rejectValue("name"
                , "myformspringvalidator.name");
        }

        // その他入力チェック増える予定
・・・
  • RESTコントローラ
@RestController
@RequestMapping("/api")
public class MyFormSpringValidationResource {

    @Inject
    MyFormSpringValidator myFormSpringValidator;

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addValidators(myFormSpringValidator);
    }

    @RequestMapping(value = "/myformspringvalidation",
        method = RequestMethod.POST)
    @Timed
    public ResponseEntity<MyFormSpringValidation> createForm(@Validated @RequestBody MyFormSpringValidation myform) {
・・・
  • エラー用コントローラ
@ControllerAdvice
public class ExceptionTranslator {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public ErrorDTO processValidationError(MethodArgumentNotValidException ex) {
        BindingResult result = ex.getBindingResult();
        List<FieldError> fieldErrors = result.getFieldErrors();

        ErrorDTO dto = new ErrorDTO(ErrorConstants.ERR_VALIDATION);

        for (FieldError fieldError : fieldErrors) {
            dto.add(fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
        }

        return dto;
    }
  • エラー用DTO
public class ErrorDTO implements Serializable {

    private final String message;
    private final String description;

    public void add(String objectName, String field, String message) {
        if (fieldErrors == null) {
            fieldErrors = new ArrayList<>();
        }
        fieldErrors.add(new FieldErrorDTO(objectName, field, message));
    } 

    // 以下、他メンバ、Getter、Setter

・・・
  • メッセージソース
@Configuration
public class MessageConfiguration {

    @Bean
    public MessageSource messageSource() {
        ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
        messageSource.setBasenames("i18n/messages");
        messageSource.setDefaultEncoding("UTF-8");
        return messageSource;
    }
}
  • メッセージソースをバリデータに設定
@Configuration
public class LocaleConfiguration extends WebMvcConfigurerAdapter implements EnvironmentAware {

    @Inject
    private MessageSource messageSource;

    @Bean
    public LocalValidatorFactoryBean validator() {
        LocalValidatorFactoryBean localValidatorFactoryBean = new LocalValidatorFactoryBean();
        localValidatorFactoryBean.setValidationMessageSource(messageSource);
        return localValidatorFactoryBean;
    }

    @Override
    public Validator getValidator()
    {
        return validator();
    }
  • メッセージプロパティファイル
myformspringvalidator.name=SpringValidatorでは必須です。
javax.validation.constraints.Size.message=文字数は{min}桁から{max}桁の範囲で入力してください。

 試したこと

  • バリデータ内のerrors.rejectValueにおいて、デフォルトメッセージにMessageSourceから取得したメッセージを渡す
import org.springframework.validation.Validator;

@Component
public class MyFormSpringValidator implements Validator{

・・・
            if(StringUtils.isEmpty(name)) {
                errors.rejectValue("name"
                    , "myformspringvalidator.name"
                    , messageSource.getMessage("myformspringvalidator.name", null, Locale.getDefault()));
            }


これはきっと、フレームワークの良しとするところではないかと・・・


ご助力を宜しくお願いします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

check解決した方法

0

 結果

クライアントに返すErrorDTOを作成する際に、MessageSource.getMessageを実行するようにしました。

  • エラー用コントローラにて
@Inject
    MessageSource messageSource;

    public ErrorDTO processValidationError(MethodArgumentNotValidException ex) {
        BindingResult result = ex.getBindingResult();
        List<FieldError> fieldErrors = result.getFieldErrors();

        ErrorDTO dto = new ErrorDTO(ErrorConstants.ERR_VALIDATION);

        for (FieldError fieldError : fieldErrors) {
            // 変更前
            // dto.add(fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());

            // 変更後
            dto.add(fieldError.getObjectName(), fieldError.getField(),
                messageSource.getMessage(fieldError.getCode(), fieldError.getArguments(), fieldError.getDefaultMessage(), Locale.getDefault()));
        }

        return dto;
    }

 理由その1

JSR-303による入力チェック時(javax.validation.constraintsパッケージのアノテーション、Bean Validation)、BindingResult.ErrorへのFieldErrorインスタンス投入は、SpringValidatorAdapterクラスのprocessConstraintViolationsメソッドで行われているようでした。

/**
     * Process the given JSR-303 ConstraintViolations, adding corresponding errors to
     * the provided Spring {@link Errors} object.
     * @param violations the JSR-303 ConstraintViolation results
     * @param errors the Spring errors object to register to
     */
    protected void processConstraintViolations(Set<ConstraintViolation<Object>> violations, Errors errors) {
        for (ConstraintViolation<Object> violation : violations) {
・・・
                            bindingResult.addError(new FieldError(
                                    errors.getObjectName(), nestedField, rejectedValue, false,
                                    errorCodes, errorArgs, violation.getMessage()));
・・・

1つの理由は、この位置と同等のレベルの自作クラスを用意する必要性を感じなかったことです。

 理由その2(こっちのほうが実感あり)

そもそも取得しようとしていたFieldError.getDefaultMessageメソッドはあくまで*デフォルトメッセージ取得*が目的であることに気づきました(名前からしてそうなんですが・・・)。

FieldErrorクラスに用意されたメッセージ関係メソッドが

  • getCode
  • getDefaultMessage

であるところをみると、そもそもこのFieldErrorクラスで取り扱うのはまだ最終的なメッセージではないということです。

私が本来欲しかったのはWebAPIとしてクライアントに返される、システムとして最終的な結果メッセージです。

ということは、アノテーションの場合もSpring Validatorの場合も、FieldErrorの結果を受けて最終的なクライアントへのレスポンスを返すフィルターないしレイヤーが必要ということを感じました。

 というわけで

FieldErrorからErrorDTOに詰め替える間に、MessageSource.getMessageを実行することにしました。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.10%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る