TOC

Spring MVCのカスタムデータバインダー

Spring MVCのカスタムデータバインダー

1. 概要

この記事では、自動プリミティブをオブジェクト変換に適用することでコードをより明確で読みやすくするために、Springのデータバインディングメカニズムを使用する方法を示します。

デフォルトでは、Springは単純型の変換方法のみを知っています。 つまり、コントローラーInt、String、またはBooleanタイプのデータにデータを送信すると、適切なJavaタイプに自動的にバインドされます。

しかし、実際のプロジェクトでは、we might need to bind more complex types of objectsのようにそれだけでは十分ではありません。

2. 個々のオブジェクトをリクエストパラメータにバインドする

単純なものから始めて、最初に単純な型をバインドしましょう。 Converter<S, T>インターフェースのカスタム実装を提供する必要があります。ここで、Sは変換元のタイプであり、Tは変換先のタイプです。 

@Component
public class StringToLocalDateTimeConverter
  implements Converter {

    @Override
    public LocalDateTime convert(String source) {
        return LocalDateTime.parse(
          source, DateTimeFormatter.ISO_LOCAL_DATE_TIME);
    }
}

これで、コントローラーで次の構文を使用できます。 

@GetMapping("/findbydate/{date}")
public GenericEntity findByDate(@PathVariable("date") LocalDateTime date) {
    return ...;
}

2.1. リクエストパラメータとしての列挙型の使用

次に、how to use enum as a RequestParameterが表示されます。

ここに、単純なenumModesがあります。 

public enum Modes {
    ALPHA, BETA;
}

次のようにStringからenum Converterを作成します。 

public class StringToEnumConverter implements Converter {

    @Override
    public Modes convert(String from) {
        return Modes.valueOf(from);
    }
}

次に、Converterを登録する必要があります。 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToEnumConverter());
    }
}

これで、EnumをRequestParameterとして使用できます。 

@GetMapping
public ResponseEntity getStringToMode(@RequestParam("mode") Modes mode) {
    // ...
}





またはPathVariableとして： 








@GetMapping("/entity/findbymode/{mode}")
public GenericEntity findByEnum(@PathVariable("mode") Modes mode) {
    // ...
}











3. オブジェクトの階層のバインド 






オブジェクト階層のツリー全体を変換する必要がある場合があり、個々のコンバーターのセットではなく、より集中化されたバインディングを使用することが理にかなっています。 






この例では、基本クラスにAbstractEntityがあります。 








public abstract class AbstractEntity {
    long id;
    public AbstractEntity(long id){
        this.id = id;
    }
}








そして、サブクラスFooとBar： 








public class Foo extends AbstractEntity {
    private String name;

    // standard constructors, getters, setters
}










public class Bar extends AbstractEntity {
    private int value;

    // standard constructors, getters, setters
}








この場合、変換できるクラスの範囲を定義するwe can implement ConverterFactory<S, R> where S will be the type we are converting from and R to be the base type： 








public class StringToAbstractEntityConverterFactory
  implements ConverterFactory{

    @Override
    public  Converter getConverter(Class targetClass) {
        return new StringToAbstractEntityConverter<>(targetClass);
    }

    private static class StringToAbstractEntityConverter
      implements Converter {

        private Class targetClass;

        public StringToAbstractEntityConverter(Class targetClass) {
            this.targetClass = targetClass;
        }

        @Override
        public T convert(String source) {
            long id = Long.parseLong(source);
            if(this.targetClass == Foo.class) {
                return (T) new Foo(id);
            }
            else if(this.targetClass == Bar.class) {
                return (T) new Bar(id);
            } else {
                return null;
            }
        }
    }
}








ご覧のとおり、実装する必要がある唯一のメソッドは、必要なタイプのコンバーターを返すgetConverter()です。 変換プロセスは、このコンバーターに委任されます。 






次に、ConverterFactoryを登録する必要があります。 








@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(new StringToAbstractEntityConverterFactory());
    }
}








最後に、コントローラーで好きなように使用できます。 








@RestController
@RequestMapping("/string-to-abstract")
public class AbstractEntityController {

    @GetMapping("/foo/{foo}")
    public ResponseEntity getStringToFoo(@PathVariable Foo foo) {
        return ResponseEntity.ok(foo);
    }

    @GetMapping("/bar/{bar}")
    public ResponseEntity getStringToBar(@PathVariable Bar bar) {
        return ResponseEntity.ok(bar);
    }
}







4. ドメインオブジェクトのバインド 






データをオブジェクトにバインドしたい場合がありますが、それは直接的な方法ではなく（たとえば、Session、Header、またはCookie変数から）、またはに格納されます。データソース。 そのような場合、別のソリューションを使用する必要があります。 






4.1. カスタム引数リゾルバ 




まず、このようなパラメーターの注釈を定義します。 








@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface Version {
}








次に、カスタムHandlerMethodArgumentResolver:を実装します 








public class HeaderVersionArgumentResolver
  implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return methodParameter.getParameterAnnotation(Version.class) != null;
    }

    @Override
    public Object resolveArgument(
      MethodParameter methodParameter,
      ModelAndViewContainer modelAndViewContainer,
      NativeWebRequest nativeWebRequest,
      WebDataBinderFactory webDataBinderFactory) throws Exception {

        HttpServletRequest request
          = (HttpServletRequest) nativeWebRequest.getNativeRequest();

        return request.getHeader("Version");
    }
}








最後に、Springに検索先を知らせます。 








@Configuration
public class WebConfig implements WebMvcConfigurer {

    //...

    @Override
    public void addArgumentResolvers(
      List argumentResolvers) {
        argumentResolvers.add(new HeaderVersionArgumentResolver());
    }
}








それでおしまい。 これでコントローラーで使用できます： 








@GetMapping("/entity/{id}")
public ResponseEntity findByVersion(
  @PathVariable Long id, @Version String version) {
    return ...;
}








ご覧のとおり、HandlerMethodArgumentResolverのresolveArgument()メソッドはObject.を返します。つまり、Stringだけでなく、任意のオブジェクトを返すことができます。 












5. 結論 






その結果、多くの日常的な変換を取り除き、Springにほとんどの処理を任せました。 最後に、次のように結論付けましょう。 






    

  • 

    個々の単純な型からオブジェクトへの変換には、Converterの実装を使用する必要があります 
    

    • 

  • 

    さまざまなオブジェクトの変換ロジックをカプセル化するために、ConverterFactoryの実装を試すことができます 
    

    • 

  • 

    データが間接的に送信される場合、または関連データを取得するために追加のロジックを適用する必要がある場合は、HandlerMethodArgumentResolverを使用することをお勧めします 
    

    • 







いつものように、すべての例は常にGitHub repositoryにあります。 























































Related