11 KiB
使用 Django
本小节内容适合
Python开发人员阅读。
本节将使用 Docker Compose 配置并运行一个 Django + PostgreSQL 应用。笔者不仅会介绍具体步骤,还会解释每个配置项的作用,以及开发环境和生产环境的差异。
架构概览
在开始之前,让我们先理解我们要构建的架构:
┌─────────────────────────────────────────────────────────────┐
│ Docker Compose 网络 │
│ │
│ ┌─────────────────────┐ ┌─────────────────────┐ │
│ │ web 服务 │ │ db 服务 │ │
│ │ ┌───────────────┐ │ │ ┌───────────────┐ │ │
│ │ │ Django │ │──────│ │ PostgreSQL │ │ │
│ │ │ 应用 │ │ :5432│ │ 数据库 │ │ │
│ │ └───────────────┘ │ │ └───────────────┘ │ │
│ │ :8000 │ │ │ │
│ └──────────┬──────────┘ └─────────────────────┘ │
│ │ │
└─────────────┼───────────────────────────────────────────────┘
│
▼
localhost:8000
(浏览器访问)
关键点:
web服务运行 Django 应用,对外暴露 8000 端口db服务运行 PostgreSQL 数据库,只在内部网络可访问- 两个服务通过 Docker Compose 自动创建的网络相互通信
web服务可以通过服务名db访问数据库(Docker 内置 DNS)
准备工作
创建一个项目目录并进入:
$ mkdir django-docker && cd django-docker
我们需要创建三个文件:Dockerfile、requirements.txt 和 docker-compose.yml。
Step 1: 创建 Dockerfile
具体内容如下:
FROM python:3.12-slim
## 防止 Python 缓冲 stdout/stderr,让日志实时输出
ENV PYTHONUNBUFFERED=1
## 设置工作目录
WORKDIR /code
## 先复制依赖文件,利用 Docker 缓存加速构建
COPY requirements.txt /code/
## 安装依赖
RUN pip install --no-cache-dir -r requirements.txt
## 复制项目代码
COPY . /code/
逐行解释:
| 指令 | 作用 | 为什么这样写 |
|---|---|---|
FROM python:3.12-slim |
基础镜像 | slim 版本比完整版小很多,但包含运行 Python 所需的一切 |
ENV PYTHONUNBUFFERED=1 |
关闭输出缓冲 | 让 print() 和日志立即显示,便于调试 |
WORKDIR /code |
设置工作目录 | 后续命令都在此目录执行 |
COPY requirements.txt 在前 |
分层复制 | 只有 requirements.txt 变化时才重新安装依赖,加速构建 |
--no-cache-dir |
不缓存 pip 下载 | 减小镜像体积 |
💡 笔者建议:总是将变化频率低的文件先复制,变化频率高的后复制。这样可以最大化利用 Docker 的构建缓存。
Step 2: 创建 requirements.txt
具体内容如下:
Django>=5.0,<6.0
psycopg[binary]>=3.1,<4.0
gunicorn>=21.0,<22.0
依赖说明:
| 包名 | 作用 |
|---|---|
Django |
Web 框架 |
psycopg[binary] |
PostgreSQL 数据库驱动(推荐使用 psycopg 3) |
gunicorn |
生产环境 WSGI 服务器(可选,开发时可不用) |
Step 3: 创建 docker-compose.yml
Step 3: 创建 docker-compose.yml 配置如下:
services:
db:
image: postgres:16
environment:
POSTGRES_DB: django_db
POSTGRES_USER: django_user
POSTGRES_PASSWORD: django_password
volumes:
- postgres_data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U django_user -d django_db"]
interval: 5s
timeout: 5s
retries: 5
web:
build: .
command: python manage.py runserver 0.0.0.0:8000
volumes:
- .:/code
ports:
- "8000:8000"
depends_on:
db:
condition: service_healthy
environment:
DATABASE_URL: postgres://django_user:django_password@db:5432/django_db
volumes:
postgres_data:
配置详解:
db 服务
db 服务 配置如下:
db:
image: postgres:16 # 使用官方 PostgreSQL 16 镜像
environment:
POSTGRES_DB: django_db # 创建的数据库名
POSTGRES_USER: django_user # 数据库用户
POSTGRES_PASSWORD: django_password # 数据库密码
volumes:
- postgres_data:/var/lib/postgresql/data # 持久化数据
healthcheck: # 健康检查,确保数据库就绪
test: ["CMD-SHELL", "pg_isready -U django_user -d django_db"]
interval: 5s
⚠️ 笔者提醒:
volumes配置很重要!没有它,每次容器重启数据都会丢失。笔者见过不少新手因为忘记这一步,导致开发数据全部丢失。
web 服务
web 服务 配置如下:
web:
build: . # 从当前目录的 Dockerfile 构建
command: python manage.py runserver # 启动 Django 开发服务器
volumes:
- .:/code # 挂载代码目录,支持热更新
ports:
- "8000:8000" # 映射端口
depends_on:
db:
condition: service_healthy # 等待数据库健康后再启动
关键配置说明:
| 配置项 | 作用 | 笔者建议 |
|---|---|---|
volumes: .:/code |
代码挂载 | 开发时必备,修改代码无需重新构建镜像 |
depends_on + healthcheck |
启动顺序 | 确保数据库就绪后 Django 才启动,避免连接错误 |
environment |
环境变量 | 推荐用环境变量管理配置,避免硬编码 |
Step 4: 创建 Django 项目
运行以下命令创建新的 Django 项目:
$ docker compose run --rm web django-admin startproject mysite .
命令解释:
docker compose run:运行一次性命令--rm:命令执行后删除临时容器web:在 web 服务环境中执行django-admin startproject mysite .:在当前目录创建 Django 项目
生成的目录结构:
django-docker/
├── docker-compose.yml
├── Dockerfile
├── requirements.txt
├── manage.py
└── mysite/
├── __init__.py
├── settings.py
├── urls.py
├── asgi.py
└── wsgi.py
💡 Linux 用户注意:如果遇到权限问题,执行
sudo chown -R $USER:$USER .
Step 5: 配置数据库连接
修改 mysite/settings.py,配置数据库连接:
import os
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': os.environ.get('POSTGRES_DB', 'django_db'),
'USER': os.environ.get('POSTGRES_USER', 'django_user'),
'PASSWORD': os.environ.get('POSTGRES_PASSWORD', 'django_password'),
'HOST': 'db', # Docker Compose 服务名
'PORT': 5432,
}
}
## 允许的主机(开发环境)
ALLOWED_HOSTS = ['*']
为什么 HOST 是 db 而不是 localhost?
在 Docker Compose 中,各服务通过服务名相互访问。Docker 内置的 DNS 会将 db 解析为 db 服务容器的 IP 地址。这是 Docker Compose 的核心功能之一。
Step 6: 启动应用
运行以下命令:
$ docker compose up
你会看到:
- 首先构建 web 镜像(第一次运行)
- 启动 db 服务,等待健康检查通过
- 启动 web 服务
db-1 | PostgreSQL init process complete; ready for start up.
db-1 | LOG: database system is ready to accept connections
web-1 | Watching for file changes with StatReloader
web-1 | Starting development server at http://0.0.0.0:8000/
打开浏览器访问 http://localhost:8000,可以看到 Django 欢迎页面!
常用开发命令
在另一个终端窗口执行:
## 执行数据库迁移
$ docker compose exec web python manage.py migrate
## 创建超级用户
$ docker compose exec web python manage.py createsuperuser
## 进入 Django shell
$ docker compose exec web python manage.py shell
## 进入 PostgreSQL 命令行
$ docker compose exec db psql -U django_user -d django_db
💡 笔者建议使用
exec而不是run。exec在已运行的容器中执行命令,run会创建新容器。
常见问题排查
Q1: 数据库连接失败
错误信息:django.db.utils.OperationalError: could not connect to server
可能原因与解决方案:
| 原因 | 解决方案 |
|---|---|
| 数据库还没启动完成 | 使用 depends_on + healthcheck |
| HOST 配置错误 | 确保使用服务名 db 而不是 localhost |
| 网络未创建 | 运行 docker compose down 后重新 up |
## 调试:检查数据库是否正常运行
$ docker compose ps
$ docker compose logs db
Q2: 代码修改没有生效
可能原因:
- 开发服务器没有自动重载:确保使用
runserver而不是gunicorn - Volume 挂载问题:检查
docker-compose.yml中的 volumes 配置 - 缓存问题:尝试
docker compose restart web
Q3: 权限问题(Linux)
运行以下命令:
## 如果容器内创建的文件 root 用户所有
$ sudo chown -R $USER:$USER .
开发 vs 生产:关键差异
笔者特别提醒,本节的配置是开发环境配置。生产环境需要以下调整:
| 配置项 | 开发环境 | 生产环境 |
|---|---|---|
| Web 服务器 | runserver |
gunicorn + Nginx |
| DEBUG | True |
False |
| 密码管理 | 明文写在配置 | 使用 Docker Secrets 或环境变量 |
| Volume | 挂载代码目录 | 代码直接 COPY 进镜像 |
| ALLOWED_HOSTS | ['*'] |
具体域名 |
生产环境 docker-compose.yml 示例:
## docker-compose.prod.yml
services:
web:
build: .
command: gunicorn mysite.wsgi:application --bind 0.0.0.0:8000
# 不挂载代码,使用镜像内的代码
environment:
DEBUG: 'False'
ALLOWED_HOSTS: 'example.com,www.example.com'
# ...
延伸阅读
- Compose 模板文件详解:深入理解 docker-compose.yml 的所有配置项
- 使用 WordPress:另一个 Compose 实战案例
- Dockerfile 最佳实践:构建更小、更安全的镜像
- 数据管理:Volume 和数据持久化详解