小編寫這篇文章的主要目的，就是給大家進(jìn)行介紹在python中，使用Django的restframework接口處的框架進(jìn)行自定義返回?cái)?shù)據(jù)，并給大家貼出了具體代碼，大家可以進(jìn)行仔細(xì)的閱讀。

　　就目前來(lái)看，前后端分離是一個(gè)比較大的趨勢(shì)，前端獲取數(shù)據(jù)的方式，主要是通過(guò)調(diào)用接口的形式，來(lái)獲取到后端的應(yīng)用服務(wù)。Django是Python進(jìn)行web應(yīng)用開(kāi)發(fā)常用的web框架，用Django框架進(jìn)行web應(yīng)用框架減少了很多工作，使用較少的代碼，就能完成很大的一個(gè)工作量。

　　同樣用Django的restframework的相關(guān)框架，向外部，幾行代碼就可以將數(shù)據(jù)對(duì)象通過(guò)接口的方式提供服務(wù)。因?yàn)樵趯?shí)際開(kāi)發(fā)過(guò)程中接口的返回?cái)?shù)據(jù)有一定的格式，本文介紹通過(guò)自定義Response返回對(duì)象來(lái)自定義接口返回?cái)?shù)據(jù)格式。

　　以下示例將數(shù)據(jù)對(duì)象Friend通過(guò)restframework框架進(jìn)行接口發(fā)布。

　　只要定義Friend數(shù)據(jù)對(duì)象

　　classFriend(BaseModel):
　　id=models.AutoField(primary_key=True)
　　siteName=models.CharField(max_length=20,verbose_name='友鏈站點(diǎn)名稱')
　　path=models.CharField(max_length=100,verbose_name='地址路徑')
　　desc=models.CharField(max_length=200,verbose_name='描述')
　　def__str__(self):
　　returnself.siteName
　　classMeta:
　　verbose_name='友鏈'
　　verbose_name_plural='友鏈'

　　定義一個(gè)序列化類將返回的字段序列化

　classFriendModelSerializer(serializers.ModelSerializer):
　　classMeta:
　　model=Friend
　　fields="__all__"

　　定義一個(gè)接口視圖類獲取數(shù)據(jù)

　classFriendView(viewsets.ModelViewSet):
　　queryset=Friend.objects.all()
　　serializer_class=FriendModelSerializer

　　定義接口路由就可以通過(guò)httprestfull的接口進(jìn)行訪問(wèn)了

　friend_list=views.FriendView.as_view({'get':'list',})
　　urlpatterns=[
　　path('friend/',friend_list),
　　]

　　接口訪問(wèn)效果如下：

　　http://localhost:8000/api/friend/

　　但是在項(xiàng)目中經(jīng)常會(huì)碰到接口格式變化的情況，restframework框架默認(rèn)的返回?cái)?shù)據(jù)格式不滿足應(yīng)用的需求。比如一般的接口都會(huì)有接口返回的code、msg、data，code用來(lái)標(biāo)識(shí)接口返回代碼比如200是正常，msg用來(lái)記錄異常或其信息，data用來(lái)返回具體的數(shù)據(jù)。

　　通過(guò)restframework接口自定義返回?cái)?shù)據(jù)格式也是很簡(jiǎn)單方便的。

　　先自定義Response返回對(duì)象，在返回對(duì)象中自定義數(shù)據(jù)返回的格式，示例代碼如下：

　　fromrest_framework.responseimportResponse
　　fromrest_framework.serializersimportSerializer
　　classCustomResponse(Response):
　　def__init__(self,data=None,code=None,msg=None,
　　status=None,
　　template_name=None,headers=None,
　　exception=False,content_type=None,**kwargs):
　　super().__init__(None,status=status)
　　ifisinstance(data,Serializer):
　　msg=(
　　'YoupassedaSerializerinstanceasdata,but'
　　'probablymeanttopassserialized`.data`or'
　　'`.error`.representation.'
　　)
　　raiseAssertionError(msg)
　　#自定義返回格式
　　self.data={'code':code,'msg':msg,'data':data}
　　self.data.update(kwargs)
　　self.template_name=template_name
　　self.exception=exception
　　self.content_type=content_type
　　ifheaders:
　　forname,valueinheaders.items():
　　self[name]=value
　　在接口接口視圖類獲取數(shù)據(jù)返回時(shí)，使用該自定義的Response返回對(duì)象。
　　classFriendView(viewsets.ModelViewSet):
　　queryset=Friend.objects.all()
　　serializer_class=FriendModelSerializer
　　#自定義list方法，自定義Response返回
　　deflist(self,request,*args,**kwargs):
　　queryset=self.filter_queryset(self.get_queryset())
　　serializer=self.get_serializer(queryset,many=True)
　　returnCustomResponse(data=serializer.data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口訪問(wèn)效果如下：

　　可以看到返回?cái)?shù)據(jù)格式中增加了code,msg數(shù)據(jù)放到了data節(jié)點(diǎn)

　　列表數(shù)據(jù)通常接口要提供翻頁(yè)功能，在接口中要有總頁(yè)數(shù)、當(dāng)前頁(yè)、是否有下一頁(yè)的信息。

　　可以自定義一個(gè)分頁(yè)器，在分頁(yè)器中自定義需要返回的分頁(yè)參數(shù)

　　參考示例代碼如下：

　　fromrest_frameworkimportstatus
　　fromrest_framework.paginationimportPageNumberPagination
　　fromcommon.customresponseimportCustomResponse
　　classMyPage(PageNumberPagination):
　　page_size=8#每頁(yè)顯示數(shù)量
　　max_page_size=50#每頁(yè)最大顯示數(shù)量。
　　page_size_query_param='size'#每頁(yè)數(shù)量的參數(shù)名稱
　　page_query_param='page'#頁(yè)碼的參數(shù)名稱
　　defget_paginated_response(self,data):
　　#自定義分頁(yè)器的返回參數(shù)
　　returnCustomResponse(data=data,code=200,msg="OK",status=status.HTTP_200_OK,count=self.page.paginator.count,next=self.get_next_link(),previous=self.get_previous_link(),size=self.page_size,page=self.page.number)

　　在接口接口視圖類獲取數(shù)據(jù)返回時(shí)，如果有分頁(yè)器則使用該分頁(yè)器自定義的Response返回對(duì)象。

　　classFriendView(viewsets.ModelViewSet):

　　queryset=Friend.objects.all()

　　serializer_class=FriendModelSerializer

　　pagination_class=MyPage

　　#自定義list方法，自定義Response返回

　　deflist(self,request,*args,**kwargs):

　　queryset=self.filter_queryset(self.get_queryset())

　　page=self.paginate_queryset(queryset)

　　#如果有分頁(yè)器，則進(jìn)行分頁(yè)后返回

　　ifpageisnotNone:

　　serializer=self.get_serializer(page,many=True)

　　returnself.get_paginated_response(serializer.data)

　　serializer=self.get_serializer(queryset,many=True)

　　returnCustomResponse(data=serializer.data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口訪問(wèn)效果如下：

　　可以看到接口中自定義增加了分頁(yè)信息。

　　但是有時(shí)候可能希望分頁(yè)的信息數(shù)據(jù)要放在data節(jié)點(diǎn)里面，這樣也是可以做到的。

　fromrest_frameworkimportstatus
　　fromrest_framework.paginationimportPageNumberPagination
　　fromcommon.customresponseimportCustomResponse
　　classMyPage(PageNumberPagination):
　　page_size=8#每頁(yè)顯示數(shù)量
　　max_page_size=50#每頁(yè)最大顯示數(shù)量。
　　page_size_query_param='size'#每頁(yè)數(shù)量的參數(shù)名稱
　　page_query_param='page'#頁(yè)碼的參數(shù)名稱
　　#自定義分頁(yè)器的返回參數(shù)
　　defget_paginated_response(self,data):
　　ret_data=dict()
　　ret_data['items']=data
　　#加入自定義分頁(yè)信息
　　ret_data['total']=self.page.paginator.count
　　ret_data['hasNextPage']=self.get_next_link()
　　ret_data['size']=self.page_size
　　ret_data['page']=self.page.number
　　returnCustomResponse(data=ret_data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口訪問(wèn)效果如下：

　　可以看到接口中自定義增加了分頁(yè)信息，分頁(yè)的信息數(shù)據(jù)放在data節(jié)點(diǎn)里面了

　　至此，本文介紹了通過(guò)Django的restframework接口框架自定義Response返回對(duì)象來(lái)自定義返回?cái)?shù)據(jù)格式。Django的restframework接口框架使用簡(jiǎn)單方便，拿來(lái)即用，能夠很大程度上減少代碼開(kāi)發(fā)量。