更新:2026-09-05 16:11

概览:一文认清整个平台

面向新加入的开发者,描述 Rule 社区平台体系的全貌、仓库结构与阅读路线图。

体系组成

仓库 技术栈 定位
RuleAppRro uniapp + Vue2(H5/APP/小程序) 主前端移动端
RuleAppX uniapp + Vue3 RuleAppRro 的 Vue3 镜像(功能同步)
RuleApiPro Spring Boot 2.2 + JDK8 主后端 API
RuleApiX Spring Boot 4 + JDK21 RuleApiPro 的升级镜像
Sulo Nuxt 4 + Vue3 + Element Plus Web 门户 / SEO 站
RuleApiVisible Nuxt + Element Plus 配置管理中心
docs/ PHP + Markdown 官方文档站(本站)

数据流

RuleApp(移动端) ─┐
RuleAppX(镜像)  ─┤→ RuleApiPro / RuleApiX(后端) → MySQL / Redis / 对象存储
Sulo(Web 门户) ──┘
RuleApiVisible(配置中心) → 调用安装/配置接口管理站点

开发规范速记

  • 前端(uniapp):新样式必须写入 static/base.css 公共文件,页面内禁用 <style>;根节点绑定 [AppStyle, ThemeClass] 以适配换肤与黑夜模式。
  • 双端同步:功能先在 RuleAppRro 开发,确认后同步到 RuleAppX(注意 Vue2→Vue3 语法差异)。
  • 后端:以 RuleApiPro 为准,规则同步到 RuleApiX。
  • 表结构变更:必须同步 InstallController 的迁移逻辑(soft_module_ddl.sql + 列迁移),管理端“刷新数据表”会幂等执行。
  • 文档:接口文档由 docs/api/generate.py 从 Controller 源码自动生成,改接口后需重新生成。

阅读路线

  1. 先读「01-项目架构与模块划分」理解各目录。
  2. 后端同学读「02-后端二次开发指南」→「04-新增接口全流程」。
  3. 前端同学读「03-前端二次开发指南」→「05-模块扩展」。
  4. 上线前读「07-缓存与性能规范」「06-权限与安全规范」。
  5. 多端同步前读「08-双端同步流程」。