dotenv-java 使用教程

dotenv-java 使用教程

1. 项目的目录结构及介绍

dotenv-java 是一个用于加载环境变量的纯 Java 模块。以下是其基本的目录结构：

dotenv-java/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── io/
│   │   │       └── github/
│   │   │           └── cdimascio/
│   │   │               └── dotenv/
│   │   │                   ├── Dotenv.java
│   │   │                   ├── DotenvEntry.java
│   │   │                   ├── DotenvEntryParser.java
│   │   │                   ├── DotenvException.java
│   │   │                   ├── DotenvParser.java
│   │   │                   ├── DotenvReader.java
│   │   │                   └── internal/
│   │   │                       ├── DotenvBuilder.java
│   │   │                       ├── DotenvConfig.java
│   │   │                       └── DotenvImpl.java
│   │   └── resources/
│   └── test/
│       ├── java/
│       │   └── io/
│       │       └── github/
│       │           └── cdimascio/
│       │               └── dotenv/
│       │                   ├── DotenvTest.java
│       │                   └── DotenvReaderTest.java
│       └── resources/
│           └── .env
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── dotenv-java.iml

目录结构介绍

• src/main/java/io/github/cdimascio/dotenv/：包含主要的 Java 源代码文件。
  • Dotenv.java：主要接口，用于加载和访问环境变量。
  • DotenvEntry.java：表示环境变量条目。
  • DotenvEntryParser.java：解析环境变量条目。
  • DotenvException.java：异常处理类。
  • DotenvParser.java：解析 .env 文件。
  • DotenvReader.java：读取 .env 文件。
  • internal/：内部实现类。
• src/main/resources/：包含资源文件，如 .env 文件。
• src/test/：包含测试代码和资源文件。
• .gitignore：Git 忽略文件。
• LICENSE：许可证文件。
• README.md：项目说明文档。
• pom.xml：Maven 项目配置文件。
• dotenv-java.iml：IntelliJ IDEA 项目文件。

2. 项目的启动文件介绍

dotenv-java 的启动文件主要是 Dotenv.java 接口。用户可以通过该接口加载和访问 .env 文件中的环境变量。

import io.github.cdimascio.dotenv.Dotenv;

public class Main {
    public static void main(String[] args) {
        Dotenv dotenv = Dotenv.configure()
            .directory("/path/to/.env")
            .load();

        String dbUrl = dotenv.get("DATABASE_URL");
        System.out.println("Database URL: " + dbUrl);
    }
}

启动文件介绍

• Dotenv.java：提供配置和加载 .env 文件的方法。
  • configure()：配置 .env 文件的路径和其他选项。
  • load()：加载 .env 文件中的环境变量。
  • get(String key)：获取指定键的环境变量值。

3. 项目的配置文件介绍

dotenv-java 的配置文件是 .env 文件，通常位于项目的根目录或指定的路径。

.env 文件示例

DATABASE_URL=jdbc:mysql://localhost:3306/mydatabase
DATABASE_USER=root
DATABASE_PASSWORD=secret

配置文件介绍

• .env 文件：包含键值对形式的环境变量。
  • 每行一个环境变量，格式为 KEY=VALUE。
  • 可以包含注释，以 # 开头。
  • 支持多