Flask 视图 请求 序列化

最新推荐文章于 2023-07-17 16:11:18 发布
最新推荐文章于 2023-07-17 16:11:18 发布
阅读量363 收藏
点赞数 1
分类专栏： Flask 文章标签： python flask
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_47906106/article/details/123754820
版权

Flask-RESTful 是一个 Flask 扩展，它添加了快速构建 REST APIs 的支持。

环境安装

pip install flask-restful

构建RESTAPI

使用 flask-restful 构建RESTAPI只需要进行三步操作

  • 创建扩展/组件对象
组件对象 = Api(app)
  • 定义类视图
class 自定义视图类(Resource):
  • 组件添加类视图
组件对象.add_resource(视图类, URL资源段)

from flask import Flask
from flask_restful import Api, Resource

app = Flask(__name__)
# 1. 创建API对象  用于管理类视图(资源)
api = Api(app)


# 2.定义类视图  继承Resource
class DemoResource(Resource):
    def get(self):
        # 类视图响应的content-type默认变为json形式
        # 类视图的返回值可以是字典, 会被自动转为json字符串
        return {'foo': 'get'}

    def post(self):
        return {'foo': 'post'}


# 3.添加类视图  函数标记默认为类名小写
api.add_resource(DemoResource, '/', endpoint='demo')

# @app.route('/')
# def index():
#
#     return "index"

if __name__ == '__main__':
    print(app.url_map)
    app.run(debug=True)
  • 类视图的优点
    视图响应的 content-type 默认变为 JSON形式
    类视图的 返回值可以是字典, 会被自动转为json字符串
from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

def deco1(f):
    def wrapper(*args, **kwargs):
        print('deco1')
        return f(*args, **kwargs)

    return wrapper


def deco2(f):
    def wrapper(*args, **kwargs):
        print('deco2')
        return f(*args, **kwargs)

    return wrapper


class DemoResource(Resource):
    # 通过method_decorators类属性来设置类视图的装饰器
    # method_decorators = [deco1, deco2]  # 列表形式 所有请求方式都会使用
    method_decorators = {'get': [deco1], 'post': [deco2]}  # 字典形式 给请求方式分别设置装饰器

    # @deco2
    # @deco1
    def get(self):
        return {'foo': "get"}

    def post(self):
        return {'foo': "post"}


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

蓝图和类视图

蓝图和类视图可以配合使用, 步骤如下:
创建蓝图对象

蓝图对象 = Blueprint('蓝图名', __name__)

每个蓝图分别创建组件对象

组件对象 = Api(蓝图对象)

组件对象添加类视图

组件对象.add_resource(视图类, URL资源段)

应用注册蓝图

应用对象.register_blueprint(蓝图对象)

在 user包中创建 views文件, 定义类视图

# user/views.py

from flask_restful import Resource


class DemoResource(Resource):
    def get(self):
        return {'get': 'hello'}

    def post(self):
        return {'post': 'world'}

在 user包 的初始化文件 init.py 中

  • 创建蓝图对象
  • 通过蓝图对象创建对应的组件对象
  • 组件对象添加类视图
# user/__init__.py

from flask import Blueprint
from flask_restful import Api
from user.views import DemoResource

# 1.创建蓝图对象
user_blu = Blueprint('user', __name__, url_prefix='/user')

# 2.创建蓝图对应的api对象
user_api = Api(user_blu)

# 3.添加类视图
user_api.add_resource(DemoResource, '/')

想要让蓝图对象能够完成路由定义, 还需要 Flask应用注册蓝图对象

# main.py

from flask import Flask
from user import user_blu

app = Flask(__name__)
# 4.注册蓝图
app.register_blueprint(user_blu)


if __name__ == '__main__':
    print(app.url_map)
    app.run(debug=True, port=8000)

在这里插入图片描述

请求

1. 请求解析
通过前一阶段的学习, 我们知道 DRF框架 的核心功能 序列化器, 包括以下功能
反序列化

  • 参数解析 RequestParser
  • 数据保存

序列化
marshal函数

flask-restful 没有提供数据保存功能, 数据存储可以使用后续的flask-sqlalchemy扩展 来完成

RequestParser 负责请求解析工作, 基本步骤如下
创建请求解析器

请求解析器 = RequestParser()

添加参数规则

请求解析器.add_argument(参数名, 参数规则..)

执行解析

参数对象 = 请求解析器.parse_args()

获取参数

参数对象.参数名

from flask import Flask
from flask_restful import Resource, Api
from flask_restful.reqparse import RequestParser

app = Flask(__name__)
api = Api(app)


class DemoResource(Resource):
    def get(self):
        # 1.创建请求解析器
        parser = RequestParser()

        # 2.添加参数规则
        parser.add_argument('name')
        parser.add_argument('age')

        # 3.执行解析  默认会从 查询字符串/post键值对/post-json数据 进行参数提取
        args = parser.parse_args()

        # 4.获取参数
        print(args.name)
        print(args.age)

        return {'foo': "get"}


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

2.常用参数
在这里插入图片描述
default & required & location参数

from flask import Flask
from flask_restful import Resource, Api
from flask_restful.reqparse import RequestParser

app = Flask(__name__)
api = Api(app)


class DemoResource(Resource):
    def post(self):
        parser = RequestParser()

        parser.add_argument('name', required=True, location='json')
        parser.add_argument('age', default=10)

        args = parser.parse_args()

        print(args.name)
        print(args.age)

        return {'foo': "post"}


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

type参数
类型转换和格式校验

from flask import Flask
from flask_restful import Resource, Api
from flask_restful.reqparse import RequestParser
from flask_restful.inputs import *

app = Flask(__name__)
api = Api(app)

# 自定义函数进行参数校验和转换
def func1(value):  # 必须定义形参来接收传递来的参数
    if re.match(r'^user:', value):
        return value[5:] # 转换完, 还需要将结果返回
    else:
        raise ValueError('age参数格式错误')  # 校验失败, 会将错误信息以json形式返回


class DemoResource(Resource):
    def put(self):
        parser = RequestParser()

        parser.add_argument('name')
        # parser.add_argument('age', type=int)  # 转为int类型

        # parser.add_argument('age', type=boolean)  # 转为bool类型   1/0 true/false
        # parser.add_argument('age', type=date)  # 日期 转为datetime类型   YYYY-mm-dd
        # parser.add_argument('age', type=datetime_from_iso8601)  # 时间 转为datetime类型  2012-01-01T23:30:00+02:00
        # parser.add_argument('age', type=int_range(5, 10))  # 转为int类型 限定范围[5, 10]

        # parser.add_argument('age', type=regex(r'^1[3-9]\d{9}$'))  # 要求匹配正则
        parser.add_argument('age', type=func1)  # 自定义函数

        args = parser.parse_args()

        print(args.name)
        print(args.age)
        print(type(args.age))

        return {'foo': 'put'}


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

序列化

flask-restful 通过 marshal函数 来完成序列化处理
定义序列化规则

序列化规则 = {字段名: 序列化类型}

marshal函数 按照序列化规则 将模型对象转为字典

序列化后的字典 = marshal(模型对象, 序列化规则)

from flask import Flask
from flask_restful import Resource, Api, marshal_with, fields

app = Flask(__name__)
api = Api(app)

class User:  # 定义模型类
    def __init__(self):
        self.name = 'zs'
        self.age = 20
        self.height = 1.8
        self.scores = [80, 90]
        self.info = {
            'gender': True
        }


fields = {  # 序列化规则
    'username': fields.String(attribute='name'), # 指定对应的模型属性
    'age': fields.Integer(default=10),  # 设置默认值
    'height': fields.Float,
    'scores': fields.List(fields.Integer),  # 元素类型唯一
    'info': fields.Nested({'gender': fields.Boolean})
}


class DemoResource(Resource):
    method_decorators = {'post': [marshal_with(fields)]}
    def post(self):
        user1 = User()
        # 如果设置了marshal_with装饰器, 可以直接返回模型对象
        return user1


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

在这里插入图片描述
在这里插入图片描述
marshal_with 装饰器
在这里插入图片描述

实际开发中, 考虑到序列化的复杂性, 部分公司还会采用 自定义方法 的方式来完成序列化处理

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class User:
    def __init__(self):
        self.name = 'zs'
        self.age = 20
        self.height = 1.8
        self.scores = [80, 90]
        self.info = {
            'gender': True
        }

    def to_dict(self):  # 自定义模型转换方法
        return {
            'name': self.name,
            'age': self.age
        }


class DemoResource(Resource):
    def put(self):
        user1 = User()
        return user1.to_dict()


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

自定义JSON

实际开发中, 返回的JSON数据中除了包含基础数据, 往往还需要设置一些 统一的外层包装, 以便前端进行更好的解析处理, 如:

{
    "message": "ok",  // 外层包装
    "code": 200,  // 外层包装
    "data": {   // 基础数据
        "name": "张三",
        "age": 20
    }
}
  • flask-restful 提供了 api.representation()装饰器方法, 允许开发者自定义返回的数据格式
  • 在实现自定义JSON格式时, 可以参考 flask-restful 默认转换函数 (字典转json数据) 的源代码
  • 默认转换函数的源代码:
# flask_restful/representations/json.py

def output_json(data, code, headers=None):
    """Makes a Flask response with a JSON encoded body"""

    settings = current_app.config.get('RESTFUL_JSON', {})

    # If we're in debug mode, and the indent is not set, we set it to a
    # reasonable value here.  Note that this won't override any existing value
    # that was set.  We also set the "sort_keys" value.
    if current_app.debug:
        settings.setdefault('indent', 4)
        settings.setdefault('sort_keys', not PY3)

    # always end the json dumps with a new line
    # see https://github.com/mitsuhiko/flask/pull/1262
    dumped = dumps(data, **settings) + "\n"

    resp = make_response(dumped, code)
    resp.headers.extend(headers or {})
    return resp

from collections import OrderedDict
from json import dumps

from flask import Flask, current_app, make_response, Response
from flask_restful import Resource, Api
from six import PY3

app = Flask(__name__)
api = Api(app)


@api.representation('application/json')  # 指定响应形式对应的转换函数
def output_json(data, code, headers=None):
    """自定义json形式"""
    # 根据flask内置配置, 进行格式处理(缩进/key是否排序等)
    settings = current_app.config.get('RESTFUL_JSON', {})

    if current_app.debug:
        settings.setdefault('indent', 4)
        settings.setdefault('sort_keys', not PY3)

    # 添加json外层包装
    if 'message' not in data:  # 判断是否设置了自定义的错误信息
        data = {
            'message': 'ok',
            'data': data
        }

    # 字典转json字符串
    dumped = dumps(data, **settings) + "\n"

    # 构建响应对象
    resp = make_response(dumped, code)
    resp.headers.extend(headers or {})
    return resp


class DemoResource(Resource):
    def get(self):

        return {'foo': "get"}

    def post(self):
        return {'message': 'parameter error: name', "data": None}


api.add_resource(DemoResource, '/')


if __name__ == '__main__':
    app.run(debug=True)

在这里插入图片描述

实际开发中, 可能还会展开装饰器来设置自定义响应格式

def output_json(data, code, headers=None):
    """自定义json形式"""
    # 根据flask内置配置, 进行格式处理(缩进/key是否排序等)
    settings = current_app.config.get('RESTFUL_JSON', {})

    if current_app.debug:
        settings.setdefault('indent', 4)
        settings.setdefault('sort_keys', not PY3)

    # 添加json外层包装
    if 'message' not in data:  # 判断是否设置了自定义的错误信息
        data = {
            'message': 'ok',
            'data': data
        }

    # 字典转json字符串
    dumped = dumps(data, **settings) + "\n"

    # 构建响应对象
    resp = make_response(dumped, code)
    resp.headers.extend(headers or {})
    return resp


# 展开装饰器的形式设置自定义响应形式
api.representation('application/json')(output_json)
季布，
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
flask-serialize:使用SQLAlchemy的Flask应用程序的模型的读写JSON序列化
05-04
烧瓶序列化 使用SQLAlchemy对Flask应用程序进行PUT和POST写入的DB Model JSON序列化 安装 pip install flask-serialize 简单而快速地开始两个步骤。 .1。 导入FlaskSerializeMixin mixin并将其添加到模型中： from flask_serialize import FlaskSerialize # create a flask-serialize mixin instance from # the factory method `FlaskSerialize` fs_mixin = FlaskSerialize ( db ) class Item ( db . Model , fs_mixin ): id = db . Column ( db . Integer , primary_key = Tr
flask自定义序列化
baidu_36831253的博客
11-02 852
flask自定义序列化类
flask_restful扩展
weixin_46072106的博客
11-04 247
1. 视图 1.1 基本使用 1.2 类视图装饰器 1.3 蓝图和类视图 2. 请求 2.1 请求解析 2.2 参数详解 3. 响应 3.1 序列化 3.2 自定义json格式
Flask序列化
aimiandai4698的博客
01-09 1270
我们在做后台接口的时候，对于返回值，用的最多的就是json数据格式 flask中，返回json数据格式，我们可以用到flask的jsonify函数。 对于基础序列是可以直接序列化的，但是更多的情况下，我们要返回给前端的是一个从数据库查询的模型对象。那么要如何序列化一个模型对象呢？ 追踪flask源码，我们会发现，在处理特殊类型的数据的时候，flask用到了json包下的一个JSON...
flask orm序列化
weixin_44772419的博客
06-24 399
flask orm序列化,反序列化,marshmallow用法
工程硕士学位论文 基于Android+HTML5的移动Web项目高效开发探究
02-28
市场上相应的检测平台诸如检测通、凡特网等皆为pc端检测网站，并且操作繁琐不够人性化，用户在实地使用中存在很多问题。昆山工业技术研究院着眼于为委托用户和质检机构搭建良好的沟通桥梁，免去目前市场业务中企业...
ASP.NET4高级程序设计第4版 带目录PDF 分卷压缩包 part1
08-19
12.3　序列化 12.4　总结 第13章　LINQ 13.1　LINQ基础 13.1.1　延迟执行 13.1.2　LINQ是如何工作的 13.1.3　LINQ表达式 13.1.4　揭秘LINQ表达式 13.2　LINQ to DataSet 13.2.1　强类型的DataSet 13.2.2...
ASP.NET4高级程序设计(第4版) 3/3
10-29
12.3　序列化　423 12.4　总结　426 第13章　LINQ　427 13.1　LINQ基础　427 13.1.1　延迟执行　429 13.1.2　LINQ是如何工作的　429 13.1.3　LINQ表达式　430 13.1.4　揭秘LINQ表达式　436 13.2　LINQ to DataSet　...
flex3的cookbook书籍完整版dpf（包含目录）
07-14
使用IExternalizable接口自定义序列化 18.6节. 跟踪多个同时发生的服务调用的结果 18.7节. 使用发布/订阅消息 18.8节. 注册服务端数据类型 18.9节. 与WebService通信 18.10节. 添加SOAP头到WebSerice请求 18.11节. ...
Python Flask框架学习31：orm操作及序列化/更规范的文件格式
京斗码农的博客
05-21 492
文件树如下: 首先是utils包: functions.py配置代码如下: from flask_sqlalchemy import SQLAlchemy from flask_debugtoolbar import DebugToolbarExtension from flask_restful import Api from flask_marshmallow import Marshmallow db = SQLAlchemy() debugtoolbar = DebugToolb
关于flask的jsonify序列化dict后的结果会自动根据key的下标升序排列,希望dict原样返回的方法【重写jsonify方法】
weixin_43343144的博客
07-01 2739
from flask import current_app, json class GlobalJson: # 重写flask的jsonify方法【给json.dumps增加sort_keys=False属性,确保返回的dict原样输出-不参与key的排序】 def jsonify(*args, **kwargs): """ 修改flas...
Flask_使用flask_marshmallow序列化数据
GDYY3721的博客
07-16 1333
Flask_使用flask_marshmallow序列化数据
Flask SQLAlchemy_Serializer ORM模型序列化
最新发布
weixin_47906106的博客
07-17 1820
在前后端分离项目中，经常需要把ORM模型转化为字典，再将字典转化为JSON格式的字符串。在遇到sqlalchemy_serializer之前，我都是通过类似Java中的反射原理，获取当前ORM模型的所有字段，然后写一个to_dict方法来将字段以及他的值封装成字典。这种做法虽然一定程度上方便了开发，但也是带着枷锁跳舞，存在以下几个弊端：无法优雅的排除不需要序列化的字段。无法优雅的序列化多表之间的关系。
flask8:数据库对象序列化
梁景智的博客
03-09 1565
1.在数据对象基类上增加__getitem__ 与 keys 方法，使对象可以通过字典形式序列化 class Base(db.Model): __abstract__ = True create_date = Column('create_date', DateTime) invalid_date = Column('invalid_date', DateTime) ...
解决flask的序列化对象报错（TypeError: Object of type 'BookCollection' is not JSON serializable）
w_yuqing的博客
09-20 2388
出错场景： return jsonify(books) 解决办法： return json.dumps(books, default=lambda o: o.__dict__) 原理剖析： 首先我们知道flask的视图函数能够直接序列化字典，通常情况下对于序列化对象我们可以用 __dict__ (它能够将对象下面的所有属性序列化成字典)，但是当在对象的属性包含对象，那 么__dict__就会...
Flask 学习-36.Flask-RESTful 序列化输出对象
qq_27371025的博客
09-03 592
Flask-RESTful 提供了一种简单的方法来控制您在响应中实际呈现的数据。使用该fields模块，您可以在资源中使用所需的任何对象（ORM 模型/自定义类/等）。 fields还允许您格式化和过滤响应，因此您不必担心暴露内部数据结构。
flask-序列化
weixin_30553837的博客
08-20 610
序列化 示例代码 from flask import Flask from flask_restful import Resource, Api, marshal, fields, marshal_with app = Flask(__name__) api = Api(app) class User: def __init__(self): self.n...
Flask-SQLAlchemy资源序列化：将数据库的数据转化为JSON标准格式输出
雪月的博客
11-19 7814
我觉得最简单明了的就是在模型定义的时候给个序列化的方法，想要哪个或想变成其他格式都很方便，就是要多写一些代码 继承改写 flask 里面的 JSONEncoder，这个方法好像很好，但如何去除自己不想要的变量，不知道有没有可以参考的源代码，求解？ 也有说用 Marshmallow，看起来还要定义很多东西，不知道用的人多不多？ 方法一：见grey li书中例子：https://github.com/...
Django 模型 序列化 视图
06-06
在Django中，可以通过序列化模型来实现在视图中返回JSON数据等格式的数据。 以下是一个简单的示例，演示如何在Django视图中序列化模型： 1. 定义模型 ```python from django.db import models class Book(models...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

季布，

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值