Python代码规范(Cursor版)

Router层规范

规范

1. 参数统一叫param，示例：param: user_model.UserPageDTO
2. 接口都为Post请求，示例：@router.post
3. 返回示例代码

data = user_service.UserService.page(param)
return http_resp.ResponseSuccess(data)

4. DTO/VO命名规范为：router路径 + 方法名 + DTO/VO，例如UserPageDTO

接口命名示例

Router示例方法名如下，

• page - 分页；pageBy* - 根据某一个条件分页，例如pageByOrg；page* - 分页查询某对象，例如pageOrg
• list - 查询列表，listBy, list 类似page
• get - 获取对象，getBy，get类似page
• save - 保存对方，saveBy，save类似page
• update - 更新对象，updateBy，update类似page
• delete - 删除对象，deleteBy，delete类似page

Application层规范

1. *_service层的实现逻辑分为2步：1）获取数据；2）调用wrapper层方法进行数据组装并返回；
2. 只有service可以调用wrapper
3. Page，代表实体名称，例如orgCampusPage【从数据查询得到page对象】

Wrapper规范

Wrapper方法命名如下

1. entityForSave，供保存对象使用，代表实体名称，例如entityBookForSave
2. entityBatchForSave，供批量保存对象使用，代表实体名称，例如entityBookBatchForSave
3. entityForUpdate，供更新对象使用，代表实体名称，例如entityBookForUpdate
4. entityBatchForUpdate，供批量更新对象使用，代表实体名称，例如entityBookBatchForUpdate
5. entity
6. entity，代表VO的名称，例如 entitySysCategoryPageBookVO()
7. entityPageCondition
8. entityPageWrapper，供组装page查询条件使用
9. Wrapper原则上不再进行方法的拆分

TODO

• 在user_router新增一个保存用户的方法