Spring Boot 读取配置文件的几种方式

最新推荐文章于 2024-06-08 11:45:59 发布
最新推荐文章于 2024-06-08 11:45:59 发布
阅读量10w+ 收藏 122
点赞数 15
分类专栏： Spring boot 文章标签： spring-boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/github_35169934/article/details/78233421
版权

Spring Boot 读取配置文件的方式可以分为
1. 注解
2. 获取 Spring Boot 的环境变量
来获取配置文件的信息，其中注解的方式又有集中表现形式。

第一步：创建 Spring Boot 工程（ Maven 工程添加 Spring Boot 相应的依赖）。
这里写图片描述
这里写图片描述
这里写图片描述
现在我们只是测试 Spring Boot 的 配置文件的读取，不需要其他的依赖，所以什么都没选，直接下一步 – 下一步 – 完成，项目目录结构如下：
这里写图片描述
此时的 application.properties 的内容为空
这里写图片描述
POM 文件内容为：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.china.prop</groupId>
    <artifactId>springboot-properties</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>springboot-properties</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

POM 文件中的依赖是 IDEA 通过这种创建工程的方式给我们自动生成的。

第二步：在配置文件中添加一些测试信息。
这里写图片描述

string.port=1111
integer.port=1111

db.link.url=jdbc:mysql://localhost:3306/test
db.link.driver=com.mysql.jdbc.Driver
db.link.username=root
db.link.password=root

上面的配置变量仅仅是为了测试而添加的，不具有实际意义。string.port 与 integer.port 都是string 类型普通变量，这里只是做个名称区分而已。

一、 通过获取环境变量来获取配置参数

1.1. 主类

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class SpringbootPropertiesApplication {

    public static void main(String[] args) {
        // 获取 Spring Boot 上下文
        ConfigurableApplicationContext ctx = SpringApplication.run(SpringbootPropertiesApplication.class, args);
        // ctx.getEnvironment(); // 获取 边境变量
        System.out.println("===========================================");
        //获取字符串
        System.out.println("String: " + (ctx.getEnvironment().getProperty("string.port") + 1111) );

        //获取整数
        System.out.println("Interger:   " + (ctx.getEnvironment().getProperty("integer.port",Integer.class) + 1111 ));
        System.out.println(ctx.getEnvironment().getProperty("db.link.url"));
        System.out.println(ctx.getEnvironment().getProperty("db.link.driver"));
        System.out.println(ctx.getEnvironment().getProperty("db.link.username"));
        System.out.println(ctx.getEnvironment().getProperty("db.link.password"));
        System.out.println("===========================================");

    }
}

1.2. 运行主类

===========================================
String: 11111111
Interger:   2222
jdbc:mysql://localhost:3306/test
com.mysql.jdbc.Driver
root
root
===========================================

可以看到配置文件中相同格式的port变量，可以获取到不同的格式数据。

  1. 1 新建 bean，通过注入环境变量来获取配置信息。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyConf {

    @Autowired
    private Environment env;

    public void show(){
        System.out.println("===========================================");
        //获取字符串
        System.out.println("String: " +env.getProperty("string.port") + 1111);

        //获取整数
        System.out.println("Interger:   " + (env.getProperty("integer.port",Integer.class) + 1111 ));
        System.out.println(env.getProperty("db.link.url"));
        System.out.println(env.getProperty("db.link.driver"));
        System.out.println(env.getProperty("db.link.username"));
        System.out.println(env.getProperty("db.link.password"));
        System.out.println("===========================================");
    }
}

2.2 改造主类并运行 

public static void main(String[] args) {

                ConfigurableApplicationContext ctx = SpringApplication.run(SpringbootPropApplication.class, args);

        MyConf myconf = (MyConf) ctx.getBean("myConf");
        myconf.show();

        ctx.close();
    }

结果：

===========================================
String: 11111111
Interger:   2222
jdbc:mysql://localhost:3306/test
com.mysql.jdbc.Driver
root
root
===========================================

二、通过注解获取配置文件信息

  1. 改造上面的 bean 配置类 MyConf：
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConf {

    @Value("${string.port}")     private int intPort;
    @Value("${string.port}")     private  String stringPort;
    @Value("${db.link.url}")     private String dbUrl;
    @Value("${db.link.driver}")  private String dbDriver;
    @Value("${db.link.username}")private String dbUsername;
    @Value("${db.link.password}")private String dbPassword;

    public void show(){
        System.out.println("===========================================");
        System.out.println("intPort :   " + (intPort + 1111));
        System.out.println("stringPort :   " + (stringPort + 1111));
        System.out.println("string :   " + dbUrl);
        System.out.println("string :   " + dbDriver);
        System.out.println("string :   " + dbUsername);
        System.out.println("string :   " + dbPassword);
        System.out.println("===========================================");
    }
}
  1. 运行主类可得：
===========================================
intPort :   2222
stringPort :   11111111
string :   jdbc:mysql://localhost:3306/test
string :   com.mysql.jdbc.Driver
string :   root
string :   root
===========================================
  1. 指定配置文件,@PropertySource可以声明多个，
    或者使用@PropertySources(@PropertySource(“xxx”),@PropertySource(“xxx”))。
    2.1 新建配置文件 my.prop
aaa.a=111
aaa.b=222
aaa.c=333

2.2 新建配置类

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:config/my.prop")
public class PropConf {

    @Value("${aaa.a}")
    private String a;
    @Value("${aaa.b}")
    private String b;
    @Value("${aaa.c}")
    private String c;

    public void show(){
        System.out.println("a --- > " + a);
        System.out.println("b --- > " + b);
        System.out.println("c --- > " + c);
    }
}

2.3. 在主类中添加相应调用代码

PropConf conf = (PropConf) ctx.getBean("propConf");
conf.show();

2.4. 结果:

a --- > 111
b --- > 222
c --- > 333

改造一

可以改造上面的PropConf 类：添加@ConfigurationProperties(prefix = “aaa”)
指定配置文件的前缀，生成giter 和 setter 方法来获取配置信息。


import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:config/my.prop")
@ConfigurationProperties(prefix = "aaa")
public class PropConf {

    private String a;
    private String b;
    private String c;

    public String getA() {return a;}
    public void setA(String a) {this.a = a;}
    public String getB() {return b;}
    public void setB(String b) {this.b = b;}
    public String getC() {return c;}
    public void setC(String c) {this.c = c;}

    public void show(){
        System.out.println("a --- > " + a);
        System.out.println("b --- > " + b);
        System.out.println("c --- > " + c);
    }
}

运行主类可以获得同样的结果。

改造二

可以只声明 setter 方法：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:config/my.prop")
@ConfigurationProperties(prefix = "aaa")
public class PropConf {

    private String a;
    private String b;
    private String c;

    public void setA(String a) {  this.a = a;  }
    public void setB(String b) { this.b = b;  }
    public void setC(String c) {  this.c = c; }

    public void show(){
        System.out.println("a --- > " + a);
        System.out.println("b --- > " + b);
        System.out.println("c --- > " + c);
    }
}

运行主类也可以得到同样的结果：

a --- > 111
b --- > 222
c --- > 333

=======================================

笔记1

上面获取配置文件的位置都是在 classpath 根目录下面的，Spring Boot 默认的配置文件地址有两个：（application.properties 为默认的配置文件名称）
1. classpath： 即放在resources里面。
2. classpath：config里面。
这里写图片描述
3. file:/
4. file:/config/

笔记2

在系统系统时可以通过 –spring.config.name=xxx.properties 环境变量指定配置文件。
比如resources下有一个 dblink.properties，然后添加启动参数：
这里写图片描述

笔记3 应用启动可以指定配置文件地址

这里写图片描述

笔记4 Spring Boot 配置文件可以使用变量

这里写图片描述

笔记5 配置文件可以使用数组或者集合

  1. 在配置文件中添加集合信息
aaa.host[0]=127.0.0.1
aaa.host[1]=10.66.0.108
aaa.host[2]=10.66.0.111
aaa.host[3]=10.66.0.12
aaa.host[4]=10.66.0.134
  1. 在配置类中注入参数
    这里写图片描述
  2. 输出 host变量 可得：
[127.0.0.1, 10.66.0.108, 10.66.0.111, 10.66.0.12, 10.66.0.134]
git_DingSJ
关注
  • 15
    点赞
  • 踩
  • 122
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
Spring Boot读取配置的几种方式
PrimeYun的博客
04-08 701
Spring Boot可以通过@Value、@PropertySource、@ConfigurationProperties、Environment类来读取配置文件 一、创建配置文件application.properties或者application.yml 本文选择properties文件 project.name=springboot project.user=admin 二、使用注解进行...
Springboot读取配置文件的几种方式
屢敗屢戰
09-29 644
1，介绍:        开发中难免会有使用到定义属性的时候，那学习springboot的肯定都知道获取方式，因为工作常用，我简单归纳几种方式以便需时查看。 1.1，yml格式常见的几种方式： application.yml配置文件: company: id: 1 nanme: 东方红 describe: 一种颜色,美好的颜色 第一种方式: /** * @author lblz * @deacription * @da
详解Spring-boot中读取config配置文件的两种方式
08-29
主要介绍了详解Spring-boot中读取config配置文件的两种方式，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
spring把resources目录下的文件读取出来装载到String，Java
Zhang Phil
12-07 663
spring把resources目录下的文件读取出来装载到String，Java。
Spring中读取配置文件的五种方式
最新发布
qq_35949344的博客
06-08 865
只支持读取.properties类型的配置文件student.name = 张三@Component...只支持读取.properties类型的配置文件student.name = 张三/*** @Component标识为是Spring的一个组件，只有容器组件，容器才会为ConfigurationProperties提供此注入共* 功能*/@Component...
SpringBoot 常用读取配置文件的 3 种方法！
weixin_43924444的博客
02-03 5790
它可以扫描特定包下所有的被**@ConfigurationProperties**标记的配置类，并将它们进行IoC注入。注解可以将指定的配置读取类的对象加载到Spring容器，也就是说，在其他配置类上使用一个@EnableConfigurationProperties注解，来将配置文件的参数和RabbitmqProperties类的属性绑定。如果仅仅只是使用了@ConfigurationProperties注解是没有效果的,它并不会将这个配置注入容器中，它还需要和注入容器的注解一起使用。
利用Java，spring boot读取文件，将file文件中的内容读出为字符串类型。
鹏神丶明月天
07-15 2449
3.通过StringBuilder中的append方法接收该int字符内容数据。
springboot读取指定目录下的所有配置文件
qq8057656qq的博客
12-28 7512
直接上代码，获取 resource 目录下conf文件夹中的所有properties文件 try { ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); Resource[] resources = resolver.getResources(...
Java中spring读取配置文件的几种方法示例
08-31
本文将详细讲解如何在Spring中读取配置文件。 首先，Spring配置文件通常以XML格式存在，例如`bean_config.xml`。这些文件定义了Bean的结构和它们之间的依赖关系。一个简单的配置文件示例如下： ```xml <!DOCTYPE ...
详解springboot读取yml配置的几种方式
08-25
接下来，我们将介绍SpringBoot读取YML配置的三种方式： **第一种方式：@Value注解** 当只需获取配置文件中的个别值时，使用`@Value`是最直接的方法。例如： ```java @Configuration public class AppConfig { @...
如何解决springboot读取配置文件的中文乱码问题
08-27
通过以上一种或多种方式，一般可以解决Spring Boot读取配置文件时的中文乱码问题。在实践中，通常推荐首先检查和修改IDE的编码设置，因为这是最容易出错且影响全局的地方。同时，确保整个开发环境中的一致性，包括...
Spring Boot技术知识点：如何读取不同路径里的applicationContext.xml配置文件4
06-18
然而，如果确实有需求，可以通过以下几种方式引入XML配置： 1. **启用XML配置** 在Spring Boot项目中，我们可以通过添加`@ImportResource`注解到主配置类（即带有@SpringBootApplication注解的类）上来导入XML配置...
Spring Boot 如何读取.config文件？
程序羊的博客
03-08 1175
新的SpringBoot项目有个需求，需要读取config文件生成导航栏，由于以前C#项目的配置文件是后缀为.config的文件，所以在Java这边，我们需要将它改为.xml文件去解析。
dblink
shenglam的专栏
01-17 379
进入系统管理员SQL>操作符下，运行命令： >create public database link ecbm_19  connect to ecbm_userName  // 远程数据库的用户名  identified by ecbm_pwd  //远程数据库的用户密码  using 'CCPBS_19'; //远程数据库的服务名 Database link created.格式:c
SpringBoot整合数据库连接
m0_56799642的博客
10-01 8815
通过this调用同一个service中的方法，this是指service实现类对象本身，不是代理对象，就相当于方法中的代码粘到了大方法里面，相当于还是一个方法。t_user中数据不会变化，因为执行这条sql的时候报错了嘛，但是t_book这个表里面的库存减一了，也就是“买书三步骤”中的第三步报错了，但是第二步依旧没回滚。若B方法执行的过程中，只要有抛出异常，B事务方法回滚，A不会回滚，即不影响A中的其他事务的执行（如第二次买书失败不影响第一次买书成成功）mybatis默认不开启驼峰命名规则。
6 种方式读取 Springboot 的配置，老鸟都这么玩（原理+实战）
程序员内点事
06-16 1700
Environment 是 springboot 核心的环境配置接口，它提供了简单的方法来访问应用程序属性，包括系统属性、操作系统环境变量、命令行参数、和应用程序配置文件中定义的属性等等。如果上边的几种读取配置的方式你都不喜欢，就想自己写个更流批的轮子，那也很好办。我们直接注入获取所有属性的配置队列，你是想用注解实现还是其他什么方式，就可以为所欲为了。
【springboot】配置Oracle多数据源切换（仅需调整配置文件）
qq_41563868的博客
08-30 2908
配置Oracle多数据源切换（仅需调整配置文件）
springboot服务器环境config配置文件读取的小细节
lhjllff12345的专栏
03-07 428
springboot服务器环境config配置文件读取的小细节
spring boot 读取 resources 下的文件,把文件内容读到String中
qq_31683775的博客
03-07 2702
File file = ResourceUtils.getFile(ResourceUtils.CLASSPATH_URL_PREFIX+"static/detect.js"); String result = IOUtils.toString(new FileInputStream(file), String.valueOf(StandardCharsets.UTF_8));
开启 Spring Boot 特性有哪几种方式
08-11
### 回答1： C知道回答：开启 Spring Boot 特性的方式有以下几种： 1. 使用 @EnableAutoConfiguration 注解 2. 使用 @SpringBootApplication 注解 3. 使用 @Configuration 和 @Import 注解手动导入配置类 4. 使用 XML 配置文件手动配置 Spring Boot 特性 ### 回答2： 开启 Spring Boot 特性有以下几种方式： 1. 使用@EnableAutoConfiguration注解：通过在主配置类上添加@EnableAutoConfiguration注解，可以自动开启Spring Boot的自动配置特性。该注解会根据项目中的依赖关系自动配置相应的组件和配置项，简化项目配置工作。 2. 使用@SpringBootApplication注解：@SpringBootApplication是Spring Boot项目的入口注解，它包含了@EnableAutoConfiguration和@Configuration注解。使用@SpringBootApplication注解可以一次性开启Spring Boot的自动配置、组件扫描和配置类的扫描等特性。 3. 使用starter依赖：Spring Boot提供了一系列的starter依赖，每个starter都定义了一组常用的依赖项。通过在项目中引入相应的starter依赖，可以方便地开启特定的功能特性。比如，使用spring-boot-starter-web依赖可以开启Web开发相关的特性。 4. 自定义配置类：在Spring Boot中，我们可以通过编写自定义的配置类来开启一些特定的功能。通过在配置类上使用@Configuration注解，我们可以定义一些@Bean的方法来配置特定的组件或特性。通过将这个配置类注册为Bean，在应用启动时自动生成相应的组件。 综上所述，使用@EnableAutoConfiguration注解、@SpringBootApplication注解、starter依赖和自定义配置类等方式都可以帮助开启Spring Boot的特性。根据项目需求和实际情况，选择适合的方式来快速搭建和配置Spring Boot应用。 ### 回答3： 开启 Spring Boot 特性有以下几种方式： 1. 使用 @EnableAutoConfiguration 注解：Spring Boot 基于约定优于配置的原则，自动配置了很多常用的特性。通过在主配置类上加上 @EnableAutoConfiguration 注解，可以启用自动配置特性。该注解会根据项目使用的依赖自动配置相关的 Bean，简化了配置过程。 2. 配置文件属性：Spring Boot 通过读取配置文件中的属性来设置特性。可以通过在 application.properties 或 application.yml 配置文件中设置相关属性来开启特性。例如，可以设置 spring.data.mongodb.uri 属性来启用 MongoDB 的支持。 3. 使用 @Conditional 注解：Spring Boot 提供了很多条件注解，利用这些注解可以根据条件来选择性地开启特定的特性。例如，可以使用 @ConditionalOnClass 注解来判断某个类是否在 classpath 中存在，从而决定是否启用某个特性。 4. 自定义配置类：Spring Boot 提供了一个 @Configuration 注解，通过在该注解下定义相关的配置类，可以进行更细粒度的配置。在配置类中可以使用 @Bean 注解配置特性相关的 Bean，从而启用特性。 5. 外部化配置：Spring Boot 可以通过外部化配置来灵活地开启和配置特性。可以通过命令行参数、环境变量、属性文件等方式来设置特性相关的配置项。 总之，Spring Boot 提供了多种开启特性的方式，开发人员可以根据项目需求和个人偏好选择适合的方式来启用特性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值