首页 | 编程 | python

在 Windows 下搭建高效的 django 开发环境的详细教程

2020年07月27日 作者：追梦人物原文

从初学 django 到现在（记得那时最新版本是 1.8，本文发布时已经发展到 3.1 了），开发环境一直都是使用从官方文档或者别的教程中学来的方式搭建的。但是在实际项目的开发中，越来越感觉之前的开发环境难以适应项目的发展。官方文档或一些教程中的环境搭建方式主要存在这些问题：

python manage.py runserver 启动的开发服务器热重载非常慢，尤其是当项目中导入了大量模块时，有时候改一次代码要等几秒钟才能完成重载。 主力开发环境为 Windows + PyCharm，然而有时候依赖的一些服务只能在 Linux 下运行（例如 Celery 以及其他一些异步任务的库如 django-q ）。

针对以上的一些痛点，我在实际开发当中逐步摸索出一套新的开发环境搭建方法，用来搭建一套舒适的 django 开发环境，总的来说，新的环境包括以下几个方面的改进：

  • 使用 Uvicorn 代替 django 自带的开发服务器启动应用，极大提高代码热重载速度。
  •  使用 Pipenv 或者 Poetry 来管理虚拟环境和项目依赖。
  • 使用 Docker 容器来运行需要在 Linux 平台下才能运行的服务。
  • 使用 AutoHotkey 为常用命令设置 alias。

PyCharm 创建 django 项目

Django 项目开发首选 PyCharm，当然你也可以使用 VS Code，不过极有可能随着一通折腾和配置之后，你会发现终于成功地把 VS Code 配置成了一个 PyCharm。所以为了节约有限的开发时间以及生命，推荐直接使用 PyCharm。

PyCharm 创建一个 django 项目非常简单，如果是第一次打开 PyCharm，点击 + Create New Project 就会弹出创建新项目的对话框。如果已经打开过别的项目，则依次点击顶部导航条的 File > New Project 也会弹出创建新项目的对话框。

然后在对话框左侧点击 django ，就会进入 django 项目的配置页面，完成一些初始化设置，PyCharm 就会自动为我们创建一个新的 django 项目。

Django 项目的配置页面如图：

Uvicorn 安装好后，可以在命令行使用 uvicorn 命令来运行 django。但是，每次输命令启动 django 会非常麻烦！最好的做法是创建一个脚本，启动 django 只需要执行脚本就可以了。

在 项目根目录 创建一个 run_uvicorn.py 的脚本（脚本名可以自己随便取），代码如下：

run_uvicorn.py

import uvicorn
import os

def main():
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_dev_env_demo.settings")
 uvicorn.run(
  "django_dev_env_demo.asgi:application",
  host="0.0.0.0",
  port=8000,
  log_level="debug",
  reload=True,
 )

if __name__ == "__main__":
 main()

脚本中可以随意定制代码的逻辑，非常灵活。比如这里我首先设置了一个环境变量 DJANGO_SETTINGS_MODULE 用来指定 django 启动时加载的配置文件。举一反三，可以在 uvicorn.run 之前进行更多的设置。例如对于更加复杂的项目，我通常会把一些重要的路径加入到 sys.path 中，以及设置项目所需的环境变量。

然后就是 uvicorn.run 启动 django。更确切点地说就是启动一个 ASGI 或者 WSGI 应用。django 3 以后逐渐支持 ASGI 应用，而在此之前则是 WSGI。第一个参数传入 ASGI 或者 WSGI 应用所在的模块。例如这里的 django_dev_env_demo.asgi:application 表示 django_dev_env_demo 下 asgi.py 模块里的 application（django 提供的 ASGI 应用的实例），在 django_dev_env_demo/asgi.py 下可以看到。如果是 django 3.0 以前版本，相应改为 WSGI application 所在模块即可。

其它启动参数顾名思义，最为重要的就是这个 reload ，它启动热重载功能，比 django 自带的开发服务器重载快 很多。

脚本运行后的输出：

对于运行过的脚本，PyCharm 都会记录在右上角，以后只要在右上角的下拉框中选择需要执行的脚本，然后点击绿色三角或者 debug 按钮执行就可以了，非常方便！

对于 SQLite 数据库，只需要双击数据库文件就可以直接连接，然后就能查看数据库表结构以及表中的数据了：

点击右上角的齿轮，再点击 Add 添加虚拟环境，选择 Existing environment，再点击 Interpreter 后面的省略号，选择 poetry env info --path 输出的虚拟环境路径下的 Scripts/python.exe 作为解释器。

然后点击 ok 确认就 ok 了。

这样，在使用 PyCharm 的 Terminal 时，就会自动激活 poetry 创建的虚拟环境，和用 Pipenv 创建的虚拟环境一样。

总结

这里给大家展示了如何使用 PyCharm + Uvicorn + Docker + AutoHotkey + Pipenv or Poetry 搭建舒适的 django 开发环境，基本上能满足大部分不是很复杂的项目。

要记住，无论以什么样的方式搭建开发环境，核心目的只有一个： 让开发者只需关注核心业务逻辑的开发，而不是被各种环境问题分心。

当然，对于一些更加复杂的项目，在此基础上我们还可以进一步优化环境的配置来满足各种复杂的环境要求，我会在以后的文章里进行进一步地介绍。

到此这篇关于在 Windows 下搭建高效的 django 开发环境的详细教程的文章就介绍到这了,更多相关Windows 搭建django 开发环境内容请搜索来客网以前的文章或继续浏览下面的相关文章希望大家以后多多支持来客网！

相关链接