Django 如何正确地设置环境变量 Gitlab CI/CD 和 Docker

在本文中，我们将介绍如何在使用Django开发Web应用时，正确地设置环境变量，并将其与Gitlab CI/CD和Docker集成起来。环境变量是配置和保护应用程序的重要组成部分，可以包含敏感信息，如数据库密码、API密钥等。通过正确地设置环境变量，我们可以避免将其硬编码到代码中，增加应用程序的安全性，并轻松地在不同的环境中切换配置。

阅读更多：Django 教程

为何使用环境变量

在Web应用程序中，通过环境变量来配置敏感信息是一种良好的实践。相比将这些信息直接写入代码中，使用环境变量有以下优点：

安全性：避免将敏感信息硬编码到代码中，提高应用程序的安全性。这样即使代码被泄露，攻击者也无法得到敏感数据。
可配置性：将配置信息与代码解耦，可以轻松地在不同的环境中切换配置，如测试环境、开发环境和生产环境。
便于管理：使用环境变量可以集中管理配置信息，方便在需要时修改和更新。

具体到Django应用程序中，环境变量通常用于配置以下信息：

数据库连接：如数据库类型、主机地址、端口、用户名和密码等。
缓存连接：如Redis或Memcached等缓存服务的连接信息。
第三方服务：如短信接口、支付网关等的API密钥和访问地址。
日志和调试配置：如日志级别、日志文件路径和调试模式等。

设置环境变量

在Django中，设置环境变量可以使用Python的os.environ模块。os.environ是一个字典对象，可以通过它来设置和获取环境变量的值。我们可以在Django的settings.py文件中添加以下代码来设置环境变量：

import os

os.environ['DATABASE_URL'] = 'postgres://user:password@localhost:5432/mydatabase'
os.environ['SECRET_KEY'] = 'your-secret-key'
os.environ['DEBUG'] = 'False'

在上面的示例中，我们设置了DATABASE_URL、SECRET_KEY和DEBUG三个环境变量。DATABASE_URL环境变量用于配置数据库连接，SECRET_KEY环境变量用于配置Django的密钥，DEBUG环境变量用于配置是否启用调试模式。

为了方便管理和使用环境变量，我们可以使用一个.env文件来存储这些配置。.env文件是一个文本文件，每一行表示一个环境变量的设置，格式为KEY=VALUE。在Django项目的根目录下，我们可以创建一个名为.env的文件，并将上面的示例配置写入其中：

DATABASE_URL=postgres://user:password@localhost:5432/mydatabase
SECRET_KEY=your-secret-key
DEBUG=False

然后，在settings.py文件中，我们可以添加以下代码来从.env文件中加载环境变量：

import dotenv

dotenv.load_dotenv()

上面的代码使用了第三方库python-dotenv来加载.env文件中的环境变量。

使用Gitlab CI/CD和Docker集成

Gitlab CI/CD是一种集成到Gitlab的持续集成和持续部署工具。通过在项目根目录下创建.gitlab-ci.yml文件，我们可以配置一系列的作业（jobs）和阶段（stages），用于自动化构建、测试和部署应用程序。

要在Gitlab CI/CD中使用环境变量，我们首先需要将配置信息存储在Gitlab项目的Settings页面中，具体的操作如下：

进入Gitlab项目的主页，点击左侧菜单栏中的Settings。
在Settings页面中，点击CI/CD选项卡。
滚动到Variables部分，点击Add variable按钮。
在弹出的对话框中，填写环境变量的Key和Value，然后点击Add variable按钮。

完成上述步骤后，我们就可以在.gitlab-ci.yml文件中使用这些环境变量了。下面是一个示例：

stages:
  - build
  - test
  - deploy

variables:
  DATABASE_URL: DATABASE_URL
  SECRET_KEY:SECRET_KEY
  DEBUG: $DEBUG

build:
  stage: build
  script:
    - docker build -t myapp .

test:
  stage: test
  script:
    - docker run myapp python manage.py test

deploy:
  stage: deploy
  script:
    - docker push myapp

在上面的示例中，我们定义了三个阶段（stages）：build、test和deploy。在variables部分，我们将Gitlab CI/CD的环境变量映射到Docker容器中，并使用$DATABASE_URL、$SECRET_KEY和$DEBUG来引用这些环境变量。在build阶段中，我们使用Docker构建应用程序的镜像；在test阶段中，我们使用Docker运行应用程序的测试；在deploy阶段中，我们将应用程序的镜像推送到Docker仓库中。

通过将环境变量配置在Gitlab CI/CD中，我们可以在不同的CI/CD作业中使用相同的环境变量，实现配置的共享和复用。