SpringBoot 读取配置文件

已于 2024-08-22 09:48:31 修改
阅读量326 收藏
点赞数
分类专栏： SpringBoot 文章标签： spring boot java spring
于 2023-06-30 09:12:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baihaibo1024/article/details/131410158
版权 
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>

默认配置文件

application.properties / application.yml

一、参数

app.name = yuque
app.web-url = https://www.csdn.com
app.cron = 0/10 * * * * ?

app:
  name: yuque
  web-url: https://www.csdn.com
  # 每两天执行一次
  cron: 0 0 0 */2 * ?

1. 直接获取

注解上可直接获取，其他地方需要使用 @Value 获取

@Value("${app.web-url}")
private String url;

@KafkaListener(topics = "${app.name}")
public void onMessage() {
    System.out.print("地址信息：" + url);
}

@Scheduled(cron = "${app.cron}")
public void test() {}

2. 使用 @Value 注解

在当前类使用

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {
    
    @Value("${app.name}")
    private String name;
    
    @Value("${app.web-url}")
    private String webUrl;
    
    @Test
    public void test() {
        System.out.println(name);
        System.out.println(webUrl);
    }
}

3. 使用 @ConfigurationProperties 注解

采用自动配置的方式映射配置文件属性，配置完成后直接当做 java 对象即可使用

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


/**
 * - @ConfigurationProperties(value = "app") 表示的配置文件里属性的前缀都是 app 开头
 * - 文件映射规则，短横线(-)驼峰式命名
 */
@Data
@Component
@ConfigurationProperties(value = "app")
public class AppProperties {
     
    private String name;    
    private String webUrl;
}

4. 测试类

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {

    @Autowired
    private AppProperties appProperties;

    @Test
    public void test() {
        System.out.println(appProperties.getName());
        System.out.println(appProperties.getWebUrl());
    }
}

二、对象

app.test-user.name = cnbai
app.test-user.address = xian

app:
  test-user:
    address: xian
    name: cnbai

1. 使用 @Value 注解

在当前类使用

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {
    
    @Value("${app.test-user.name}")
    private String username;
    
    @Value("${app.test-user.address}")
    private String address;
    
    @Test
    public void test() {
        System.out.println(username);
        System.out.println(address);
    }
}

2. 使用 @ConfigurationProperties 注解

采用自动配置的方式映射配置文件属性，配置完成后直接当做 java 对象即可使用

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

@Data
@Component
@ConfigurationProperties(value = "app")
public class AppProperties {
     
    private TestUser testUser;
    
    @Data
    public static class TestUser {
        private String name;
        private String address;
    }
}

3. 测试类

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {

    @Autowired
    private AppProperties appProperties;

    @Test
    public void test() {
        System.out.println(appProperties.getTestUser().getName());
        System.out.println(appProperties.getTestUser().getAddress());
    }
}

三、数组

app.name = zhangsan,lisi

app:
  name: zhangsan,lisi

1. 使用 @Value 注解

在当前类使用

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {
    
    @Value("${app.name}")
    private String[] name;
    
    @Test
    public void test() {
        System.out.println(name);
    }
}

2. 使用 @ConfigurationProperties 注解

采用自动配置的方式映射配置文件属性，配置完成后直接当做 java 对象即可使用

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

@Data
@Component
@ConfigurationProperties(value = "app")
public class AppProperties {
    
    private String[] name;
}

3. 测试类

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {

    @Autowired
    private AppProperties appProperties;

    @Test
    public void test() {
        System.out.println(appProperties.getName());
    }
}

四、List 集合

app.user[0].name = zhangsan
app.user[0].age = 20
app.user[1].name = lisi
app.user[1].age = 21

app.addresses[0] = 127.0.0.1:8888
app.addresses[1] = 127.0.0.1:9999

# list 集合
app:
  user:
    - age: 20
      name: zhangsan
    - age: 21
      name: lisi
      
  addresses:
    - 127.0.0.1:8888
    - 127.0.0.1:9999

1. 使用 @ConfigurationProperties 注解

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import java.util.List;

@Data
@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
    
    // 获取对象集合
    private List<User> userList;
    
    // 获取参数集合
    private List<String> addresses;

    @Data
    public static class User {

        private String name;
        private String age;
    }
}

2. 测试类

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.List;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {

    @Autowired
    private AppProperties appProperties;

    @Test
    public void test() {
        
        // 对象集合
        List<AppProperties.User> userList = appProperties.getUserList();
        for (AppProperties.User user : userList) {
            System.out.println(user.getName());
            System.out.println(user.getAge());
        } 
        
        // 参数集合
        List<String> addresses = appProperties.getAddresses();
        for (String address : addresses) {
            System.out.println(address);
        }
    }
}

五、Map 集合

app.user.name = cnbai
app.user.address = xian

app:
  user: { name: cnbai , address: xian }

app:
  user:
    name: cnbai
    address: xian

1. 使用 @ConfigurationProperties 注解

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import java.util.Map;

@Data
@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
    
    private Map<String , String> user;
}

2. 测试类

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.Map;

@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
public class ApplicationTest {

    @Autowired
    private AppProperties appProperties;

    @Test
    public void test() {
        
        Map<String , String> user = appProperties.getUser();
        for (Map.Entry<String, String> entry : user.entrySet()) {
            System.out.println(entry.getKey() + " : " + entry.getValue());
        }
    }
}

Properties 配置文件

@PropertySource + @ConfigurationProperties

1. user.properties

app.name = cnbai
app.address = xian

2. 使用 @ConfigurationProperties 注解

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


/**
 * - @PropertySource 中 ignoreResourceNotFound 属性值为 true 时没找到指定配置文件的时候不报错
 */
@Data
@Component
@ConfigurationProperties(prefix = "app")
@PropertySource(value = "classpath:user.properties", encoding = "UTF-8", ignoreResourceNotFound = false) 
public class AppProperties {

    private String name;    
    private String address;
}

Yml 配置文件

@PropertySource + @ConfigurationProperties
yml 格式不支持 @PropertySource 注解直接导入配置，实现 PropertySourceFactory 接口，重写 createPropertySource 方法

1. test.yml

app:
  name: cnbai
  address: xian

2. Yml 文件处理类

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;
import org.springframework.lang.Nullable;
 
import java.io.IOException;
import java.util.List;
import java.util.Optional;
 
public class YamlPropertySourceFactory implements PropertySourceFactory {
 
    @Override
    public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {
        String resourceName = Optional.ofNullable(name).orElse(resource.getResource().getFilename());
        assert resourceName != null;
        if (resourceName.endsWith(".yml") || resourceName.endsWith(".yaml")) {
            List<org.springframework.core.env.PropertySource<?>> yamlSources = new YamlPropertySourceLoader().load(resourceName, resource.getResource());
            return yamlSources.get(0);
        } else {
            return new DefaultPropertySourceFactory().createPropertySource(name, resource);
        }
    }
}

3. 使用 @ConfigurationProperties 注解

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


/**
 * - @PropertySource 中 factory 属性配置 Yml 文件处理类
 */
@Data
@Component
@ConfigurationProperties(prefix = "app")
@PropertySource(factory = YamlPropertySourceFactory.class, value = "classpath:test.yml", encoding = "UTF-8", ignoreResourceNotFound = false) 
public class AppProperties {

    private String name;    
    private String address;
}
baihb1024
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot读取配置文件
freyaalisa的专栏
12-18 1万+
一、springboot配置文件         核心配置文件和自定义配置文件。核心配置文件是指在resources根目录下的application.properties或application.yml配置文    件。为了不破坏核心文件的原生态，但又需要有自定义的配置信息存在，一般情况下会选择自定义配置文件来放这些自定义    信息，这里在resources/config目录下创建配置文
Springboot读取配置文件
qq_21963133的博客
04-28 407
Springboot读取配置文件        在springboot中配置文件的形式有两种，第一种是传统的properties形式，第二种是yml格式的文件，也是spring官方推荐的配置形式，结构比较清晰。        下面以一个简单的数据源配置来看一下两种配置文件的区别：        在properties种是这样的：spring.datasource.url=jdbc:mysql://...
springboot读取配置文件.rar
03-19
springboot读取配置文件.rar springboot读取配置文件.rar springboot读取配置文件.rar
SpringBoot读取配置的6种方式
最新发布
一起coding，一起嗨。
07-25 1018
SpringBoot读取配置的6种方式
Spring Boot读取配置文件
hitpter的专栏
10-11 883
配置文件是用于存储应用程序的配置信息的文件。它可以包含各种配置项，如数据库连接信息、端口号、日志级别等。通过使用配置文件，我们可以将这些配置信息与应用程序的代码分离，使得应用程序更加灵活和可配置。和.yml。是一种基于键值对的格式，适合简单的配置信息。.yml是一种基于层次结构的格式，适合复杂的配置信息。在配置文件中，可以定义需要读取的配置项。myapp:port: 8080myapp.host和myapp.port。然后，在配置文件中，我们可以定义需要读取的配置项。
SpringBoot 读取配置文件的 5 种方法！
磊哥聊Java
08-19 8804
作者 | 磊哥来源 | Java面试真题解析（ID：aimianshi666）转载请联系授权（微信ID：GG_Stone）Spring Boot 中读取配置文件有以下 5 种方法：使用 @Value 读取配置文件。使用 @ConfigurationProperties 读取配置文件。使用 Environment 读取配置文件。使用 @PropertySource 读取配置文件。使用原生方式读取配置...
SpringBoot-读取配置文件的几种方法
踏雨歌青春，诗酒趁年华
01-04 2397
本文是关于Spring Boot框架下读取配置文件的指南。该指南介绍了如何通过注解和属性文件以及工具类来加载和访问应用程序的配置信息。Spring Boot提供了简单而强大的功能，可以轻松地加载各种类型的配置文件，并将其映射到Java对象中。
SpringBoot读取配置文件常用方法解析
08-18
SpringBoot读取配置文件常用方法解析 SpringBoot 读取配置文件是指在 SpringBoot 项目中读取外部配置文件的方法，用于获取配置信息。下面将介绍 SpringBoot 读取配置文件的常用方法。 传统项目读取配置方式 在没有...
如何解决springboot读取配置文件的中文乱码问题
08-27
下面将详细介绍如何解决Spring Boot读取配置文件时的中文乱码问题。 首先，我们需要理解编码的基本概念。在计算机中，文本是以二进制形式存储的，而编码则是一种规则，用于将字符转换为二进制和反向转换。UTF-8是最...
SpringBoot读取配置文件的三种方法
asdfadafd的博客
07-28 738
分析SpringBoot分别提供3中方式读取项目的application.properties配置文件的内容。这个方式分别为Environment类、注解以及注解。你必须要知道的事情下面提供的三种方式，都可以拿到配置文件的信息，不要纠结那种方式好与坏。只要能解决问题就可以了。...
springboot 读取配置文件中自定义数据的三种方式
javaxiaobaichi19的博客
02-21 1232
springboot 读取配置文件中自定义数据的三种方式@Value("${xx}")结果展示@ConfigurationProperties结果展示注意Environment结果展示 用于测试的文件数据 person: personboolean: TRUE #TRUE,true,True,FALSE,false，False均可 personfloat: 3.14 #6.8523015e+5 #支持科学计数法 personint: 123
springboot配置文件读取
kk6891的博客
08-25 396
直接上代码： package com.ly.learnSpringboot; import java.util.HashSet; import java.util.List; import java.util.Set; import org.springframework.beans.factory.annotation.Autowired; import org.springframew...
SpringBoot配置文件读取
weixin_45729042的博客
04-21 132
SpringBoot配置文件读取前言一、读取默认配置文件二、读取自定义配置文件2.1@PropertiesSource+@Value注解读取文件内容2.2@PropertiesSource+@ConfigurationProperties注解读取文件内容三、在读取文件时出现中文乱码问题总结 前言 在SpringBoot中有默认给的application.properties配置文件，还有一些自定义的配置文件，本文将介绍这些配置文件的读取方式。 一、读取默认配置文件 application.prope
Spring boot 配置文件读取
Black Monkey
04-22 716
（1）：application.properties  配置信息如下              com.didispace.blog.title=Spring Boot （2）：entity 编写如下： @Component public class BlogProperties { @Value("${com.didispace.blog.title}") pr
SpringBoot读取配置文件
一个想法
03-10 736
使用 @ConfigurationProperties 注解读取配置 使用 @Value 注解读取配置
springboot 读取配置文件
09-16
springboot 读取配置文件有两种常用的方法。第一种方法是使用注解@Value，通过将配置值直接注入到对应的变量中。在配置文件中添加需要读取的配置项，然后在需要读取配置的类中使用@Value注解将配置值注入到对应的变量中即可。第二种方法是使用Environment类，通过将Environment类注入到需要读取配置的类中，然后使用getProperty方法来获取具体的配置值。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值