安装与管理模块
[🕒 预计 15 分钟] | 难度:入门
模块的安装与管理入口位于左侧边栏底部的 模块 组(模块检查器面板),所有操作都在这里完成。
1. 从市场安装模块
- 在侧边栏 模块 组中打开模块检查器,切换到 模块市场 区域。
- 按分类浏览或搜索目标模块。
- 点击模块卡片上的 预览安装,确认模块信息与依赖后等待下载完成。
- 状态变为 已安装 即表示模块可用。
2. 手动导入模块
部分模块以 .lbmod 文件形式离线分发,可通过手动导入安装:
- 在侧边栏 模块 组中打开模块生态面板,展开 安装 .lbmod 区域。
- 把
.lbmod文件拖入拖放区,或在路径框填写路径:支持.lingbuilder/module-packages下的工作区相对路径(例如.lingbuilder/module-packages/demo.lbmod);桌面版也支持本机绝对路径(例如D:/Downloads/demo.lbmod),预览时会先校验文件并自动复制进工作区再走同一预览流程。网页版仅支持相对路径。 - 点击 预览安装。通过后状态行提示「模块包预览通过,等待确认安装。」,并弹出 模块安装预览:模块名与 ID、版本、文件数与大小、SHA256、是否替换现有版本,以及安全检查结论(通过时显示「检查通过,可以安装。」)。
- 需要当前项目直接使用该模块时保持勾选 安装完成后加入当前项目,然后点击 确认安装。预览未通过时该按钮不可用,请按安全检查列出的诊断处理。
NOTE
.lbmod 本质是 zip 包,根目录必须包含 v2 格式的 lingbuilder.module.json。导入失败时请确认文件未被损坏、清单符合 v2 规范,且平台目标包含当前系统架构。旧版 v1 模块包需先用模块迁移工具重新打包。
3. 管理已安装模块
在侧边栏 模块 组的 本地模块 列表中(每行显示为 模块 ID · 版本 · 能力 N 项)可以:
- 查看模块详情:点击模块行的 接口 打开「模块公开信息」,按 类型/类、命令接口、设计器控件、代码片段、C++ 依赖、文档 分类查看随包内容。
- 启用 / 禁用模块:禁用后模块功能不会参与补全与构建。
- 卸载模块:从环境中移除模块。
- 更新模块:检测到市场有更新版本时升级;自建模块重新导入新版
.lbmod即可覆盖,见下文「模块版本升级」。
4. 在项目中使用模块
模块安装后,需要确保当前项目启用了该模块:
- 在 解决方案资源管理器 的项目节点下展开 模块 组。
- 点击 配置项目所使用模块,勾选目标模块。
- 项目启用的模块会保存到
.lingbuilder/project-modules.json,编辑器补全与构建都会随之生效。 - 按
F5编译并热运行验证,模块运行时依赖会自动复制到构建目录。
5. 模块版本升级
模块按工作区级安装:模块文件统一存放在 <工作区>/.lingbuilder/modules/<模块 ID>/,整个工作区共用一份;项目只在自己的 project-modules.json 里记录启用的模块 ID,不复制模块文件。因此升级一个模块只需要重装一次,工作区内所有引用该模块的项目都会一起用上新版本,不需要逐个项目重新配置或复制。
自己封装的模块(.lbmod 离线分发)升级流程:
- 修改模块源码后提高 manifest 中的
version,重新打包出新的.lbmod。 - 按上文 手动导入模块 的流程再安装一次:安装预览的「升级」一行会显示「将替换现有版本 <当前版本号>」,确认后新包整体替换
.lingbuilder/modules/<模块 ID>/中的旧版本(IDE 会先把旧版本存入模块历史快照)。 - 对使用到该模块的项目各按一次
F5(或重新导出工程):构建时会从安装目录重新复制头文件、库和 DLL,生成产物自动升级到新版本。
从市场安装的模块直接在 本地模块 列表点 更新模块 即可,同样是重装一次、全工作区生效。
升级时的注意事项:
- 项目里已写的
.lcpp源码和旧的已生成 C++ 不会自动改写。如果新版本调整了中文命令签名、参数或语义,需要同步修改源码后再重新构建;只改实现不改签名的升级则重新构建即可。 - 把项目复制到其他机器或分享给他人时,项目 JSON 只携带模块 ID,对方必须另行安装同名模块(官方模块从市场装,自建模块分发
.lbmod)。 - 覆盖安装是整目录替换,不会残留旧版本文件;安装前 IDE 会自动把旧版本归档为模块历史快照(记录在
.lingbuilder/module-history.json),需要回退时可手动取回。日常升级请保持 manifest 版本号递增,便于项目记录与排查。