django-ModelViewSet

本文轉載自查看原文 2020-10-05 16:50 665

ModelViewSet

功能

1.認證 (登錄認證)
2.權限 (規定用戶的可操作范圍)
3.限流 (限制接口訪問速度)
4.分頁 
5.序列化 (返回json)
6.過濾 ()
7.排序 (ordering=-id)
8.版本 (接口版本號，用v1/v2/v3)

安裝DjangoRestFramework

pip install djangorestframework==3.11.1
pip install django-filter==2.3.0  #過濾器
pip install markdown

在settings中注冊

INSTALLED_APPS = [
    'Django_filter',
    'rest_frameword',
]

在settings配置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.認證器（全局）
    'DEFAULT_AUTHENTICATION_CLASSES': [
        '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'
   },
}

urls.py

from django.urls import include,path
from user import views
from rest_framework.routers import SimpleRouter,DefaultRouter


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

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

urlpatterns += router.urls  #模塊地址

創建user/serializer.py寫序列化器

from rest_framework import serializer
from user.models import User

def address_validate(data):
    #獨立校驗器
    #raise serializer.ValidationError('請填寫實際地址') #有錯就拋出異常
    #沒錯就返回數據
    return data

class UserSerializer(serializers.ModelSerializer):
    # 1.獨立校驗器：重新設定字段，替換掉模型中的設定，重新設定地址的長度為5
 address = serializers.CharField(max_length=255, min_length=5, validators=[address_validate])
 
    # 2.單一字段驗證，驗證地址
    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
    
    def validate(self, attrs):
        # attrs:{"username":"zhangsan", "phone":"12312312311", .....}
        # 所有屬性驗證器
        # self.context 中有request和view上下文
        # self.context['view'].action 可以取到動作
        # attrs 是需要序列化的數據
        # raise serializers.ValidationError('xxx錯誤') # 有問題報錯
        return attrs 
 class Meta:
        model = User
        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__"

user/view.py

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.throttling import UserRateThrottle
from rest_framework.response import Response
from rest_framework.pagination import PageNumberPagination
from rest_framework.views import APIView
from rest_framework.permissions import BasePermission, SAFE_METHODS
from user.serializers 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(self, request, view, obj):
    # 這樣設置以后，即使是Django admin管理員也只能查詢自己user的信息，不能查詢其他用戶的單條信息
    def has_object_permission(self, reuqest, 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', 'id_active') # ?username=&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, reuqest, *args, **kwargs):
        # 獲取查詢集，過濾出未激活的用戶
        qs = self.queryset.filter(is_active=False)
        # 使用序列化器， 序列化查詢集，並且是
        ser = self.get_serializer(qs, many=Ture)
        return Response(ser.data)

查詢接口

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Django中ModelViewSet的應用 Django Rest Framework----ModelViewSet視圖 ModelViewSet源碼分析 django 初始化項目和modelviewset 使用統一修改 Django Rest framework ModelViewSet 的默認返回信息 django_rest_framework ModelViewSet不支持PUT方法，PUT修改后不生效 django rest_framework中的APIView,ModelViewSet,認證，權限，頻率，版本 ModelViewSet的使用 ModelViewSet+ModelSerializer使用 drf modelviewset 之update操作 ModelViewSet 視圖集實現接口