Spring Boot 2.0 配置属性自定义转换的方法

 更新时间:2018年11月08日 11:12:05   作者:paderlol  
这篇文章主要介绍了Spring Boot 2.0 配置属性自定义转换的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

引言

当我们通过@ConfigurationProperties注解实现配置 bean的时候,如果默认的配置属性转换无法满足我们的需求的时候,我们可以根据自己的需求通过以下扩展方式对配置属性进行转换

PropertyEditorSupport实现

下面的例子是把属性中定义的字符串转换成Movie,并且把name的值大写

继承PropertyEditorSupport并且实现PropertyEditorRegistrar接口

package com.paderlol.spring.practice.properties.editor;

import com.paderlol.spring.practice.properties.pojo.Movie;
import java.beans.PropertyEditorSupport;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.PropertyEditorRegistrar;
import org.springframework.beans.PropertyEditorRegistry;

/**
 * @author pader PropertyEditor 在不同的包下面
 */
@Slf4j
public class CustomMovieEditor extends PropertyEditorSupport
implements PropertyEditorRegistrar {

  @Override
  public String getAsText() {
    Movie movie = (Movie) getValue();
    return movie == null ? "" : movie.getName();
  }

  @Override
  public void setAsText(String text) throws IllegalArgumentException {
    log.info("继承[PropertyEditorSupport]类,转换数据={}", text);
    String[] data = text.split("-");
    Movie movie = Movie.builder().name(data[0]
    .toUpperCase()).seat(Integer.parseInt(data[1]))
    .build();
    setValue(movie);
  }


  @Override
  public void registerCustomEditors(PropertyEditorRegistry registry) {
    registry.registerCustomEditor(Movie.class,this);
  }
}

注册自定义的PropertyEditor

@Bean
public CustomEditorConfigurer customEditorConfigurer() {
  CustomEditorConfigurer customEditorConfigurer = new CustomEditorConfigurer();   
   // 有两种注册方式 这是第一种
  customEditorConfigurer.setPropertyEditorRegistrars( 
    new PropertyEditorRegistrar[]{ new CustomMovieEditor() });
     // 第二 种
    Map<Class<?>,Class<? extends PropertyEditor>> maps = new HashMap<>();
    maps.put(Movie.class,CustomMovieEditor.class);

  return customEditorConfigurer;
}

Converter接口+@ConfigurationPropertiesBinding注解

//注意
@Component
@ConfigurationPropertiesBinding
public class StringToPersonConverter implements Converter<String, Person> {

  @Override
  public Person convert(String from) {
    log.info("使用[Converter]接口,转换数据={}", from);
    String[] data = from.split(",");
    return Person.builder().name(data[0]).age(Integer.parseInt(data[1])).build();
  }
}

总结

  • 以上两种实现方式结果,但是Converter接口相比PropertyEditor接口更加灵活一些,PropertyEditor接口仅限于String转换,Converter可以自定义别的,并且PropertyEditor接口通常用于Controller中的接收参数的转换。
  • @ConfigurationPropertiesBinding是限定符注解@Qualifier的派生类而已,参考org.springframework.boot.context.properties.ConversionServiceDeducer,以下是源代码片段
@Autowired(required = false)
@ConfigurationPropertiesBinding
public void setConverters(List<Converter<?, ?>> converters) {
   this.converters = converters;
}

/**
* A list of custom converters (in addition to the defaults) to use when
* converting properties for binding.
* @param converters the converters to set
*/
@Autowired(required = false)
@ConfigurationPropertiesBinding
public void setGenericConverters(List<GenericConverter> converters) {
this.genericConverters = converters;
 }

  • Formatter接口是不能对属性完成转换的,因为ConversionServiceDeducer初始化的时候只获取GenericConverter和Converter接口
  • 官方文档上还介绍了可以使用实现org.springframework.core.convert.ConversionService并且Bean名称也必须叫conversionService,不过大部分情况不推荐自己通过这种方式去实现这个接口,因为自己实现的ConversionService会替代默认的。具体参考ConversionServiceDeducer源码:
public ConversionService getConversionService() {
    try {
      //默认首先寻找Bean名称叫conversionService的ConversionService的Bean类
      return this.applicationContext.getBean(
          ConfigurableApplicationContext.CONVERSION_SERVICE_BEAN_NAME,
          ConversionService.class);
    }
    catch (NoSuchBeanDefinitionException ex) {
      //找不到就默认生成ApplicationConversionService类
      return this.applicationContext.getAutowireCapableBeanFactory()
          .createBean(Factory.class).create();
    }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 关于SpringMVC请求域对象的数据共享问题

    关于SpringMVC请求域对象的数据共享问题

    这篇文章主要介绍了SpringMVC请求域对象的数据共享问题,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-02-02
  • Java 利用dom方式读取、创建xml详解及实例代码

    Java 利用dom方式读取、创建xml详解及实例代码

    这篇文章主要介绍了Java 利用dom方式读取、创建xml的相关资料,需要的朋友可以参考下
    2017-03-03
  • Java设计模式之桥接模式的实现

    Java设计模式之桥接模式的实现

    今天给大家带来的文章是Java设计模式的相关知识点,文中对桥接模式作了非常详细的介绍及代码示例,对正在学习的小伙伴们很有帮助,需要的朋友可以参考下
    2021-06-06
  • Java中Jackson快速入门

    Java中Jackson快速入门

    这篇文章主要介绍了Java中Jackson快速入门,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • java 中的封装介绍及使用方法

    java 中的封装介绍及使用方法

    这篇文章主要介绍了java 中的封装介绍及使用方法的相关资料,封装是指一种将抽象性函式接口的实现细节部份包装、隐藏起来的方法,需要的朋友可以参考下
    2017-08-08
  • 使用SpringBoot简单实现一个苹果支付的场景

    使用SpringBoot简单实现一个苹果支付的场景

    这篇文章主要为大家详细介绍了如何在Spring Boot项目中集成Apple Pay功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-11-11
  • java简单实现数组的增删改查方法

    java简单实现数组的增删改查方法

    这篇文章主要介绍了Java数组的增删改查的示例,帮助大家更好的利用Java处理数据,感兴趣的朋友可以了解下,希望能给你带来帮助
    2021-07-07
  • 使用IDEA创建maven父子工程项目 (图文)

    使用IDEA创建maven父子工程项目 (图文)

    本文主要介绍了使用IDEA创建maven父子工程项目,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-04-04
  • Java微信公众平台开发(11) 微信三大平台的关联

    Java微信公众平台开发(11) 微信三大平台的关联

    这篇文章主要介绍了Java微信公众平台开发第十一步,微信开发中微信公众平台、开放平台和商户平台的关联,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • Maven中利用assembly插件打包jar包

    Maven中利用assembly插件打包jar包

    本文详细讲解了Maven中利用assembly插件打包jar包的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-12-12

最新评论