Installation Guide

XWorker 安装教程

XWorker 本质是一个由 Maven 管理的 Java 项目。即使发行版,也通过 Maven 管理。下面提供两种安装方式与各操作系统的一键安装脚本。

★ 推荐 · 通用

🧩 方式一:Jar 通用安装

适用于 所有操作系统(Windows / Linux / macOS),需自行安装 Java 与 Maven。

  • 下载 xworker-2.0.4-SNAPSHOT.jar
  • 运行 java -jar xworker-2.0.4-SNAPSHOT.jar
  • 程序自动创建 pom.xml、执行 mvn package、初始化数据库与索引
Windows · 新手专用

🪟 方式二:Windows 绿色版

专为 没有安装 Java 和 Maven 的 Windows 新手 准备,解压即用。

  • 下载绿色版 zip 压缩包
  • 解压到任意目录,双击启动脚本即可
  • 无需安装 Java / Maven,开箱即用

📋 教程目录

  1. 了解 XWorker 的安装模式
  2. 方式一:Jar 通用安装(推荐)
    —— 前置准备 · 下载 · 交互选择版本 · 生成启动脚本 · 一键自动化脚本(Windows/Linux/macOS)
  3. 方式二:Windows 绿色版
  4. 升级 XWorker
  5. 常见问题(FAQ)

了解 XWorker 的安装模式

XWorker 本质上是一个由 Maven 管理的 Java 项目。即便是发行版,底层也仍是通过 Maven 来组织与构建的。理解这一点,你就理解了一切安装方式的背后逻辑:

  • 核心机制:XWorker 的"安装"本质上是在某个工作目录中创建一个 pom.xml,然后通过 Maven 拉取所需的 xworker_* 类库并构建启动脚本。这与你用 Maven 管理一个普通 Java 项目完全一致。
  • 统一启动器:无论哪种方式安装,最终都以 xworker.cmd(Windows)或 xworker.sh(Linux/macOS)作为统一启动入口,避免因启动方式不一而产生歧义。
  • 无需区分操作系统:通用的 Jar 安装方式在 Windows、Linux、macOS 上完全一致,差异仅在启动脚本的后缀(.cmd / .sh)。
对比维度方式一 · Jar 通用安装方式二 · Windows 绿色版
适用操作系统Windows / Linux / macOS 全平台仅 Windows
需要预装 Java需要(JDK 8 或更高)不需要(已内置)
需要预装 Maven需要(Maven 3)不需要(已内置)
个性化选择可选择 Java 11 / Java 17 / Web 版等固定版本
适合人群开发者、已有 Java/Maven 环境的用户没有 Java/Maven 的 Windows 新手
升级方式修改 pom.xml 后重跑 jar下载新绿色版 / 或迁移到 Jar 方式
💡 怎么选?只要是 Windows 且没有安装 Java 和 Maven,强烈建议用方式二(绿色版);其余情况(Linux、macOS、以及愿意配置 Java/Maven 环境的 Windows 用户)请用方式一(Jar 通用安装)

方式一:Jar 通用安装(推荐)

1.1 前置准备:安装 Java 与 Maven

Jar 安装方式需要你自行安装 Java(JDK 8 或更高)Maven 3。安装后请确认下列命令可用:

验证环境(Windows / Linux / macOS 通用)
java -version      # 应显示 Java 版本信息
mvn -version        # 应显示 Maven 版本信息
  • 未安装 Java? 推荐从 Adoptium / Eclipse Temurin 下载 JDK。若你的机器已装过其它软件依赖 Java,建议直接升级到受支持版本。
  • 未安装 Maven?Apache Maven 官网 下载,解压后将其 bin 目录加入系统 PATH 即可。
  • 如果你不想手工配置,可跳至文末的自动化安装脚本,脚本会自动检测并引导安装 Java / Maven。

1.2 下载发行版 Jar

下载 XWorker 的发行版 xworker-2.0.4-SNAPSHOT.jar

XWorker 2.0.4-SNAPSHOT(通用发行版)

基于 Spring Boot,内含 XWorker 安装与初始化程序(xworker.setup)。适用于所有操作系统。

⬇ 下载 xworker-2.0.4-SNAPSHOT.jar

1.3 运行安装程序(交互选择版本)

将下载的 jar 放到你希望作为 XWorker 工作目录的文件夹中,然后执行:

运行安装程序
java -jar xworker-2.0.4-SNAPSHOT.jar

程序会在当前目录判断是否存在 pom.xml。若不存在,将出现下面的版本选择菜单

💡 如果当前目录已经有 pom.xml(例如升级时),程序会直接使用现有 pom.xml,不显示此菜单,而直接执行构建。

1.4 自动构建(mvn package)与初始化

选定版本后,安装程序会自动完成以下工作:

  1. 创建 pom.xml:写入所选版本的 Maven 工程描述,声明对 xworker_swt_thingeditorxworker_webserver 等类库的依赖。
  2. 执行 mvn package:从 Maven 仓库(含 central-portal-snapshots 快照源)拉取所有依赖并打包。首次构建较慢,请耐心等待。
  3. 拷贝依赖:将依赖的 jar 拷贝到本地 lib/mvnlib_rap 等目录,供 XWorker 离线运行。
  4. 生成启动脚本:在目录下生成 swt.cmd/swt.shweb.cmd/web.sh 等启动入口。
  5. 初始化数据库与索引:完成 XWorker 运行所需的数据库与模型索引初始化。
⚠️ 首次构建耗时:由于要下载大量依赖,且部分来自境外快照源(Sonatype),首次 mvn package 可能需要较长时间,请勿中断。若网络中断,可重跑本命令续传。

1.5 生成统一启动器 xworker.cmd / xworker.sh

安装程序会生成 swt.cmd/swt.shweb.cmd/web.sh 等,但不会生成统一的 xworker.cmd / xworker.sh。为保证所有用户使用统一的启动入口、避免歧义,请手动复制一份(内容一致):

Windows(命令提示符)
REM 复制 swt.cmd 为 xworker.cmd(内容一致)
copy swt.cmd xworker.cmd
Linux / macOS
# 复制 swt.sh 为 xworker.sh(内容一致)并赋予执行权限
cp swt.sh xworker.sh
chmod +x xworker.sh
说明:xworker.cmd/xworker.shswt.cmd/swt.sh 内容完全相同,只是命名统一。后续无论启动还是升级,都统一使用 xworker.cmd(Windows)或 xworker.sh(Linux/macOS)。

1.6 启动 XWorker

Windows
xworker.cmd
Linux / macOS
./xworker.sh

启动后即进入 XWorker 的图形化模型编辑器,你可以开始创建模型、封装功能,以及创建属于你自己的 Agent 和工具了。

一键自动化安装脚本

为不同操作系统提供了一键自动化安装脚本。脚本会自动完成:检测并自动安装 Java 与 Maven → 下载发行版 jar → 提示选择版本 → 运行安装 → 生成统一的 xworker.cmd/xworker.sh,无需手工逐条执行。

3.1 下载脚本

🐞 Windows 脚本

install-xworker.bat — 右键以管理员身份运行。若需永久将 Maven 加入 PATH,请在脚本运行后按提示操作。

⬇ 下载 install-xworker.bat
🐧 Linux / macOS 脚本

install-xworker.sh — 下载后执行 bash install-xworker.sh 或先 chmod +x./install-xworker.sh

⬇ 下载 install-xworker.sh

3.2 使用步骤

  1. 下载对应系统的脚本,放到希望作为 XWorker 工作目录的文件夹中。
  2. 运行脚本(Windows 需管理员身份;Linux/macOS 用 bash 执行)。
  3. 脚本会依次:自动安装缺失的 Java / Maven → 下载 jar → 提示你选择版本(1=Java11 版、2=Java17 版、4=Web 版等)→ 运行安装并等待构建完成。
  4. 自动生成 xworker.cmd(Windows)或 xworker.sh(Linux/macOS)。
  5. 启动:双击 xworker.cmd,或执行 ./xworker.sh
💡 脚本做了哪些事?① 检测 Java,缺失则自动安装(Windows 用 winget 装 Temurin,Linux 用系统包管理器,macOS 用 Homebrew);② 检测 Maven,缺失则下载 apache-maven 3.9.x 到用户目录;③ 下载发行版 jar;④ 交由你选择版本后自动运行安装;⑤ 复制 swt.cmd/shxworker.cmd/sh
⚠️ 注意:脚本会自动安装 Java / Maven,需要管理员权限(Windows)或 sudo(Linux 用 apt/yum 时)。若你已有 Java/Maven,脚本会直接复用,不会重复安装。Windows 下 Maven 默认只对当前会话生效,若希望全局可用,可按脚本输出的提示手动加入系统 PATH。

方式二:Windows 绿色版

如果你在 Windows 上且还没有安装 Java 和 Maven,推荐使用绿色版——它已经把所有运行时(含 Java 与 Maven)打好包,解压即用,无需任何环境配置。

4.1 下载绿色版

XWorker 2.0.4b · Windows 绿色版

免安装、解压即用,内置 Java 与 Maven 运行环境,包含完整动态模型引擎与模型编辑器。

⬇ 下载 xworker2.0.4b.zip

4.2 解压与安装

  1. 将下载的 xworker2.0.4b.zip 解压到本地磁盘。建议解压到不含中文和空格的路径,例如 C:\xworker\
  2. 绿色版 无需安装程序、无需写注册表,解压即完成"安装"。
  3. 删除整个目录即可彻底卸载。

4.3 启动

进入解压目录,双击启动脚本即可(绿色版已内置统一启动脚本):

解压目录中的启动脚本
xworker.cmd          # 统一启动器(模型编辑器)
web.cmd            # 启动 Web 版编辑器

4.4 从绿色版升级到 Jar 方式(可选)

💡 若你已有 Java/Maven 环境,或希望像标准项目一样通过 Maven 管理依赖、灵活升级,可采用方式一(Jar 安装)在新目录中重新初始化一个标准工作目录,再把绿色版中的 projects 等自建内容迁移过去即可。

升级 XWorker

XWorker 的后续升级主要通过修改 pom.xml 实现,然后重新执行 java -jar xworker-2.0.4-SNAPSHOT.jar 完成安装与升级。

5.1 升级流程(通用)

  1. 修改 pom.xml:在 <dependencies> 中调整依赖的版本号(例如将 xworker_swt_thingeditor 的版本升级到最新 2.0.x),或新增你需要的类库依赖。
  2. 运行安装程序
    执行安装与升级
    java -jar xworker-2.0.4-SNAPSHOT.jar
  3. 因为此时目录下已存在 pom.xml,程序会直接使用现有 pom.xml 执行构建(不会让你重新选择版本),拉取新版依赖并更新 lib/mvnlib_rap 等目录及初始化索引。
  4. 重启 XWorker:关闭后重新执行 xworker.cmd(Windows)或 ./xworker.sh(Linux/macOS),即完成升级。

5.2 举个升级例子

假设你想把 XWorker 从当前版本升到新版本,只需在 pom.xml 中把依赖版本号提高:

修改 pom.xml 中的依赖版本
<!-- 修改前 -->
<dependency>
    <groupId>org.xworker</groupId>
    <artifactId>xworker_swt_thingeditor</artifactId>
    <version>2.0.4-SNAPSHOT</version>
</dependency>

<!-- 修改后:升级到新版本 -->
<dependency>
    <groupId>org.xworker</groupId>
    <artifactId>xworker_swt_thingeditor</artifactId>
    <version>2.0.5-SNAPSHOT</version>
</dependency>

5.3 升级安装新类库

XWorker 通过 Maven 管理依赖,因此安装新的类库也是通过修改 pom.xml 添加依赖来实现的:

在 pom.xml 中新增依赖
<!-- 在 <dependencies> 中新增一个类库依赖 -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>some-lib</artifactId>
    <version>1.0.0</version>
</dependency>

保存后重新运行 java -jar xworker-2.0.4-SNAPSHOT.jar,依赖就会被拉取并随之可用。这也印证了最初那句话:XWorker 本质是一个 Maven 管理的 Java 项目,安装、升级、增删依赖,全都统一收敛到 Maven 的 pom.xml 上。

提示:升级前建议先备份工作目录下的资源(如 projects、你自己创建的模型)。使用 java -jar 前,若某依赖下载失败,可重跑命令续传,Maven 会自动断点重试(大文件网络波动时可配合 aria2c / curl 续传,详见帮助文档)。
?

常见问题(FAQ)

Q1:我用的方法一(Jar),安装后没有 xworker.cmd / xworker.sh,怎么启动?

安装程序只生成 swt.cmd/swt.shweb.cmd/web.sh 等,不生成 xworker.cmd/xworker.sh。请将 swt.cmd 复制为 xworker.cmd(Windows),或将 swt.sh 复制并 chmod +xxworker.sh(Linux/macOS),内容一致。我们统一用 xworker.cmd/xworker.sh 启动,避免歧义。一键安装脚本会自动完成这一步。

Q2:运行 java -jar 时弹出版本选择菜单,我该选哪个?

一般的桌面/编辑器使用选 1(Java 11 版,推荐);若你跟进了最新 SWT(因最新 SWT 已不支持 Java 11),选 2(Java 17 版);仅需通过浏览器使用选 4(Web 版)3(Explorer 版)已不建议。选 5 退出。

Q3:运行后提示没有 Java 或 Maven?

Jar 方式需要自行安装 Java(JDK 8+)与 Maven 3。请用 java -versionmvn -version 验证;或用我们提供的一键脚本(自动安装)。若在 Windows 的新手,直接推荐使用绿色版。

Q4:首次 mvn package 很慢 / 卡住怎么办?

首次需要从中央仓库与 central-portal-snapshots 快照源下载大量依赖,且部分境外源速度波动大,请耐心等待。网络中断时重跑命令会自动续传;超大文件(>1MB)下载失败时可手动用 aria2ccurl -C - 续传到本地 Maven 仓库后重试。

Q5:如何彻底卸载 XWorker?

Jar 安装:删除工作目录即可(含 pom.xmllibprojects 等)。绿色版:删除解压目录即可。都不会写注册表,因此无需其它卸载动作。

Q6:XWorker 与 x-meta 是什么关系?

x-meta(X-Meta)是动态模型引擎(核心运行时),xworker 是基于该引擎开发的完整平台(模型库、IDE、Web 组件等)。安装 XWorker 时,Maven 会自动拉取所需的 xworker_* 类库(它们已包含引擎),无需单独安装。

Q7:我可以通过 Maven 引入自己的类库吗?

当然可以。XWorker 本质是 Maven 项目,你在 pom.xml 中新增任意依赖,再用 java -jar xworker-2.0.4-SNAPSHOT.jar 重新构建即可将其纳入 XWorker。这也是"封装 Java 能力成模型、扩展 XWorker"的基础。