构建可重用的Django App

笔者所在的小组负责SaaS开发，几乎承载了中心的全部SaaS需求。其中，有长期维护的重点项目，也有短期突击的演示项目，每个人都身兼数职。当然，开发平台也开放给其他人员使用，整个平台有着成百上千的SaaS应用。这些应用中存在大量重复的功能块，重复的开发工作。随着开发平台的建设，部分功能被沉淀到平台组件，笔者希望另一部分也能够复用。一方面可以减轻开发任务，另一方面是有利于功能解耦和维护。由于平台提供的开发框架是Django，本文主要讨论构建可重用Django APP的原则和相关事项。

1. 可重用应用的原则

设计、构建、测试和维护一个网页应用有许多工作要做。许多的Python和Django项目都有常见的共同问题。可重用将会节省这些重复工作。

• 约定结构。Django App本身也只是一个Python包，它特意用于Django项目中。一个可复用的Django App应该具有约定的子模块，比如models、urls、views等模块。约定结构可以显著降低使用成本。
• 相互隔离。为了唯一标识每个app，Django App名作为ID是个不错的选择。App应该明确自己的url前缀，数据库表名，全局的常、变量名，同时不能相互的依赖。
• README。说明文档是每个Django App必须的。文档中要交代，Django App的文件结构、实施细节、依赖关系、可能的风险、甚至联系方式。

2. 项目的文件结构

良好的目录结构，不仅能帮助开发人员更好的归档代码，还能增强构建可重用Django App的意识。

2.1 Project的目录结构

• django_app_template目录。创建的django app，一个项目会划分很多个django app，每个app都有独立的django_app_template目录。
• common目录。存放项目相关的公共函数库，比如上下文处理、装饰器、中间件、工具函数等。
• static目录。存放静态文件。在部署前，使用collectstatic命令将全部静态文件聚合在一起。
• templates目录。存放模板文件。
• settings.py文件。配置项目相关的环境变量、目录、初始化设置等。如果，配置内容较多，还可以将配置单独放在一个config文件夹，根据不同的环境设置不同的settings.py文件，比如config/settings_local.py。
• urls.py文件。根URL配置，装配的django app，需要在此文件添加url配置。
• requirements.txt文件。项目的依赖包，包括全部django app中requirements.txt拷贝。

2.2 App的目录结构

• static目录。静态文件应放在django_app_template子目录下，避免与其他app发生冲突。
• templates目录。模板文件应放在django_app_template子目录下，避免与其他app发生冲突。
• admin.py文件。用于admin页面的显示和定制化
• constants.py文件。用于存放常量
• feeds.py文件。用于输出rss
• forms.py文件。用于验证前端的数据
• middleware.py文件。django app中用到的中间件
• settings.py文件。django app中相关的配置
• utils.py文件。django app中使用到的工具函数
• README文件。用于描述django app的相关说明信息
• requirements.txt文件。用于记录django app的相关依赖
• tests.py文件。用于写django app的测试用例。

3. 如何打包你的应用

3.1 准备相关文件

• 创建父目录django-app-template。将整个django_app_template拷贝到这个目录，django-app-template/django_app_template。
• 创建django-app-template/README.rst文件，撰写打包应用的配置、安装、使用过程。
• 创建django-app-template/requirements.txt文件，依赖的包。
• 创建django-app-template/LICENSE文件，许可协议。
• 创建django-app-template/setup.py文件。

如果需要包含其他文件，还需要配置django-app-template/MANIFEST.in文件

1
2
3
4

include LICENSE
include README.rst
include requirements.txt
exclude build.sh

3.2 编写打包配置

编写django-app-template/setup.py。更详细的使用可以查阅setuptools相关手册。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# -*- coding: utf-8 -*-
import os
from setuptools import find_packages, setup
from pip.req import parse_requirements
install_reqs = parse_requirements('requirements.txt', session='hack')
# reqs is a list of requirement
# e.g. ['django==1.5.1', 'mezzanine==1.4.6']
reqs = [str(ir.req) for ir in install_reqs]

with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
    README = readme.read()

# allow setup.py to be run from any path
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))

setup(
    name='django-app-template',
    version='0.0.1',
    author='',
    author_email='@gmail.com',
    description='django-app-template',
    long_description=README,
    keywords='django app',
    license='BSD License',
    url='http://django-app-template.com/',

    packages=find_packages(exclude=[]),
    include_package_data=True,
    zip_safe=False,
	install_requires=reqs,

    classifiers=[
        'Environment :: Web Environment',
        'Framework :: Django',
        'Framework :: Django :: 1.8',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License',
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Topic :: Internet :: WWW/HTTP',
        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
    ],
)

3.3 执行打包命令

使用python setup sdist创建一个新包。

1

python setup sdist

3.4 测试安装

安装

1

pip  install  djangp-app-template/dist/djangp-app-template-0.0.1.tar.gz

卸载

1

pip  uninstall djangp-app-template

4. 参考

• https://djangopackages.org/
• http://python.usyiyi.cn/django/intro/reusable-apps.html
• https://django-intro-zh.readthedocs.io/zh_CN/latest/reusable_app/