自定义类读取properties/yml配置文件

最新推荐文章于 2023-06-24 11:58:35 发布

qq_42151769

最新推荐文章于 2023-06-24 11:58:35 发布

阅读量332

点赞数

分类专栏： Java 文章标签： spring boot定义类接收yml参数

转载请注明原创

本文链接：https://blog.youkuaiyun.com/qq_42151769/article/details/103597186

版权

Java 专栏收录该内容

73 篇文章

订阅专栏

本文介绍了一种Spring Boot读取配置文件的方法，通过创建特定类来接收YML配置，避免使用@Value。文章展示了如何用Map接收log/mail下的属性，定义并注册UserMqProperties类，以及在不同场景下如何使用@ConfigurationProperties注解进行配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

这里记录一种spring boot读取配置文件的方式,不讨论@Value的方式了,那个太简单了

假设我们Yml中有配置:

##### 自定义队列信息
user:
  mq:
    log:
      queue: logQueue
      exchange: logExchange
      routingKey: logRk
    mail:
      queue: mailQueue
      exchange: mailExchange
      routingKey: mailRk

新建已给类来接收

package com.wm.contextinit.config;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;

import java.util.Map;

/***
 * @ClassName: UserMqProperties
 * @Description:
 * @Author: wm_yu
 * @Create_time: 14:12 2019-12-18
 */
@ConfigurationProperties("user.mq")
@Data
@ToString
public class UserMqProperties {

    private Map<String,String> log;
    private Map<String,String> mail;

    @Bean("logMqProperties")
    public MqProperties logMqProperties(){
        return new MqProperties(log.get("queue"),log.get("exchange"),log.get("routingKey"));
    }

    @Bean("mailMqProperties")
    public MqProperties mailMqProperties(){
        return new MqProperties(mail.get("queue"),mail.get("exchange"),mail.get("routingKey"));
    }

}

上图是用map接收log/mail下的属性

在定义一个类

package com.wm.contextinit.config;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.ToString;

/***
 * @ClassName: MqProperties
 * @Description:
 * @Author: wm_yu
 * @Create_time: 14:25 2019-12-18
 */
@Data
@AllArgsConstructor
@ToString
public class MqProperties {
    private String queue;
    private String exchange;
    private String routingKey;
}

在使用的地方使用注解:

@EnableConfigurationProperties({UserMqProperties.class})

如下:

package com.wm.contextinit.service;

import com.wm.contextinit.config.MqProperties;
import com.wm.contextinit.config.UserMqProperties;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.stereotype.Service;

/***
 * @ClassName: TestService
 * @Description:
 * @Author: wm_yu
 * @Create_time: 14:19 2019-12-18
 */
@Service
@Slf4j
@EnableConfigurationProperties({UserMqProperties.class})
public class TestService {

    @Autowired
    private UserMqProperties userMqProperties;

    @Autowired
    private MqProperties logMqProperties;


    @Autowired
    private MqProperties mailMqProperties;

    public void test(){
        log.info("userMqProperties:[{}],logMqProperties:[{}],mailMqProperties:[{}]",userMqProperties.toString(),logMqProperties.toString(),mailMqProperties.toString());
    }



}

测试如下:

其实还可以更简单,如下:

直接在UserMqProperties上添加注解@Compment 注册到ioc

package com.wm.contextinit.config;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import java.util.Map;

/***
 * @ClassName: UserMqProperties
 * @Description:
 * @Author: wm_yu
 * @Create_time: 14:12 2019-12-18
 */
@ConfigurationProperties("user.mq")
@Data
@ToString
@Component
public class UserMqProperties {

    private Map<String,String> log;
    private Map<String,String> mail;

    @Bean("logMqProperties")
    public MqProperties logMqProperties(){
        return new MqProperties(log.get("queue"),log.get("exchange"),log.get("routingKey"));
    }

    @Bean("mailMqProperties")
    public MqProperties mailMqProperties(){
        return new MqProperties(mail.get("queue"),mail.get("exchange"),mail.get("routingKey"));
    }

}

在使用的类上面,去掉注解

@EnableConfigurationProperties({UserMqProperties.class})

如下:

package com.wm.contextinit.service;

import com.wm.contextinit.config.MqProperties;
import com.wm.contextinit.config.UserMqProperties;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/***
 * @ClassName: TestService
 * @Description:
 * @Author: wm_yu
 * @Create_time: 14:19 2019-12-18
 */
@Service
@Slf4j
public class TestService {

    @Autowired
    private UserMqProperties userMqProperties;

    @Autowired
    private MqProperties logMqProperties;


    @Autowired
    private MqProperties mailMqProperties;

    public void test(){
        log.info("userMqProperties:[{}],logMqProperties:[{}],mailMqProperties:[{}]",userMqProperties.toString(),logMqProperties.toString(),mailMqProperties.toString());
    }



}

再次测试,结果一样的,关键点就是使用Map来接收这个属性

引用别人的接收数据的几种情况