资讯专栏INFORMATION COLUMN

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

lingdududu / 1072人阅读

引言

当我们通过@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> maps = new HashMap<>();
        maps.put(Movie.class,CustomMovieEditor.class);

    return customEditorConfigurer;
}
Converter接口+@ConfigurationPropertiesBinding注解
//注意
@Component
@ConfigurationPropertiesBinding
public class StringToPersonConverter implements Converter {

    @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> 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 converters) {
this.genericConverters = converters;
  }

Formatter接口是不能对属性完成转换的,因为ConversionServiceDeducer初始化的时候只获取GenericConverterConverter接口

官方文档上还介绍了可以使用实现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();
        }
}

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/72074.html

相关文章

  • Spring Boot 配置文件中的花样,看这一篇足矣!

    摘要:的默认配置文件位置为。比如,我们需要自定义模块的服务端口号,可以在中添加来指定服务端口为,也可以通过来指定应用名该名字在应用中会被注册为服务名。同时,配置内容都对开发人员可见,本身这也是一种安全隐患。 在快速入门一节中,我们轻松的实现了一个简单的RESTful API应用,体验了一下Spring Boot给我们带来的诸多优点,我们用非常少的代码量就成功的实现了一个Web应用,这是传统的...

    pingan8787 评论0 收藏0
  • 【译】Spring Boot 2.0属性绑定

    摘要:比如,在中,不能将属性绑定到对象。引入了新的接口,能够指出属性取值的准确位置。比如,属性绑定的验证异常现在会显示类允许你使用多个。我们计划在中继续加强的功能,而第一个想要支持的功能是不可变属性绑定。 Spring Boot2.0的属性绑定 原文从Spring boot第一个版本以来,我们可以使用@ConfigurationProperties注解将属性绑定到对象。也可以指定属性的各种不...

    1treeS 评论0 收藏0
  • Spring Boot 2.0 @ConfigurationProperties 使用

    摘要:引言的一个便捷功能是外部化配置,可以轻松访问属性文件中定义的属性。本文将详细介绍的使用。 引言 Spring Boot的一个便捷功能是外部化配置,可以轻松访问属性文件中定义的属性。本文将详细介绍@ConfigurationProperties的使用。 配置项目POM 在pom.xml中定义Spring-Boot 为parent org.springframework.boot...

    mating 评论0 收藏0
  • Spring Boot 2.0 外部化配置介绍

    摘要:可以使用外部化配置来方便在不同环境的运行同样的程序文件文件环境变量命令行参数内置顺序实现了很多按以下顺序进行合理的相同属性的覆盖目录下的全局设置属性,如果激活测试用例上的注解测试用例上的注解。 简介 在应用中管理配置并不是一个容易的任务,尤其是在应用需要部署到多个环境中时。通常会需要为每个环境提供一个对应的属性文件,用来配置各自的数据库连接信息、服务器信息和第三方服务账号等。通常的应用...

    lmxdawn 评论0 收藏0
  • java | Spring Boot 与 Redis 实现 Cache 以及 Session 共享

    摘要:完成状态编写中已完成维护中原文是一个使用编写的开源支持网络基于内存可选持久性的键值对存储数据库维基百科是目前业界使用广泛的基于内存的数据库。 完成状态 [ ] 编写中 [ ] 已完成 [x] 维护中 原文 Redis Redis是一个使用ANSI C编写的开源、支持网络、基于内存、可选持久性的键值对存储数据库 ------ 维基百科 Redis 是目前业界使用广泛的基于内存的...

    ssshooter 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<