django 读取环境变量|极客教程

django 读取环境变量

在开发和部署 Django 项目时，我们经常需要读取环境变量来配置项目的一些参数，例如数据库连接字符串、密钥等敏感信息。通过使用环境变量，可以更加安全地管理这些配置信息，避免将敏感信息硬编码在代码中或版本控制中暴露出去。

本文将介绍如何在 Django 项目中读取环境变量，并给出一些实际应用的示例。

为什么要使用环境变量

在开发、测试、生产环境中，我们通常会有不同的配置信息，例如不同的数据库连接、不同的密钥等。如果将这些信息硬编码在代码中，会导致代码在不同环境中需要做大量的修改，增加维护成本并且不安全。

通过使用环境变量，我们可以将这些信息从代码中剥离出来，使得代码更具可移植性和安全性。此外，在 Docker、Kubernetes、CI/CD 等场景下，环境变量也是常用的配置方案。

Django 读取环境变量的方法

在 Django 中，可以使用 os 模块来读取环境变量。通常情况下，我们会将环境变量的配置放在一个单独的文件中，例如 .env 文件，并使用 python-dotenv 库来解析 .env 文件中的环境变量。

以下是一个简单的示例，演示了如何使用环境变量配置 Django 项目中的 SECRET_KEY。

首先，安装 python-dotenv 库：

pip install python-dotenv

然后，在项目根目录下创建一个 .env 文件，内容如下：

SECRET_KEY=your_secret_key_here

在 Django 项目的 settings.py 文件中，添加以下代码：

import os
from dotenv import load_dotenv

# 加载 .env 文件
load_dotenv()

SECRET_KEY = os.getenv('SECRET_KEY')

现在，当 Django 启动时，会从 .env 文件中读取 SECRET_KEY 的值，并将其赋给 SECRET_KEY 变量。

示例应用

下面通过一个示例应用演示如何使用环境变量配置 Django 项目。

步骤1：创建 Django 项目

首先，使用以下命令创建一个新的 Django 项目：

django-admin startproject myproject

步骤2：安装 `python-dotenv` 库

在项目根目录下执行以下命令安装 python-dotenv 库：

pip install python-dotenv

步骤3：配置环境变量

在项目根目录下创建一个 .env 文件，添加以下内容：

DB_NAME=mydatabase
DB_USER=myuser
DB_PASSWORD=mypassword

步骤4：读取环境变量

在 settings.py 文件中添加以下代码读取环境变量：

import os
from dotenv import load_dotenv

# 加载 .env 文件
load_dotenv()

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': os.getenv('DB_NAME'),
        'USER': os.getenv('DB_USER'),
        'PASSWORD': os.getenv('DB_PASSWORD'),
        'HOST': 'localhost',
        'PORT': '',
    }
}