flask入门教程之小项目实践

news2024/11/15 10:38:52

前面的2个章节对flask的一些简单操作进行了说明（后面再慢慢补充进阶内容）
flask入门教程之请求与响应
flask入门教程之数据库保存
这个章节主要是根据前2个章节学到的内容，进行一个简单的学生信息增删改查的项目实践。

项目的简单介绍：

  • 学生信息包含：
    • 学生号，不超过20位，每个学生对应其唯一的学生号
    • 姓名：学生姓名，不超过30个字
    • 性别：单选“男”或“女”
    • 年级：数字类型，比如1表示一年级，2表示二年级，7表示初一

基本框架

按照restful风格，增、删、改、查对应的请求方式是：post、delete、put、get。我们按照该风格进行大体的设计，如下：

from flask import Flask
from flask_restx import Resource, Api, Namespace

app = Flask(__name__)
api = Api(app)
ns = Namespace("学生信息管理", description="对学生的增删改查操作")

@ns.route("/management")
class StudentManagement(Resource):


    def get(self):
        """
        根据学生号id或学生姓名name对数据库进行查询，并返回查询到的结果
        :return: 查询到的结果
        """
        return {"学生信息查询"}


    def post(self):
        """
        添加学生信息，如果学号id已被使用，则添加失败
        :return:
        """
        return {"学生信息添加"}

    def put(self):
        """
        修改学生信息，如果数据库查询id不存在，则修改失败
        :return:
        """
        return {"学生信息修改询"}

    def delete(self):
        """
        删除对应学号的学生信息（物理删除）
        :return:
        """
        return {"学生信息删除"}
        

api.add_namespace(ns, "/student")

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

结果如下：
在这里插入图片描述

请求方式确认好之后，我们的学生信息需要保存，本章是保存到本地的mysql数据库，根据ORM概念，我们使用SQLAIchemy库来创建表、操作表数据，表的定义如下：

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()
app.config["SQLALCHEMY_DATABASE_URI"] = "mysql+pymysql://root:wen@127.0.0.1:3306/test?charset=utf8"
db.init_app(app)

class StudentInfo(db.Model):
    id = db.Column(db.String(20), primary_key=True)
    name = db.Column(db.String(30), nullable=False)
    gender = db.Column(db.String(2), nullable=False)
    grade = db.Column(db.Integer)

if __name__ == "__main__":
    with app.app_context():
        db.create_all()

注意：表信息和请求逻辑代码，作者是放在一个模块（.py）下的，这里是为了方便阅读分开了，文章末尾会有完整的代码

接口实现

post请求

由于刚开始没有数据，所以我先实现了post请求。
添加学生信息的逻辑是：校验请求字段 --> 判断学生号是否已被使用 --> 数据库添加学生信息
代码如下：

@ns.route("/management")
class StudentManagement(Resource):
	...
    post_parser = api.parser()
    post_parser.add_argument("id", type=str, required=True, help="学号", location="json")
    post_parser.add_argument("name", type=str, required=True, help="姓名", location="json")
    post_parser.add_argument("gender", required=True, choices=("男", "女"), help="性别", location="json")
    post_parser.add_argument("grade", type=int, help="年级", location="json")
    @ns.expect(post_parser)
    def post(self):
        """
        添加学生信息，如果学号id已被使用，则添加失败
        :return:
        """
        # 对请求的数据字段值进行合理性校验
        # id必传且为纯数字，最大长度是20位
        id = request.json.get("id")
        if not id or not id.isdigit() or len(id) > 20:
            return {"status": 101, "message": "id值必传且必须为最长20位的纯数字"}

        # name必传且最多30个字
        name = request.json.get("name")
        if not name or len(name) > 30:
            return {"status": 102, "message": "name值必传且最多30个字"}

        # gender必传且必须为'男'或'女'
        gender = request.json.get("gender")
        if not gender or gender not in ("男", "女"):
            return {"status": 103, "message": "gender必传且必须为'男'或'女'"}

        # 年级必须是纯数字
        grade = request.json.get("grade")
        if grade and not str(grade).isdigit():
            return {"status": 104, "message": "grade必须是纯数字"}

        # 查询数据库，获取第一条数据
        res = StudentInfo.query.filter_by(id=id).first()
        if res:     # 如果第一条数据不为空，则表示该id已被使用，返回id已被使用的消息
            return {"status": 201, "message": f"{id}已被使用"}
        else:   # 如果第一条数据为空，则表示id还未被使用，进行数据库插入数据的操作
            s = StudentInfo(**request.json)
            db.session.add(s)
            db.session.commit()
            db.session.close()
            return {"status": 0, "message": f"{id}学生数据保存成功"}

get请求

get请求用来查询学生信息，可以根据学生号或学生姓名来查询
实现如下：

@ns.route("/management")
class StudentManagement(Resource):
    get_parser = api.parser()
    get_parser.add_argument("id", type=str, help="学号", location="args")
    get_parser.add_argument("name", type=str, help="姓名", location="args")
    @ns.expect(get_parser)
    def get(self):
        """
        根据学生号id或学生姓名name对数据库进行查询，并返回查询到的结果
        :return: 查询到的结果
        """
        id = request.args.get("id")
        name = request.args.get("name")
        if not id and not name:
            return {"status": 105, "message": "id或name至少一个有值"}

        # id必须为纯数字，最大长度是20位
        if id and (not id.isdigit() or len(id) > 20):
            return {"status": 101, "message": "id值必须为纯数字，且最长20位"}

        # name必传且最多30个字
        if name and len(name) > 30:
            return {"status": 102, "message": "name值最多30个字"}

        res = None
        if id:  # 如果id不为空，则根据id条件查询
            res = StudentInfo.query.filter_by(id=id)
            if name:    # 如果name不为空，则增加name的查询条件
                res = res.filter_by(name=name)
        else:   # 由于id和
            res = StudentInfo.query.filter_by(name=name)

        res = res.all()
        # 对数据进行封装并返回
        resp = []
        for si in res:
            data = {
                "id": si.id,
                "name": si.name,
                "gender": si.gender,
                "grade": si.grade
            }
            resp.append(data)

        return {"status": 0, "data": resp}

put请求

put请求是修改学生信息，逻辑是：如果学生号存在，修改学生号对应的学生信息，比如姓名、性别、年级；学生号不存在则返回相关错误信息

@ns.route("/management")
class StudentManagement(Resource):
    put_parser = api.parser()
    put_parser.add_argument("id", help="待修改学生的学号", type=str, location="json", required=True)
    put_parser.add_argument("name", help="修改后的姓名", type=str, location="json")
    put_parser.add_argument("gender", help="修改后的性别", type=str, location="json")
    put_parser.add_argument("grade", help="修改后的年级", type=int, location="json")
    @ns.expect(put_parser)
    def put(self):
        """
        修改学生信息，如果数据库查询id不存在，则修改失败
        :return:
        """
        # 对请求数据进行字段校验
        id = request.json.get("id")
        if not id or not id.isdigit() or len(id) > 20:
            return {"status": 101, "message": "id必传且为纯数字，最长20位数字"}
        name = request.json.get("name")
        if name and len(name) > 30:
            return {"status": 102, "message": "name值最多30个字"}
        gender = request.json.get("gender")
        if gender and gender not in ("男", "女"):
            return {"status": 103, "message": "gender必须为'男'或'女'"}
        grade = request.json.get("grade")
        if grade and not str(grade).isdigit():
            return {"status": 104, "message": "grade必须是纯数字"}

        # 根据id对对应的学生信息进行修改
        res = StudentInfo.query.filter_by(id=id).first()
        if not res:     # 如果res为空，则表示数据库中没有该学生，修改失败
            return {"status": 202, "message": f"未找到学生号{id}的信息，修改失败"}
        # 根据上传的字段对查询到的数据进行修改
        if name:
            res.name = name
        if gender:
            res.gender = gender
        if grade:
            res.grade = grade
        db.session.commit()
        db.session.close()
        return {"status": 0, "message": f"学生号为{id}的学生信息修改成功"}

delete请求

delete请求用来删除学生信息，根据上传的id号删除学生信息，如果学生信息没有查询到，则返回错误信息

@ns.route("/management")
class StudentManagement(Resource):
    delete_parser = api.parser()
    delete_parser.add_argument("id", type=str, help="待删除学生的学生号", location="json")
    @ns.expect(delete_parser)
    def delete(self):
        """
        删除对应学号的学生信息（物理删除）
        :return:
        """
        # 对id字段值进行校验
        id = request.json.get("id")
        if not id or len(id) > 20:
            return {"status": 101, "message": "id必传且为纯数字，最长20位数字"}

        res = StudentInfo.query.filter_by(id=id).first()
        if not res:     # 若数据库查询为空，表示不存在对应学号的学生
            return {"status": 203, "message": f"未找到学生号{id}的信息，删除失败"}
        db.session.delete(res)
        db.session.commit()
        db.session.close()
        return {"status": 0, "message": f"学生号为{id}的学生信息删除成功"}

调试

在单个接口请求实现后，都会去发送请求查看接口实现是否OK，错误的地方就会进行修改，比如delete我一开始delete_parser.add_argument()忘了传入location参数，所以界面默认使用的是url参数传入，但我id又写的是从request.json中获取的，导致发送请求一直返回id未传的错误信息。
启动服务后，会在mysql中自动创建student_info表
在这里插入图片描述
发送post请求，返回添加成功的信息后，在student_info表中可以看到对应的数据：
在这里插入图片描述
get请求查询数据：
在这里插入图片描述
put请求修改数据：
在这里插入图片描述
delete请求：
在这里插入图片描述

附录代码及说明

完整代码如下：

from flask import Flask, request
from flask_restx import Resource, Api, Namespace
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
api = Api(app)
ns = Namespace("学生信息管理", description="对学生的增删改查操作")

db = SQLAlchemy()
app.config["SQLALCHEMY_DATABASE_URI"] = "mysql+pymysql://root:wen@127.0.0.1:3306/test?charset=utf8"
db.init_app(app)

class StudentInfo(db.Model):
    id = db.Column(db.String(20), primary_key=True)
    name = db.Column(db.String(30), nullable=False)
    gender = db.Column(db.String(2), nullable=False)
    grade = db.Column(db.Integer)

@ns.route("/management")
class StudentManagement(Resource):

    get_parser = api.parser()
    get_parser.add_argument("id", type=str, help="学号", location="args")
    get_parser.add_argument("name", type=str, help="姓名", location="args")
    @ns.expect(get_parser)
    def get(self):
        """
        根据学生号id或学生姓名name对数据库进行查询，并返回查询到的结果
        :return: 查询到的结果
        """
        id = request.args.get("id")
        name = request.args.get("name")
        if not id and not name:
            return {"status": 105, "message": "id或name至少一个有值"}

        # id必须为纯数字，最大长度是20位
        if id and (not id.isdigit() or len(id) > 20):
            return {"status": 101, "message": "id值必须为纯数字，且最长20位"}

        # name必传且最多30个字
        if name and len(name) > 30:
            return {"status": 102, "message": "name值最多30个字"}

        res = None
        if id:  # 如果id不为空，则根据id条件查询
            res = StudentInfo.query.filter_by(id=id)
            if name:    # 如果name不为空，则增加name的查询条件
                res = res.filter_by(name=name)
        else:   # 由于id和
            res = StudentInfo.query.filter_by(name=name)

        res = res.all()
        # 对数据进行封装并返回
        resp = []
        for si in res:
            data = {
                "id": si.id,
                "name": si.name,
                "gender": si.gender,
                "grade": si.grade
            }
            resp.append(data)

        return {"status": 0, "data": resp}

    post_parser = api.parser()
    post_parser.add_argument("id", type=str, required=True, help="学号", location="json")
    post_parser.add_argument("name", type=str, required=True, help="姓名", location="json")
    post_parser.add_argument("gender", required=True, choices=("男", "女"), help="性别", location="json")
    post_parser.add_argument("grade", type=int, help="年级", location="json")
    @ns.expect(post_parser)
    def post(self):
        """
        添加学生信息，如果学号id已被使用，则添加失败
        :return:
        """
        # 对请求的数据字段值进行合理性校验
        # id必传且为纯数字，最大长度是20位
        id = request.json.get("id")
        if not id or not id.isdigit() or len(id) > 20:
            return {"status": 101, "message": "id值必传且必须为最长20位的纯数字"}

        # name必传且最多30个字
        name = request.json.get("name")
        if not name or len(name) > 30:
            return {"status": 102, "message": "name值必传且最多30个字"}

        # gender必传且必须为'男'或'女'
        gender = request.json.get("gender")
        if not gender or gender not in ("男", "女"):
            return {"status": 103, "message": "gender必传且必须为'男'或'女'"}

        # 年级必须是纯数字
        grade = request.json.get("grade")
        if grade and not str(grade).isdigit():
            return {"status": 104, "message": "grade必须是纯数字"}

        # 查询数据库，获取第一条数据
        res = StudentInfo.query.filter_by(id=id).first()
        if res:     # 如果第一条数据不为空，则表示该id已被使用，返回id已被使用的消息
            return {"status": 201, "message": f"{id}已被使用"}
        else:   # 如果第一条数据为空，则表示id还未被使用，进行数据库插入数据的操作
            s = StudentInfo(**request.json)
            db.session.add(s)
            db.session.commit()
            db.session.close()
            return {"status": 0, "message": f"{id}学生数据保存成功"}

    put_parser = api.parser()
    put_parser.add_argument("id", help="待修改学生的学号", type=str, location="json", required=True)
    put_parser.add_argument("name", help="修改后的姓名", type=str, location="json")
    put_parser.add_argument("gender", help="修改后的性别", type=str, location="json")
    put_parser.add_argument("grade", help="修改后的年级", type=int, location="json")
    @ns.expect(put_parser)
    def put(self):
        """
        修改学生信息，如果数据库查询id不存在，则修改失败
        :return:
        """
        # 对请求数据进行字段校验
        id = request.json.get("id")
        if not id or not id.isdigit() or len(id) > 20:
            return {"status": 101, "message": "id必传且为纯数字，最长20位数字"}
        name = request.json.get("name")
        if name and len(name) > 30:
            return {"status": 102, "message": "name值最多30个字"}
        gender = request.json.get("gender")
        if gender and gender not in ("男", "女"):
            return {"status": 103, "message": "gender必须为'男'或'女'"}
        grade = request.json.get("grade")
        if grade and not str(grade).isdigit():
            return {"status": 104, "message": "grade必须是纯数字"}

        # 根据id对对应的学生信息进行修改
        res = StudentInfo.query.filter_by(id=id).first()
        if not res:     # 如果res为空，则表示数据库中没有该学生，修改失败
            return {"status": 202, "message": f"未找到学生号{id}的信息，修改失败"}
        # 根据上传的字段对查询到的数据进行修改
        if name:
            res.name = name
        if gender:
            res.gender = gender
        if grade:
            res.grade = grade
        db.session.commit()
        db.session.close()
        return {"status": 0, "message": f"学生号为{id}的学生信息修改成功"}

    delete_parser = api.parser()
    delete_parser.add_argument("id", type=str, help="待删除学生的学生号", location="json")
    @ns.expect(delete_parser)
    def delete(self):
        """
        删除对应学号的学生信息（物理删除）
        :return:
        """
        # 对id字段值进行校验
        id = request.json.get("id")
        if not id or len(id) > 20:
            return {"status": 101, "message": "id必传且为纯数字，最长20位数字"}

        res = StudentInfo.query.filter_by(id=id).first()
        if not res:     # 若数据库查询为空，表示不存在对应学号的学生
            return {"status": 203, "message": f"未找到学生号{id}的信息，删除失败"}
        db.session.delete(res)
        db.session.commit()
        db.session.close()
        return {"status": 0, "message": f"学生号为{id}的学生信息删除成功"}

api.add_namespace(ns, "/student")

if __name__ == "__main__":
    with app.app_context():
        db.create_all()
        app.run(debug=True)

说明：其实这段代码还有需要完善的地方，比如数据库数据操作部分，需要考虑到数据库服务异常的情况，但是这里没有考虑到，我们可以使用try/except对异常进行输出，尽量不将程序执行异常的信息直接发送出去。还有一个是日志输出，考虑到前面的2个章节没有对这个日志进行讲解，这里也忽略了，后续博主会持续学习，持续更新~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/57949.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

学习Java编程知识 必知要点

学习Java编程知识 必知要点

Java 是全球最受欢迎的编程语言之一，在世界编程语言排行榜 TIOBE 中，Java 一直霸占着前三名，有好多年甚至都是第一名。那么如此强大的Java你真的了解他的知识体系吗？他的学习路线你知道吗？ 1. Java虚拟机——JVM JVM&a…
阅读更多...
启动eureka服务端客户端报java.net.ConnectException: Connection refused: connect的错误

启动eureka服务端客户端报java.net.ConnectException: Connection refused: connect的错误

Request execution failed with message: java.net.ConnectException: Connection refused: connect1.先检查eureka服务端和客户端模块中的pom文件中是否引入了相对应的server和client的依赖 2.主启动类上是否加了对应启动注解： EnableEurekaServer //服务端的启动…
阅读更多...
frp内网穿透搭建-宝塔版

frp内网穿透搭建-宝塔版

一、搭建frp准备 下载frp部署文件：https://github.com/fatedier/frp/releases把防火墙安全端口打开，默认7500，7000，其他的自行设置打开，如阿里云服务器要打开端口规则。 二、配置frps服务端 把frps、frps.ini、LICE…
阅读更多...
Java并发编程—java异步Future的迭代过程

Java并发编程—java异步Future的迭代过程

在我们java多线程中，我想做一件事儿，但是我又不想影响主线程的执行，很多铁子都会想到用异步任务完成，这个时候我们的主角FutureTask就登场了。 一、FutureTask介绍 FutureTask提供了对Future的基本实现，是一个可取消的…
阅读更多...
aws batch 在eks上配置计算环境和提交任务

aws batch 在eks上配置计算环境和提交任务

文档 Getting started with Amazon Batch on Amazon EKSAmazon EKS jobsMemory and vCPU considerations for Amazon Batch on Amazon EKS batch不会管理集群，只是会管理节点（自动扩缩）并运行任务。batch在eks中单独管理自身资源&#xff0…
阅读更多...
异常Exception

异常Exception

1.异常是什么？ 程序中可能出出现的问题 2.异常体系的最上层父类是谁？异常分为几类 父类：Exception 异常分为两类：编译时异常、运行时异常 3.编译时异常和运行时异常的区别 编译时异常：除了RuntimeException和他的子类…
阅读更多...
华为悦盒ec6108v9c使用ADB卡刷Linux（Ubuntu）

华为悦盒ec6108v9c使用ADB卡刷Linux（Ubuntu）

1. adb连接华为ec6108v9c： adb连接盒子IP: adb connect 192.168.3.4进入adb shell: adb shell在安卓后台终端输入以下命令，读取盒子的 reg name 管脚对应名称: cat /dev/block/mmcblk0p1 | grep -a hi3798m 2. 用Hitool工具制作对应你盒子reg名称的烧…
阅读更多...
Python测试进阶（一）

Python测试进阶（一）

文章目录测试框架pytestMarkskip参数化异常处理数据驱动Allure集成生成报告Fixture基操作用域yield数据共享自动应用参数化ini运行规则配置命令行参数指定/忽略执行目录配置日志插件开发常用插件分布式并发自定义插件打包发布hook小结测试框架 先了解unittest问题分析 自动化测…
阅读更多...
SAS，Stata，HLM，R，SPSS和Mplus分层线性模型HLM分析学生受欢迎程度数据

SAS，Stata，HLM，R，SPSS和Mplus分层线性模型HLM分析学生受欢迎程度数据

全文链接：http://tecdat.cn/?p10809本文用于比较六个不同统计软件程序（SAS，Stata，HLM，R，SPSS和Mplus）的两级分层线性模型的过程和输出（点击文末“阅读原文”获取完整代码数据&#…
阅读更多...
Java项目：SSM学生会管理系统

Java项目：SSM学生会管理系统

作者主页：源码空间站2022 简介：Java领域优质创作者、Java项目、学习资料、技术互助 文末获取源码 项目介绍 本项目分为管理员、学生两种角色， 管理员角色包含以下功能： 管理员登陆,管理学生,管理机构,活动信息发布,部门管理,职位…
阅读更多...
仿SpringBoot启动Dome实现

仿SpringBoot启动Dome实现

文章目录前言环境搭建依赖项目结构实现启动获取服务器自动配置启动Tomcat总结前言 填一下以前这篇博文：如何纯注解整合Spring SpringMVC Mybatis埋下的坑，我们来简单的了解一下SpringBoot它做的一些自动配置是怎么一回事，同时也看看SpringBo…
阅读更多...
【人民币识别】人民币序列号识别【含GUI Matlab源码 908期】

【人民币识别】人民币序列号识别【含GUI Matlab源码 908期】

⛄一、简介 本文描述的人民币序列号识别系统实现了从图像预处理到识别结果的过程, 而序列号识别是本文的重要内容.以序列号区域为研究对象, 主要包括图像预处理、图像分割以及序列号识别等过程。 1 图像预处理 人民币图像总体上来说灰度偏高, 灰度值基本上都大于150 (对8位25…
阅读更多...
具有平滑正曲线边界的一般凸体的精确闭式闵可夫斯基研究（Matlab代码实现）

具有平滑正曲线边界的一般凸体的精确闭式闵可夫斯基研究（Matlab代码实现）

👨‍🎓个人主页：研学社的博客 💥💥💞💞欢迎来到本博客❤️❤️💥💥 🏆博主优势：🌞🌞🌞博客内容尽量做到思维缜…
阅读更多...
Minecraft 1.19.2 Forge模组开发 04.动画效果物品

Minecraft 1.19.2 Forge模组开发 04.动画效果物品

我们本次实现一个具有动画效果的物品，本次演示的模型代码均在文末给出 效果演示效果演示效果演示 首先，请确保你的开发包中引入了geckolib依赖，相关教程请参考:Minecraft 1.19.2 Forge模组开发 03.动画生物实体 1.首先我们要使用geckolib制…
阅读更多...
（三）操作系统的运行环境

（三）操作系统的运行环境

文章目录一、操作系统的运行机制1. 时钟管理2. 中断机制3. 原语4. 系统数据结构5. 系统调用二、操作系统体系结构1. 传统的操作系统结构（大内核）第一代：无结构OS第二代：模块化结构OS：模块-接口法OS第三代：分…
阅读更多...
[附源码]计算机毕业设计springboot学习帮扶网站设计与实现

[附源码]计算机毕业设计springboot学习帮扶网站设计与实现

项目运行 环境配置： Jdk1.8 Tomcat7.0 Mysql HBuilderX（Webstorm也行） Eclispe（IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持）。 项目技术： SSM mybatis Maven Vue 等等组成，B/S模式 M…
阅读更多...
坦克大战②

坦克大战②

1. 我方坦克发射单颗子弹 当发射一颗子弹后，就相当于启动一个线程来控制它的位置坐标；Hero[我方坦克]有子弹的对象，当按下J时，就创建一个发射子弹的线程，通过坐标变化让子弹不停的移动，形成一个射击的效果&…
阅读更多...
redis 集群搭建的三种方式

redis 集群搭建的三种方式

文章目录一、Redis主从二、Redis哨兵三、Redis集群一、Redis主从 二、Redis哨兵 三、Redis集群 下载redis wget http://download.redis.io/releases/redis-5.0.3.tar.gz解压redis tar zxvf redis-5.0.3.tar.gz进行重命名 mv redis-5.0.3 redis安装gcc yum install gcc进入red…
阅读更多...
如何学习一门技术

如何学习一门技术

如何学习一门技术 同样的生活，在你经历了一些意外和不如意之后，你再回过头来看，之前你所抱怨的生活其实是一个蛮不错的生活。 罗翔：每一个人都应该拥有学习的能力和权力，真正的知识要能走出书斋，去影响每…
阅读更多...
StarkNet 性能路线图

StarkNet 性能路线图

目录 前言 区块限制：Validity Rollups vs L1 为什么 L1 吞吐量有限？ 为什么相同的障碍不影响validity rollups？ Sequencer 并行化 Cairo-VM 的新 Rust 实现 Rust 对 sequencer重新实现 Provers呢？ Summary 参考 前言 St…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023