Django 路飞学成书写规范的总结

阅读目录

1. 路飞学成书写规范的总结
   • 命名
   • 路由
   • 类和方法的注释
   • 特殊的异常需要捕获
   • 不用admin就直接注释。
   • 模块导入
   • 取一条用get
   • 简单逻辑先往上放
   • 封装数据对象
   • 接口如何编写
   • 事务
   • 减少代码层级

 

---

回到顶部

路飞学成书写规范的总结

命名

项目/文件/函数 -> 小写+下划线

类 驼峰式

 

路由

将每个功能的路由进行分割,

或者做上注释

 

类和方法的注释

每个类都要注释是干什么的

每个方法也要进行注释标明处理逻辑

 

特殊的异常需要捕获

user=models.UserInfo.objects.get(username=username,password=pwd)
from django.core.exceptions import ObjectDoesNotExist
#获取值异常
except ObjectDoesNotExist as e:
      ret.code=1003
      ret.error = '用户名或者密码错误'

except IndexError as e :
#获取索引异常
username=request.data.get('username')
            pass

 

不用admin就直接注释。

因为在Django启动的时候会加载admin

 

模块导入

• 先放置内置模块,再放自己写的模块进行区分
• 短的往上放

import uuid
from rest_framework.views import APIView
from rest_framework.response import Response
from django.core.exceptions import ObjectDoesNotExist

from api import models
from utils.response import BaseResponse

 

取一条用get

取单挑数据尽量用get

 

简单逻辑先往上放

简单的逻辑往上放,

复杂的逻辑往下放

 

封装数据对象

在路飞学成里封装响应对象

延伸出来的是,传输数据尽量用类进行封装

 

接口如何编写

业务:

返回所有 http://127.0.0.1:8000/api/v2/course/1/

多个接口 http://127.0.0.1:8000/api/v2/course/1/

　　　　http://127.0.0.1:8000/api/v2/section/?course=1

　　　　http://127.0.0.1:8000/api/v2/chapter/?course=1

根据业务逻辑和上司的要求,在api返回接口的时候,可以全部返回

也可以一个model一个model的返回

 

事务

在操数据库的时候,可能需要对两张表以上的数据进行修改(有关联)

例如 文章评论数,和评论内容那么需要用事务在解决

 

减少代码层级

增加代码的可读性