ModelViewSet+ModelSerializer使用

1 Django路徑

1.1 路徑問題引入

import sys
當前文件夾優先搜索（同名會覆蓋）
BASE_DIR 指的是django項目根路徑
print(os.path.abspath(__file__))
# 當前文件絕對路徑
# /root/shiyanlou_project/syl/syl/settings.py
print(sys.path.insert(0,os.path.join(BASE_DIR,'apps')))
# /root/shiyanlou_project/syl/apps/

 

1.2 操作系統文件絕對路徑

django靜態文件查找，模板查找

# 去配置好的文件夾中查找指定的文件
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
STATIC_URL = '/static/'
# /teacher/shiyanlou_project/syl/apps/user/         # linux
# E:\_000\XSX

 

1.3 django導包路徑

第一訪問：當前文件夾
導報之前，包的上級路徑，需要存在於python system的path
sys.path 這是一個列表
'''
sys.path.insert(0, os.path.join(BASE_DIR, 'apps'))
'''
from xxx import yyy 才能成功
第二訪問才回去路徑，列表的索引為0

 

1.4 django模型引用路徑

想使用一個 models.py 文件中的模型
apps名稱.model模型名
'users.User'

 

2 DRF初始化

2.1 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）

 

2.2 相關包

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

 

2.3 安裝DjangoRestFramework

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

 

2.4 注冊+配置

2.4.1 在syl/settings.py中注冊

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

 

2.4.2 syl/settings.py配置DRF： 全局配置

# 過濾器
# 1,安裝 django-filter
# 2,注冊應用
# 3,配置settings, 在view里配置可過濾的字段
# 4,使用 查詢字符串攜帶過濾信息
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',                             # 所有用戶都可以訪問
    ],
    
    #3.限流（防爬蟲）
    'DEFAULT_THROTTLE_CLASSES': [
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle',
    ],
    
    #3.1限流策略
    'DEFAULT_THROTTLE_RATES': {
        'user': '100/hour', # 認證用戶每小時100次
        'anon': '3/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': 10, # 默認 None
    
    
    #5.過濾器后端
    'DEFAULT_FILTER_BACKENDS': [
    'django_filters.rest_framework.DjangoFilterBackend',
    # 'django_filters.rest_framework.backends.DjangoFilterBackend', 包路徑有變化
    ],
    
    
    #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'
    },
}

 

3 DRF八大功能具體實現

3.1 ModelViewSet注冊路由三部曲

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.模塊地址
# 實質上是路由拼接
​
# 輸出router.urls的時候發現
'''
   [<URLPattern '^user/$' [name='user-list']>,
   <URLPattern '^user\.(?P<format>[a-z0-9]+)/?$' [name='user-list']>,
   <URLPattern '^user/actived/$' [name='user-actived']>,
   <URLPattern '^user/actived\.(?P<format>[a-z0-9]+)/?$' [name='user-actived']>,
   <URLPattern '^user/unactived/$' [name='user-unactived']>,
   <URLPattern '^user/unactived\.(?P<format>[a-z0-9]+)/?$' [name='userunactived']>, <URLPattern '^user/(?P<pk>[^/.]+)/$' [name='user-detail']>,
   <URLPattern '^user/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$' [name='userdetail']>, <URLPattern '^$' [name='api-root']>, <URLPattern '^\.(?P<format>[a-z0-
   9]+)/?$' [name='api-root']>] DRF
'''

3.2 主要功能梳理

3.2.1 數據校驗

創建/修改數據 在創建數據或者修改數據時校驗用戶提交的數據是否合法 用戶名必須是8位以上，郵箱、手機號是合法的

3.2.2 序列化

把通過model查詢的queryset對象轉換成JSON格式

3.2.3 具體實現

from rest_framework import serializers
from user.models import User
def address_validate(data):
    print(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 = ('id', ) # 臨時添加字段也需要寫在這里
        fields = '__all__' # 所有字段
        # exclude = ['id'] # 排除 id 字段
        read_only_fields = ('',) # 指定字段為 read_only,
        # 擴展address： extra_kwargs = {} # 局部替換某些字段的設定, 或者新增設定
        extra_kwargs = {
            "address": {
                "min_length": 5, # 給地址增加 最小長度限制
                "default": '默認測試地址', # 增加默認值
            }
        }
​
class UserUnActiveSerializer(serializers.ModelSerializer):
   
    class Meta:
        model = User
        fields = ('id', 'username', 'is_active') # 臨時添加字段也需要寫在這里
        # fields = '__all__' # 所有字段

 

3.2.4 view代碼

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
​
def index(request):
    # 需要認證才能訪問的視圖
    return HttpResponse('hello')
​
# 分頁（局部）：自定義分頁器 局部
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)

 

• 權限的本質就是有沒有對一個表的增刪改查權限

3.2.5 查詢 接口

#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

4 根源目錄