Open
[站群 M4] 插件 SDK + 内置插件改造 + 文档 #8
凤城老人Add on  Oct 17
凤城老人
凤城老人Collaborators
Oct 17 Create

站群模式 M4:插件 SDK + 内置插件改造 + 文档

设计依据:docs/SITE_GROUP.md。依赖 M1–M3(核心已站点化)。
目标:把站群能力收敛到插件层——提供统一 SDK,内置插件(form/friend_link/product/job/analytics 等)接入站点维度,第三方插件按文档低成本接入;补齐开发者文档。

前置条件

  • M1:核心内容表 site_id 列 + 解析器 + SiteScopedMixin。
  • M2/M3:后台站点管理、站点化子系统(settings/theme/search/缓存/会员)。

范围

A. 插件 SDK

  1. SiteScopedMixin(M1 已建于 app/models/site.py):插件内容模型继承即获得 site_id 列:
    class Form(SiteScopedMixin, db.Model):
        __tablename__ = 'forms'
        ...
    
  2. plugin_api 扩展(app/plugin_api.py):
    • 暴露 current_site_id()(供插件查询过滤);
    • 暴露 SiteScopedMixin(供插件模型继承);
    • 提供 site_filter(query) 辅助:自动给模型查询追加 site_id=current_site_id()(仅对含 site_id 的模型生效)。
    • 可选 site_url(site_id, ...) 生成跨站点绝对 URL。
  3. 约定(写入 docs/PLUGIN_DEV.md 站群章节):
    • 内容查询按当前站点过滤;
    • slug 类唯一约束改 (site_id, slug) 复合唯一;
    • 插件后台管理页按当前站点过滤列表。

B. 插件迁移(各自加 site_id,幂等守卫)

  • 内置插件各自加迁移补 site_id(沿用核心 _table_exists 幂等守卫范式),或随核心 0010 一并处理(推荐内置随核心,第三方各插件自管):
    • forms(slug → (site_id, slug))
    • friend_links(无 slug 全局唯一,加 site_id 列即可)
    • product / job 等含内容模型与 slug 的插件
    • analytics(无自有内容表,仅按站点键读 Setting,无需加列)
  • 插件 db.create_all() 兜底建表自动带 site_id(模型已继承 mixin)。

C. 内置插件改造(逐插件)

插件 改造点
form Form 继承 mixin;表单 slug 站点内唯一;前台表单按当前站点过滤;后台表单/提交列表按站点过滤
friend_link FriendLink 继承 mixin;前台友链全局函数按站点过滤
product 产品模型继承 mixin;产品 slug/列表按站点
job 岗位模型继承 mixin;岗位列表按站点
banner 横幅按站点(若含内容模型)
member 按 M3 member_scope 处理(共享/独立),登录/短信按站过滤
auto_translate 翻译按站点 + 语言正交(站点化对象上的 i18n)
analytics 按站点键读 Setting(M3 已站点化 Setting),各站注入各自统计代码

具体插件清单以 plugins/ 目录实际内容为准;含内容表/前台路由/后台管理的插件均需过一遍「站点过滤 + slug 唯一」检查。

D. 文档

  1. docs/PLUGIN_DEV.md 新增「站群接入」章节:mixin 继承、current_site_id()/site_filter 用法、slug 唯一约束约定、后台列表过滤。
  2. docs/SITE_GROUP.md:把 M4 落地后的实际 API(plugin_api 暴露的函数签名)回填,保持设计与实现一致。
  3. README.md 特性表新增「站群模式(多站点)」行;UPGRADE.md 增加 v3.2.0 站群升级说明(默认站点零感知、新站点创建流程)。

验收标准

不做

  • 按站点备份导出(增强项,单列 issue)
  • 站群批量操作(跨站点复制内容/模板,增强项)

关联

  • 设计文档:docs/SITE_GROUP.md §10
  • 依赖:M1(必需)、M2/M3(建议)
  • 收尾:站群模式四阶段全部完成,版本 v3.2.0 发布候选
likedislike