【Python开发】Flask项目的组织架构

Flask项目的组织架构

在大型Flask项目中，主要有三种常见的项目组织架构：功能式架构（也就是 Bluelog 程序使用的架构）、分区式架构和混合式架构。我们将以一个示例程序 myapp 作为示例来介绍这三种架构的特点和区别，这个程序按照功能主要分为三部分：前台页面 front、认证 auth、后台管理 dashboard，为每个部分创建一个蓝本。

1.功能式架构

在功能式架构中，程序包由各个代表程序组件（功能）的子包组成，比如 blueprints（蓝本）、forms（表单）、templates（模板）、models（模型）等，在这些子包中，按照程序的板块分模块来组织代码，比如 forms 子包下包含 front.py、auth.py 和 dashboard.py。这种架构结构清晰，更容易在开发时让开发者迅速找到文件，其他维护者也能迅速了解程序结构。使用功能式架构的程序包目录结构示意如下。

因为程序比较简单，蓝本主要是用来组织路由，所以项目中的蓝本直接在 blueprints 包下的模块中创建。如果蓝本需要注册更多的处理程序，比如错误处理函数、请求处理函数等，可以在 blueprints 包中为每个蓝本创建单独的子包，目录结构示意如下所示：

通过为蓝本创建子包还可以支持为蓝本创建独立的 templates 和 static 文件夹：

和在单模块中创建蓝本不同，当在子包中创建蓝本时，为了方便其他模块导入蓝本对象，这时蓝本对象在蓝本子包的构造文件中创建。而且，因为蓝本在构造文件中定义，为了把路由、错误处理器、请求处理函数等和蓝本对象关联起来，需要在构造文件中导入这些模块。为了避免循环依赖，在构造文件的底部添加这些导入语句。

在路由模块等要使用蓝本对象的地方可以直接导入这里创建的蓝本对象。

2.分区式架构

在分区式架构中，程序被按照自身的板块分成不同的子包。myapp 使用分区式架构可以分别创建front、auth 和 dashboard 三个子包，这些子包直接在程序包的根目录下创建，子包中使用模块组织不同的程序组件，比如 views.py、forms.py 等。这种分类自然决定了每一个子包都对应着一个蓝本，这时蓝本在每个子包的构造文件中创建。使用分区式架构的程序包目录结构示意如下所示：

3.混合式架构

混合式架构，顾名思义，就是不按照常规分类来组织。比如，采用类似分区式架构的子包来组织程序，但各个蓝本共用程序包根目录下的模板文件夹和静态文件文件夹。

或是某个蓝本采用分区式架构单独组织，其他蓝本则使用功能式架构统一放到 blueprints 子包中。

4.如何选择？

不同类型的程序适合不同的组织方式。一般来说，如果程序各个功能之间联系较为紧密，我们可以采用功能式组织方式，反之则适合采用分区式架构。

比如，一个社交程序的 程序本身、后台管理、公司博客、API文档 是功能设计和页面样式都相对独立的四部分，各个部分都会使用自己的模板、静态文件、错误处理器等，这时则更适合使用分区式架构。