inteplm-integration 技术文档

1. 项目概述

inteplm-integration 是一个专为 嘉立创EDA / EasyEDA 专业版 V3 开发的扩展（当前版本 1.3.2）。同一 .eext 可用于 网页版 与 V3 客户端（在线 / 半离线 / 全离线）。主要功能是实现 EDA 与 IntePLM 的集成：登录、检出、撤销检出、检入、查询与打开。不支持专业版 V2（.epro）。

2. 项目架构分析

本项目采用了典型的 "客户端扩展架构（Client-Extension Architecture）"，整体分为两层：

• 宿主环境层（Extension Logic）：运行在 EDA 客户端的扩展进程中，负责与 EDA 客户端的底层 API（如系统消息、存储、菜单栏注册、IFrame 创建）进行交互。
• UI 展现层（IFrame Views）：基于 HTML/CSS/JS 构筑的独立页面，通过 EDA 提供的 IFrame 容器进行渲染。页面负责收集用户输入，并与宿主环境或外部 PLM 系统进行数据通信。

核心工作流

1. 用户在 EDA 顶部菜单栏点击 IntePLM 相关菜单。
2. 触发 src/index.ts 中注册的命令函数（如 menuCheckIn）。
3. 扩展程序调用 eda.sys_IFrame.openIFrame 打开对应的本地 HTML 页面（位于 iframe/ 目录）。
4. IFrame / 宿主通过 eda.sys_ClientUrl 访问 IntePLM（见 iframe/eda-runtime.js），打开工程由宿主 src/index.ts 下载 .epro2 并调用 importProjectByProjectFile。

3. 核心技术栈

• 编程语言：TypeScript（宿主扩展逻辑）、JavaScript/HTML/CSS（前端 UI 页面）
• UI 框架：原生 DOM 配合 CSS（未使用重量级框架如 Vue/React，以保证扩展轻量化）
• 构建工具：esbuild（负责极速编译 TS），ts-node（执行打包脚本）
• 类型定义：@jlceda/pro-api-types（嘉立创 EDA 专业版扩展 API 类型声明）
• 代码规范：eslint + eslint-config-alloy，prettier，husky + lint-staged
• 其他依赖：jszip（用于处理本地设计文件的压缩与解压）

4. 模块依赖关系 (目录结构)

inteplm-integration/
├── src/
│   ├── index.ts                 # 扩展入口、菜单命令、打开/导入
│   └── operate/                 # 检出 / 撤销检出 / HTTP 工具
├── iframe/
│   ├── eda-runtime.js           # 环境探测 + sys_ClientUrl PLM 请求
│   ├── login.html/js            # 登录
│   ├── checkin.html/js          # 检入
│   ├── logout.js                # 登录态与注销
│   └── queryAndOpen.html/js     # 查询与打开
├── config/
├── build/
├── locales/
├── extension.json
├── plmConfig.json
└── package.json

核心模块说明

• src/index.ts：activate、菜单回调、工程下载与导入（网页/客户端团队降级；半离线按云端同名覆盖）。
• iframe/eda-runtime.js：isWeb / isClient / 离线模式探测，统一 PLM HTTP。
• iframe/login.html：多账号记忆、服务器地址、密码存储（Web Crypto 不可用时降级）。
• iframe/checkin.html：检入；工程文件显式导出 .epro2。
• iframe/queryAndOpen.html：查询列表，经 MessageBus 通知宿主打开。
• src/operate/：检出、撤销检出及 requestPlmApi。

5. 功能模块详解

5.1 登录模块

功能说明：

• 支持用户名/密码登录验证
• 多账号历史记录记忆（最多10条）
• 服务器地址配置与缓存
• 密码加密存储（AES-CBC）
• 登录状态持久化

交互流程：

1. 用户输入用户名、密码、PLM服务器地址
2. 调用 /rest/userService/v1/user/userLogin 接口验证
3. 登录成功后缓存 authorization Token、USER_OID 等用户信息
4. 支持自动填充最近登录账号

5.2 查询与打开模块

功能说明：

• 支持关键词搜索（名称、标识）
• 分页展示 PLM 工程列表
• 支持列宽拖拽调整
• 显示工程状态（c/i-检入、c/o-检出、wrk-工作中）
• 支持直接打开或检出并打开

交互流程：

1. 调用 queryProjectByParam 接口获取工程列表
2. 支持分页加载（10/20/50/100条每页）
3. 选中工程后可执行"打开"或"检出并打开"。检出并打开会先完成检出并提示「检出成功」，再询问是否覆盖打开；取消覆盖时提示「检出已完成，已取消打开」，查询窗保持打开
4. 打开时自动下载文件并导入 EDA。若当前工作区没有同名工程，会继续查其他团队和其他工作区（半离线下的云端工程）；命中则覆盖云端同名工程，并单独提示这是云端同步工程而不是本地工程，避免新建时报「工程名称已存在」。云端同名工程当时不在当前窗口时无法先清文档树，由宿主按已有工程导入。有同名时先弹覆盖确认（查询窗仍开着），确认后再关查询窗并下载；取消覆盖可继续选其它图纸。

5.3 检入模块

功能说明：

• 批量录入配置
• 支持关联关系选择（主控关联等）
• 文档类型配置（CAD文档等）
• 零部件类型与位置选择
• 零部件分类树选择
• 检入提交会带上 partClassificationOid（与分类树按字符串匹配；拉树失败保留回填，树上找不到则清空）

交互流程：

1. 获取当前工程信息
2. 查询默认工作区（支持缓存）
3. 加载关联关系、文档类型、零部件类型等元数据
4. 用户配置检入参数后提交
5. 调用 importProject 接口完成检入

5.4 检出模块

功能说明：

• 从 PLM 系统检出工程
• 自动下载工程文件
• 支持覆盖本地已有工程；半离线下也会覆盖云端同名工程
• 覆盖前会等待目标工程文档树加载完成再清理；从另一张已打开图纸覆盖时，避免残留 PCB 被导入成根目录 原名_1

交互流程：

1. 查询用户默认工作区
2. 调用 batchCheckoutCadDocs 接口执行检出
3. 检出成功后自动下载文件
4. 导入到 EDA 当前工作区

5.5 撤销检出模块

功能说明：

• 撤销已检出的工程
• 释放 PLM 系统锁定状态

交互流程：

1. 获取当前工程信息
2. 调用撤销检出接口
3. 更新本地工程状态

6. 关键配置文件说明

extension.json

EDA 扩展的清单文件（Manifest），决定了扩展在 EDA 软件中的表现形态：

{
	"name": "inteplm-integration",
	"version": "1.3.2",
	"engines": {
		"eda": "^3.2.0"
	},
	"entry": "./dist/index",
	"headerMenus": [
		{
			"id": "inteplm",
			"name": "IntePLM",
			"target": "home,sch",
			"submenu": [
				{ "name": "登录", "registerFn": "menuLogin" },
				{ "name": "检入", "registerFn": "menuCheckIn" },
				{ "name": "检出", "registerFn": "menuCheckOut" },
				{ "name": "撤销检出", "registerFn": "menuCancelCheckOut" },
				{ "name": "查询并打开", "registerFn": "menuQueryAndOpen" },
				{ "name": "登出", "registerFn": "menuLogout" }
			]
		}
	]
}

plmConfig.json

存储了 IntePLM 系统的接口路由映射关系：

{
	"url": {
		"login": "/rest/userService/v1/user/userLogin",
		"logout": "/rest/userService/v1/user/userLogout",
		"queryProjectByParam": "/rest/ecadService/v1/ecad/queryProjectByParam",
		"batchCheckoutCadDocs": "/rest/ecadService/v1/ecad/batchCheckoutCadDocs",
		"importProject": "/rest/ecadService/v1/ecad/importProject",
		"queryDefaultWorkspaceOrCreate": "/rest/ecadService/v1/ecad/queryDefaultWorkspaceOrCreate",
		"downFileByFileId": "/rest/ecadService/v1/ecad/downFileByFileId"
	}
}

package.json

定义了项目名称和构建脚本：

• compile: 使用 esbuild 将 TS 代码编译到 dist/
• build: 运行编译后，调用 packaged.ts 将所有资源打包为 .eext 格式的插件包

7. API 接口文档

7.1 用户认证接口

接口名称	HTTP 方法	接口路径	作用描述
用户登录	POST	/rest/userService/v1/user/userLogin	验证凭据并获取 Token
用户注销	GET	/rest/userService/v1/user/userLogout	清除服务端 Token

7.2 ECAD 工程接口

接口名称	HTTP 方法	接口路径	作用描述
查询工程列表	POST	/rest/ecadService/v1/ecad/queryProjectByParam	获取 PLM 系统中的工程列表
检出工程	POST	/rest/ecadService/v1/ecad/batchCheckoutCadDocs	将 PLM 工程锁定并下载到本地
检入工程	POST	/rest/ecadService/v1/ecad/importProject	将本地工程上传至 PLM
查询默认工作区	GET	/rest/ecadService/v1/ecad/queryDefaultWorkspaceOrCreate	获取用户默认工作区
下载文件	GET	/rest/ecadService/v1/ecad/downFileByFileId	根据文件 ID 下载工程文件
查询 ECAD 信息	POST	/rest/ecadService/v1/ecad/queryECadByMainFileName	根据主文件名查询 ECAD 文档

7.3 宿主与 IFrame 协作

方式	说明
eda.sys_MessageBus 主题 iframe-query-result	查询页请求打开工程
eda.sys_MessageBus.rpcServicePublic('openIframeCheckinSetting')	检出等场景下载并打开 .epro2
eda.sys_ClientUrl.request	访问 IntePLM（需外部交互权限）

8. 部署与打包流程

8.1 环境准备

确保本地安装 Node.js (>=20.5.0) 及包管理器（npm/pnpm）。

8.2 安装依赖

npm install

8.3 执行打包

npm run build

打包流程：

1. 自动清理 dist 目录
2. 使用 esbuild 将 TS 编译为 JS
3. 运行 build/packaged.ts 将 dist/、iframe/、images/、locales/ 及相关配置文件打包

8.4 输出产物

在 build/dist/ 目录下生成 inteplm-integration_v1.3.2.eext 扩展安装包。

8.5 安装（网页版与 V3 客户端）

网页版与嘉立创 EDA 专业版 V3 客户端（在线 / 半离线 / 全离线）安装同一 .eext。在「扩展管理」中选择本地安装即可。

客户端请开启本扩展权限：

• 外部交互（访问 IntePLM）
• 工程管理 > 下载工程（检入导出 .epro2）
• 工程设计图 > 文件导出（PCB/原理图 PDF、BOM）

IntePLM 服务端 CORS 不要只放行 pro.lceda.cn，客户端请求 Origin 与网页不同。半/全离线客户端仍需能访问 IntePLM 地址。工程主文件统一为 .epro2，不兼容 V2 .epro。

9. 数据持久化说明

本项目作为纯客户端扩展，不存在独立的后端关系型数据库。数据持久化主要依赖 EDA 客户端提供的系统存储 API（eda.sys_Storage）：

存储键	数据类型	说明
USERNAME	string	登录用户名
authorization	string	认证 Token
PLMServerUrl	string	PLM 服务器地址
USER_OID	string	用户唯一标识
DEFAULT_WORKSPACE_ID	string	默认工作区 ID（运行时查询缓存）
plmConfig	object	PLM 接口配置

---

文档版本: 1.3.2 最后更新: 2026-09-07