Django rest_framework實現增刪改查介面
阿新 • • 發佈：2022-05-08
本文使用Django的rest_framework框架的ModelSerializer模組和ListSerializer模組實現單查群查、單刪群刪、單增群增、單改群改介面。
回到頂部寫介面前的知識準備
__all__的使用方法
在預設情況下，如果使用“from 模組名 import *”這樣的語句來匯入模組，程式會匯入該模組中所有不以下畫線開頭的成員（包括變數、函式和類）。但在一些場景中，我們並不希望每個成員都被暴露出來供外界使用，此時可藉助於模組的 __all__ 變數，將變數的值設定成一個列表，只有該列表中的成員才會被暴露出來。
以下劃線_開頭的變數在導包時用“from 模組名 import *”是無法匯入的，可以通過__all__來指定匯入的_變數。
例如，下面程式定義了一個包含 __all__ 變數的模組：
'''測試__all__變數的模組'''
def hello():
print("Hello, Python")
def world():
print("Pyhton World is funny")
def test():
print('--test--')
# 定義__all__變數，指定預設只匯入hello和world兩個成員__all__ = ['hello', 'world']
上面的 __all__ 變數指定該模組預設只被匯入 hello 和 world 兩個成員。下面程式示範了模組中 __all__ 變數的用處：
# 匯入all_module模組內所有成員from all_module import *hello()world()test() # 會提示找不到test()函式
上面第 2 行程式碼使用“from all_module import *”匯入了 all_module 模組下所有的成員。由於該模組包含了 __all__ 變數，因此該語句只匯入 __all__ 變數所列出的成員。
序列化類配置
內嵌類Meta的三個屬性介紹：
fields = ['name', 'address', 'books']或者" __all__"fields可以指定欄位進行序列化、反序列化，以及連表查詢時可以查詢到的欄位。
exclude = ['name']指查詢的時候不包括該欄位。
depth = 1 值代表深度次數，深度查詢指的是當一張表有關聯的表時，在查詢查自己的表時順便將關聯的表的內容也查出來，如果被深度查詢的外來鍵採用__all__，會將所關聯表的所有欄位都查出來。如果將深度值設定為2則將所關聯表的其他關聯的表也查出來，就這樣一層一層深入，已經查過的表就不查了，所以不會出現死迴圈。
class BookModelSerializer(serializers.ModelSerializer):
# 配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
class Meta:
list_serializer_class = BookListSerializer
model = models.Book
fields = ['name', 'price', 'publish', 'authors', 'publish_info', 'author_list']
extra_kwargs = {
'publish': {
'write_only': True
},
'authors': {
'write_only': True
}
}
class PublishModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Publish
fields = ['name', 'address', 'books']
# 瞭解配置
# fields = '__all__'
# exclude = ['name']
# depth = 2 # 自動深度，值代表深度次數，但是被深度的外來鍵採用__all__，顯示所以欄位
Response二次封裝
對rest_framework的Response類進行二次封裝可以按照我們自己的要求去定義response的功能。
from rest_framework.response import Response
class APIResponse(Response):
def __init__(self, status=0, msg='ok', results=None, http_status=None,
headers=None, exception=False, content_type=None, **kwargs):
# 將status、msg、results、kwargs格式化成data
data = {
'status': status,
'msg': msg,
}
# results只要不為空都是資料：False、0、'' 都是資料 => 條件不能寫if results
if results is not None:
data['results'] = results
# 將kwargs中額外的k-v資料新增到data中
data.update(**kwargs)
super().__init__(data=data, status=http_status, headers=headers, exception=exception, content_type=content_type)
連表深度查詢
連表深度查詢的方式有三種：
第一種：子序列化：必須有子序列化類配合，不能反向查詢
第二種：配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
第三種：插拔式@property：名字不能與外來鍵名同名（最常用方式）
下面介紹插拔式：
如果書要連表查詢出版社，首先在書的模板類中定義@property的方法如下：
@property
def publish_info(self): # 單個數據
return {
'name': self.publish.name,
'address': self.publish.address,
}#return出我們需要查詢出來的第二張表的欄位和資料，前提方法名不能和外來鍵欄位名重名
然後在序列化類BookModelSerializer中的meta的fields屬性中新增上面定義的方法名，這樣就可以實現連表查詢。
class BookModelSerializer(serializers.ModelSerializer):
# 外來鍵欄位預設顯示的是外來鍵值(int型別)，不會自己進行深度查詢
# 深度查詢方式：
# 1）子序列化：必須有子序列化類配合，不能反序列化了
# 2）配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
# 3）插拔式@property：名字不能與外來鍵名同名
class Meta:
# ModelSerializer預設配置了ListSerializer輔助類，幫助完成群增群改
# list_serializer_class = serializers.ListSerializer
# 如果只有群增，是不需要自定義配置的，但要完成群改，必須自定義配置
list_serializer_class = BookListSerializer
model = models.Book
fields = ['name', 'price', 'publish', 'authors', 'publish_info', 'author_list']
插拔式還可以在模型類中匯入所連結串列的序列化的資料達到連查的目的如：
@property
def publish_info(self): # 單個數據
from .serializers import PublishModelSerializer
return PublishModelSerializer(self.publish).data
然後在序列化類BookModelSerializer中的meta的fields屬性中新增上面定義的方法名。
回到頂部單查群查介面
class BookAPIView(APIView):
# 單查群查
def get(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk:
book_obj = models.Book.objects.filter(is_delete=False, pk=pk).first()
book_ser = serializers.BookModelSerializer(book_obj)
else:
book_query = models.Book.objects.filter(is_delete=False).all()
book_ser = serializers.BookModelSerializer(book_query, many=True)
return APIResponse(results=book_ser.data)
# return Response(data=book_ser.data)
單刪群刪介面
def delete(self, request, *args, **kwargs):
"""
單刪：介面：/books/(pk)/ 資料：空
群刪：介面：/books/ 資料：[pk1, ..., pkn]
邏輯：修改is_delete欄位，修改成功代表刪除成功，修改失敗代表刪除失敗
"""
pk = kwargs.get('pk')
if pk:
pks = [pk] # 將單刪格式化成群刪一條
else:
pks = request.data # 群刪
try: # 資料如果有誤，資料庫執行會出錯
rows = models.Book.objects.filter(is_delete=False, pk__in=pks).update(is_delete=True)
except:
return APIResponse(1, '資料有誤')
if rows:
return APIResponse(0, '刪除成功')
return APIResponse(1, '刪除失敗')
單增，群增介面
def post(self, request, *args, **kwargs):
"""
單增：介面：/books/ 資料：{...}
群增：介面：/books/ 資料：[{...}, ..., {...}]
邏輯：將資料給系列化類處理，資料的型別關係到 many 屬性是否為True
"""
if isinstance(request.data, dict):
many = False
elif isinstance(request.data, list):
many = True
else:
return Response(data={'detail': '資料有誤'}, status=400)
book_ser = serializers.BookModelSerializer(data=request.data, many=many)
book_ser.is_valid(raise_exception=True)
book_obj_or_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj_or_list, many=many).data)
整體單改群改介面
def put(self, request, *args, **kwargs):
"""
單改：介面：/books/(pk)/ 資料：{...}
群增：介面：/books/ 資料：[{pk, ...}, ..., {pk, ...}]
邏輯：將資料給系列化類處理，資料的型別關係到 many 屬性是否為True
"""
pk = kwargs.get('pk')
if pk: # 單改
try:
# 與增的區別在於，需要明確被修改的物件，交給序列化類
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data)
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
# 分析（重點）：
# 1）資料是列表套字典，每個字典必須帶pk，就是指定要修改的物件，如果有一條沒帶pk，整個資料有誤
# 2）如果pk對應的物件已被刪除，或是對應的物件不存在，可以認為整個資料有誤(建議)，可以認為將這些錯誤資料丟擲即可
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk') # 解決分析1，沒有pk pop方法就會拋異常
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk對應的資料不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True)
book_ser.is_valid(raise_exception=True)
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
區域性修改資料
# 區域性單改群改
def patch(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 單改
try:
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
# 設定partial=True的序列化類，參與反序列化的欄位，都會置為選填欄位
# 1）提供了值得欄位發生修改。
# 2）沒有提供的欄位採用被修改物件原來的值
# 設定context的值，目的：在序列化完成自定義校驗(區域性與全域性鉤子)時，可能需要檢視類中的變數，如請求物件request
# 可以通過context將其傳入，在序列化校驗方法中，self.context就能拿到傳入的檢視類中的變數
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data, partial=True, context={'request': request})
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk')
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk對應的資料不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True, partial=True)
book_ser.is_valid(raise_exception=True)
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
檢視給序列化傳參
def patch(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 單改
try:
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
# 設定partial=True的序列化類，參與反序列化的欄位，都會置為選填欄位
# 1）提供了值得欄位發生修改。
# 2）沒有提供的欄位採用被修改物件原來的值
# 設定context的值，目的：在序列化完成自定義校驗(區域性與全域性鉤子)時，可能需要檢視類中的變數，如請求物件request
# 可以通過context將其傳入，在序列化校驗方法中，self.context就能拿到傳入的檢視類中的變數
book_ser = serializers.BookModelSerializer(instance=book_instance,
data=request.data,
partial=True,
context={'request': request})
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
本文使用Django的rest_framework框架的ModelSerializer模組和ListSerializer模組實現單查群查、單刪群刪、單增群增、單改群改介面。
回到頂部寫介面前的知識準備
__all__的使用方法
在預設情況下，如果使用“from 模組名 import *”這樣的語句來匯入模組，程式會匯入該模組中所有不以下畫線開頭的成員（包括變數、函式和類）。但在一些場景中，我們並不希望每個成員都被暴露出來供外界使用，此時可藉助於模組的 __all__ 變數，將變數的值設定成一個列表，只有該列表中的成員才會被暴露出來。
以下劃線_開頭的變數在導包時用“from 模組名 import *”是無法匯入的，可以通過__all__來指定匯入的_變數。
例如，下面程式定義了一個包含 __all__ 變數的模組：
'''測試__all__變數的模組'''
def hello():
print("Hello, Python")
def world():
print("Pyhton World is funny")
def test():
print('--test--')
# 定義__all__變數，指定預設只匯入hello和world兩個成員__all__ = ['hello', 'world']
上面的 __all__ 變數指定該模組預設只被匯入 hello 和 world 兩個成員。下面程式示範了模組中 __all__ 變數的用處：
# 匯入all_module模組內所有成員from all_module import *hello()world()test() # 會提示找不到test()函式
上面第 2 行程式碼使用“from all_module import *”匯入了 all_module 模組下所有的成員。由於該模組包含了 __all__ 變數，因此該語句只匯入 __all__ 變數所列出的成員。
序列化類配置
內嵌類Meta的三個屬性介紹：
fields = ['name', 'address', 'books']或者" __all__"fields可以指定欄位進行序列化、反序列化，以及連表查詢時可以查詢到的欄位。
exclude = ['name']指查詢的時候不包括該欄位。
depth = 1 值代表深度次數，深度查詢指的是當一張表有關聯的表時，在查詢查自己的表時順便將關聯的表的內容也查出來，如果被深度查詢的外來鍵採用__all__，會將所關聯表的所有欄位都查出來。如果將深度值設定為2則將所關聯表的其他關聯的表也查出來，就這樣一層一層深入，已經查過的表就不查了，所以不會出現死迴圈。
class BookModelSerializer(serializers.ModelSerializer):
# 配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
class Meta:
list_serializer_class = BookListSerializer
model = models.Book
fields = ['name', 'price', 'publish', 'authors', 'publish_info', 'author_list']
extra_kwargs = {
'publish': {
'write_only': True
},
'authors': {
'write_only': True
}
}
class PublishModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Publish
fields = ['name', 'address', 'books']
# 瞭解配置
# fields = '__all__'
# exclude = ['name']
# depth = 2 # 自動深度，值代表深度次數，但是被深度的外來鍵採用__all__，顯示所以欄位
Response二次封裝
對rest_framework的Response類進行二次封裝可以按照我們自己的要求去定義response的功能。
from rest_framework.response import Response
class APIResponse(Response):
def __init__(self, status=0, msg='ok', results=None, http_status=None,
headers=None, exception=False, content_type=None, **kwargs):
# 將status、msg、results、kwargs格式化成data
data = {
'status': status,
'msg': msg,
}
# results只要不為空都是資料：False、0、'' 都是資料 => 條件不能寫if results
if results is not None:
data['results'] = results
# 將kwargs中額外的k-v資料新增到data中
data.update(**kwargs)
super().__init__(data=data, status=http_status, headers=headers, exception=exception, content_type=content_type)
連表深度查詢
連表深度查詢的方式有三種：
第一種：子序列化：必須有子序列化類配合，不能反向查詢
第二種：配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
第三種：插拔式@property：名字不能與外來鍵名同名（最常用方式）
下面介紹插拔式：
如果書要連表查詢出版社，首先在書的模板類中定義@property的方法如下：
@property
def publish_info(self): # 單個數據
return {
'name': self.publish.name,
'address': self.publish.address,
}#return出我們需要查詢出來的第二張表的欄位和資料，前提方法名不能和外來鍵欄位名重名
然後在序列化類BookModelSerializer中的meta的fields屬性中新增上面定義的方法名，這樣就可以實現連表查詢。
class BookModelSerializer(serializers.ModelSerializer):
# 外來鍵欄位預設顯示的是外來鍵值(int型別)，不會自己進行深度查詢
# 深度查詢方式：
# 1）子序列化：必須有子序列化類配合，不能反序列化了
# 2）配置depth：自動深度查詢的是關聯表的所有欄位，資料量太多
# 3）插拔式@property：名字不能與外來鍵名同名
class Meta:
# ModelSerializer預設配置了ListSerializer輔助類，幫助完成群增群改
# list_serializer_class = serializers.ListSerializer
# 如果只有群增，是不需要自定義配置的，但要完成群改，必須自定義配置
list_serializer_class = BookListSerializer
model = models.Book
fields = ['name', 'price', 'publish', 'authors', 'publish_info', 'author_list']
插拔式還可以在模型類中匯入所連結串列的序列化的資料達到連查的目的如：
@property
def publish_info(self): # 單個數據
from .serializers import PublishModelSerializer
return PublishModelSerializer(self.publish).data
然後在序列化類BookModelSerializer中的meta的fields屬性中新增上面定義的方法名。
回到頂部單查群查介面
class BookAPIView(APIView):
# 單查群查
def get(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk:
book_obj = models.Book.objects.filter(is_delete=False, pk=pk).first()
book_ser = serializers.BookModelSerializer(book_obj)
else:
book_query = models.Book.objects.filter(is_delete=False).all()
book_ser = serializers.BookModelSerializer(book_query, many=True)
return APIResponse(results=book_ser.data)
# return Response(data=book_ser.data)
單刪群刪介面
def delete(self, request, *args, **kwargs):
"""
單刪：介面：/books/(pk)/ 資料：空
群刪：介面：/books/ 資料：[pk1, ..., pkn]
邏輯：修改is_delete欄位，修改成功代表刪除成功，修改失敗代表刪除失敗
"""
pk = kwargs.get('pk')
if pk:
pks = [pk] # 將單刪格式化成群刪一條
else:
pks = request.data # 群刪
try: # 資料如果有誤，資料庫執行會出錯
rows = models.Book.objects.filter(is_delete=False, pk__in=pks).update(is_delete=True)
except:
return APIResponse(1, '資料有誤')
if rows:
return APIResponse(0, '刪除成功')
return APIResponse(1, '刪除失敗')
單增，群增介面
def post(self, request, *args, **kwargs):
"""
單增：介面：/books/ 資料：{...}
群增：介面：/books/ 資料：[{...}, ..., {...}]
邏輯：將資料給系列化類處理，資料的型別關係到 many 屬性是否為True
"""
if isinstance(request.data, dict):
many = False
elif isinstance(request.data, list):
many = True
else:
return Response(data={'detail': '資料有誤'}, status=400)
book_ser = serializers.BookModelSerializer(data=request.data, many=many)
book_ser.is_valid(raise_exception=True)
book_obj_or_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj_or_list, many=many).data)
整體單改群改介面
def put(self, request, *args, **kwargs):
"""
單改：介面：/books/(pk)/ 資料：{...}
群增：介面：/books/ 資料：[{pk, ...}, ..., {pk, ...}]
邏輯：將資料給系列化類處理，資料的型別關係到 many 屬性是否為True
"""
pk = kwargs.get('pk')
if pk: # 單改
try:
# 與增的區別在於，需要明確被修改的物件，交給序列化類
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data)
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
# 分析（重點）：
# 1）資料是列表套字典，每個字典必須帶pk，就是指定要修改的物件，如果有一條沒帶pk，整個資料有誤
# 2）如果pk對應的物件已被刪除，或是對應的物件不存在，可以認為整個資料有誤(建議)，可以認為將這些錯誤資料丟擲即可
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk') # 解決分析1，沒有pk pop方法就會拋異常
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk對應的資料不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True)
book_ser.is_valid(raise_exception=True)
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
區域性修改資料
# 區域性單改群改
def patch(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 單改
try:
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
# 設定partial=True的序列化類，參與反序列化的欄位，都會置為選填欄位
# 1）提供了值得欄位發生修改。
# 2）沒有提供的欄位採用被修改物件原來的值
# 設定context的值，目的：在序列化完成自定義校驗(區域性與全域性鉤子)時，可能需要檢視類中的變數，如請求物件request
# 可以通過context將其傳入，在序列化校驗方法中，self.context就能拿到傳入的檢視類中的變數
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data, partial=True, context={'request': request})
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk')
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk對應的資料不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True, partial=True)
book_ser.is_valid(raise_exception=True)
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
檢視給序列化傳參
def patch(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 單改
try:
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
# 設定partial=True的序列化類，參與反序列化的欄位，都會置為選填欄位
# 1）提供了值得欄位發生修改。
# 2）沒有提供的欄位採用被修改物件原來的值
# 設定context的值，目的：在序列化完成自定義校驗(區域性與全域性鉤子)時，可能需要檢視類中的變數，如請求物件request
# 可以通過context將其傳入，在序列化校驗方法中，self.context就能拿到傳入的檢視類中的變數
book_ser = serializers.BookModelSerializer(instance=book_instance,
data=request.data,
partial=True,
context={'request': request})
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)