フラスコ導入チュートリアルの小さなプロジェクトの実践

開発 2023-04-08 18:04:10 訪問数: null

前の 2 つの章では、flask の簡単な操作について説明しました (高度な内容は後で徐々に追加されます)
フラスコ入門チュートリアルのリクエストと応答
フラスコ入門チュートリアルのデータベース ストレージ
この章は、主に最初の 2 つの章で学んだ内容に基づいています章 , 生徒の情報を追加、削除、変更、確認する簡単なプロジェクトの練習を行います。

プロジェクトの簡単な紹介:

  • 学生情報には以下が含まれます。
    • 学生番号は 20 文字以内で、各学生は一意の学生番号に対応しています
    • 名前：学生名、30文字以内
    • 性別：「男性」または「女性」を1つ選択
    • Grade: 数値タイプ。たとえば、1 は 1 年生、2 は 2 年生、7 は 1 年生を意味します。

基本的な枠組み

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）下的，这里是为了方便阅读分开了，文章末尾会有完整的代码

インターフェイスの実装

投稿リクエスト

最初はデータがないので、投稿リクエストを先に実装しました。
学生情報を追加するロジックは、リクエスト フィールドを確認する-->学生番号が使用されているかどうかを判断する-->学生情報をデータベースに追加する、というものです。
コードは次のとおりです。

@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 リクエストは、学生 ID または学生名に基づいてクエリできる学生情報を照会するために使用されます。
実装は次のとおりです。

@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リクエストは生徒情報を変更するもので、論理的には、学籍番号が存在する場合は、学籍番号に対応する氏名、性別、学年などの学籍番号を変更し、学籍番号が存在しない場合は該当する学籍番号を返すというロジックです。エラーメッセージ

@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}的学生信息修改成功"}

リクエストを削除

削除リクエストは、生徒情報の削除、アップロードされた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 かどうかを確認するリクエストが送信され、削除などの間違った場所が変更されます。そのため、インターフェイスはデフォルトで url パラメータを使用します. 渡されましたが、私の ID は request.json から取得するように記述されていたため、送信リクエストは常に ID が渡されなかったというエラー メッセージを返します.
サービス開始後、mysqlにstudent_infoテーブルが自動作成されるので、
ここに画像の説明を挿入
POSTリクエストを送信し、追加が成功したという情報を返すと、student_infoテーブルの対応するデータを見ることができます: get request
ここに画像の説明を挿入
query data:
ここに画像の説明を挿入
put request modifyデータ:
ここに画像の説明を挿入
削除リクエスト:
ここに画像の説明を挿入

付録コードと説明

完全なコードは次のとおりです。

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 を使用して、プログラムを実行しないようにし、異常な情報を直接送信します。もう1つはログ出力. 前の2つの章ではこのログについて説明していなかったため、ここでは無視します. フォローアップブロガーは引き続き学習して更新します~

おすすめ

転載: blog.csdn.net/wenxiaoba/article/details/128159651
おすすめ
openKylinコミュニティ生態委員会の第6回会議が無事に開催されました
Alibaba Cloud、Tongyi Qianwen 2.5を正式リリース
Python 3.13 が最初のベータ版をリリース: 実験的なフリー スレッド モードと JIT、改善された対話型インタープリター
Stack Overflow は私のコードを使用して大規模な AI モデルをトレーニングし、私のアカウントを禁止しました。
Pop!_OS の COSMIC デスクトップが App Store のリストに掲載される
レポート: Django は依然として 74% の開発者にとって第一の選択肢です
「2024年第1四半期のインターネット投融資業務」調査レポート
15 年前、彼は「FFmpeg 恥の柱」に立っていたのに、今でも私たちに感謝しなければなりません - Tencent QQPlayer はその恥を晴らしますか?
ランキング
ブルーブリッジカップクロップハイブリッド（再帰的）
java线程、线程池
关于毕业前后的道路
JVMの基本
OpenCV ヒストグラムの原理と表示、マスキング、イコライゼーション、適応イコライゼーション
PHPのAES暗号化と復号化、MCRYPT_ENCRYPTとopenssl_encrypt
スコアボードを回転poj3335
Vueで要求されたデータ：タイムスタンプ変換時間
Javaの合併のpng画像
HttpServletResponseアプリケーションリクエストのリダイレクト
アーカイブ
もっと
2024-05-10(33)
2024-05-09(30)
2024-05-08(18)
2024-05-07(34)
2024-05-06(6)
2024-05-05(0)
2024-05-04(18)
2024-05-03(8)
2024-05-02(0)
2024-05-01(4)

コードワールド

© 2018 codetd.com