flask项目：基于文件系统动态生成路由，降低项目路由管理成本

所谓路由，就是处理请求URL和函数之间关系的程序，传统使用路由的方式需要手动编写路由，而基于文件系统的路由则会根据 /routes/ 下的文件目录结构，自动生成所有的访问路由。
在项目不断迭代增长的情况下（接口数量级达上千时），通过文件对应的路由配置，能节省手动配置路由的时间，极高的提高项目的管理能力。

一、效果演示

（1）Flask项目目录下，指定routes存放应用文件，如下图所示

（2）在routes目录下，创建接口文件，如 /routes/prod/school/student.py（prod表示为生产环境，school/student.py表示为校园学生的数据接口文件），内容如下：

  class Student():
    # http://127.0.0.1:5000/prod/school/student/say
    def say(self):
        return 'I am prod student!'

（3）启动项目

运行指令启动项目

python main.py

（4）启动项目

通过 /prod/school/student/say 即可访问路由

二、功能实现

（1）创建路由动态生成工具类

import os
import importlib
from stat import *

class Route():
    # 构造函数，传入app,项目路径，应用名称
    def __init__(self, app, project_path, route_dir, file_dir):
        self.__app = app                                # flask 的app
        self.__project_path = project_path              # 当前的项目路径(通过在main中传入__file__)
        self.__route_dir = route_dir                    # 存放route的目录(指定存放route的目录)
        self.__file_dir = file_dir                      # 需要生成路由的目录(指定route目录下需要生成路由的目录)
        self.route_start_path = self.__project_path + "/{0}/".format(self.__route_dir) + self.__file_dir

    def build(self):
        self.__make(self.route_start_path)              # 需要生成路由的起始目录

    def __make(self,top):

        for f in os.listdir(top):   
            pathname = os.path.join(top, f)
            try:
                mode = os.stat(pathname).st_mode        # python获取文件的状态，用于进一步判断是否文件
            except PermissionError:
                continue
            else:
                if S_ISDIR(mode) and not f.startswith("__"):        # 如果是文件夹且不以"__"开头，则继续获取下层内容
                    self.__make(pathname)
                elif S_ISREG(mode):                     # 如果是文件，则生成路由配置
                    self.__gen_route(pathname,f.replace(".py",""))
                else:
                    pass

    def __gen_route(self,pathname,name):
        moduleStr = pathname.replace(self.__project_path+"/","").replace(".py","").replace("/",".").replace("\\",".")
        moduleObj = importlib.import_module(moduleStr)

        for classStr in dir(moduleObj):
            if not classStr.startswith("__") and classStr.lower()==name.lower():
                classObj = getattr(moduleObj, classStr)
                obj = classObj()
                urlPath = pathname.replace(self.__project_path,"").replace("{0}/".format(self.__route_dir),"").replace(".py","").replace("\\","/").lower()
                
                for methodName in dir(classObj):
                    if not methodName.startswith("__"):
                        print('产生路由：', urlPath+"/"+methodName.lower())
                        self.__app.add_url_rule(urlPath+"/"+methodName.lower(), 
                                                endpoint=urlPath.replace("/","-")+"-"+methodName, 
                                                view_func=getattr(obj, methodName),
                                                methods=["GET","POST"])

（2）在app启动前，调用生成路由

from flask import Flask
import os
from libs.Route import Route 

app = Flask(__name__)

if __name__ == '__main__':
    prod_route = Route(app, os.path.dirname(__file__), 'routes', 'prod').build()                # 生产环境路由生成
    # 验证地址：
    # http://127.0.0.1:5000/prod/school/student/say
    # http://127.0.0.1:5000/prod/school/teacher/say

    test_route = Route(app, os.path.dirname(__file__), 'routes', 'test').build()                # 测试环境路由生成
    # 验证地址
    # http://127.0.0.1:5000/test/school/student/say
    # http://127.0.0.1:5000/test/school/teacher/say

    app.run()

（3）运行项目

运行指令启动项目

python main.py

（4）访问路径

http://127.0.0.1:5000/prod/school/student/say
http://127.0.0.1:5000/prod/school/teacher/say
http://127.0.0.1:5000/test/school/student/say
http://127.0.0.1:5000/test/school/teacher/say