python版若依框架开发：后端开发规范

python版若依框架开发

从0起步，扬帆起航。

1. python版若依部署
2. 代码生成指南，迅速落地CURD！
3. 项目结构解析
4. 前端开发规范
5. 后端开发规范

---

---

1.启动命令

本项⽬⾃定义了两个启动命令

pyhton app.py --env=dev

python app.py --env=prod

这两个启动命令的作⽤在于根据指定的 env 参数来加载对应的配置⽂件， 指定 --env=dev 会加载 . env.dev 配置⽂件， 指定 --env=prod 会加载 .env.prod 配置⽂件。

2.配置⽂件

.env.dev

# -------- 应⽤配置  --------
# 应⽤运⾏环境
APP_ENV = 'dev'
# 应⽤名称
APP_NAME = 'RuoYi-FastAPI'
# 应⽤代理路径
APP_ROOT_PATH = '/dev-api'

.env.prod

# -------- 应⽤配置  --------
# 应⽤运⾏环境
APP_ENV = 'prod'
# 应⽤名称
APP_NAME = 'RuoYi-FastAPI'
# 应⽤代理路径
APP_ROOT_PATH = '/prod-api'

配置⽂件中的⼤多数字段都是顾名思义，不再赘述，下⾯对部分字段进⾏详细说明
APP_IP_LOCATION_QUERY ：这个字段⽤于配置应⽤是否记录请求的IP归属区域， 由于查询IP归属区 域需要调⽤外部接⼝ ， 当应⽤部署在内⽹环境时， ⽆法调⽤外部接⼝ ， 建议设置此字段为 false 。
APP_SAME_TIME_LOGIN ：这个字段⽤于配置应⽤同—账户是否可以同时登录， 如果设置
为 false ， 对于同—个账户， 当后⾯的⽤户登录时， 前⾯的⽤户将会被强制下线。
JWT_SECRET_KEY ：这个字段可在控制台通过 openssl rand -hex 32 ⽣成， 部署应⽤时请修 改。
JWT_EXPIRE_MINUTES ：这个字段表示 Jwt 令牌本身的过期时间， 当 Jwt 令牌本身过期时， ⽆ 论 redis 中的 Jwt 令牌是否过期， ⽤户都会下线。
JWT_REDIS_EXPIRE_MINUTES ：这个字段表示 redis 中Jwt令牌过期时间， 当⽤户在这个过期时 间内没有任何应⽤操作时， redis中Jwt令牌将会过期， ⽤户将会下线， 如果⽤户有应⽤操作， 将会⾃动 刷新这个过期时间。

3.上传配置

 class UploadSettings:
"""
上传配置
"""
UPLOAD_PREFIX = '/profile'
UPLOAD_PATH = 'vf_admin/upload_path'
UPLOAD_MACHINE = 'A'
DEFAULT_ALLOWED_EXTENSION = [
# 图⽚
'bmp',
'gif',
'jpg',
'jpeg',
'png',
# word excel powerpoint
'doc',
'docx',
'xls',
'xlsx',
'ppt',
'pptx',
'html',
'htm',
'txt',
# 压缩⽂件
'rar',
'zip',
'gz',
'bz2',
# 视频格式
'mp4',
'avi',
'rmvb',
# pdf
'pdf',
]
DOWNLOAD_PATH = 'vf_admin/download_path'

UPLOAD_PREFIX  ：静态⽂件挂载到主应⽤的前缀 。例如本系统所有静态⽂件都可以通过http:127.

0.0.1/9099/profile/xxx 或者通过代理访问。
UPLOAD_PATH ：保存上传⽂件的⽬录。
UPLOAD_MACHINE ：上传⽂件的识别码， ⽤于上传⽂件名称的⽣成和上传⽂件下载的前置校验。

DEFAULT_ALLOWED_EXTENSION  ：上传⽂件允许的⽂件后缀。
DOWNLOAD_PATH  ：下载⽂件⽬录， ⼿动放置⽂件供前端下载。