flask入门教程之小项目实践

前面的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:[email protected]: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:[email protected]: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个章节没有对这个日志进行讲解，这里也忽略了，后续博主会持续学习，持续更新~