refactor(api):移除marshal序列化

2021-12-07 20:24:07 +08:00
parent 9490ccb7c0
commit 820ab9f5c6
13 changed files with 282 additions and 172 deletions
@@ -21,16 +21,22 @@ def create_app(config_name=None):
    # 引入数据库配置
    app.config.from_object(common)
    app.config.from_object(config[config_name])
+
    # 注册各种插件
    init_plugs(app)

    # 注册路由
    init_view(app)
+
+    # 注册接口（restful api）
    init_api(app)
+
    # 文件上传
    configure_uploads(app, photos)

-    logo()
+    if os.environ.get('WERKZEUG_RUN_MAIN') == 'true':
+        logo()
+
    return app


@@ -1,6 +1,5 @@
 from flask import jsonify
-from flask_restful import Resource
-from flask_restful import marshal, reqparse
+from flask_restful import Resource, reqparse

 from applications.common.utils.http import success_api, fail_api
 from applications.extensions import db
@@ -14,9 +13,23 @@ class DepartmentsResource(Resource):
        # TODO dtree 需要返回状态信息
        res = {
            "status": {"code": 200, "message": "默认"},
-            "data": marshal(dept_data, CompanyDepartment.fields())
+            "data": [
+
+                {
+                    'deptId': item.id,
+                    'parentId': item.parent_id,
+                    'deptName': item.dept_name,
+                    'sort': item.sort,
+                    'leader': item.leader,
+                    'phone': item.phone,
+                    'email': item.email,
+                    'status': item.status,
+                    'comment': item.comment,
+                    'address': item.address,
+                    'create_at': item.create_at.strftime('%Y-%m-%d %H:%M:%S')
+                } for item in dept_data
+            ]
        }
-        print(dept_data)
        return jsonify(res)

    def post(self):
@@ -3,7 +3,7 @@ from collections import OrderedDict

 from flask import request, jsonify, current_app
 from flask_login import current_user
-from flask_restful import Resource, reqparse, marshal
+from flask_restful import Resource, reqparse

 from applications.common.utils.http import success_api, fail_api
 from applications.extensions import db
@@ -12,58 +12,61 @@ from applications.models import RightsPower, RightsRole

 def get_render_config():
    # 网站配置
-    config = dict(logo={
-        # 网站名称
-        "title": current_app.config.get("SYSTEM_NAME"),
-        # 网站图标
-        "image": "/static/admin/admin/images/logo.png"
-        # 菜单配置
-    }, menu={
-        # 菜单数据来源
-        "data": "/api/v1/rights/menu",
-        "collaspe": True,
-        # 是否同时只打开一个菜单目录
-        "accordion": True,
-        "method": "GET",
-        # 是否开启多系统菜单模式
-        "control": False,
-        # 默认选中的菜单项
-        "select": "0",
-        # 是否开启异步菜单，false 时 data 属性设置为菜单数据，false 时为 json 文件或后端接口
-        "async": True
-    }, tab={
-        # 是否开启多选项卡
-        "muiltTab": True,
-        # 切换选项卡时，是否刷新页面状态
-        "keepState": True,
-        # 是否开启 Tab 记忆
-        "session": True,
-        # 最大可打开的选项卡数量
-        "tabMax": 30,
-        "index": {
-            # 标识 ID , 建议与菜单项中的 ID 一致
-            "id": "10",
-            # 页面地址
-            "href": "/admin/welcome",
-            # 标题
-            "title": "首页"
-        }
-    }, theme={
-        # 默认主题色，对应 colors 配置中的 ID 标识
-        "defaultColor": "2",
-        # 默认的菜单主题 dark-theme 黑 / light-theme 白
-        "defaultMenu": "dark-theme",
-        # 是否允许用户切换主题，false 时关闭自定义主题面板
-        "allowCustom": True
-    }, colors=[{
-        "id": "1",
-        "color": "#2d8cf0"
-    },
-        {
+    config = {
+        'logo': {
+            # 网站名称
+            "title": current_app.config.get("SYSTEM_NAME"),
+            # 网站图标
+            "image": "/static/admin/admin/images/logo.png"
+            # 菜单配置
+        },
+        'menu': {
+            # 菜单数据来源
+            "data": "/api/v1/rights/menu",
+            "collaspe": True,
+            # 是否同时只打开一个菜单目录
+            "accordion": True,
+            "method": "GET",
+            # 是否开启多系统菜单模式
+            "control": False,
+            # 默认选中的菜单项
+            "select": "0",
+            # 是否开启异步菜单，false 时 data 属性设置为菜单数据，false 时为 json 文件或后端接口
+            "async": True
+        },
+        'tab': {
+            # 是否开启多选项卡
+            "muiltTab": True,
+            # 切换选项卡时，是否刷新页面状态
+            "keepState": True,
+            # 是否开启 Tab 记忆
+            "session": True,
+            # 最大可打开的选项卡数量
+            "tabMax": 30,
+            "index": {
+                # 标识 ID , 建议与菜单项中的 ID 一致
+                "id": "10",
+                # 页面地址
+                "href": "/admin/welcome",
+                # 标题
+                "title": "首页"
+            }
+        },
+        'theme': {
+            # 默认主题色，对应 colors 配置中的 ID 标识
+            "defaultColor": "2",
+            # 默认的菜单主题 dark-theme 黑 / light-theme 白
+            "defaultMenu": "dark-theme",
+            # 是否允许用户切换主题，false 时关闭自定义主题面板
+            "allowCustom": True
+        },
+        'colors': [{
+            "id": "1",
+            "color": "#2d8cf0"
+        }, {
            "id": "2",
            "color": "#5FB878"
-        },
-        {
+        }, {
            "id": "3",
            "color": "#1E9FFF"
        }, {
@@ -72,13 +75,16 @@ def get_render_config():
        }, {
            "id": "5",
            "color": "darkgray"
-        }
-    ], links=current_app.config.get("SYSTEM_PANEL_LINKS"), other={
-        # 主页动画时长
-        "keepLoad": 1200,
-        # 布局顶部主题
-        "autoHead": False
-    }, header=False)
+        }],
+        'links': current_app.config.get("SYSTEM_PANEL_LINKS"),
+        'other': {
+            # 主页动画时长
+            "keepLoad": 1200,
+            # 布局顶部主题
+            "autoHead": False
+        },
+        'header': False
+    }
    return config


@@ -99,7 +105,23 @@ def make_menu_tree():
            if p.type == 0 or p.type == 1:
                powers.append(p)

-    power_dict = marshal(powers, RightsPower.fields2())  # 生成可序列化对象
+    # power_dict = marshal(powers, RightsPower.fields2())  # 生成可序列化对象
+    power_dict = [
+        {
+            'id': item.id,
+            'title': item.name,
+            'type': item.type,
+            'code': item.code,
+            'href': item.url,
+            'openType': item.open_type,
+            'parent_id': item.parent_id,
+            'icon': item.icon,
+            'sort': item.sort,
+            'enable': item.enable,
+            'update_at': item.update_at.strftime('%Y-%m-%d %H:%M:%S'),
+            'create_at': item.create_at.strftime('%Y-%m-%d %H:%M:%S'),
+        } for item in powers
+    ]
    power_dict.sort(key=lambda x: x['id'], reverse=True)

    menu_dict = OrderedDict()
@@ -156,12 +178,26 @@ class RightRightsResource(Resource):
        """获取选择父节点"""

        power = RightsPower.query.all()
-        power_data = marshal(power, RightsPower.fields())
+        # power_data = marshal(power, RightsPower.fields())
+        power_data = [
+            {
+                'powerId': item.id,
+                'powerName': item.name,
+                'powerType': item.type,
+                'powerUrl': item.url,
+                'openType': item.open_type,
+                'parentId': item.parent_id,
+                'icon': item.icon,
+                'sort': item.sort,
+                'create_at': item.create_at.strftime('%Y-%m-%d %H:%M:%S'),
+                'update_at': item.update_at.strftime('%Y-%m-%d %H:%M:%S'),
+                'enable': item.enable,
+            } for item in power
+        ]
        power_data.append({"powerId": 0, "powerName": "顶级权限", "parentId": -1})
        res = {
            "status": {"code": 200, "message": "默认"},
            "data": power_data
-
        }
        return res

@@ -1,7 +1,7 @@
 import os

 from flask import request, jsonify, current_app
-from flask_restful import Resource, marshal
+from flask_restful import Resource
 from sqlalchemy import desc

 from applications.common.utils.http import fail_api, success_api, table_api
@@ -19,7 +19,18 @@ class FilePhotosResource(Resource):
                                                  ).paginate(page=page,
                                                             per_page=limit,
                                                             error_out=False)
-        data = marshal(photo_paginate.items, FilePhoto.fields())
+        # data = marshal(photo_paginate.items, FilePhoto.fields())
+        data = [
+            {
+                'id': item.id,
+                'name': item.name,
+                'href': item.href,
+                'mime': item.mime,
+                'size': item.size,
+                'ext': item.ext,
+                'create_at': item.create_at,
+            } for item in photo_paginate.items
+        ]
        return table_api(result={'items': data,
                                 'total': photo_paginate.total, },
                         code=0)
@@ -24,6 +24,7 @@ class LoginResource(Resource):
        req = login_req.parse_args()

        s_code = session.get("code", None)
+        session["code"] = None

        if req.captcha != s_code:
            return fail_api(message="验证码错误")
@@ -1,5 +1,3 @@
-from flask_restful import fields
-
 from applications.extensions import db

 from ..base import BaseModel
@@ -12,15 +10,3 @@ class FilePhoto(db.Model, BaseModel):
    href = db.Column(db.String(255))
    mime = db.Column(db.CHAR(50), nullable=False)
    size = db.Column(db.CHAR(30), nullable=False)
-
-    @staticmethod
-    def fields():
-        return {
-            'id': fields.Integer,
-            'name': fields.String,
-            'href': fields.String,
-            'mime': fields.String,
-            'size': fields.String,
-            'ext': fields.String,
-            'create_at': fields.DateTime,
-        }
@@ -14,17 +14,3 @@ class LoggingModel(db.Model, BaseModel):
    ip = db.Column(db.String(255))
    success = db.Column(db.Boolean, default=True)
    user_agent = db.Column(db.Text)
-
-    @staticmethod
-    def fields():
-        return {
-            'id': fields.Integer,
-            'method': fields.String,
-            'uid': fields.String,
-            'url': fields.Url,
-            'desc': fields.String,
-            'ip': fields.String,
-            'success': fields.Boolean,
-            'user_agent': fields.String,
-            'create_at': fields.DateTime,
-        }
@@ -1,5 +1,3 @@
-from flask_restful import fields
-
 from applications.extensions import db
 from ..base import BaseModel

@@ -18,37 +16,3 @@ class RightsPower(db.Model, BaseModel):
    enable = db.Column(db.Boolean, comment='是否开启')

    parent = db.relationship("RightsPower", remote_side=[id])  # 自关联
-
-    @staticmethod
-    def fields():
-        return {
-            'powerId': fields.String(attribute="id"),
-            'powerName': fields.String(attribute="name"),
-            'powerType': fields.String(attribute="type"),
-            'powerUrl': fields.String(attribute="url"),
-            'openType': fields.String(attribute="open_type"),
-            'parentId': fields.String(attribute="parent_id"),
-            'icon': fields.String,
-            'sort': fields.Integer,
-            'create_at': fields.DateTime,
-            'update_at': fields.DateTime,
-            'enable': fields.Integer,
-        }
-
-    @staticmethod
-    def fields2():
-        return {
-            'id': fields.Integer,
-            'title': fields.String(attribute="name"),
-            'type': fields.String,
-            'code': fields.String,
-            'href': fields.String(attribute="url"),
-            'openType': fields.String(attribute="open_type"),
-            'parent_id': fields.Integer,
-            'icon': fields.String,
-            'sort': fields.Integer,
-            'enable': fields.Boolean,
-            'update_at': fields.DateTime,
-            'create_at': fields.DateTime,
-
-        }
@@ -15,17 +15,3 @@ class RightsRole(db.Model, BaseModel):
    sort = db.Column(db.Integer, comment='排序')

    power = db.relationship('RightsPower', secondary="rt_role_power", backref=db.backref('role'))
-
-    @staticmethod
-    def fields():
-        return {
-            'id': fields.Integer,
-            'roleName': fields.String(attribute="name"),
-            'roleCode': fields.String(attribute="code"),
-            'enable': fields.Boolean,
-            'comment': fields.String,
-            'details': fields.String,
-            'sort': fields.Integer,
-            'create_at': fields.DateTime,
-            'update_at': fields.DateTime,
-        }
@@ -18,6 +18,10 @@ class CompanyDepartment(db.Model, BaseModel):

    @staticmethod
    def fields():
+        """
+        定义模型的常用输出字段，新手请忽略。可以简化字段序列化操作，
+        详细操作请查看 flask-restful marshal 的用法
+        """
        return {
            'deptId': fields.Integer(attribute="id"),
            'parentId': fields.Integer(attribute="parent_id"),
@@ -21,25 +21,9 @@ class CompanyUser(db.Model, UserMixin, BaseModel):
    role = db.relationship('RightsRole', secondary="rt_user_role", backref=db.backref('user'), lazy='dynamic')

    def set_password(self, password):
+        """设置密码，对密码进行加密存储"""
        self.password_hash = generate_password_hash(password)

    def validate_password(self, password):
+        """校验密码方法"""
        return check_password_hash(self.password_hash, password)
-
-    @staticmethod
-    def fields():
-        return {
-            'id': fields.Integer,
-            'username': fields.String,
-            'realname': fields.String,
-            'mobile': fields.String,
-            'avatar': fields.Url,
-            'comment': fields.String,
-            # 'password_hash': fields.String,
-            'enable': fields.Boolean,
-            # 'dept_id': fields.Integer,
-            'dept_id': fields.Integer,
-            'create_at': fields.DateTime,
-            'update_at': fields.DateTime,
-        }
-
@@ -1,6 +1,5 @@
 from flask import Blueprint, request, render_template
 from sqlalchemy import desc
-from flask_restful import marshal

 from applications.common.utils.http import table_api
 from applications.common.utils.rights import permission_required
@@ -24,7 +23,19 @@ def login_log():
        url='/api/v1/passport/login').order_by(
        desc(LoggingModel.create_at)).paginate(
        page=page, per_page=limit, error_out=False)
-    data = marshal(log_paginate.items, LoggingModel.fields())
+    data = [
+        {
+            'id': item.id,
+            'method': item.method,
+            'uid': item.uid,
+            'url': item.url,
+            'desc': item.desc,
+            'ip': item.ip,
+            'success': item.success,
+            'user_agent': item.user_agent,
+            'create_at': item.create_at.strftime('%Y-%m-%d %H:%M:%S'),
+        } for item in log_paginate.items
+    ]

    return table_api(result={'items': data,
                             'total': log_paginate.total, },
@@ -40,7 +51,19 @@ def operate_log():
        LoggingModel.url != '/api/v1/passport/login').order_by(
        desc(LoggingModel.create_at)).paginate(
        page=page, per_page=limit, error_out=False)
-    data = marshal(log_paginate.items, LoggingModel.fields())
+    data = [
+        {
+            'id': item.id,
+            'method': item.method,
+            'uid': item.uid,
+            'url': item.url,
+            'desc': item.desc,
+            'ip': item.ip,
+            'success': item.success,
+            'user_agent': item.user_agent,
+            'create_at': item.create_at.strftime('%Y-%m-%d %H:%M:%S'),
+        } for item in log_paginate.items
+    ]
    return table_api(result={'items': data,
                             'total': log_paginate.total, },
                     code=0)