更新文档

2025-01-27 19:48:27 +08:00
parent 155af93c77
commit 5153daf7da
39 changed files with 767 additions and 593 deletions
@@ -0,0 +1,9 @@
+.. title:: 最佳实践
+
+目录索引
+
+.. toctree::
+    :maxdepth: 1
+
+    plugin
+    trick
@@ -0,0 +1,129 @@
+插件开发
+=================
+
+插件功能旨在最大限度不修改原框架的前提下添加新功能，并可以像程序原有框架一样进行流程注册，而且不需要修改任何程序框架原有代码（仅在配置文件中设置即可）。
+
+所有插件放置在 `plugins` 文件夹中，项目提供了三个示例插件，分别是 `helloworld` 、 `realip` 和 `replacePage` ，分别用于示例页面的注册、修改 Flask 上下文和页面替换。
+
+像项目自带的用户管理、部门管理等基本功能属于程序自身的“功能插件”，对于大多数衍生项目来说，多的是修改字符串和删除部分不需要的功能，
+而插件开发主要可以用于添加自己的视图函数和功能，可以完美于项目融合，增加可拓展性。
+
+插件的启用
+-----------------
+
+插件需要在 `applications/config.py` 中配置，你会找到如下的内容：
+
+.. code-block:: python
+
+    PLUGIN_ENABLE_FOLDERS = []
+
+而在目录 `plugins` 中，你会发现存在 文件夹名称 为 `helloworld` 、 `realip` 和 `replacePage` 三个插件。比如我们想要启用 `helloworld` 插件，
+仅需要做如下修改：
+
+.. code-block:: python
+
+    PLUGIN_ENABLE_FOLDERS = ["helloworld"]
+
+假设有多个插件，只要依次在列表 `PLUGIN_ENABLE_FOLDERS` 中填入插件的文件夹名称即可。**注意：填写的先后顺序会影响插件加载的前后顺序，越前面的插件越早被加载。**
+
+假设插件启用成功，你将会在控制台收到如下的提示：
+
+.. code-block:: bash
+
+    * Plugin: Loaded plugin: Hello World .
+
+|
+
+.. image:: ../_static/plugin_run.png
+   :align: center
+
+|
+
+`helloworld` 插件启用之后，你可以访问 `http://127.0.0.1:5000/hello_world/` 来请求到新添加的页面。你会发现添加页面变的简单，仅需要修改一下设置项就行了。
+
+|
+
+.. image:: ../_static/helloworld.png
+   :align: center
+
+|
+
+插件的目录架构
+-------------------
+
+插件的目录架构如下：
+
+.. code-block:: bash
+
+    Plugin
+    │  __init__.json
+    └─ __init__.py
+
+这是一个插件基本的目录架构，插件信息保存在 `__init__.json` 中，其本质是一个包含如下 JSON 字符串的文本文件：
+
+.. code-block:: json
+
+    {
+      "plugin_name": "Hello World",
+      "plugin_version": "1.0.0.1",
+      "plugin_description": "一个测试的插件。"
+    }
+
+这个 JSON 文件中，记录了基本的插件名称与插件版本，以及插件的介绍，请确保一个插件至少包含上述的三个字段，因为这三个字段会被项目所读取并在加载成功之后展示在控制台。
+
+编写插件入口
+-------------------
+
+插件入口位于 `__init__.py` 中，请确保 `__init__.py` 文件一定包含 `event_init(app: Flask)` 函数，如下：
+
+.. code-block:: python
+
+    def event_init(app: Flask):
+        pass
+
+这个函数将会在插件加载时被调用，并传入项目的 `Flask` 对象，此后你可以像一般使用 Flask 一样添加视图函数。例如：
+
+.. code-block:: python
+
+    def event_init(app: Flask):
+        @app.get('/test')
+        def test():
+            return "这是测试页面"
+
+**当然，不推荐这样直接使用 Flask 对象创建视图函数，更妥当的做法是通过注册蓝图的方式来添加视图函数。您可以这样做：**
+
+在您编写的插件目录下建立一个 `main.py` 文件，并在该文件中添加蓝图：
+
+.. code-block:: python
+
+    from flask import render_template, Blueprint
+
+    # 创建蓝图
+    helloworld_blueprint = Blueprint('hello_world', __name__,
+                                     template_folder='templates',
+                                     static_folder="static",
+                                     url_prefix="/hello_world")
+
+    @helloworld_blueprint.route("/")
+    def index():
+        return render_template("helloworld_index.html")
+
+而后在 `__init__.py` 中注册该蓝图：
+
+.. code-block:: python
+
+    from flask import Flask
+    from .main import helloworld_blueprint
+
+
+    def event_init(app: Flask):
+        """初始化完成时会调用这里"""
+        app.register_blueprint(helloworld_blueprint)
+
+这样可以使目录架构更加清晰。
+
+.. important::
+
+    注意不要直接在 `__init__.py` 的 `event_init` 函数外直接写存在阻塞的代码，不然项目 Flask 将不能初始化完成。
+
+
@@ -0,0 +1,199 @@
+开发技巧
+===================
+
+开发 Web 过程中需要用到许多技巧来加速开发，本章节将介绍开发的小技巧与一些需要注意的细节。
+
+配置数据库
+-----------
+
+项目采用 flask-sqlalchemy，支持多数据库连接，默认是使用 sqlite 的，可以在 `applications/config.py` 中配置，如果需要连接其他数据库需要可以参考：
+
+* HOSTNAME: 指数据库的IP地址
+* USERNAME：指数据库登录的用户名
+* PASSWORD：指数据库登录密码
+* PORT：指数据库开放的端口
+* DATABASE：指需要连接的数据库名称
+
+.. code-block:: python
+
+    # MSSQL
+    SQLALCHEMY_DATABASE_URI =  f"mssql+pymssql://{USERNAME}:{PASSWORD}@{HOSTNAME}:{PORT}/{DATABASE}?charset=cp936"
+
+    # mysql
+    SQLALCHEMY_DATABASE_URI =  f"mysql+pymysql://{USERNAME}:{PASSWORD}@{HOSTNAME}:{PORT}/{DATABASE}?charset=utf8mb4"
+
+    # Oracle
+    SQLALCHEMY_DATABASE_URI =  f"oracle+cx_oracle://{USERNAME}:{PASSWORD}@{HOSTNAME}:{PORT}/{DATABASE}"
+
+    # SQLite
+    SQLALCHEMY_DATABASE_URI =  "sqlite://../database.db"
+
+    # Postgres
+    SQLALCHEMY_DATABASE_URI =  f"postgresql+psycopg2://{USERNAME}:{PASSWORD}@{HOSTNAME}:{PORT}/{DATABASE}"
+
+.. important::
+
+    使用不同的数据库需要安装另外的库，比如 mysql 要安装 pymysql 库（不同平台可能名称不一样），请自行查询资料而后进行配置。
+
+权限效验
+------------
+
+在开发后台管理模板的过程中会涉及到权限效验，即访问控制。Pear Admin Flask 中提供了方便的函数用于进行权限效验。详情请查看 :ref:`权限验证模块` 章节。
+
+Schema 序列化
+---------------
+
+项目中时常会涉及到数据库的读写，在读入数据时采用 SQLAlchemy，将模型查询的数据对象转化为字典，以此方便与前端页面进行数据交换。
+
+.. important::
+
+    Schema 模型放在了 `applications/schemas` 文件夹中，与 `applications/models` 中的数据库模型对应（准确来说是序列化为字典的配置）。
+
+进行序列化时，常常会用到 `applications/common/curd.py` 中的 `model_to_dicts` 函数，下面是一个常见的用法。
+
+.. code-block:: python
+
+    from applications.models import Dept
+    from applications.common import curd
+    from applications.schemas import DeptSchema
+
+    dept = Dept.query.order_by(Dept.sort).all()
+    power_data = curd.model_to_dicts(schema=DeptSchema, data=dept)  # 此处 power_data 将会是一个列表，存储了部门的数据字典
+
+在自己撰写 Schema 模型时，推荐使用自动化类型转化：
+
+.. code-block:: python
+
+    from flask_marshmallow.sqla import SQLAlchemyAutoSchema
+    from applications.models import 你的模型类
+    class RoleOutSchema(SQLAlchemyAutoSchema):
+        class Meta:
+            model = 你的模型类  # table = models.Album.__table__
+            # include_relationships = True  # 输出模型对象时同时对外键，是否也一并进行处理
+            include_fk = True  # 序列化阶段是否也一并返回主键
+            # fields= ["id","name"] # 启动的字段列表
+            # exclude = ["id","name"] # 排除字段列表
+
+
+与 layui 的数据格式同步
+------------------------------
+
+项目的前端页面基于 layui 框架，在一些数据展示页面（如：layui 动态表格）需要与 layui 框架进行快速的数据交换。比如前端会传入 limit 和 page 参数
+用于限定数据展示的范围。故项目中在 SQLAlchemy 中添加了专有的查询函数。详情可以查看文件 `applications/extensions/init_sqlalchemy.py` 。
+下面是对 `Query` 类的解释。
+
+.. class:: Query(BaseQuery)
+
+   自定义查询类，扩展了 BaseQuery 的功能，支持软删除、逻辑查询、分页和序列化。
+
+   **示例：**
+
+   .. code-block:: python
+
+      # 软删除
+      User.query.filter_by(id=1).soft_delete()
+
+      # 查询所有未删除的记录
+      users = User.query.logic_all()
+
+      # 分页查询并返回 JSON 数据
+      data, total, page, per_page = User.query.layui_paginate_json(UserSchema)
+
+
+   .. method:: soft_delete()
+
+      软删除当前查询结果集中的记录。
+
+      :return: 返回更新操作影响的行数。
+
+
+   .. method:: logic_all()
+
+      查询所有未删除的记录。
+
+      :return: 返回未删除的记录列表。
+
+
+   .. method:: all_json(schema: Schema)
+
+      将查询结果序列化为 JSON 格式。
+
+      :param schema: Marshmallow Schema 类。
+      :return: 返回序列化后的 JSON 数据。
+
+
+   .. method:: layui_paginate(page=None, limit=None)
+
+      分页查询，适用于 Layui 表格。
+
+      **需要注意的是，如果不提供 page 和 limit 则该函数必须在视图函数中使用，该函数会自动获取 GET 请求中的 limit 和 page 参数构成查询。**
+
+      :return: 返回分页对象。
+
+      **示例：**
+
+      .. code-block:: python
+
+          # 查询邮件数据并分页
+          mail = Mail.query.filter(mf.get_filter(Mail)).layui_paginate()
+          return model_to_dicts(schema=MailOutSchema, data=mail.items)
+
+
+   .. method:: layui_paginate_json(schema: Schema)
+
+      分页查询并返回 JSON 格式数据，适用于 Layui 表格。
+
+      :param schema: Marshmallow Schema 类。
+      :return: 返回包含序列化数据、总数、当前页码和每页条数的元组。
+
+
+   .. method:: layui_paginate_db_json()
+
+      分页查询并返回数据库原始数据的 JSON 格式，适用于 Layui 表格。
+
+      :return: 返回包含序列化数据和总数的元组。
+
+      **示例：**
+
+      .. code-block:: python
+
+         db.query(User.name).layui_paginate_db_json()
+
+
+进行字段构造
+-----------------------
+
+提炼数据时常常会用到准确匹配或者模糊匹配，又或者是进行多条件大小比较的匹配，此时可以通过字段构造来解决。项目中提供了字段构造的类位于
+`applications/common/helper.py` 。详情查看 :ref:`字段构造模块` 章节。
+
+
+响应合适的响应数据
+-----------------------
+
+在进行 JSON 数据响应时，应该注重响应的 JSON 格式类型，一般情况下，项目的 JSON 响应会形如：
+
+.. code-block:: json
+
+    {
+        "code": 0,
+        "msg": "请求成功",
+        "data": [],
+        "count": 0,
+        "limit": 0
+    }
+
+其中，`data` 、 `total` 和 `limit` 字段是可选的，仅在传输数据的时候存在。项目提供了生成统一响应格式的函数，位于 `applications/common/utils/http.py` 。
+详情查看 :ref:`JSON 响应正文生成模块` 章节。
+
+
+发送硬件
+-----------------------
+
+程序提供了发送邮件的模块，前提是需要正确在 `applications/config.py` 中配置 SMTP 服务器。详情查看 ref:`邮件模块` 章节。
+
+.. code-block:: python
+
+    from flask_login import current_user
+    from applications.common.utils import mail
+
+    mail.add("test@test.com", "subject", "<h1>Hello</h1>", current_user.id)