中国 帮助

开始使用

第一次接手 Wujies 时的分区入口:按你要办的事挑该读的那一页,并说明这套文档对应哪条代码线。

开始使用
封面

> 本文整理自平台文档 docs/wujies/5.x/introduction/index.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-f790897a80f8-cover.svg)

刚拿到这套代码的人通常卡在两个地方:说不清哪些功能归宿主、哪些归可安装的应用,以及不知道该从哪一页读起。第二个问题这一页回答,第一个问题交给[核心概念](/docs/wujies/5.x/introduction/concepts)。

定性一句话:Wujies 的宿主只保留用户、角色、部门、菜单、租户、字典、文件存储、任务调度这些底座能力,业务功能(商城、会员、图床、考试、内容中心……)以「应用」为单位独立交付,安装、升级、启停、卸载都在运行期完成,宿主进程不重启。底座来自 RuoYi-Vue-Plus 5.X,上游文档原样收录在本站,平台在其上新增、替换、移除了哪些东西,逐项列在[与上游 5.X 的差异](/docs/wujies/5.x/introduction/differences)。

按你要办的事进

顺序背后的理由

侧边栏把七页排成一条线,但真正决定读序的是三件事:

1. 先跑起来再读概念。 这套平台的名词(应用、目录、安装实例、落位、路由墓碑)都对应后台里看得见的界面和库里的真实表行。系统没跑起来时读[核心概念](/docs/wujies/5.x/introduction/concepts),只会把「目录」和「市场页面」混成一个词。 2. 想改底座之前先读差异清单。 平台与上游共用的那批文件(wujies-common/*、wujies-system 的大半、工作流)改起来要按上游节奏走;改动集中在自研模块时才有自由。哪些文件属于哪一边,见[与上游 5.X 的差异](/docs/wujies/5.x/introduction/differences)。 3. 写应用之前先读结构。 应用的代码住在另一个仓库,产物落位路径、前端 ESM 目录名、清单里的 appCode 是同一个约定的四个位置;先确认自己在改哪个仓库,再动手。

按这三条展开的推荐路径:

你的情形依次读
决定要不要采用这套架构[这个项目是什么](/docs/wujies/5.x/introduction/what-is-wujies) → [为什么这样设计](/docs/wujies/5.x/introduction/why-wujies) → [授权与版本](/docs/wujies/5.x/license/)
第一次把它跑起来[环境准备](/docs/wujies/5.x/introduction/prerequisites) → [快速开始](/docs/wujies/5.x/introduction/quickstart) → [核心概念](/docs/wujies/5.x/introduction/concepts)
接手维护、要改代码[项目结构](/docs/wujies/5.x/introduction/structure) → [与上游 5.X 的差异](/docs/wujies/5.x/introduction/differences) → [必须遵守的不变量](/docs/wujies/5.x/platform/plugin/basics/invariants)
要做一个自己的应用[插件开发](/docs/wujies/5.x/platform/plugin/) → [打包与上架](/docs/wujies/5.x/platform/package/) → [部署与运维](/docs/wujies/5.x/deploy/)
只想用现成的应用[应用清单](/docs/wujies/5.x/plugins/) → [在部署里使用应用](/docs/wujies/5.x/platform/app-market/using-apps)

这七页各管一段

同一段内容只在一页里详写,其它页给链接。分工是这样定的:

页面只管这件事不管的事
这个项目是什么平台与应用的边界、装不装这套结构的判据设计推导(去「为什么」)、模块清单(去「差异」)
为什么这样设计三条判断的来路与代价环境、命令
环境准备工具链、中间件、端口、工作目录、建库启动后的操作(去「快速开始」)
快速开始从零跑通并装一个应用机制解释
核心概念名词各自指什么、边界在哪文件放在哪个目录(去「结构」)
项目结构仓库与目录、产物怎么进宿主概念定义
与上游差异自研动了上游的哪一块平台自身机制

版本适用范围

本站 5.x 分区描述的是 feature/app-market 分支上的当前代码,对应下面这几个具体值:

位置值从哪查
平台 Maven revision5.6.2wujies-platform/pom.xml 第 16 行
Java 目标版本17同文件 <java.version>
Spring Boot3.5.15同文件 <spring-boot.version>,[版本目录](https://repo1.maven.org/maven2/org/springframework/boot/spring-boot/)
MyBatis-Plus3.5.16同文件 <mybatis-plus.version>
上游底座v5.6.1[本站收录的上游更新日志](/docs/wujies/5.x/ruoyi-vue-plus/changelog)
宿主前端包wujies-admin 5.5.1-2.5.1wujies-admin/package.json

前端那个版本号与后端 revision 对不上(前者沿用 plus-ui 的版本习惯),这不是笔误,两边各自发版;跨端排查时按仓库各自的号来核对产物。

正文里凡是「自 x.x.x 起」「已删除」「尚未发布」这类带时间性质的说法,都以 dev 分支代码为准,写这页时逐条在源码里对过。已合并进 dev 但还没随正式版发布的能力,会在原句里显式说明。

文档约定

  • 命令与路径:不特别说明时在对应仓库根执行。Windows 示例用 PowerShell,Linux 示例用 Bash;示例里的主机与凭据一律写成 <host>、YOUR_*。
  • 站内链接:只写绝对发布路由 /docs/wujies/5.x/...,不带 .mdx。
  • 截图占位:正文里带「截图占位」的位置留给管理员补图,文件放进 public 下对应路径后自动显示。
  • 表格里的数量:应用个数、表数量、行数这类会随版本变的数字,事实源是代码或 SQL(各仓 app.json、script/sql/*.sql、根 pom.xml),页面只负责指出「去哪查」。应用清单只有一处:[十三个应用](/docs/wujies/5.x/plugins/)。

相邻分区

  • [无界平台文档首页](/docs/wujies/5.x/):全部分区导航
  • [平台功能(自研)](/docs/wujies/5.x/platform/):应用市场、插件运行时、可视化配置、消息中心、开放接口
  • [后端框架 · RuoYi-Vue-Plus](/docs/wujies/5.x/ruoyi-vue-plus/) 与 [前端框架 · plus-ui](/docs/wujies/5.x/plus-ui/):上游官方文档
  • [授权与版本](/docs/wujies/5.x/license/):社区版 / 专业版 / 企业版三档
  • [部署与运维](/docs/wujies/5.x/deploy/):构建、配置、升级、备份与故障排查

1.x 分区是只读存档,不再更新;左侧栏顶部可切换版本。

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-f790897a80f8-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容