Spring中自定義數(shù)據(jù)類型轉(zhuǎn)換的方法詳解

更新時(shí)間：2022年06月20日 09:23:09 作者：Spring全家桶實(shí)戰(zhàn)案例

Spring3引入了一個(gè)core.onvert包，提供一個(gè)通用類型轉(zhuǎn)換系統(tǒng)。在Spring容器中，可以使用這個(gè)系統(tǒng)作為PropertyEditor實(shí)現(xiàn)的替代，將外部化的bean屬性值字符串轉(zhuǎn)換為所需的屬性類型。本文將詳解這一系統(tǒng)的使用方法，需要的可以參考一下

Spring 3引入了一個(gè)core.onvert包，提供一個(gè)通用類型轉(zhuǎn)換系統(tǒng)。系統(tǒng)定義了一個(gè)SPI來(lái)實(shí)現(xiàn)類型轉(zhuǎn)換邏輯，以及一個(gè)API來(lái)在運(yùn)行時(shí)執(zhí)行類型轉(zhuǎn)換。在Spring容器中，可以使用這個(gè)系統(tǒng)作為PropertyEditor實(shí)現(xiàn)的替代，將外部化的bean屬性值字符串轉(zhuǎn)換為所需的屬性類型。還可以在應(yīng)用程序中需要類型轉(zhuǎn)換的任何地方使用公共API。

類型轉(zhuǎn)換服務(wù)

ConversionService 類型轉(zhuǎn)換服務(wù)的接口。

public interface ConversionService {
  // 判斷是否能進(jìn)行轉(zhuǎn)換
  boolean canConvert(Class<?> sourceType, Class<?> targetType);
  boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType);
  // 進(jìn)行類型轉(zhuǎn)換
  <T> T convert(Object source, Class<T> targetType);
  Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}

在大多數(shù)情況下我們應(yīng)該實(shí)現(xiàn)。

ConfigurableConversionService可配置的類型轉(zhuǎn)換服務(wù)接口。該接口整合ConversionService的所有操作和ConverterRegistry接口的相關(guān)操作，可對(duì)具體的轉(zhuǎn)換進(jìn)行增刪。在應(yīng)用程序上下文引導(dǎo)代碼中處理ConfigurableEnvironment實(shí)例時(shí)，后者特別有用。

ConfigurableConversionService接口。

public interface ConfigurableConversionService extends ConversionService, ConverterRegistry {
}

Spring提供了GenericConversionService 實(shí)現(xiàn)類；該類適合在大多數(shù)環(huán)境中使用的基本 ConversionService實(shí)現(xiàn)。通過(guò)

ConfigurableConversionService接口間接實(shí)現(xiàn)ConverterRegistry作為注冊(cè)API。該類沒(méi)有提供默認(rèn)的類型轉(zhuǎn)換功能，需要我們自己添加轉(zhuǎn)換接口。

示例：

GenericConversionService gcs = new GenericConversionService() ;
Long result = gcs.convert("10", Long.class) ;
System.out.println(result) ;

以上代碼運(yùn)行將報(bào)錯(cuò)：

Exception in thread "main" org.springframework.core.convert.ConverterNotFoundException: No converter found capable of converting from type [java.lang.String] to type [java.lang.Long]
at org.springframework.core.convert.support.GenericConversionService.handleConverterNotFound(GenericConversionService.java:322)
at org.springframework.core.convert.support.GenericConversionService.convert(GenericConversionService.java:195)
at org.springframework.core.convert.support.GenericConversionService.convert(GenericConversionService.java:175)
at com.pack.main.conversion.GenericConversionServiceMain.main(GenericConversionServiceMain.java:9)

沒(méi)有轉(zhuǎn)換接口發(fā)現(xiàn)錯(cuò)誤。

FormattingConversionService 類是GenericConversionService 子類對(duì)象，主要作用就是增加了格式化功能（還是類型轉(zhuǎn)換的一種表現(xiàn)），該類提供了 Printer和Parser的支持，可對(duì)對(duì)象進(jìn)行打印展示及將源數(shù)據(jù)解析成目標(biāo)對(duì)象，示例：

FormattingConversionService fcs = new FormattingConversionService() ;
fcs.addParser(new Parser<Teacher>() {
  @Override
  public Teacher parse(String text, Locale locale) throws ParseException {
    String[] t = text.split("\\|") ;
    return new Teacher(t[0], Integer.valueOf(t[1])) ;
  }
});
System.out.println(fcs.convert("張晶晶|26", Teacher.class)) ;

這里的addParser方法最后還是將Parser轉(zhuǎn)換為GenericConverter。

將對(duì)象轉(zhuǎn)換為可讀的信息，示例：

FormattingConversionService fcs = new FormattingConversionService() ;
fcs.addPrinter(new Printer<Teacher>() {
  @Override
  public String print(Teacher object, Locale locale) {
    return "【 name = " + object.getName() + ", age = " + object.getAge() + "】" ;
  }
});
System.out.println(fcs.convert(new Teacher("張晶晶", 26), String.class)) ;

以上介紹的類型轉(zhuǎn)換服務(wù)默認(rèn)沒(méi)有任何的類型轉(zhuǎn)換能力，都需要我們自定義添加，在Spring中還提供了DefaultConversionService 和 WebConversionService。

通過(guò)名稱知道WebConversionService 針對(duì)Web項(xiàng)目，但是你也是可以在非Web項(xiàng)目中使用。這里我就介紹DefaultConversionService 。先看示例：

DefaultConversionService dcs = new DefaultConversionService() ;
Long result = dcs.convert("10", Long.class) ;
Date date = dcs.convert("2022-07-01", Date.class) ;
System.out.println(result) ;
System.out.println(date) ;

上面兩個(gè)類型的轉(zhuǎn)換都能成功，為什么呢？因?yàn)镈efaultConversionService 內(nèi)部已經(jīng)幫我們注冊(cè)了很多的類型轉(zhuǎn)換，源碼：

public class DefaultConversionService extends GenericConversionService {
  public DefaultConversionService() {
    addDefaultConverters(this);
  }
  public static void addDefaultConverters(ConverterRegistry converterRegistry) {
    addScalarConverters(converterRegistry);
    // 該方法中還注冊(cè)了很多集合，流數(shù)據(jù)類型的轉(zhuǎn)換功能，詳細(xì)查看源碼
    addCollectionConverters(converterRegistry);
    converterRegistry.addConverter(new ByteBufferConverter((ConversionService) converterRegistry));
    converterRegistry.addConverter(new StringToTimeZoneConverter());
    converterRegistry.addConverter(new ZoneIdToTimeZoneConverter());
    converterRegistry.addConverter(new ZonedDateTimeToCalendarConverter());

    converterRegistry.addConverter(new ObjectToObjectConverter());
    converterRegistry.addConverter(new IdToEntityConverter((ConversionService) converterRegistry));
   converterRegistry.addConverter(new FallbackObjectToStringConverter());
   converterRegistry.addConverter(new ObjectToOptionalConverter((ConversionService) converterRegistry));
  }
}

通常我們一般都是使用DefaultConversionService。

在Web環(huán)境下默認(rèn)使用的WebConversionService ，這里以SpringBoot為例，源碼如下：

public class WebMvcAutoConfiguration {
  public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {
    @Bean
    @Override
    public FormattingConversionService mvcConversionService() {
      Format format = this.mvcProperties.getFormat();
      WebConversionService conversionService = new WebConversionService(new DateTimeFormatters().dateFormat(format.getDate()).timeFormat(format.getTime()).dateTimeFormat(format.getDateTime()));
      addFormatters(conversionService);
      return conversionService;
    }    
  }
}

WebConversionService的繼承關(guān)系

public class WebConversionService extends DefaultFormattingConversionService {}
public class DefaultFormattingConversionService extends FormattingConversionService {}
public class FormattingConversionService extends GenericConversionService
  implements FormatterRegistry, EmbeddedValueResolverAware {
}

Spring還提供了一個(gè)ConversionServiceFactoryBean來(lái)注冊(cè)我們自定義的類型轉(zhuǎn)換。

public class ConversionServiceFactoryBean implements FactoryBean<ConversionService>, InitializingBean {
  private Set<?> converters;
  private GenericConversionService conversionService;
  public void setConverters(Set<?> converters) {
    this.converters = converters;
  }
  @Override
  public void afterPropertiesSet() {
    this.conversionService = createConversionService();
    ConversionServiceFactory.registerConverters(this.converters, this.conversionService);
  }
  protected GenericConversionService createConversionService() {
    return new DefaultConversionService();
  }
  @Override
  public ConversionService getObject() {
    return this.conversionService;
  }
  @Override
  public Class<? extends ConversionService> getObjectType() {
    return GenericConversionService.class;
  }
  @Override
  public boolean isSingleton() {
    return true;
  }
}

我們可以定個(gè)該Bean，然后注入converters屬性值。

@Bean
public ConversionServiceFactoryBean conversionService() {
  ConversionServiceFactoryBean factory = new ConversionServiceFactoryBean() ;
  // 自定義的類型轉(zhuǎn)換
  factory.setConverters(...) ;
  return factory ;
}

Spring的類型轉(zhuǎn)換服務(wù)是不是挺簡(jiǎn)單？接下來(lái)介紹Spring提供的各種自定義類型轉(zhuǎn)換方式。

接下來(lái)我們都是以示例為主。

實(shí)現(xiàn)Converter接口

Converter接口。

@FunctionalInterface
public interface Converter<S, T> {
  T convert(S source);
}

自定義Converter接口，我們使用匿名內(nèi)部類實(shí)現(xiàn)。

DefaultConversionService cs = new DefaultConversionService();
// 自定義類型轉(zhuǎn)換器，當(dāng)有了ConversionService完全可以替代PropertyEditor
cs.addConverter(new Converter<String, Users>() {
  public Users convert(String source) {
    String[] temp = source.split("\\|") ;
    return new Users(temp[0], Integer.parseInt(temp[1])) ;
  }
}) ;
Users users = cs.convert("張三|100", Users.class) ;
System.out.println(users) ;

實(shí)現(xiàn)ConverterFactory接口

當(dāng)你需要集中整個(gè)類層次結(jié)構(gòu)的轉(zhuǎn)換邏輯時(shí)(例如，當(dāng)從String轉(zhuǎn)換到Enum對(duì)象時(shí))，你可以實(shí)現(xiàn)ConverterFactory。也就是有繼承關(guān)系的類型轉(zhuǎn)換。

ConverterFactory接口。

public interface ConverterFactory<S, R> {
  <T extends R> Converter<S, T> getConverter(Class<T> targetType);
}

自定義工廠類。

public class EnvObjectConvert implements ConverterFactory<String, EnvObject> {
  @Override
  public <T extends EnvObject> Converter<String, T> getConverter(Class<T> targetType) {
    return new EnvConvert<T>();
  }
  private class EnvConvert<T extends EnvObject> implements Converter<String, T> {
    @Override
    public T convert(String source) {
      String[] temp = source.split("\\|") ;
      return (T) new EnvObject(temp[0], Integer.valueOf(temp[1])) ;
    }
  }
}

實(shí)現(xiàn)GenericConverter接口

當(dāng)你需要復(fù)雜的Converter實(shí)現(xiàn)時(shí)，請(qǐng)考慮使用GenericConverter接口。與Converter相比，GenericConverter具有更靈活但強(qiáng)類型較少的簽名，因此它支持在多個(gè)源類型和目標(biāo)類型之間進(jìn)行轉(zhuǎn)換。此外，GenericConverter提供了可用的源和目標(biāo)字段上下文，你可以在實(shí)現(xiàn)轉(zhuǎn)換邏輯時(shí)使用它們。這樣的上下文允許通過(guò)字段注釋或在字段簽名上聲明的泛型信息驅(qū)動(dòng)類型轉(zhuǎn)換。下面的清單顯示了GenericConverter的接口定義:

GenericConverter接口。

public interface GenericConverter {
  Set<ConvertiblePair> getConvertibleTypes();
  Object convert(@Nullable Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}

自定義GenericConverter。

public class CustomGenericConverter implements GenericConverter {
  @Override
  public Set<ConvertiblePair> getConvertibleTypes() {
    // 這里我們可以定義多組的類型轉(zhuǎn)換關(guān)系
    ConvertiblePair teacherPair = new ConvertiblePair(String.class, Teacher.class) ;
    ConvertiblePair studentPair = new ConvertiblePair(String.class, Student.class) ;
    Set<ConvertiblePair> pairs = new HashSet<>() ;
    pairs.add(teacherPair) ;
    pairs.add(studentPair) ;
    return pairs ;
  }
  @Override
  public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
    // 下面分別看到不同的類型做不同的處理
    String str = null ;
    if (sourceType.getObjectType() == String.class) {
      str = (String) source ; 
    }
    if (targetType.getObjectType() == Teacher.class) {
      String[] t = str.split("\\|") ;
      return new Teacher(t[0], Integer.valueOf(t[1])) ;
    }
    if (targetType.getObjectType() == Student.class) {
      String[] t = str.split("\\|") ;
      return new Student(t[0], t[1]) ;
    }
    return null ;
  }
}

以上就是Spring中自定義數(shù)據(jù)類型轉(zhuǎn)換的方法詳解的詳細(xì)內(nèi)容，更多關(guān)于Spring數(shù)據(jù)類型轉(zhuǎn)換的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: