配置文件 - application.properties - 基本配置文件

Java - Web - Spring 《配置文件 - application.properties - 基本配置文件》

在 Java Web 开发中，Spring 框架是一个非常流行的选择。而 application.properties 作为 Spring 应用中最常用的配置文件，扮演着至关重要的角色。它允许开发者以一种简单且直观的方式配置应用的各种属性，避免了硬编码，提高了代码的可维护性和灵活性。本文将深入探讨 application.properties 的使用，包括基本配置、常见配置示例以及如何在代码中读取这些配置。

1. application.properties 简介

application.properties 是 Spring Boot 应用默认的配置文件，位于 src/main/resources 目录下。Spring Boot 在启动时会自动加载该文件，并将其中的配置属性注入到相应的组件中。配置文件采用键值对的形式，格式为 key=value，例如：

server.port=8081

上述配置将应用的端口号设置为 8081。

2. 基本配置示例

2.1 服务器配置

在开发 Web 应用时，经常需要配置服务器的端口、上下文路径等信息。以下是一些常见的服务器配置示例：

# 设置服务器端口号
server.port=8081
# 设置应用的上下文路径
server.servlet.context-path=/myapp

在上述配置中，应用将运行在 http://localhost:8081/myapp 地址上。

2.2 数据库配置

如果应用需要连接数据库，通常需要配置数据库的连接信息，如 URL、用户名、密码等。以 MySQL 数据库为例：

# 数据库连接 URL
spring.datasource.url=jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
# 数据库用户名
spring.datasource.username=root
# 数据库密码
spring.datasource.password=123456
# 数据库驱动类
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

2.3 日志配置

日志是开发和调试过程中非常重要的工具，通过配置日志可以控制日志的输出级别、格式等。以下是一个简单的日志配置示例：

# 设置日志级别
logging.level.root=INFO

上述配置将根日志级别设置为 INFO，表示只输出 INFO 及以上级别的日志信息。

3. 在代码中读取配置属性

3.1 使用 @Value 注解

@Value 注解可以将配置文件中的属性值注入到类的字段中。以下是一个示例：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class MyConfig {
    @Value("${server.port}")
    private int serverPort;
    public int getServerPort() {
        return serverPort;
    }
}

在上述代码中，@Value("${server.port}") 注解将 application.properties 中 server.port 的值注入到 serverPort 字段中。

3.2 使用 @ConfigurationProperties 注解

如果需要注入多个配置属性，可以使用 @ConfigurationProperties 注解。以下是一个示例：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;
    private String driverClassName;
    // 省略 getter 和 setter 方法
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public String getDriverClassName() {
        return driverClassName;
    }
    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }
}

在上述代码中，@ConfigurationProperties(prefix = "spring.datasource") 注解将 application.properties 中以 spring.datasource 为前缀的属性值注入到 DataSourceConfig 类的相应字段中。

4. 总结

通过使用 application.properties 配置文件，开发者可以方便地管理应用的各种配置信息，并且可以通过 @Value 和 @ConfigurationProperties 注解在代码中读取这些配置。这种方式使得代码更加灵活、可维护，是 Spring 开发中不可或缺的一部分。

希望本文对你理解和使用 application.properties 配置文件有所帮助！