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.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中看到新增加的接口,如下图所示,通过该页面还可以对接口进行测试。
网友评论