Dotenv 项目教程

1. 项目目录结构及介绍

Dotenv 项目的目录结构相对简单，主要包含以下几个文件和目录：

dotenv/
├── lib/
│   ├── dotenv.rb
│   ├── parser.rb
│   └── version.rb
├── spec/
│   ├── dotenv_spec.rb
│   └── parser_spec.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── Gemfile
├── LICENSE
├── README.md
└── dotenv.gemspec

目录结构介绍

• lib/: 包含项目的主要代码文件。

  • dotenv.rb: 项目的主文件，负责加载和解析 .env 文件。
  • parser.rb: 负责解析 .env 文件的解析器。
  • version.rb: 定义项目的版本号。

• spec/: 包含项目的测试文件。

  • dotenv_spec.rb: 测试 dotenv.rb 文件的功能。
  • parser_spec.rb: 测试 parser.rb 文件的功能。

• .gitignore: 定义 Git 忽略的文件和目录。

• .rspec: 配置 RSpec 测试框架的选项。

• .travis.yml: 配置 Travis CI 的持续集成设置。

• Gemfile: 定义项目的依赖库。

• LICENSE: 项目的开源许可证。

• README.md: 项目的说明文档。

• dotenv.gemspec: 项目的 gemspec 文件，定义 gem 的元数据。

2. 项目的启动文件介绍

Dotenv 项目的主要启动文件是 lib/dotenv.rb。这个文件负责加载和解析 .env 文件，并将环境变量注入到当前的运行环境中。

lib/dotenv.rb 文件介绍

require_relative 'parser'

module Dotenv
  class << self
    def load(*filenames)
      filenames = ['.env'] if filenames.empty?
      filenames.each do |filename|
        env = Parser.call(filename)
        env.each { |k, v| ENV[k] ||= v }
      end
    end
  end
end

• load 方法: 该方法接受一个或多个文件名作为参数，默认加载 .env 文件。它会调用 Parser.call 方法解析文件内容，并将解析后的环境变量注入到 ENV 中。

3. 项目的配置文件介绍

Dotenv 项目的主要配置文件是 .env 文件。这个文件用于定义环境变量，通常放置在项目的根目录下。

.env 文件示例

# 数据库配置
DATABASE_URL=postgres://user:password@localhost/dbname

# 应用配置
APP_ENV=development
APP_DEBUG=true

• 环境变量: .env 文件中的每一行定义一个环境变量，格式为 KEY=VALUE。
• 注释: 以 # 开头的行被视为注释，不会被解析。

使用方法

在项目中使用 Dotenv 加载 .env 文件的示例代码如下：

require 'dotenv'
Dotenv.load

puts ENV['DATABASE_URL']
puts ENV['APP_ENV']

• Dotenv.load: 加载 .env 文件中的环境变量。
• ENV['KEY']: 访问加载的环境变量。

通过以上步骤，你可以轻松地在项目中使用 Dotenv 来管理环境变量。