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();
    }
}

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

相关文章

  • Spring事件发布监听,顺序监听,异步监听方式

    Spring事件发布监听,顺序监听,异步监听方式

    这篇文章主要介绍了Spring事件发布监听,顺序监听,异步监听方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Spring的事务管理你了解吗

    Spring的事务管理你了解吗

    这篇文章主要为大家介绍了Spring的事务管理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-01-01
  • Java的ArrayList扩容源码解析

    Java的ArrayList扩容源码解析

    这篇文章主要介绍了Java的ArrayList扩容源码解析,通过动态扩容,ArrayList能够在添加元素时保持高效的性能,扩容操作是有一定开销的,但由于扩容的时间复杂度为O(n),其中n是当前元素个数,所以平均情况下,每次添加元素的时间复杂度仍然是O(1),需要的朋友可以参考下
    2024-01-01
  • maven添加jar包到本地仓库的实现

    maven添加jar包到本地仓库的实现

    本文主要介绍了maven添加jar包到本地仓库的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-06-06
  • log4j2.xml文件详解及在日志中加入全局guid

    log4j2.xml文件详解及在日志中加入全局guid

    这篇文章主要介绍了log4j2.xml文件详解及在日志中加入全局guid,基于很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 详解Java回调的原理与实现

    详解Java回调的原理与实现

    回调函数,顾名思义,用于回调的函数。回调函数只是一个功能片段,由用户按照回调函数调用约定来实现的一个函数。回调函数是一个工作流的一部分,由工作流来决定函数的调用(回调)时机。
    2017-03-03
  • SpringBoot2.x的依赖管理配置

    SpringBoot2.x的依赖管理配置

    这篇文章主要介绍了SpringBoot2.x的依赖管理配置,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 运行时常量池和字符串常量池的区别及说明

    运行时常量池和字符串常量池的区别及说明

    这篇文章主要介绍了运行时常量池和字符串常量池的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • Java超详细梳理IO流的使用方法上

    Java超详细梳理IO流的使用方法上

    流(Stream)是指一连串的数据(字符或字节),是以先进先出的方式发送信息的通道,数据源发送的数据经过这个通道到达目的地,按流向区分为输入流和输出流
    2022-04-04
  • SpringBoot项目启动时增加自定义Banner的简单方法

    SpringBoot项目启动时增加自定义Banner的简单方法

    最近看到springboot可以自定义启动时的banner,然后自己试了一下,下面这篇文章主要给大家介绍了SpringBoot项目启动时增加自定义Banner的简单方法,需要的朋友可以参考下
    2022-01-01

最新评论