docker+django+vue实例开发之二:后端api实现(二)

2)实现业务逻辑层和接口层
业务逻辑层用于实现功能模块涉及的业务逻辑,对于信息管理系统而言,大多是数据处理逻辑;接口层则更为直观,包括解析请求request的参数、通过业务逻辑层构造返回数据、将返回数据封装成response响应并返回。如果一个系统很复杂,业务规则需要重用,就需要应用设计模式将业务逻辑封装成可复用的类,对于功能简单的信息管理系统,业务逻辑层往往可以和接口层混在一起,都写在view.py文件中,如果内容较多,也可以创建不同名称的源码文件来编写。本项目业务逻辑就相对简单,因而并未区分业务逻辑层和接口层。
django rest framework提供了两种接口的定义方式,一种是function based view,另一种是class based view,二者区别可参见django rest framework文档。为了简单,本项目采用的是function based view的形式来定义接口,仅需在接口名称前面加上修饰符@api_view即可,以下代码实现了一个增、删、改、查单条数据接口:
from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework import status
@api_view(['GET', 'POST', 'DELETE', 'PUT'])
def manageStandard(request, id):
"""
功能:管理考核标准信息。
url参数和请求方法:id为记录标识;POST方法添加记录,id=0;GET方法获取记录详情,DELETE方法删除记录, PUT方法修改记录。
请求参数:考核标准表各数据项。
"""
####鉴权
auth = request.auth
if not auth:
return Response(status=status.HTTP_401_UNAUTHORIZED)
if auth.id != 1:
return Response(status=status.HTTP_401_UNAUTHORIZED)
id = int(id)
if id == 0: ####新增一条记录
if request.method != 'POST':
return Response(FailResponse('请求参数不正确'))
data = request.data.copy()
ser = StandardSerializer(data=data)
if ser.is_valid():
ser.save()
return Response(SuccessResponse(ser.data))
else:
return Response(FailResponse(ser.errors))
else:
try:
record = Standard.objects.get(id=id)
except Standard.DoesNotExist:
return Response(FailResponse('数据不存在'))
if request.method == 'GET': ####根据id读取一条记录内容
ser = StandardSerializer(record)
return Response(SuccessResponse(ser.data))
elif request.method == 'DELETE': ####根据id删除一条记录
ser = StandardSerializer(record)
if ser.data['score_count'] > 0:
return Response(FailResponse('存在评分细则,不能删除'))
try:
record.delete()
except Exception as err:
return Response(FailResponse(err.str()))
return Response(SuccessResponse({}))
elif request.method == 'PUT': ####根据id修改一条记录(可部分修改)
data = request.data.copy()
ser = StandardSerializer(record, data=data, partial=True)
if ser.is_valid():
ser.save()
return Response(SuccessResponse(ser.data))
else:
return Response(FailResponse(ser.errors))
else:
return Response(FailResponse('请求参数不正确'))
上面代码实例的业务逻辑很直接,就是对单条数据进行操作,而且其参数是直接将请求参数copy了一份,因为已经有serializer去检验参数的有效性了,接口中调用is_valid()方法即可,代码逻辑相对清晰很多,返回数据构造了Response这一json类型的响应对象,并且使用了以下预先定义的全局函数SuccessResponse和FailResponse,确保所有接口响应数据的一致性。
def SuccessResponse(data):
return {
"code": 1000,
"data": data
}

def FailResponse(msg):
return {
"code": 2000,
"msg" : msg
}
类似的,可以实现分页查询接口,代码示例如下所示:
@api_view(['POST'])
def queryStandard(request):
"""
功能:分页查询考核标准信息。
请求参数:count_per_page,每页记录数;page_number,当前页数;item_id,按考核项目筛选;to_sexy,按性别筛选;to_age_min,to_age_max,按年龄段筛选。
"""
####鉴权
auth = request.auth
if not auth:
return Response(status=status.HTTP_401_UNAUTHORIZED)
####获取参数
count_per_page = request.data.get('count_per_page', None)
page_number = request.data.get('page_number', 1)
item_id = request.data.get('item_id', None)
to_sexy = request.data.get('to_sexy', None)
to_age_min = request.data.get('to_age_min', None)
to_age_max = request.data.get('to_age_max', None)
####查询数据
rows = Standard.objects.all()
count = rows.count()
if item_id:
rows = rows.filter(item_id=int(item_id))
count = rows.count()
if to_sexy:
rows = rows.filter(to_sexy=to_sexy)
count = rows.count()
if to_age_min:
rows = rows.filter(to_age_max__gte=int(to_age_min))
count = rows.count()
if to_age_max:
rows = rows.filter(to_age_min__lte=int(to_age_max))
count = rows.count()
if count <= 0:
return Response(SuccessResponse({}))
####分页
if not count_per_page:
count_per_page = count
count_per_page = int(count_per_page)
page_number = int(page_number)
if count_per_page * (page_number - 1) >= count:
return Response(FailResponse("页数超过上限"))
start = count_per_page * (page_number - 1)
end = count_per_page * page_number
if count_per_page * page_number > count:
end = count
rows = rows[start:end]
####返回数据
standards = StandardSerializer(rows, many=True)
return Response(SuccessResponse({
'standards': standards.data,
'total': count
}))
上面查询接口里有了从request对象中获取查询参数的过程,由于并非要求传入所有参数,在查询数据时采用了if结构逐个参数筛选数据。对于分页功能,事实上在django rest framework也提供了相应组件,这里方便起见是自己实现的,而且这部分在实际项目中也是写成全局函数统一调用的。
上面两个接口实现已后,还需要编制相应的url路由,可以在功能模块根目录下创建urls.py文件来编写路由代码,上面两个接口的路由代码示例如下:
from django.conf.urls import url
from . import views
urlpatterns = [
……
url(r'^standard/(?P<id>[0-9]+)/', views.manageStandard), url(r'^standards/', views.queryStandard),
……
]
可以看出,url参数id使用了正则表达式来固化其传入形式。相应的,在工程总的urls.py文件中也要添加相应路由
urlpatterns = [
url(r'^docs/', include('rest_framework_docs.urls')), ####文档化url
url(r'^StandardModule/', include('StandardModule.urls')),
……
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
运行工程后,就可以在本地localhost:8000/docs中看到新增加的接口,如下图所示,通过该页面还可以对接口进行测试。

api2.PNG

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容