Django視圖是用來處理請求和響應的,Django默認是按Form和Template來設計的,若是要處理以JSON格式爲主的RESTful API,那麼就須要對Django請求和響應的處理代碼進行優化改造,本文就來介紹DRF在這一部分的技術升級。python
DRF把Django的HttpRequest
擴展成了Request
:django
其中最核心的屬性是request.data
,它和request.POST
的區別以下:json
request.POST # 只處理表單(Form)數據,只支持POST方法 request.data # 處理任何數據,支持POST、PUT、PATCH方法
DRF的Response
繼承自Django的django.template.response.SimpleTemplateResponse
:api
Response
能夠根據客戶端的請求render合適的content type:瀏覽器
return Response(data)
我摘取了rendered_content()
函數的代碼:iview
@property def rendered_content(self): renderer = getattr(self, 'accepted_renderer', None) accepted_media_type = getattr(self, 'accepted_media_type', None) context = getattr(self, 'renderer_context', None) assert renderer, ".accepted_renderer not set on Response" assert accepted_media_type, ".accepted_media_type not set on Response" assert context is not None, ".renderer_context not set on Response" context['response'] = self media_type = renderer.media_type charset = renderer.charset content_type = self.content_type if content_type is None and charset is not None: content_type = "{}; charset={}".format(media_type, charset) elif content_type is None: content_type = media_type self['Content-Type'] = content_type ret = renderer.render(self.data, accepted_media_type, context) if isinstance(ret, str): assert charset, ( 'renderer returned unicode, and did not specify ' 'a charset value.' ) return ret.encode(charset) if not ret: del self['Content-Type'] return ret
若是在代碼中直接寫數字形式的狀態碼如400
,是不容易閱讀的,因而DRF提供了標識符如HTTP_400_BAD_REQUEST
來替代。我列一些常見的狀態碼標識符:函數
HTTP_200_OK = 200 HTTP_201_CREATED = 201 HTTP_204_NO_CONTENT = 204 HTTP_400_BAD_REQUEST = 400 HTTP_401_UNAUTHORIZED = 401 HTTP_403_FORBIDDEN = 403 HTTP_404_NOT_FOUND = 404 HTTP_405_METHOD_NOT_ALLOWED = 405 HTTP_500_INTERNAL_SERVER_ERROR = 500 HTTP_502_BAD_GATEWAY = 502 HTTP_503_SERVICE_UNAVAILABLE = 503 HTTP_504_GATEWAY_TIMEOUT = 504
所有的狀態碼標識符能夠在rest_framework.status
模塊中看到。工具
DRF對API視圖作了2個封裝:學習
@api_view
用於函數視圖。APIView
用於類視圖。它們提供了一些新功能,好比:測試
Request
對象Response
對象405 Method Not Allowed
request.data
格式有誤時,拋出ParseError
異常接着就用上面這幾個新實現對咱們以前寫的snippets/views.py
進行改造:
from rest_framework import status from rest_framework.decorators import api_view from rest_framework.response import Response from snippets.models import Snippet from snippets.serializers import SnippetSerializer @api_view(['GET', 'POST']) def snippet_list(request): """ List all code snippets, or create a new snippet. """ if request.method == 'GET': snippets = Snippet.objects.all() serializer = SnippetSerializer(snippets, many=True) return Response(serializer.data) elif request.method == 'POST': serializer = SnippetSerializer(data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) @api_view(['GET', 'PUT', 'DELETE']) def snippet_detail(request, pk): """ Retrieve, update or delete a code snippet. """ try: snippet = Snippet.objects.get(pk=pk) except Snippet.DoesNotExist: return Response(status=status.HTTP_404_NOT_FOUND) if request.method == 'GET': serializer = SnippetSerializer(snippet) return Response(serializer.data) elif request.method == 'PUT': serializer = SnippetSerializer(snippet, data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) elif request.method == 'DELETE': snippet.delete() return Response(status=status.HTTP_204_NO_CONTENT)
改動點有這些,添加了@api_view
,如:
@api_view(['GET', 'POST'])
使用了狀態碼標識符,如:
status.HTTP_404_NOT_FOUND
使用request.data
替代了 data = JSONParser().parse(request)
,如:
serializer = SnippetSerializer(data=request.data)
使用Response()
替代了JsonResponse()
,如:
return Response(serializer.data, status=status.HTTP_201_CREATED)
request.data
和Response()
能根據請求的JSON自動處理content type。
既然DRF能自動處理content type,那麼也能夠給URL指定具體的後綴格式,好比http://example.com/api/items/4.json
。具體添加步驟是,先給view增長1個可選參數format
:
def snippet_list(request, format=None):
def snippet_detail(request, pk, format=None):
再更新snippets/urls.py
,添加format_suffix_patterns
:
from django.urls import path from rest_framework.urlpatterns import format_suffix_patterns from snippets import views urlpatterns = [ path('snippets/', views.snippet_list), path('snippets/<int:pk>', views.snippet_detail), ] urlpatterns = format_suffix_patterns(urlpatterns)
這並非必須的,實際上也無需這麼作。
http http://127.0.0.1:8000/snippets/ HTTP/1.1 200 OK ... [ { "id": 1, "title": "", "code": "foo = \"bar\"\n", "linenos": false, "language": "python", "style": "friendly" }, { "id": 2, "title": "", "code": "print(\"hello, world\")\n", "linenos": false, "language": "python", "style": "friendly" } ]
跟以前的結果同樣。再分別用form和json試試:
# POST using form data http --form POST http://127.0.0.1:8000/snippets/ code="print(123)" { "id": 3, "title": "", "code": "print(123)", "linenos": false, "language": "python", "style": "friendly" } # POST using JSON http --json POST http://127.0.0.1:8000/snippets/ code="print(456)" { "id": 4, "title": "", "code": "print(456)", "linenos": false, "language": "python", "style": "friendly" }
DRF提供了可視化的API HTML文檔,把API URL在瀏覽器中打開便可看到:
最近測試開發和業務測試的話題頻頻出如今TesterHome論壇上,討論激烈,我以爲從公司的角度來講,只會關注員工的產出有沒有給公司帶來價值,不管技術多厲害,不能創造價值終究是會優先被裁的。從我的的角度來講,只會業務測試的出路確定是會愈來愈窄的,努力提升技術,輔助業務測試,同時提高效率,纔是更好的發展方向。千萬要謹慎選擇只作純測試工具,要依託於業務,讓技術落地,在業務中發揮技術的價值,產生從業務到技術,從技術到業務的良好循環。固然,會技術是個大前提,對技術的學習不能停,好比Django REST framework。
參考資料:
https://www.django-rest-framework.org/tutorial/2-requests-and-responses/