スプリング型変換ガイド

投稿日: 2019-10-18 2022-10-31
タグ: Spring

1. 序章

この記事では、Springの型変換について見ていきます。

Springは、組み込みタイプ用のさまざまなコンバーターをすぐに使用できるように提供します。これは、 String、Integer、Boolean などの基本的なタイプ、およびその他の多くのタイプとの間で変換することを意味します。

これとは別に、Springはカスタムコンバーターを開発するためのソリッドタイプの変換SPIも提供しています。

2. 内蔵コンバーター

Springですぐに使用できるコンバーターから始めます。 文字列から整数への変換を見てみましょう。

@Autowired
ConversionService conversionService;

@Test
public void whenConvertStringToIntegerUsingDefaultConverter_thenSuccess() {
    assertThat(
      conversionService.convert("25", Integer.class)).isEqualTo(25);
}

ここで行う必要があるのは、Springが提供する ConversionService を自動配線し、 convert（）メソッドを呼び出すことだけです。最初の引数は変換する値であり、2番目の引数は変換するターゲットタイプです。

このStringからIntegerの例とは別に、さまざまな組み合わせを利用できます。

**3. カスタムコンバーターの作成**

EmployeeのString表現をEmployeeインスタンスに変換する例を見てみましょう。

Employeeクラスは次のとおりです。

public class Employee {

    private long id;
    private double salary;

    // standard constructors, getters, setters
}

The 弦を表すコンマ区切りのペアになります id と給料。たとえば、「1,50000.00」です。

私たちのカスタムを作成するためにコンバータ 、実装する必要がありますコンバータインターフェイスと実装変換（） 方法：

public class StringToEmployeeConverter
  implements Converter<String, Employee> {

    @Override
    public Employee convert(String from) {
        String[] data = from.split(",");
        return new Employee(
          Long.parseLong(data[0]), 
          Double.parseDouble(data[1]));
    }
}

まだ終わっていません。また、StringToEmployeeConverterをFormatterRegistryに追加して、この新しいコンバーターについてSpringに通知する必要があります。これは、 WebMvcConfigurer を実装し、 addFormatters（）メソッドをオーバーライドすることで実行できます。

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

以上です。新しいConverterがConversionServiceで利用できるようになり、他の組み込みのConverterと同じように使用できます。

@Test
public void whenConvertStringToEmployee_thenSuccess() {
    Employee employee = conversionService
      .convert("1,50000.00", Employee.class);
    Employee actualEmployee = new Employee(1, 50000.00);
    
    assertThat(conversionService.convert("1,50000.00", 
      Employee.class))
      .isEqualToComparingFieldByField(actualEmployee);
}

3.1. 暗黙の変換

ConversionService を使用したこれらの明示的な変換に加えて、 Springは、登録されているすべてのコンバーターのコントローラーメソッドで値を暗黙的に変換することもできます。

@RestController
public class StringToEmployeeConverterController {

    @GetMapping("/string-to-employee")
    public ResponseEntity<Object> getStringToEmployee(
      @RequestParam("employee") Employee employee) {
        return ResponseEntity.ok(employee);
    }
}

これは、コンバーターを使用するより自然な方法です。テストを追加して、実際の動作を確認しましょう。

@Test
public void getStringToEmployeeTest() throws Exception {
    mockMvc.perform(get("/string-to-employee?employee=1,2000"))
      .andDo(print())
      .andExpect(jsonPath("$.id", is(1)))
      .andExpect(jsonPath("$.salary", is(2000.0)))
}

ご覧のとおり、テストではリクエストとレスポンスのすべての詳細が出力されます。応答の一部として返されるJSON形式のEmployeeオブジェクトは次のとおりです。

{"id":1,"salary":2000.0}

**4. ConverterFactoryの作成**

オンデマンドでConverterを作成するConverterFactoryを作成することもできます。これは、EnumsのConverterを作成する場合に特に役立ちます。

本当に単純な列挙型を見てみましょう。

public enum Modes {
    ALPHA, BETA;
}

次に、Stringを任意のEnumに変換するためのConverterを生成できるStringToEnumConverterFactoryを作成しましょう。

@Component
public class StringToEnumConverterFactory 
  implements ConverterFactory<String, Enum> {

    private static class StringToEnumConverter<T extends Enum> 
      implements Converter<String, T> {

        private Class<T> enumType;

        public StringToEnumConverter(Class<T> enumType) {
            this.enumType = enumType;
        }

        public T convert(String source) {
            return (T) Enum.valueOf(this.enumType, source.trim());
        }
    }

    @Override
    public <T extends Enum> Converter<String, T> getConverter(
      Class<T> targetType) {
        return new StringToEnumConverter(targetType);
    }
}

ご覧のとおり、ファクトリクラスは内部でConverterインターフェイスの実装を使用しています。

ここで注意すべきことの1つは、 Modes Enum を使用して使用法を示しますが、StringToEnumConverterFactoryのどこにもEnumについて言及していないことです。 私たちのファクトリクラスは、任意の列挙型に対してオンデマンドでコンバータを生成するのに十分な汎用性を備えています。

次のステップは、前の例で Converter を登録したので、このファクトリクラスを登録することです。

@Override
public void addFormatters(FormatterRegistry registry) {
    registry.addConverter(new StringToEmployeeConverter());
    registry.addConverterFactory(new StringToEnumConverterFactory());
}

これで、ConversionServiceはStringをEnumに変換する準備が整いました。

@Test
public void whenConvertStringToEnum_thenSuccess() {
    assertThat(conversionService.convert("ALPHA", Modes.class))
      .isEqualTo(Modes.ALPHA);
}

**5. GenericConverterの作成**

GenericConverter は、型安全性を失うことを犠牲にして、より一般的な使用のためにConverterを作成するためのより高い柔軟性を提供します。

Integer 、 Double 、またはStringをBigDecimal値に変換する例を考えてみましょう。このための3つのコンバーター。単純なGenericConverterが目的を果たすことができます。

最初のステップは、サポートされている変換のタイプをSpringに通知することです。これを行うには、ConvertiblePairのSetを作成します。

public class GenericBigDecimalConverter 
  implements GenericConverter {

@Override
public Set<ConvertiblePair> getConvertibleTypes () {

    ConvertiblePair[] pairs = new ConvertiblePair[] {
          new ConvertiblePair(Number.class, BigDecimal.class),
          new ConvertiblePair(String.class, BigDecimal.class)};
        return ImmutableSet.copyOf(pairs);
    }
}

次のステップは、同じクラスの convert（）メソッドをオーバーライドすることです。

@Override
public Object convert (Object source, TypeDescriptor sourceType, 
  TypeDescriptor targetType) {

    if (sourceType.getType() == BigDecimal.class) {
        return source;
    }

    if(sourceType.getType() == String.class) {
        String number = (String) source;
        return new BigDecimal(number);
    } else {
        Number number = (Number) source;
        BigDecimal converted = new BigDecimal(number.doubleValue());
        return converted.setScale(2, BigDecimal.ROUND_HALF_EVEN);
    }
}

convert（）メソッドは可能な限り単純です。ただし、 TypeDescriptor は、ソースとターゲットのタイプに関する詳細を取得するという点で非常に柔軟性があります。

ご想像のとおり、次のステップはこのConverterを登録することです。

@Override
public void addFormatters(FormatterRegistry registry) {
    registry.addConverter(new StringToEmployeeConverter());
    registry.addConverterFactory(new StringToEnumConverterFactory());
    registry.addConverter(new GenericBigDecimalConverter());
}

このConverterの使用は、これまでに見た他の例と似ています。

@Test
public void whenConvertingToBigDecimalUsingGenericConverter_thenSuccess() {
    assertThat(conversionService
      .convert(Integer.valueOf(11), BigDecimal.class))
      .isEqualTo(BigDecimal.valueOf(11.00)
      .setScale(2, BigDecimal.ROUND_HALF_EVEN));
    assertThat(conversionService
      .convert(Double.valueOf(25.23), BigDecimal.class))
      .isEqualByComparingTo(BigDecimal.valueOf(Double.valueOf(25.23)));
    assertThat(conversionService.convert("2.32", BigDecimal.class))
      .isEqualTo(BigDecimal.valueOf(2.32));
}

6. 結論

このチュートリアルでは、さまざまな例を使用して、Springの型変換システムを使用および拡張する方法を説明しました。

いつものように、この記事の完全なソースコードは、GitHubのにあります。

getdocs

13036