Flask_BestPractices

Flask 最佳实践

---------->>>>>>持续更新<<<<<<----------

更新日志

这是一个项目结构,可以直接使用并开始编写业务

包含前后端分离 Restful Api 以及不分离 Jinja2 模版渲染

以下使用此结构结合 Vue 实现一套前后分自动化测试平台

自动化测试平台Web端: https://github.com/ExileLine/ExileTestPlatformWeb

自动化测试平台服务端: https://github.com/ExileLine/ExileTestPlatformServer

Aiohttp 最佳实践: https://github.com/yangyuexiong/AioHttp_BestPractices

Fastapi 最佳实践(即将完成...): https://github.com/yangyuexiong/FastApi_BestPractices

可能会再出 Tornado,Sanic,FastApi,Aiohttp 等最佳实践

大佬们！下面简陋的文档凑合先看着,有空闲时间补上详细使用文档

如有疑问 -> QQ or Wechat : 417993207 (使用遇到问题请马上联系我会及时为你解答)

你不点 Star 我更新给谁看?

Github:

https://github.com/yangyuexiong/Flask_BestPractices

码云:

https://gitee.com/yangyuexiong/Flask_BestPractices

Flask 官方文档

https://flask.palletsprojects.com/

Flask 中文文档

https://dormousehole.readthedocs.io/en/latest/

---------->>>>>>感谢支持<<<<<<----------

Flask_BestPractices
├── app(应用)
│   ├── __init__.py
│   ├── all_reference.py(通用统一导入)
│   ├── api
│   │   ├── __init__.py(注册url)
│   │   ├── method_view_demo(MethodView使用例子)
│   │   │   ├── __init__.py
│   │   │   └── method_view_demo.py
│   │   ├── restful_demo(flask_restful使用例子)
│   │   │   ├── __init__.py
│   │   │   └── restful_demo.py
│   │   └── route_demo(flask路由使用例子)
│   │       ├── __init__.py
│   │       └── route_demo.py
│   ├── controllers(其他业务)
│   │   ├── __init__.py
│   │   ├── other_module_01
│   │   │   ├── __init__.py
│   │   │   └── module_01.py
│   │   ├── other_module_02
│   │   │   ├── __init__.py
│   │   │   └── module_02.py
│   │   └── other_module_03
│   │       ├── __init__.py
│   │       └── module_03.py
│   ├── models(模型)
│   │   ├── __init__.py
│   │   └── admin
│   │       └── models.py
│   ├── static(静态文件(Js,Css,Img))
│   │   ├── flask.jpg
│   │   └── images
│   │       └── flask.jpg
│   └── templates(模版文件(HTML)用于模版渲染(前后分离不需要,这里只作为一个例子))
│       ├── index01.html
│       ├── index02.html
│       └── index03.html
├── common(公共文件分类)
│   ├── __init__.py
│   ├── interceptors(路由钩子)
│   │   ├── ApiHook.py(前台应用拦截处理器(即:访问api开头的url时做的逻辑处理))
│   │   ├── AppHook.py
│   │   ├── CmsHook.py(管理后台拦截处理器(即:访问cms开头的url时做的逻辑处理))
│   │   └── __init__.py
│   └── libs
│       ├── BaseModel.py(ORM基类)
│       ├── __init__.py
│       ├── api_result.py(统一返回json格式规范)
│       ├── customException.py(自定义异常)
│       └── tools.py(工具)
├── config(配置文件)
│   ├── __init__.py
│   ├── config.py
│   ├── dev.ini
│   └── pro.ini
├── ExtendRegister(扩展统一注册)
│   ├── __init__.py
│   ├── bp_register.py(蓝图)
│   ├── command_register.py(flask shell 注册)
│   ├── conf_register.py(配置文件)
│   ├── db_register.py(数据库)
│   ├── excep_register.py(异常处理)
│   ├── hook_register.py(路由钩子拦截器)
│   └── model_register.py(模型统一导入用于迁移)
├── logs
│   ├── __init__.py
│   └── tb.log
├── migrations(数据迁移文件(会在初始化迁移环境后生成))
├── tasks(定时任务/异步任务)
│   ├── APSchedulerTasks
│   │   └── clear_logs.py
│   ├── CeleryAsyncTasks
│   │   ├── __init__.py
│   │   ├── celeryconfig.py
│   │   └── main.py
│   └── __init__.py
├── test(测试)
│   ├── __init__.py
│   ├── excep_test.py
│   ├── req_test.py
│   ├── test_celery.py
│   ├── test_data.py
│   └── test_env.py
├── ApplicationExample.py(应用实例)
├── LICENSE
├── Pipfile(环境依赖)
├── Pipfile.lock
├── README.md
├── run.py(启动文件)
└── test_run.py(调试启动文件(可以忽略或者删除))

一、安装

Python3.9+
pip3
pipenv
```
pip3 install pipenv
```

二、配置虚拟环境

进入项目根目录
```
cd /Flask_BestPractices
```

修改 pipenv 的 pip 安装源(科学上网(翻墙)的同学可以忽略)

Pipfile

Pipfile 文件修改如下:

# 国内pip安装源(不能翻墙的同学修改如下,在可以翻墙的情况下依旧国内pip源比较快)
url = "https://pypi.doubanio.com/simple"

# 国外pip安装源(可以翻墙)
url = "https://pypi.org/simple"

# 修改对应的 Python 版本
[requires]
python_version = "3.9"

安装虚拟环境与依赖的包
```
pipenv install
```
进入虚拟环境
```
pipenv shell
```
查看虚拟环境路径
```
pipenv --venv
```
Pycharm 配置 pipenv 虚拟环境(不使用 Pycharm 的同学可以忽略)
Mac
Windows
配置 Pycharm 的 Flask 变量(因为 Pycharm 运行项目不会读取系统变量所以要配置在 Pycharm 中)
配置 Flask 运行变量
- FLASK_ENV：Flask运行环境(启动的时候默认 production 为了区分开发与生产通过以下方式配置，以下配置只能在终端启动项目生效在Pycharm不生效)
- FLASK_DEBUG：Flask2.3之后需要用到，1-True;0-False
- FLASK_APP：Flask应用实例，用于执行orm迁移，flask cli脚本，异步任务等需要。
Windows 系统(一般用于开发环境)
- FLASK_ENV为development
- FLASK_DEBUG为1
- FLASK_APP为ApplicationExample.py

MacOS 系统(一般用于开发环境)

FLASK_ENV为development
FLASK_DEBUG为1
FLASK_APP为ApplicationExample.py

vim ~/.bash_profile

打开文件找到：
    如果没看到这个文件 按: `shift`按键+`command`按键+ `.` 按键。就会显示隐藏文件因为隐藏文件一般不显示
需要使其隐藏：
    再按一次 `shift`按键+`command`按键+ `.` 按键

生效配置文件
source ~/.bash_profile

Linux 系统(一般使用为生产环境)
- FLASK_ENV为production
- FLASK_DEBUG为0
- FLASK_APP为ApplicationExample.py
```
vim ~/.bashrc
```
```
source ~/.bashrc
```

三、配置文件

前置准备(如:创建数据库)
- /config/dev.ini
- /config/pro.ini

四、ORM

这里我提供了一套简单的后台权限管理,用于测试数据迁移

command_register.py 文件中注册 flask-cli 当前已经定义好初始化数据,创建表等方法

进入项目环境

pipenv shell

查看项目下所有cli脚本与命令(即: flask 命令名称)

flask

创建表与新增表时执行(如果已经在项目环境中请忽略：pipenv shell)
```
pipenv shell
```
```
flask orm
```
新增 model 后，需要在 model_register.py 导入后执行
```
flask orm
```

五、路由注册

创建(路由,Api,视图)
路由注册
- /Flask_BestPractices/app/api/init.py
路由绑定应用
- /Flask_BestPractices/ExtendRegister/bp_register.py
获取请求参数例子
- demo_api.py
- /Flask_BestPractices/app/api/init.py
测试全局异常
- test_api.py
- /Flask_BestPractices/app/api/init.py

六、钩子函数(拦截器):

拿其中一个举例(业务逻辑根据自己需要编写)
- /Flask_BestPractices/common/interceptors/ApiHook.py

七、自定义异常:

在 customException.py 添加

# 在 custom_resp_dict 添加 kay:value
custom_resp_dict = {
          333: '测试自定义异常',
          400: '参数类型错误',
          401: '未登录_认证信息失败_令牌过期',
          403: '无权限',
          500: '服务器异常',
          666: 'Token?',
          996: '没救了'
      }

使用

  from common.libs.customException import method_view_ab_code as ab_code
  from common.libs.customException import flask_restful_ab_code as ab_code_2

  
  # flask_restful 使用 ab_code_2
  class FlaskRestfulCustomException(Resource):

      def get(self):
          ab_code_2(333)

  # MethodView 使用 ab_code
  class MethodViewCustomException(MethodView):

      def get(self):
          ab_code(333)

八、接口调用

(注意在 url 末尾要加上'/'否则会出现 308 报错,或者在定义 url 时不在末尾加上'/')
api:
- http://0.0.0.0:9999/api/
cms:
- http://0.0.0.0:9999/cms/
其他业务模块:

九、任务

异步任务(celery5.2)(更新时间：2022-07-19)
- 配置文件
  - celeryconfig.py
- 启动celery例子(需要先进入pipenv shell后在执行celery命令)
  - celery_app.py
- 任务例子(新增任务需要再上述celeryconfig.py中引入)
定时任务
- 间隔触发任务
  - interval_test.py
- 周期触发任务
  - cron_test.py
- 日期触发任务
  - date_test.py

十、部署(2022-01-18 更新):

我掘金的一些文章
- 方法1：本机部署：https://juejin.cn/post/6844903870250876935
- 方法2：Docker部署：https://juejin.cn/post/7054460759526342687
- 方法3：执行该项目下的 server_start.sh (推荐)

备注

代码中可能存在大量打印调试代码语句(print('xxxx'))可以将其注释或者删除。
快试试快速实现你业务需求吧！！！嘻嘻！！！

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Flask_BestPractices

Flask 最佳实践

一、安装

二、配置虚拟环境

三、配置文件

四、ORM

五、路由注册

六、钩子函数(拦截器):

七、自定义异常:

八、接口调用

九、任务

十、部署(2022-01-18 更新):

备注

About

Releases 1

Packages

Contributors 3

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 126 Commits
ExtendRegister		ExtendRegister
app		app
common		common
config		config
images		images
logs		logs
tasks		tasks
test		test
.DS_Store		.DS_Store
.gitignore		.gitignore
ApplicationExample.py		ApplicationExample.py
CHANGES.md		CHANGES.md
Dockerfile		Dockerfile
LICENSE		LICENSE
Pipfile		Pipfile
Pipfile.lock		Pipfile.lock
README.md		README.md
README1.0.md		README1.0.md
all_reference.py		all_reference.py
celery_app.py		celery_app.py
run.py		run.py
server_start.sh		server_start.sh
test_run.py		test_run.py
uwsgi_for_docker.ini		uwsgi_for_docker.ini

License

yangyuexiong/Flask_BestPractices

Folders and files

Latest commit

History

Repository files navigation

Flask_BestPractices

Flask 最佳实践

一、安装

二、配置虚拟环境

三、配置文件

四、ORM

五、路由注册

六、钩子函数(拦截器):

七、自定义异常:

八、接口调用

九、任务

十、部署(2022-01-18 更新):

备注

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 1

Packages 0

Contributors 3

Languages

Packages