ModelViewSet+ModelSerializer使用

老王同學_?發表於2020-12-14
View

1.DRF初始化

  • DRF框架的8個核心功能

1.認證（使用者登入校驗使用者名稱密碼或者token是否合法）
2.許可權（根據不同的使用者角色，可以操作不同的表）
3.限流（限制介面訪問速度）
4.序列化（返回json）
5.分頁
6.版本（介面版本號，用 v1/v2/v3）
    # api.example.com/v1/login     # 只有使用者名稱密碼登入
    # api.example.com/v2/login     # 手機號，微信 登入
7.過濾（username=zhangsan）
8.排序（ordering=-id）

  • 相關包

'''1.序列化相關'''
serializer
ModelSerializer
'''2.DRF檢視函式繼承'''
APIView
ModelViewSet

1.1 安裝DjangoRestFramework

pip install djangorestframework==3.11.1
pip install django-filter==2.3.0             # 過濾器
pip install markdown                         # Markdown support for the browsable API.

1.2 在settings.py中註冊 

INSTALLED_APPS = [
    'django_filters',
    'rest_framework',
]

1.3 settings.py配置DRF（全域性）

ModelViewSet+ModelSerializer使用 
REST_FRAMEWORK = {
    # 文件報錯： AttributeError: ‘AutoSchema’ object has no attribute ‘get_link’
    # 用下面的設定可以解決
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
    # 預設設定是:
    # 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.openapi.AutoSchema',

    # 異常處理器
    # 'EXCEPTION_HANDLER': 'user.utils.exception_handler',

    # Base API policies
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser'
    ],
    # 1.認證器（全域性）：使用者登入校驗使用者名稱密碼或者token是否合法
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_jwt.authentication.JSONWebTokenAuthentication',    # 在DRF中配置JWT認證
        # 'rest_framework.authentication.SessionAuthentication',  # 使用session時的認證器
        # 'rest_framework.authentication.BasicAuthentication'     # 提交表單時的認證器
    ],
    #2.許可權配置（全域性）： 順序靠上的嚴格（根據不同的使用者角色，可以操作不同的表）
    'DEFAULT_PERMISSION_CLASSES': [
        # 'rest_framework.permissions.IsAdminUser',                # 管理員可以訪問
        # 'rest_framework.permissions.IsAuthenticated',            # 認證使用者可以訪問
        # 'rest_framework.permissions.IsAuthenticatedOrReadOnly',  # 認證使用者可以訪問, 否則只能讀取
        # 'rest_framework.permissions.AllowAny',                   # 所有使用者都可以訪問
        # 'user.utils.VipPermission',  #自定義許可權
    ],
    #3.限流（防爬蟲）
    'DEFAULT_THROTTLE_CLASSES': [
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle',
    ],
    #3.1限流策略
    # 'DEFAULT_THROTTLE_RATES': {
    #     'user': '100/hour',    # 認證使用者每小時100次
    #     'anon': '10/day',       # 未認證使用者每天能訪問3次
    # },

    'DEFAULT_CONTENT_NEGOTIATION_CLASS': 'rest_framework.negotiation.DefaultContentNegotiation',
    'DEFAULT_METADATA_CLASS': 'rest_framework.metadata.SimpleMetadata',
    'DEFAULT_VERSIONING_CLASS': None,

    #4.分頁（全域性）：全域性分頁器, 例如 省市區的資料自定義分頁器, 不需要分頁
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 每頁返回數量
    # 'PAGE_SIZE': 3,  # 預設 None

    #5.過濾器後端
    'DEFAULT_FILTER_BACKENDS': [
        'django_filters.rest_framework.DjangoFilterBackend',
        # 'django_filters.rest_framework.backends.DjangoFilterBackend', 包路徑有變化
        'rest_framework.filters.OrderingFilter',
    ],

    #5.1過濾排序（全域性）：Filtering 過濾排序
    # 'SEARCH_PARAM': 'search',
    # 'ORDERING_PARAM': 'ordering',
    #
    # 'NUM_PROXIES': None,

    #6.版本控制：Versioning  介面版本控制
    'DEFAULT_VERSION': None,
    'ALLOWED_VERSIONS': None,
    'VERSION_PARAM': 'version',

    # Authentication  認證
    # 未認證使用者使用的使用者型別
    'UNAUTHENTICATED_USER': 'django.contrib.auth.models.AnonymousUser',
    # 未認證使用者使用的Token值
    'UNAUTHENTICATED_TOKEN': None,

    # View configuration
    'VIEW_NAME_FUNCTION': 'rest_framework.views.get_view_name',
    'VIEW_DESCRIPTION_FUNCTION': 'rest_framework.views.get_view_description',

    'NON_FIELD_ERRORS_KEY': 'non_field_errors',

    # Testing
    'TEST_REQUEST_RENDERER_CLASSES': [
        'rest_framework.renderers.MultiPartRenderer',
        'rest_framework.renderers.JSONRenderer'
    ],
    'TEST_REQUEST_DEFAULT_FORMAT': 'multipart',

    # Hyperlink settings
    'URL_FORMAT_OVERRIDE': 'format',
    'FORMAT_SUFFIX_KWARG': 'format',
    'URL_FIELD_NAME': 'url',

    # Encoding
    'UNICODE_JSON': True,
    'COMPACT_JSON': True,
    'STRICT_JSON': True,
    'COERCE_DECIMAL_TO_STRING': True,
    'UPLOADED_FILES_USE_URL': True,

    # Browseable API
    'HTML_SELECT_CUTOFF': 1000,
    'HTML_SELECT_CUTOFF_TEXT': "More than {count} items...",

    # Schemas
    'SCHEMA_COERCE_PATH_PK': True,
    'SCHEMA_COERCE_METHOD_NAMES': {
        'retrieve': 'read',
        'destroy': 'delete'
    },
}
settings.py

2.程式碼實踐

ModelViewSet+ModelSerializer使用 
from django.urls import include, path
from user import views
from rest_framework.routers import SimpleRouter, DefaultRouter

# 自動生成路由方法, 必須使用檢視集
# router = SimpleRouter()  # 沒有根路由  /user/ 無法識別
router = DefaultRouter()                       # 1.有根路由
router.register(r'user', views.UserViewSet)    # 2.配置路由

urlpatterns = [
    path('index/', views.index),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))  # 認證地址
]

urlpatterns += router.urls     # 3.模組地址
user/urls.py
ModelViewSet+ModelSerializer使用 
from django.http import HttpResponse
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework import viewsets
from rest_framework.authentication import BasicAuthentication, SessionAuthentication
from rest_framework.decorators import action
from rest_framework.filters import OrderingFilter
from rest_framework.permissions import AllowAny, IsAdminUser, IsAuthenticated, IsAuthenticatedOrReadOnly
from rest_framework.response import Response
from rest_framework.throttling import UserRateThrottle
from rest_framework.pagination import PageNumberPagination
from rest_framework.views import APIView
from rest_framework.permissions import BasePermission, SAFE_METHODS
from user.models import User
from user.serializers import UserSerializer, UserUnActiveSerializer


# 分頁（區域性）：自定義分頁器 區域性
class PageNum(PageNumberPagination):
    # 查詢字串中代表每頁返回資料數量的引數名, 預設值: None
    page_size_query_param = 'page_size'
    # 查詢字串中代表頁碼的引數名, 有預設值: page
    # page_query_param = 'page'
    # 一頁中最多的結果條數
    max_page_size = 2


# 自定義許可權（區域性）
class MyPermission(BasePermission):
    # has_permission 是使用者對這個檢視有沒有 GET POST PUT PATCH DELETE 許可權的分別判斷
    def has_permission(self, request, view):
        print('has_perm')
        # print(view.kwargs.get("pk"), request.user.id)
        """判斷使用者對模型有沒有訪問權"""
        # 任何使用者對使用此許可權類的檢視都有訪問許可權
        if request.user.is_superuser:
            # 管理員對使用者模型有訪問權
            return True
        elif view.kwargs.get('pk') == str(request.user.id):
            # 攜帶的id和使用者的id相同時有訪問權
            return True
        return False

    # has_object_permission 是使用者過了 has_permission 判斷有許可權以後，再判斷這個使用者有沒有對一個具體的物件有沒有操作許可權
    # 這樣設定以後，即使是django admin管理員也只能查詢自己user標的資訊，不能查詢其他使用者的單條資訊
    def has_object_permission(self, request, view, obj):
        print('has_object_perm')
        """獲取單個資料時,判斷使用者對某個資料物件是否有訪問許可權"""
        if request.user.id == obj.id:
            return True
        return False


class UserViewSet(viewsets.ModelViewSet):
    """
    完成產品的增刪改查
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer  # 優先使用 get_serializer_class 返回的序列化器

    # # 1.認證：自定義認證類, 自定義會覆蓋全域性配置
    # authentication_classes = (BasicAuthentication, SessionAuthentication)
    # # 2.許可權：自定義許可權類
    # permission_classes = (MyPermission,)

    # 3.分頁：自定義分頁器 覆蓋全域性配置
    pagination_class = PageNum

    # 4.限流：自定義限流類
    throttle_classes = [UserRateThrottle]

    # 5.過濾：指定過濾方法類, 排序方法類, 一個或多個
    filter_backends = (DjangoFilterBackend, OrderingFilter)  # 同時支援過濾和排序
    # 5.1指定排序欄位, 不設定, 排序功能不起效
    ordering_fields = ('date_joined', 'id')  # ?ordering=-id
    # 5.2指定過濾欄位, 不設定, 過濾功能不起效
    filter_fields = ('username', 'phone', 'is_active')  # ?username=tom&phone=&is_active=true

    # 根據不同的請求, 獲得不同的序列化器
    def get_serializer_class(self):
        if self.action == 'unactived':
            return UserUnActiveSerializer
        else:
            return UserSerializer

    @action(methods=['get'], detail=False)
    def unactived(self, request, *args, **kwargs):
        # 獲取查詢集, 過濾出未啟用的使用者
        qs = self.queryset.filter(is_active=False)
        # 使用序列化器, 序列化查詢集, 並且是
        ser = self.get_serializer(qs, many=True)
        return Response(ser.data)

    @action(methods=['get'], detail=False)
    def actived(self, request, *args, **kwargs):
        # 獲取查詢集, 過濾出未啟用的使用者
        qs = self.queryset.filter(is_active=True)
        # 使用序列化器, 序列化查詢集, 並且是
        ser = self.get_serializer(qs, many=True)
        return Response(ser.data)
user/views.py
ModelViewSet+ModelSerializer使用 
from rest_framework import serializers
from user.models import User


def address_validate(data):
    # data：是使用者提交的地址這個欄位的資料（河南省 鄭州市）
    # 獨立校驗器
    # raise serializers.ValidationError('請填寫實際地址')  # 有錯就丟擲異常
    # 沒錯就返回資料
    return data


class UserSerializer(serializers.ModelSerializer):
    # 1.獨立校驗器：重新設定欄位, 替換掉模型中的設定, 重新設定地址的長度為5
    # address_validate是自定義的資料校驗函式
    address = serializers.CharField(max_length=255, min_length=5, validators=[address_validate])

    # 2.單一欄位驗證（validate_欄位名）, 驗證地址
    def validate_address(self, data):
        if data == '測試':
            raise serializers.ValidationError('請填寫實際地址')  # 有錯就丟擲異常
        return data  # 沒錯就返回結果

    def validate_phone(self, data):
        # 不符合手機號格式
        # raise serializers.ValidationError('手機號格式不正確')
        model = self.root.Meta.model
        num = model.objects.filter(phone=data).count()
        if num > 0:
            raise serializers.ValidationError('手機號已存在')
        return data

    # 3.所有屬性驗證器
    def validate(self, attrs):
        # attrs：{"username":"zhangsan", "phone":"18538752511", ....}
        # 所有屬性驗證器
        # self.context 中有request和view上下文
        # self.context['view'].action 可以取到動作
        # attrs 是需要序列化的資料
        # raise serializers.ValidationError('xxx錯誤')  # 有問題報錯
        return attrs  # 沒問題返回資料

    class Meta:
        model = User                  # 具體對哪個表進行序列化
        fields = '__all__'          # 所有欄位
        # fields = ('id', )           # 臨時新增欄位也需要寫在這裡
        # exclude = ['id']          # 排除 id 欄位
        # read_only_fields = ('',)  # 指定欄位為 read_only,
        # depth = 1                 # 深度（序列化外來鍵欄位，外來鍵欄位有幾層就=於幾）


class UserUnActiveSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('id', 'username', 'is_active')  # 臨時新增欄位也需要寫在這裡
        # fields = '__all__'  # 所有欄位
user/serializers.py

3.postman測試介面

  • 查詢路由

#1.查詢所有使用者
http://192.168.56.100:8888/user/user/
#2.查詢id=1的使用者
http://192.168.56.100:8888/user/user/1/
#3.查詢 使用者名稱（tom），啟用的使用者
http://192.168.56.100:8888/user/user/?username=tom&phone=&is_active=true
#4.查詢所有使用者 用id 反向排序
http://192.168.56.100:8888/user/user/?ordering=-id
#5.查詢使用者表中第一頁，每頁顯示一條資料
http://192.168.56.100:8888/user/user/?page=1&page_size=1

  • 增加（POST）

http://192.168.56.100:8888/user/user/

  • 修改（PUT）

http://192.168.56.100:8888/user/user/1/

  • 刪除（DELETE）

http://192.168.56.100:8888/user/user/1/

 

相關文章