码迷,mamicode.com
首页 > Web开发 > 详细

一: DRF web应用框架基础

时间:2019-03-19 01:14:00      阅读:261      评论:0      收藏:0      [点我收藏+]

标签:数据库表   主表   web项目   install   查看   根目录   column   cno   sqlite3   

---恢复内容开始---

一: web 应用模式(有两种)

1: 前后端不分离(前端从后端直接获取数据)

技术图片

2: 前后端分离技术图片

二: api 接口

原因一: 为了在团队内部形成共识、防止个人习惯差异引起的混乱,我们需要找到一种大家都觉得很好的接口实现规范,
而且这种规范能够让后端写的接口,用途一目了然,减少双方之间的合作成本。 目前市面上大部分公司开发人员使用的接口服务架构主要有:restful、rpc。
1: rpc: 翻译成中文:远程过程调用[远程服务调用]. post请求 action=get_all_student&params=301&sex=1 原因二: 接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口 2: restful: 翻译成中文: 资源状态转换. 把后端所有的数据/文件都看成资源. 那么接口请求数据,本质上来说就是对资源的操作了. web项目中操作资源,无非就是增删查改.所以要求在地址栏中声明要操作的资源是什么,然后通过http请求动词来说明对资源进行哪一种操作. POST http://www.lufei.com/api/students/ 添加数据 GET http://www.lufei.com/api/students/ 获取所有学生

三: RESTful API规范

REST全称是Representational State Transfer,中文意思是表述(编者注:通常译为表征)性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。
而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
请求方法请求地址后端操作
GET /students 获取所有学生
POST /students 增加学生
GET /students/1 获取编号为1的学生
PUT /students/1 修改编号为1的学生
DELETE /students/1 删除编号为1的学生

事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口。参考文档:http://www.runoob.com/w3cnote/restful-architecture.html

四: 序列化

api接口开发,最核心最常见的一个过程就是序列化,所谓序列化就是把**数据转换格式**,序列化可以分两个阶段:
1. 序列化: 把我们识别的数据转换成指定的格式提供给别人。
例如:我们在django中获取到的数据默认是模型对象,但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。

2.反序列化:把别人提供的数据转换/还原成我们需要的格式。
例如:前端js提供过来的json数据,对于python而言就是字符串,我们需要进行反序列化换成模型类对象,这样我们才能把数据保存到数据库中。

5: Django Rest_Framework(DRF网络框架)

核心思想:缩减编写api接口的代码

中文文档:https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework

技术图片
Django REST framework是一个建立在Django基础之上的Web 应用开发框架,可以快速的开发REST API接口应用。在REST framework中,提供了序列化器Serialzier的定义,可以帮助我们简化序列化与反序列化的过程,不仅如此,还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
概述
技术图片
- 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
- 提供了丰富的类视图、Mixin扩展类,简化视图的编写;
- 丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
- 多种身份认证和权限认证方式的支持;[jwt]
- 内置了限流系统;
- 直观的 API web 界面;
- 可扩展性,插件丰富
特点

六: 安装及配置环境

1.部署环境

DRF需要以下依赖:
- Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
- Django (1.10, 1.11, 2.0)
-DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需从新创建。(若没有Django环境,需要先创建环境安装Django)
技术图片
1. 本地安装django项目
django-admin startproject drf

2. 创建子应用目录booktest,在项目根目录下执行以下命令
python manage.py startapp booktest

创建一个数据库,book
create database book charset=utf8;
grant all privileges on book.* to root@localhost identified by 123456;
flush privileges;

3. 配置数据库信息
   3.1 在主应用drf目录下的drf/__init__.py添加以下代码:
   import pymysql
   pymysql.install_as_MySQLdb()
   
   3.2 在项目配置文件中,settings中修改数据链接信息。
   
   DATABASES = {
    # ‘default‘: {
    #     ‘ENGINE‘: ‘django.db.backends.sqlite3‘,
    #     ‘NAME‘: os.path.join(BASE_DIR, ‘db.sqlite3‘),
    # }
    default: {
        ENGINE: django.db.backends.mysql,
        NAME: drf,
        USER: root,
        PASSWORD: 123456,
        HOST: 127.0.0.1,
        PORT: 3306,
    },
    }
新建项目及配置项目

2. 定义

  创建应用book_test,在book_test目录下的models.py中定义模型类,创建模型表

from django.db import models

#定义图书模型类BookInfo
class BookInfo(models.Model):
    btitle = models.CharField(max_length=20, verbose_name=图书标题)
    bpub_date = models.DateField(verbose_name=出版时间)
    bread = models.IntegerField(default=0, verbose_name=阅读量)
    bcomment = models.IntegerField(default=0, verbose_name=评论量)
    is_delete = models.BooleanField(default=False, verbose_name=逻辑删除)

    class Meta:
        db_table = tb_books  # 指明数据库表名
        verbose_name = 图书  # 在admin站点中显示的名称
        verbose_name_plural = verbose_name  # 显示的复数名称

    def __str__(self):
        """定义每个数据对象的显示信息"""
        return "图书:《"+self.btitle+""

#定义英雄模型类HeroInfo
class HeroInfo(models.Model):
    GENDER_CHOICES = (
        (0, female),
        (1, male)
    )
    hname = models.CharField(max_length=20, verbose_name=名称) 
    hgender = models.SmallIntegerField(choices=GENDER_CHOICES, default=0, verbose_name=性别)  
    hcomment = models.CharField(max_length=200, null=True, verbose_name=描述信息) 
    hbook = models.ForeignKey(BookInfo, on_delete=models.CASCADE, verbose_name=图书)  # 外键
    is_delete = models.BooleanField(default=False, verbose_name=逻辑删除)

    class Meta:
        db_table = tb_heros
        verbose_name = 英雄
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.hname
1) 数据库表名
模型类如果未指明表名,Django默认以 小写app应用名_小写模型类名 为数据库表名。
可通过db_table 指明数据库表名。
2) 关于主键
django会为表创建自动增长的主键列,每个模型只能有一个主键列,如果使用选项设置某属性为主键列后django不会再创建自动增长的主键列。

默认创建的主键列属性为id,可以使用pk代替,pk全拼为primary key。

3) 属性命名限制
- 不能是python的保留关键字。
- 不允许使用连续的下划线,这是由django的查询方式决定的。
- 定义属性时需要指定字段类型,通过字段类型的参数指定选项,语法如下:
  属性=models.字段类型(选项)
4)字段类型
类型说明
AutoField 自动增长的IntegerField,通常不用指定,不指定时Django会自动创建属性名为id的自动增长属性
BooleanField 布尔字段,值为True或False
NullBooleanField 支持Null、True、False三种值
CharField 字符串,参数max_length表示最大字符个数
TextField 大文本字段,一般超过4000个字符时使用
IntegerField 整数
DecimalField 十进制浮点数, 参数max_digits表示总位数, 参数decimal_places表示小数位数
FloatField 浮点数
DateField 日期, 参数auto_now表示每次保存对象时,自动设置该字段为当前时间,用于"最后一次修改"的时间戳,它总是使用当前日期,默认为False; 参数auto_now_add表示当对象第一次被创建时自动设置当前时间,用于创建的时间戳,它总是使用当前日期,默认为False; 参数auto_now_add和auto_now是相互排斥的,组合将会发生错误
TimeField 时间,参数同DateField
DateTimeField 日期时间,参数同DateField
FileField 上传文件字段
ImageField 继承于FileField,对上传的内容进行校验,确保是有效的图片
5)选项
选项说明
null 如果为True,表示允许为空,默认值是False
blank 如果为True,则该字段允许为空白,默认值是False
db_column 字段的名称,如果未指定,则使用属性的名称
db_index 若值为True, 则在表中会为此字段创建索引,默认值是False
default 默认
primary_key 若为True,则该字段会成为模型的主键字段,默认值是False,一般作为AutoField的选项使用
unique 如果为True, 这个字段在表中必须有唯一值,默认值是False

            null是数据库范畴的概念,blank是表单验证范畴的

6) 外键
在设置外键时,需要通过**on_delete**选项指明主表删除数据时,对于外键引用表数据如何处理,在django.db.models中包含了可选常量:
- **CASCADE** 级联,删除主表数据时连通一起删除外键表中数据
- **PROTECT** 保护,通过抛出**ProtectedError**异常,来阻止删除主表中被外键应用的数据
- **SET_NULL** 设置为NULL,仅在该字段null=True允许为null时可用
- **SET_DEFAULT** 设置为默认值,仅在该字段设置了默认值时可用
- **SET()** 设置为特定值或者调用特定方法,如
from django.conf import settings
from django.contrib.auth import get_user_model
from django.db import models

def get_sentinel_user():
    return get_user_model().objects.get_or_create(username=‘deleted‘)[0]

class MyModel(models.Model):
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.SET(get_sentinel_user),
    )
**DO_NOTHING** 不做任何操作,如果数据库前置指明级联性,此选项会抛出**IntegrityError**异常

3. 数据迁移(将模型类同步到数据库中)

1)生成迁移文件
python manage.py makemigrations
2)同步到数据库中
python manage.py migrate 

4.添加测试数据

技术图片
insert into tb_books(btitle,bpub_date,bread,bcomment,is_delete) values
(射雕英雄传,1980-5-1,12,34,0),
(天龙八部,1986-7-24,36,40,0),
(笑傲江湖,1995-12-24,20,80,0),
(雪山飞狐,1987-11-11,58,24,0);


insert into tb_heros(hname,hgender,hbook_id,hcomment,is_delete) values
(郭靖,1,1,降龙十八掌,0),
(黄蓉,0,1,打狗棍法,0),
(黄药师,1,1,弹指神通,0),
(欧阳锋,1,1,蛤蟆功,0),
(梅超风,0,1,九阴白骨爪,0),
(乔峰,1,2,降龙十八掌,0),
(段誉,1,2,六脉神剑,0),
(虚竹,1,2,天山六阳掌,0),
(王语嫣,0,2,神仙姐姐,0),
(令狐冲,1,3,独孤九剑,0),
(任盈盈,0,3,弹琴,0),
(岳不群,1,3,华山剑法,0),
(东方不败,0,3,葵花宝典,0),
(胡斐,1,4,胡家刀法,0),
(苗若兰,0,4,黄衣,0),
(程灵素,0,4,医术,0),
(袁紫衣,0,4,六合拳,0);
测试数据

使用pycharm插入数据 方法如下

第一步:

技术图片

第二部:

技术图片

第三步

技术图片

 5. 配置项目路由

1).在全局路由

  技术图片

技术图片
from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path(admin/, admin.site.urls),
    path(api/,include("booktest.urls"))
]
urls.py

2)在分支路由配置book_test下创建路由文件urls.py

from django.urls import path
from .views import BookAPI
urlpatterns={
    path(r"books/",BookAPI.as_view()),
}

6. 开发图书相关的数据接口的视图函数

技术图片
from django.shortcuts import render

# Create your views here.
# Create your views here.
# 图书相关的restful api接口
# 获取所有数据
# 添加一条数据
# 删除一条数据
# 修改一条数据
from   django.views import View
from  .models import BookInfo
from django.http.response import JsonResponse
class BookAPI(View):
    def get(self,request):
        ‘‘‘获取所有图书数据‘‘‘
        #1 操作数据库
        books=BookInfo.objects.all()
        #2 序列化转换数据
        data=[]
        for book in books:
            data.append({
                "id":book.id,
                "btitle":book.btitle,
            })
        #3 返回客户端
        #safe=false 不要对json数据进行安全监测,默认情况下jsonresponse
        #不能对列表数据进行转换json
        return JsonResponse(data,safe=False)
views.py

7. 运行项目 

python manage.py migrate

浏览器效果:
技术图片

 

 

 

 

 

 

 

 

 

---恢复内容结束---

一: DRF web应用框架基础

标签:数据库表   主表   web项目   install   查看   根目录   column   cno   sqlite3   

原文地址:https://www.cnblogs.com/liucsxiaoxiaobai/p/10556074.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!