Springboot读取配置文件及自定义配置文件的方法

Spring Boot是一个非常流行的Java框架，它提供了一种便捷的方式来简化新项目的搭建过程和现有项目的升级过程。这就意味着很多的Java开发人员会使用Spring Boot，因此了解如何读取配置文件和自定义配置文件的方法是至关重要的。

1. Springboot读取配置文件的方法

Spring Boot默认会读取classpath下的application.properties或application.yml文件作为配置文件。开发人员可以在这个文件中设置应用程序的配置信息。下面是读取配置文件的方法：

1.1 配置文件的位置

Spring Boot默认的配置文件为：classpath:application.{properties|yml}。我们也可以通过以下方式指定配置文件的位置：

• 在resources文件夹下，创建一个名为config的文件夹（如果该文件夹不存在），并将配置文件放在该文件夹中，Spring Boot就会自动读取这个文件夹下的配置文件。

• 在启动应用程序时，使用--spring.config.name和--spring.config.location参数来指定配置文件的名称和位置。例如 java -jar myproject.jar --spring.config.name=myproject --spring.config.location=/etc/myproject/。

1.2 配置文件的内容

以下是一个application.properties文件示例：

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# 日志配置
logging.level.root=info
logging.file.name=myproject.log

1.3 在代码中读取配置文件

开发人员可以通过@Value注解或者@ConfigurationProperties注解来读取配置文件中的值。

1.3.1 使用@Value注解

@Component
public class MyBean {
    @Value("${spring.datasource.url}")
    private String datasourceUrl;

    @Value("${logging.level.root}")
    private String logLevelRoot;

    // ...
}

1.3.2 使用@ConfigurationProperties注解

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties {

    private String url;
    private String username;
    private String password;
    private String driverClassName;

    // getters and setters
}

2. Springboot自定义配置文件的方法

开发人员可以创建自己的配置文件来存储应用程序的配置信息。下面是自定义配置文件的方法：

2.1 创建自定义配置文件

创建一个名为myproject.properties或myproject.yml的文件，并将其放置在classpath路径下的任何位置。

2.2 在代码中读取自定义配置文件

开发人员可以通过@Value注解或者@ConfigurationProperties注解来读取自定义配置文件中的值。

2.2.1 使用@Value注解

@Component
public class MyBean {
    @Value("${myproject.datasource.url}")
    private String datasourceUrl;

    @Value("${myproject.logging.level.root}")
    private String logLevelRoot;

    // ...
}

2.2.2 使用@ConfigurationProperties注解

@ConfigurationProperties(prefix = "myproject.datasource")
public class DataSourceProperties {

    private String url;
    private String username;
    private String password;
    private String driverClassName;

    // getters and setters
}

2.3 加载自定义配置文件

在Spring Boot中加载自定义的配置文件非常简单。只需要在application.properties或application.yml中指定要加载的自定义配置文件，即可将其加载到应用程序上下文中。

# 加载自定义配置文件
spring.config.name=myproject
spring.config.location=classpath:/myconfig/

以上示例将加载classpath:/myconfig/myproject.properties或classpath:/myconfig/myproject.yml中的配置信息。

示例说明

以下是两个示例，演示如何在Spring Boot项目中读取配置文件和自定义配置文件：

示例1：使用@Value注解读取配置文件

application.properties

app.name=My App

MyBean.java

@Component
public class MyBean {

    @Value("${app.name}")
    private String appName;

    public void showName() {
        System.out.println("App name: " + appName);
    }
}

Application.java

@SpringBootApplication
public class Application {

    @Autowired
    private MyBean myBean;

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @PostConstruct
    public void init() {
        myBean.showName();
    }
}

示例2：使用@ConfigurationProperties注解读取自定义配置文件

MyConfig.properties

app.name=My App

MyAppConfig.java

@ConfigurationProperties(prefix = "app")
@Component
public class MyAppConfig {

    private String name;

    // getters and setters
}

Application.java

@SpringBootApplication
public class Application {

    @Autowired
    private MyAppConfig myAppConfig;

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @PostConstruct
    public void init() {
        System.out.println("App name: " + myAppConfig.getName());
    }
}

以上示例演示了如何使用@Value注解和@ConfigurationProperties注解读取配置文件和自定义配置文件。可以通过指定--spring.config.name和--spring.config.location参数来指定要加载的自定义配置文件。