Django&DRF重點(diǎn)內(nèi)容大盤(pán)點(diǎn)

本文只是將學(xué)習(xí)過(guò)程中需要深刻記憶，在工作中常用的一些命令或者知識(shí)點(diǎn)進(jìn)行一個(gè)羅列并闡釋，不會(huì)全面的將所有內(nèi)容進(jìn)行講解。大家可以在了解了Django框架和DRF框架之后再來(lái)看這邊文章。否則會(huì)有點(diǎn)不知所云。

1.Django

1.1創(chuàng)建Django項(xiàng)目

這一命令必須熟記于心：

django-admin startproject 項(xiàng)目名

1.2 創(chuàng)建子應(yīng)用

1.在工作中我們要開(kāi)發(fā)很多項(xiàng)目，肯定需要很多模塊，創(chuàng)建子應(yīng)用肯定也需要掌握：

python manage.py startapp 子應(yīng)用名

注意：此命令需要在項(xiàng)目的目錄下進(jìn)行輸入。

2.創(chuàng)建完子應(yīng)用中之后，千萬(wàn)不要忘記去INSTALLED_APPS中進(jìn)行注冊(cè)，這個(gè)參數(shù)在setting文件中。

1.3一個(gè)程序注意的點(diǎn)

1.3.1視圖函數(shù)的定義

1）定義視圖函數(shù)之后，要有一個(gè)request形參接收請(qǐng)求對(duì)象。

2）返回的時(shí)候用到了HttpResponse這一命令返回響應(yīng)對(duì)象

1.3.2url地址的配置

1.在子應(yīng)用中的urls.py文件中設(shè)置當(dāng)前子應(yīng)用中url地址和視圖對(duì)應(yīng)關(guān)系

urlpatterns = [
    url(r'^url正則表達(dá)式$',views.視圖函數(shù)名)
]

2.在項(xiàng)目總的urls.py文件中包含子應(yīng)用中的urls.py文件

urlpatterns = [
    url(r'^',include('users.urls'))
]

1.4url配置

在子應(yīng)用中進(jìn)行url地址的配置時(shí)，建議嚴(yán)格匹配開(kāi)頭和結(jié)尾，避免在地址匹配時(shí)候出錯(cuò)。

1.5項(xiàng)目配置項(xiàng)

1.BASE_DIR指的是Django項(xiàng)目根目錄

2.語(yǔ)言和時(shí)區(qū)本地化：

LANGUAGE_CODE = 'zh-Hans' # 中文語(yǔ)言
TIME_ZONE = 'Asia/Shanghai' # 中國(guó)時(shí)間

1.6客戶端向服務(wù)器傳遞參數(shù)途徑

1.6.1通過(guò)URL地址傳遞參數(shù)

在我們的url地址中的參數(shù)，我們?nèi)绻胍@取可以在子應(yīng)用中的urls文件中進(jìn)行設(shè)置

/weather/城市/年份
url(r'weather/(?P<city>\w+)/(?P<year>\d{4})/$'views.weather)

1.6.2通過(guò)查詢字符串傳遞參數(shù)

# /qs/?a=1&b=2&a=3
def qs(request):
    a = request.GET.get('a')
    b = request.GET.get('b')
    alist = request.GET.getlist('a')
    print(a)  # 3
    print(b)  # 2
    print(alist)  # ['1', '3']
    return HttpResponse('OK')

重要：查詢字符串不區(qū)分請(qǐng)求方式，即假使客戶端進(jìn)行POST方式的請(qǐng)求，依然可以通過(guò)request.GET獲取請(qǐng)求中的查詢字符串?dāng)?shù)據(jù)。

1.6.3通過(guò)請(qǐng)求體傳遞數(shù)據(jù)

1)post表單提交的數(shù)據(jù)

/form/
def form_data(request):
    name = request.POST.get('name')
    age = request.POST.get('age')
    return HttpResponse('OK')

2)json數(shù)據(jù)

/json/
def json_data(request):
    req_data = request.body
    json_str = req_data.decode()
    req_dict = json.loads(json_str)
    name = req_dict.get('name')
    age = req_dict.get('age')
    return HttpResponse('OK')

1.6.4通過(guò)請(qǐng)求頭傳遞數(shù)據(jù)（了解即可）

1.6.5request對(duì)象的屬性

1.7相應(yīng)對(duì)象構(gòu)造

1.7.1響應(yīng)時(shí)返回json數(shù)據(jù)

def get_json(request):
    res_dict = {
        'name':'xiaoyan',
        'age':'18'
    }
    return JsonResponse(res_dict)

1.7.2響應(yīng)時(shí)進(jìn)行頁(yè)面重定向

def redirect_test(request):
    # 第一個(gè)參數(shù)是namespace，第二個(gè)參數(shù)是name
    req_url = reverse('users:index')
    return redirect(req_url)

1.8狀態(tài)保持之session

1）將session信息保存到redis中

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    }
}
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
SESSION_CACHE_ALIAS = "default"

2)設(shè)置session

request.session['<key>'] = '<value>'

3)獲取session

request.session.get('<key>')

1.9類視圖

1.9.1類視圖的使用

1）定義類視圖

/register/
class RegisterView(View):
    def get(self,request):
        return HttpResponse('返回注冊(cè)頁(yè)面')
    def post(self,request):
        return HttpResponse('進(jìn)行注冊(cè)處理...')
    def put(self,request):
        return HttpResponse('put方法被調(diào)用')

2）進(jìn)行url配置

url(r'^register/$',views.RegisterView.as_view())

1.9.2類視圖添加裝飾器

使用Django框架提供method_decorator將針對(duì)函數(shù)視圖裝飾器添加到類視圖的方法上面

# 為全部請(qǐng)求方法添加裝飾器
@method_decorator(my_decorator, name='dispatch')
class DemoView(View):
    def get(self, request):
        print('get方法')
        return HttpResponse('ok')

    def post(self, request):
        print('post方法')
        return HttpResponse('ok')


# 為特定請(qǐng)求方法添加裝飾器
@method_decorator(my_decorator, name='get')
class DemoView(View):
    def get(self, request):
        print('get方法')
        return HttpResponse('ok')

    def post(self, request):
        print('post方法')
        return HttpResponse('ok')

1.10中間件

1.10.1定義中間件

def simple_middleware(get_response):
    # 此處編寫(xiě)的代碼僅在Django第一次配置和初始化的時(shí)候執(zhí)行一次。

    def middleware(request):
        # 此處編寫(xiě)的代碼會(huì)在每個(gè)請(qǐng)求處理視圖前被調(diào)用。

        response = get_response(request)

        # 此處編寫(xiě)的代碼會(huì)在每個(gè)請(qǐng)求處理視圖之后被調(diào)用。

        return response

    return middleware

1.10.2 在MIDDLEWARE中注冊(cè)中間

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    # 'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'users.middleware.my_middleware',  # 添加中間件
]

1.10.3注意：中間件是全局的

1.11使用模板的詳細(xì)步驟

1.加載模板：指定使用模板文件，獲取模板對(duì)象

from django.template import loader
temp = loader.get_template('模板文件名')

2.模板渲染：給模板文件傳遞變量，將模板文件中的變量進(jìn)行替換，獲取替換之后的html內(nèi)容

res_html = temp.render(字典)

3.創(chuàng)建響應(yīng)對(duì)象

return HttpResponse(res_html)

1.12數(shù)據(jù)庫(kù)

1.12.1數(shù)據(jù)庫(kù)鏈接配置

1.在settings.py進(jìn)行配置

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'HOST': '127.0.0.1',  # 數(shù)據(jù)庫(kù)主機(jī)
        'PORT': 3306,  # 數(shù)據(jù)庫(kù)端口
        'USER': 'root',  # 數(shù)據(jù)庫(kù)用戶名
        'PASSWORD': 'mysql',  # 數(shù)據(jù)庫(kù)用戶密碼
        'NAME': 'django_demo'  # 數(shù)據(jù)庫(kù)名字
    }
}

2.首次啟動(dòng)時(shí)需要在項(xiàng)目同名的目錄init.py添加

pip install pymysql

import pymysql
pymysql.install_as_MySQLdb

1.12.2定義模型類

class 模型類名(models.Model):
    # 字段名 = models.字段類型(選項(xiàng)參數(shù))
    # ...
    
    class Meta:
        db_table = '<表名>'

定義外鍵屬性

  hbook = models.ForeignKey(BookInfo, on_delete=models.CASCADE, verbose_name='圖書(shū)')  # 外鍵

cascade是級(jí)聯(lián)，刪除主表數(shù)據(jù)時(shí)連同外鍵表中數(shù)據(jù)一起刪除

1.12.3遷移生成表

1）生成遷移文件

python manage.py makemigrations

2）同步到數(shù)據(jù)庫(kù)中

python manage.py migrate

1.12.4通過(guò)模型類和對(duì)象進(jìn)行數(shù)據(jù)庫(kù)操作（增刪改查）

新增：

1. 創(chuàng)建模型類對(duì)象-->對(duì)象.save()

注意：添加HeroInfo時(shí)，可以給hbook賦值，也可以直接表中hbook_id賦值

HeroInfo是定義的英雄模型類，與圖書(shū)B(niǎo)ookInfo對(duì)應(yīng)。

2. 模型類.objects.create(...)

修改：

1. 查詢對(duì)象->修改對(duì)象屬性->對(duì)象.save()
2. 模型類.objects.filter(...).update(...)

刪除：

1. 查詢對(duì)象->對(duì)象.delete()
2. 模型類.objects.filter(...).delete()

查詢：

基本查詢
    模型類.objects.查詢函數(shù)
條件查詢
    對(duì)應(yīng)get, filter, exclude參數(shù)中可以寫(xiě)查詢條件
    格式: 屬性名__條件名=值
    注意：可以寫(xiě)多個(gè)查詢條件，默認(rèn)是且的關(guān)系
F對(duì)象
    用于查詢時(shí)字段之間的比較
    from django.db.models import F
Q對(duì)象
    用于查詢時(shí)條件之間的邏輯關(guān)系
    from django.db.models import Q
    &(與) |(或) ~(非)
聚合
    聚合類: from django.db.models import Count, Sum, Avg, Max, Min
aggregate
排序
    排序默認(rèn)是升序，降序在排序字段前加-
    order_by
關(guān)聯(lián)查詢
    1. 查詢和指定對(duì)象關(guān)聯(lián)的數(shù)據(jù)
    由1查多
        一對(duì)象.多類名小寫(xiě)_set.all()
        例：book.heroinfo_set.all()
    由多查1
        多對(duì)象.外鍵屬性
        例：hero.hbook
    2. 通過(guò)模型類進(jìn)行關(guān)聯(lián)查詢
    查圖書(shū)(一)
        一類.objects.get|filter(多類名__字段__條件=值)
        例：books = BookInfo.objects.filter(heroinfo__hcomment__contains='八')
    查英雄(多)
        多類.objects.filter(外鍵屬性__字段__條件=值)
        例：heros = HeroInfo.objects.filter(hbook__bread__gt=30)

1.13admin站點(diǎn)

上傳圖片
Django自帶文件存儲(chǔ)系統(tǒng)，可以直接通過(guò)Admin站點(diǎn)進(jìn)行圖片的上傳，默認(rèn)上傳的文件保存在服務(wù)器本地。
使用

1）在配置文件中設(shè)置配置項(xiàng)MEDIA_ROOT='上傳文件的保存目錄'

2）定義模型類時(shí)，圖片字段的類型使用ImageField

3）遷移生成表并在admin.py注冊(cè)模型類，直接登錄Admin站點(diǎn)就可以進(jìn)行圖片上傳

2.DRF框架

2.1目的

利用DRF框架快速的實(shí)現(xiàn)RestAPI接口的設(shè)計(jì)

2.2RestfulAPI接口設(shè)計(jì)風(fēng)格

關(guān)鍵點(diǎn)
1）url地址盡量使用名詞，不要使用動(dòng)詞
2）請(qǐng)求url地址采用不同的請(qǐng)求方式執(zhí)行不同的操作
GET(獲取)
POST(新增)
PUT(修改)
DELETE(刪除)
3）過(guò)濾參數(shù)可以放在查詢字符串中
4）響應(yīng)數(shù)據(jù)返回&響應(yīng)狀態(tài)碼

5）響應(yīng)數(shù)據(jù)的格式：json

2.3django自定義RestAPI接口

RestAPI接口核心工作
1.將數(shù)據(jù)庫(kù)數(shù)據(jù)序列化為前端所需要的格式，并返回
2.將前端發(fā)送的數(shù)據(jù)反序列化為模型類對(duì)象，并保存到數(shù)據(jù)庫(kù)中

2.4DRF框架

2.4.1作用：大大提高RestAPI接口開(kāi)發(fā)效率

2.5序列化器Serializer

2.5.1功能

進(jìn)行數(shù)據(jù)的序列化和反序列化

2.5.2序列化器的定義

繼承自serializers.Serializer

from rest_framework import serializers

# serializers.Serializer:DRF框架中所有序列化器的父類，定義序列化器類時(shí)，可以直接繼承此類
# serializers.ModelSerializer:Serializer類的子類，在父類的基礎(chǔ)山，添加一些功能

class 序列化器類名(serializers.Serializer):
    # 字段名 = serializers.字段名(選項(xiàng)參數(shù))

序列化器對(duì)象創(chuàng)建：

序列化器類(instance=<實(shí)例對(duì)象>,data=<數(shù)據(jù)>,**kwargs)

2.5.3序列化功能

說(shuō)白了就是將實(shí)例對(duì)象轉(zhuǎn)換為字典數(shù)據(jù)

1）序列化單個(gè)對(duì)象

book = BookInfo.objects.get(id=1)
serializer = BookInfoSerializer(book)
res = json.dumps(serializer.data,ensure_ascii=False,indent=4)

2）序列化多個(gè)對(duì)象，其實(shí)就是添加了一個(gè)many參數(shù)

books = BookInfo.objects.all()
serializer = BookInfoSerializer(books,many=True)
res = json.dumps(serializer.data,ensure_ascii=False,indent=4)

3）關(guān)聯(lián)對(duì)象的嵌套序列化

1.將關(guān)聯(lián)對(duì)象序列化為關(guān)聯(lián)對(duì)象的主鍵

hbook = serializers.PrimaryKeyRelatedField(label='圖書(shū)'，read_only=True)

2.采用指定的序列化器將關(guān)聯(lián)對(duì)象進(jìn)行序列化

hbook = BookInfoSerializer(label='圖書(shū)')    

3.將關(guān)聯(lián)對(duì)象序列化為關(guān)聯(lián)對(duì)象模型類_str_方法的返回值

hbook = serializers.StringRelatedField(label='圖書(shū)')

注意：和對(duì)象關(guān)聯(lián)的對(duì)象如果有多個(gè)，在序列化器中定義嵌套序列化字段時(shí)，需要添加many=True。

2.5.4反序列化功能

反序列化-數(shù)據(jù)校驗(yàn)：

data = {'btitle':'python','bpub_date':'1980-1-1'}
serializer = BookInfoSerializer(data)
serializer.is_valid()
serializer.errors
serialiser.validated_data

當(dāng)系統(tǒng)提供的校驗(yàn)不能滿足我們的需求的時(shí)候，我們可以補(bǔ)充額外的驗(yàn)證：

1）指定特定字段的validators參數(shù)進(jìn)行補(bǔ)充驗(yàn)證

btitle = serializers.CharField(label='標(biāo)題',max_length=20,validators=[about_django])

注意：此處的about_django為我們自定義的校驗(yàn)函數(shù)

2）在序列化器類中定義特定方法validate_<fieldname>針對(duì)特定字段進(jìn)行補(bǔ)充驗(yàn)證

def validate_btitle(self,value):
    if 'django' not in value.lower():
        raise serializers.validationError('圖書(shū)不是關(guān)于Django的')
    return value

3）定義validate方法進(jìn)行補(bǔ)充驗(yàn)證（結(jié)合多個(gè)字段內(nèi)容驗(yàn)證）

def validate(self,attrs):
    """
    此處的attrs是一個(gè)字典，創(chuàng)建序列化器對(duì)象時(shí)，傳入data數(shù)據(jù)
    """
    bread = attrs['bread']
    bcomment = attrs['bcomment']
    if bread<=bcomment:
        raise serializers.ValidationError('圖書(shū)閱讀量必須大于評(píng)論量')
    return attrs

2.5.5反序列化-數(shù)據(jù)保存（新增&更新）

校驗(yàn)通過(guò)之后，可以調(diào)用serializer.save()進(jìn)行數(shù)據(jù)保存

1)數(shù)據(jù)新增

def create(self,validated_data):
    """
    validated_data:字典，校驗(yàn)之后的數(shù)據(jù)
    """
    book = BookInfo.objects.create(**validated_data)
    return book

------------------------------------
data = {'btitle':'python','bpub_data':'1802-1-1','bread':30,'bcomment:20'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()
serializer.save()
serializer.data

2)數(shù)據(jù)更新

def update(self,instance,validated_data):
    """
    instance:創(chuàng)建序列化器對(duì)象時(shí)傳入實(shí)例對(duì)象
    validated_data:是一個(gè)字典，校驗(yàn)之后的數(shù)據(jù)
    """
    btitle = validated_data.get('btitle')
    bpub_data_date = validated_data.get('bpub_date')
    
    instance.btitle = btitle
    instance.bpub_date = bpub_date
    instance.save()
    
    return instance

2.5.6使用序列化器改寫(xiě)RestAPI接口

我們舉兩個(gè)代表性的例子即可：

# /books/
class BookListView(View):
    def get(self, request):
        """
        獲取所有的圖書(shū)的信息：
        1. 查詢所有的圖書(shū)的數(shù)據(jù)
        2. 返回所有圖書(shū)的json的數(shù)據(jù)
        """
        # 1. 查詢所有的圖書(shū)的數(shù)據(jù)
        books = BookInfo.objects.all() # QuerySet

        # 2. 返回所有圖書(shū)的json的數(shù)據(jù)，狀態(tài)碼: 200
        books_li = []
        for book in books:
            # 將book對(duì)象轉(zhuǎn)換成dict
            book_dict = {
                'id': book.id,
                'btitle': book.btitle,
                'bpub_date': book.bpub_date,
                'bread': book.bread,
                'bcomment': book.bcomment,
                'image': book.image.url if book.image else ''
            }

            books_li.append(book_dict)

        return JsonResponse(books_li, safe=False)

    def post(self, request):
        """
        新增一本圖書(shū)的信息：
        1. 獲取參數(shù)btitle和bpub_date并進(jìn)行校驗(yàn)
        2. 創(chuàng)建圖書(shū)信息并添加進(jìn)數(shù)據(jù)表中
        3. 返回新增的圖書(shū)的json數(shù)據(jù)，狀態(tài)碼: 201
        """
        # 需求: 前端需要傳遞新增圖書(shū)的信息(btitle, bpub_date)，通過(guò)json傳遞

        # 1. 獲取參數(shù)btitle和bpub_date并進(jìn)行校驗(yàn)
        # 獲取json的原始數(shù)據(jù)
        req_data = request.body # bytes

        # 將bytes轉(zhuǎn)換為str
        json_str = req_data.decode()

        # 將json字符串轉(zhuǎn)換dict
        req_dict = json.loads(json_str)

        # 獲取btitle和bpub_date
        btitle = req_dict.get('btitle')
        bpub_date = req_dict.get('bpub_date')

        # TODO: 省略參數(shù)校驗(yàn)過(guò)程...

        # 2. 創(chuàng)建圖書(shū)信息并添加進(jìn)數(shù)據(jù)表中
        book = BookInfo.objects.create(
            btitle=btitle,
            bpub_date=bpub_date
        )

        # 3. 返回新增的圖書(shū)的json數(shù)據(jù)，狀態(tài)碼: 201
        # 將book對(duì)象轉(zhuǎn)換成dict
        book_dict = {
            'id': book.id,
            'btitle': book.btitle,
            'bpub_date': book.bpub_date,
            'bread': book.bread,
            'bcomment': book.bcomment,
            'image': book.image.url if book.image else ''
        }

        return JsonResponse(book_dict, status=201)

修改之后：

class BookListView(View):
    def get(self, request):
        books = BookInfo.objects.all() # QuerySet
        serializer = BookInfoSerializer(books, many=True)
        return JsonResponse(serializer.data, safe=False)

    def post(self, request):
        req_data = request.body # bytes
        json_str = req_data.decode()
        req_dict = json.loads(json_str)
        
        serializer = BookInfoSerializer(data=req_dict)
        serializer.is_valid(raise_exception=True)

        # 反序列化-數(shù)據(jù)保存(新增) -> create
        serializer.save()
        return JsonResponse(serializer.data, status=201)