让您的本地设置正确调试您正在编写的代码所花费的时间比任何开发人员都愿意承认的要多。我们不要忘记，这主要是一个一次性完成的设置，所以如果我们不写下来，我们就不会记得。这篇文章就是为了解决这个确切的问题！ 将此作为如何启动并运行本地开发环境的书面提醒。
先决条件：
- pycharm professional（用于 docker 支持）
- docker 和 docker compose
- django rest framework (drf) 应用程序
除了调试模式所需的更新之外，本文不会介绍有关 django、docker 或 docker composer 设置的详细信息。它假设您已经掌握了如何使该部件工作的实用知识。
第 1 步：用于调试的 dockerfile 设置
将 dockerfile 设置为在开发模式下运行并允许来自 pycharm 调试器的连接。
下面是一个 dockerfile 示例：
# builder stage
from python:3.9-slim as builder
run chmod 1777 /tmp
# install system dependencies
run apt-get update && apt-get install -y \
libpq-dev \
build-essential
workdir /app
# copy the requirements file into the container
copy requirements.txt /app/
run pip install --no-cache-dir -r requirements.txt > pip_install.log
# copy the current directory contents into the container
copy . /app
# collect static files
run python manage.py collectstatic --noinput
# final stage
from python:3.9-slim
# set environment variables
env pythonunbuffered=1
env django_settings_module=template.settings.development
# set work directory
workdir /app
# copy files from the builder stage
copy --from=builder /app /app
# install pydevd-pycharm for remote debugging and gunicorn for serving
run pip install gunicorn pydevd-pycharm==241.17890.14 psycopg2-binary
# expose necessary ports
expose 8000 5679 # web app port and debug port
# entry point for the container
entrypoint ["sh", "-c", "python manage.py runserver 0.0.0.0:8000"]
有关此代码的注意事项
- pydevd-pycharm 中的 241.17890.14==241.17890.14 会有所不同，具体取决于您拥有的 pycharm 版本
- 我们公开 8000（web 服务器端口）和 5679（调试器端口）以供外部访问。
第2步：docker compose配置
让我们的 docker-compose.yml 文件来配置 web 服务（django 应用程序）以及数据库和其他服务。
这是一个示例 docker-compose.yml：
version: '3'
services:
web:
environment:
- django_environment=development
- db_host=host.docker.internal
build:
context: .
command: >
sh -c "python manage.py migrate &&
python manage.py collectstatic --noinput &&
python manage.py runserver 0.0.0.0:8000"
volumes:
- .:/app
ports:
- "8000:8000" # expose web port
- "5679:5679" # expose debugger port
extra_hosts:
- "host.docker.internal:host-gateway"
db:
image: postgres:13
environment:
- postgres_db=${db_name}
- postgres_user=${db_user}
- postgres_password=${db_password}
让我们进入代码分解
- 我们正在为 web 服务器映射端口 8000，为 pycharm 调试器映射端口 5679。
- extra_hosts 确保您的 docker 容器可以使用 host.docker.internal 与主机通信。
步骤 3：配置 pycharm 进行调试
- 创建 python 调试服务器配置：
- 在 pycharm 中导航至“运行 ➡️ 编辑配置”。
- 单击 + 按钮并选择 python 调试服务器。
- 将主机设置为 0.0.0.0 或本地计算机的 ip 地址。
- 将端口设置为 5679（或您在 docker 设置中公开的端口）。
然后点击“保存”！
启动调试器服务器：
单击“调试”按钮（绿色错误图标）启动 pycharm 调试器。这将开始侦听我们设置的端口。
第四步：向django添加远程调试代码
在 django 项目中，您需要在 manage.py 或 wsgi.py 中添加以下代码以连接到 pycharm 调试器：
import pydevd_pycharm
# connect to the pycharm debug server
pydevd_pycharm.settrace('host.docker.internal', port=5679, stdouttoserver=true, stderrtoserver=true, suspend=false)
此代码片段告诉您的 django 应用程序连接回主机上运行的 pycharm 调试器。 host.docker.internal 解析为 docker 中的主机，port=5679 与我们之前暴露的端口匹配。
第 5 步：运行 docker 并调试
- 构建并运行 docker： 运行以下命令来启动容器：
docker-compose up --build
这将构建 docker 镜像并启动服务，包括在开发模式下运行的 django。
2。设置断点：
在 pycharm 中的 django 代码中设置断点。断点应该有效，因为您的容器将连接到在端口 5679 上运行的 pycharm 调试服务器。
3。触发您的代码：
现在，在 django rest framework api 中触发任何 http 请求。当代码到达断点时，pycharm 将暂停执行，允许您检查当前状态并单步执行代码。
第 6 步：故障排除
如果您在运行 docker 时遇到错误“bind: address already in use”，则说明另一个进程已使用端口 5679。在这种情况下，您可以：
- 停止 pycharm 调试器并重新启动 docker。
- 更改 docker-compose.yml 和 pycharm 配置中的端口以避免冲突。
结论
这是我使用 pycharm 强大的调试器在 docker 容器内以开发模式运行 django rest framework 应用程序的设置。此设置可以帮助我通过在本地逐行调试代码来调试后端代码。
通过设置 docker 容器与 pycharm 通信，您可以简化 django 应用程序的编写、测试和调试，从而更轻松地编写代码！
祝你破解代码愉快！
