# gress

**Repository Path**: XYJXUST/gress

## Basic Information

- **Project Name**: gress
- **Description**: Gress 是一个现代化的企业级插件系统平台：宿主应用（gress-web + gress-fronted）提供统一的插件运行时与扩展机制，业务以**插件包（JAR + 前端 UMD）**形式安装、启动与卸载，无需改动宿主核心代码。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-26
- **Last Updated**: 2026-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gress - 企业级微内核插件系统平台

<div align="center">

![Gress Logo](docs/images/logo.png)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Java](https://img.shields.io/badge/Java-21-orange.svg)](https://openjdk.org/)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2.0-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![Vue](https://img.shields.io/badge/Vue-3.4-4FC08D.svg)](https://vuejs.org/)
[![PF4J](https://img.shields.io/badge/PF4J-3.13.0-blue.svg)](https://pf4j.org/)

**基于 PF4J 包加载 + Gress 扩展生命周期的企业级插件系统平台**

[English](README_EN.md) | 简体中文

[在线演示](#-在线演示) • [界面示例](#-界面示例) • [快速开始](#-快速开始) • [文档](#-文档) • [插件开发](#-插件开发) • [贡献](#-贡献)

</div>

---

## 🌐 在线演示

| 项目 | 说明                                                 |
|------|----------------------------------------------------|
| **地址** | [http://gress.keqi.life/](http://gress.keqi.life/) |
| **默认账号** | `test`                                             |
| **默认密码** | `36mpbEW18fX0`                                     |

演示环境为已部署的宿主实例，可直接体验插件安装、应用切换与业务插件能力（具体已装插件以线上为准）。

---

## 📷 界面示例

以下截图来自线上演示环境 [http://gress.keqi.life/](http://gress.keqi.life/)（`test` / `36mpbEW18fX0`），展示宿主与典型插件的管理界面。

### 应用管理（宿主）

集中查看已安装插件包：版本、运行状态、配置/重启等运维操作。

![应用管理 - 我的应用](docs/images/demo/app-management.png)

### 插件面板注入（devpanel 示例）

除路由、菜单外，插件可在前端 `PluginManifest.extensions.panels` 中声明**可停靠面板**，由宿主 `PanelManager` 统一挂载到布局的 **底部**、**右侧**、**左侧** 或 **模态** 区域；用户通过边缘触发条打开/切换，不占用主内容路由区域。

| 挂载位置 | `position` | 典型用途 |
|----------|------------|----------|
| 底部 | `bottom` | 日志流、终端、调试输出（如「服务日志」） |
| 右侧 | `right` | 辅助工具、测试面板、上下文信息（可注册多个面板，右侧图标切换） |
| 左侧 | `left` | 导航辅助、筛选器等 |
| 模态 | `modal` | 临时弹层类面板 |

参考实现见 [`gress-plugin-devpanel`](../gress-plugin-devpanel) 前端工厂中的 `extensions.panels`（`ServerLogPanel` → `bottom`，`RightTestPanel` → `right`）。

**底部面板**：在应用管理页底部展开「服务日志」，实时查看宿主/插件输出（SSE）。

![插件面板 - 底部注入（服务日志）](docs/images/demo/plugin-panel-bottom.png)

**右侧面板**：右侧边缘显示面板入口图标，点击后滑出插件注入的测试面板（多面板时可在右侧切换）。

![插件面板 - 右侧注入](docs/images/demo/plugin-panel-right.png)

插件侧声明示例：

```typescript
extensions: {
  panels: [
    {
      id: 'server-log',
      title: '服务日志',
      component: ServerLogPanel,
      position: 'bottom',   // bottom | right | left | modal
      icon: 'Terminal',
      defaultOpen: false,
      order: 10
    },
    {
      id: 'right-test',
      title: '右侧测试',
      component: RightTestPanel,
      position: 'right',
      icon: 'FlaskOutline',
      order: 20
    }
  ]
}
```

安装 devpanel 等声明了 `plugin.ui.hasPanel: true` 的插件后，在宿主布局中即可使用上述面板能力。详见 [`gress-fronted/src/services/PanelManager.ts`](gress-fronted/src/services/PanelManager.ts)。

### 应用配置（宿主）

单插件运维配置：路由、会话（并发登录、存储、超时、同端策略等）、安全（超级管理员）等，保存后由宿主与插件协同生效。

![应用配置](docs/images/demo/app-config.png)

### 应用详情 · 操作日志（宿主）

查看插件安装/升级/重启等运维记录：操作人、耗时、结果与说明，便于审计与排障。

![应用详情 - 操作日志](docs/images/demo/app-operation-log.png)

### 宿主 · 界面配置

全局外观与侧栏：浅色/深色主题、经典侧栏 / OA 顶栏布局、侧栏快捷应用数量等。

![宿主 - 界面配置](docs/images/demo/ui-settings.png)

### IAM · 认证配置（iam 插件）

注册/登录策略：按渠道（互联网注册、邀请、管理员创建等）配置自助注册与多种登录方式。

![IAM - 注册/登录策略](docs/images/demo/auth-login-policy.png)

### IAM · MFA 策略

全局 MFA：强制模式、已绑定用户登录是否需 MFA、Step-up 有效期等。

![IAM - MFA 策略](docs/images/demo/auth-mfa-policy.png)

### IAM · 权限管理

按角色为应用分配权限树，支持保存变更与权限反查。

![IAM - 权限管理](docs/images/demo/permission-management.png)

### 配置中心 · 维护公告（config-center 插件）

维护模式开关、公告文案、时间窗、访问白名单及登录/匿名访问限制等。

![配置中心 - 维护公告](docs/images/demo/maintenance-announcement.png)

---

## 📖 简介

Gress 是一个现代化的**企业级插件系统平台**：宿主应用（`gress-web` + `gress-fronted`）提供统一的插件运行时与扩展机制，业务以**插件包（JAR + 前端 UMD）**形式安装、启动与卸载，无需改动宿主核心代码。

典型场景包括：IAM、应用商店等**应用插件**，可插拔的**中间件**，以及可选的**触发器/任务节点**（用于工作流编排类扩展，而非平台本体定位）。

### ✨ 核心特性

#### 🔌 插件包与扩展体系

- **四类插件类型**：`APPLICATION`（应用）、`TRIGGER`（触发器）、`TASK`（任务节点）、`MIDDLEWARE`（中间件）
- **PF4J 负责 JAR 加载**：`DefaultPluginManager` + `Pf4jPackageAdapter` 管理类加载与启停
- **Gress 负责编排**：`PluginPackageLifecycleManager` + `PluginExtensionManager` 驱动安装/启动/停止/卸载及扩展链
- **包级清单 `plugin.yml`**：定义插件 id、入口类、依赖、UI、配置、治理信息；构建期生成 `plugin.properties`
- **扩展点 `@PluginSpec`**：标注 PF4J 扩展类（工作流节点、前端 `jsPath` 等），由 `PluginSpecScannerExtension` 扫描入 `PluginRepository`

#### 🧩 插件内 DI（非嵌套 Spring Boot）

- 每个插件包拥有独立 **`PluginContainer`**（`gress-core` 自定义 DI）
- 支持 `@Service`、`@Inject`、`@ConfigurationProperties`、`@Value` 等（语义类似 Spring，运行在插件 ClassLoader 内）
- 配置来自 **`PluginEnvironment`**：`plugin.yml` 的 `config` 段 + 数据库覆盖（`PluginConfigLoader` / `PluginConfigLoaderExtension`）

#### 🎨 前端插件运行时

- **生产环境**：加载插件构建产物 **IIFE/UMD**（`window.__GRESS_PLUGIN__`），工厂函数 `createPlugin(bridge, properties) → PluginManifest`
- **开发环境**：Vite 动态 `import()` + `plugin-dev-server` 热更新
- **`GressBridge`**：HTTP、路由、Pinia、权限、UI 插槽等宿主能力（`@keqi.gress/plugin-bridge`）
- **`extensions.panels`**：插件可向宿主布局注入底部/右侧等可停靠面板（`PanelManager`），见 [界面示例 · 插件面板注入](#插件面板注入devpanel-示例)
- 生命周期词汇为 **`activate` / `deactivate` / `uninstall`**（仅前端 manifest，与后端 PF4J 阶段不同）

#### 🚀 可选能力：工作流编排扩展

- 平台核心是**插件加载、生命周期、配置与 UI 扩展**；工作流是宿主上的一类可选场景
- `TRIGGER` / `TASK` 插件类型、Vue Flow 设计器、`TriggerLifecycleManager`、`WorkflowExecutor` 等
- 使用工作流能力时，SSE 可推送执行状态与日志

#### 🏢 企业级能力

- 多租户、RBAC、应用商店（独立插件仓库 `gress-plugin-appstore` 等）
- 插件 Flyway 迁移（`DatabaseMigrationExtension`）
- 可选 Redis 分布式锁、RocketMQ、文件存储（x-file-storage）

---

## 🏗️ 架构设计

### 模块与仓库布局

```
Maven 反应堆（根 pom.xml）
├── gress-common          # 公共类型、@PluginSpec、PluginType、触发器/任务接口
├── gress-core            # 插件生命周期、PF4J 适配、PluginContainer、工作流、启动编排
├── gress-plugin-api      # PluginLifecycleHook、管理 API 等插件侧契约
├── gress-bootstrap       # 首次安装向导（中间件配置、overlay 配置）
├── gress-plugin-build    # 插件工程构建工具
├── gress-plugin-parent   # 外部插件 Maven 父 POM
└── gress-web             # Spring Boot 宿主（API、SSE、安全、静态资源）

仓库内非 Maven 模块
├── gress-fronted/        # Vue 3 宿主前端（构建后由 gress-web 打入静态资源）
└── gress-plugin-packages/# 共享 npm 包：plugin-bridge、plugin-ui、shared-utils、plugin-dev-server

业务插件（通常独立 Git 仓库，安装为 JAR）
├── gress-plugin-iam/     # 权限 / 登录等
├── gress-plugin-appstore/
└── …
```

### 后端分层

```
┌─────────────────────────────────────────────────────────────┐
│ gress-web（Spring Boot 宿主，单进程）                          │
│  REST / SSE / 安全 / 多租户 / 插件管理 API                      │
│  context-path 默认 /gress，端口默认 8082                        │
└───────────────────────────┬─────────────────────────────────┘
                            │
┌───────────────────────────▼─────────────────────────────────┐
│ gress-core                                                   │
│  PluginPackageLifecycleManager  install / start / stop / …   │
│  PluginExtensionManager         BEFORE/AFTER 扩展链           │
│  PluginPackageStartupService    按 plugin.startup.package-ids 启动 │
│  Pf4jPackageAdapterImpl         PF4J 加载 JAR                 │
│  PluginContainer + DI 注解        插件内 Bean                    │
│  PluginConfigLoader             plugin.yml + DB 配置合并        │
│  可选工作流：TriggerLifecycleManager、WorkflowExecutor 等       │
└───────────────────────────┬─────────────────────────────────┘
                            │
┌───────────────────────────▼─────────────────────────────────┐
│ 已安装插件 JAR（PF4J pluginsDir，默认 plugins/）               │
│  每包：plugin.yml、扩展类、Flyway、Controller（经宿主路由暴露）   │
└─────────────────────────────────────────────────────────────┘
```

### 插件包生命周期（后端）

与前端 manifest 的 `activate` **不是同一套概念**。后端主路径：

| 阶段 | 说明 | 关键类 |
|------|------|--------|
| **INSTALL** | 加载 JAR、PF4J start、扩展链 AFTER：扫描 `@PluginSpec`、合并配置、启动 `PluginContainer`、Flyway | `PluginPackageLifecycleManager` |
| **START** | 重启/加载后再次启动容器与服务 | 同上 + `PluginConfigLoaderExtension` |
| **STOP** | 停止容器、反注册服务 | `DIContainerScannerExtension` 等 |
| **UNINSTALL** | PF4J stop/unload、清理仓库与资源 | `PluginPackageLifecycleManager` |
| **UPGRADE / RELOAD** | 升级与热重载场景 | `LifecycleContext` / `UpgradeContext` |

每个阶段还有 **BEFORE / AFTER**，由 `PluginLifecycleEventType` + `LifecyclePhase` 分发给各 `PluginExtension`。

插件入口类可实现 **`PluginLifecycleHook`**（`BEFORE_INSTALL`、`AFTER_START` 等），由 `PluginLifecycleHookDispatcher` 调用。

### 前端加载流程（概要）

```
initializePluginFramework()
  → createPluginBridge()   // window.GressBridge
  → createPluginRuntime()  // window.__GRESS_PLUGIN_RUNTIME__

生产：plugin-loader 插入 <script> 加载 *.umd.js
  → window.__GRESS_PLUGIN__.createPlugin(bridge, props)
  → PluginManifest（routes / menus / lifecycle.activate）

开发：动态 import + plugin-dev-server 代理
```

### 配置体系

| 来源 | 作用 |
|------|------|
| **`plugin.yml`** | 包 id、主类、版本、依赖、`ui`（菜单/路由壳）、`plugin.config` / 顶层同级块（如 `appstore:`） |
| **数据库插件配置** | 覆盖文件配置（安装后可在应用商店/配置中心修改） |
| **`PluginEnvironment`** | 扁平化 key（如 `up.login.passwordRsa.privateKey`），供 `@Value` / `@ConfigurationProperties` |
| **`application.yml`** | 宿主级：`plugin.startup.package-ids`、`pf4j.pluginsDir`、`gress.api-sign` 等 |

---

## 🚀 快速开始

### 一键 Docker 启动（推荐）

使用 [devops/single/docker-compose.yml](devops/single/docker-compose.yml) 拉起 **MySQL + Redis + gress-web + gress-frontend**，无需本地安装 Java / Node / Maven。

**环境要求**：Docker 20+、Docker Compose v2

```bash
# 在仓库根目录执行
cd devops/single

# 首次启动：复制环境变量（按需修改 MySQL/Redis 密码）
cp .env.example .env

# 一键启动（拉取镜像并后台运行）
docker compose --env-file .env up -d
```

或使用封装脚本（效果相同）：

```bash
cd devops/single
cp .env.example .env   # 首次
./deploy.sh
```

| 服务 | 地址 |
|------|------|
| **前端** | http://localhost:3000 |
| **后端 API** | http://localhost:8082/gress |
| **Swagger** | http://localhost:8082/gress/swagger-ui.html |

默认从 Docker Hub 拉取公共镜像 `keqi123/gress-web`、`keqi123/gress-frontend`；镜像内已内置种子插件（appstore、config-center），首次启动会自动安装。

常用命令：

```bash
cd devops/single
docker compose --env-file .env ps          # 查看状态
docker compose --env-file .env logs -f     # 查看日志
docker compose --env-file .env down          # 停止并移除容器
```

> **Mac / Windows**：`.env` 中已使用相对路径挂载本地目录（`./runtime/gress-web`），勿使用 Linux 服务器路径 `/home/gress/...`。  
> **x86 服务器部署**：`.env` 中设置 `DOCKER_PLATFORM=linux/amd64`（见 `.env.example`）。若 Hub 上镜像是 Apple Silicon 构建的 arm64，需在构建机执行 `PLATFORM=linux/amd64 ./devops/publish-dockerhub-images.sh` 重新推送。  
> 更多部署细节见 [devops/single/README.md](devops/single/README.md)、[docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)。

---

### 本地源码开发

#### 环境要求

- **Java** 21+
- **Node.js** 18+
- **Maven** 3.8+
- **MySQL** 8.0+
- **Redis** 6.0+（可选，分布式锁/会话）
- **RocketMQ** 4.9+（可选）

### 1. 克隆与数据库

```bash
git clone <your-gress-repo-url>
cd gress
```

```sql
CREATE DATABASE gress DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

配置 `gress-web/src/main/resources/application.yml`（或使用 `application-<profile>.yml`）中的数据源。

### 2. 构建并启动后端

```bash
mvn clean install -DskipTests
cd gress-web
mvn spring-boot:run
# 或 java -jar target/gress-web-1.0-SNAPSHOT.jar
```

默认地址：

- API 根路径：`http://localhost:8082/gress`
- Swagger UI：`http://localhost:8082/gress/swagger-ui.html`

### 3. 启动前端（开发）

```bash
cd gress-fronted
npm install
npm run dev
```

- 前端：`http://localhost:3000`
- 开发代理：`/api` → `http://localhost:8082/gress`（见 `vite.config.ts`）

### 4. 插件目录与启动列表

宿主默认从 **`plugins/`** 目录（`pf4j.pluginsDir`）加载 JAR。在 `application.yml` 中可指定启动包：

```yaml
plugin:
  startup:
    enabled: true
    package-ids:
      - appstore   # 与 JAR 内 plugin.yml 的 id 一致
```

首次安装还可通过 `plugin.seed-install` 从种子目录安装（见 `devops/single/plugins-seed/`）。

### 5. 集成部署

```bash
cd gress-fronted
npm run build:integrated   # 构建并复制到 gress-web/src/main/resources/static/
cd ../gress-web
mvn package -DskipTests
```

生产访问路径受 `VITE_BASE_PATH` / `server.servlet.context-path` 影响，常见为 **`/gress/`** 同源部署。

---

## 📚 文档

### 推荐阅读（准确索引）

| 文档 | 说明 |
|------|------|
| [docs/developer/README.md](docs/developer/README.md) | **开发者文档总索引** |
| [docs/developer/01-introduction.md](docs/developer/01-introduction.md) | 介绍 |
| [docs/developer/02-environment-and-quickstart.md](docs/developer/02-environment-and-quickstart.md) | 环境与快速上手 |
| [docs/developer/03-architecture-overview.md](docs/developer/03-architecture-overview.md) | 架构总览 |
| [docs/developer/04-framework-capabilities.md](docs/developer/04-framework-capabilities.md) | 框架能力 |
| [docs/developer/05-plugin-development-practice.md](docs/developer/05-plugin-development-practice.md) | 插件开发实践 |
| [docs/developer/06-lifecycle-and-events.md](docs/developer/06-lifecycle-and-events.md) | 生命周期与事件 |
| [docs/developer/11-plugin-architecture-and-fast-dev.md](docs/developer/11-plugin-architecture-and-fast-dev.md) | 插件架构与快速开发 |
| [docs/developer/12-frontend-host-architecture.md](docs/developer/12-frontend-host-architecture.md) | 前端宿主架构 |
| [docs/developer/13-frontend-bridge-capabilities.md](docs/developer/13-frontend-bridge-capabilities.md) | Bridge 能力 |
| [docs/PLUGIN_DEVELOPMENT_COMPLETE_GUIDE.md](docs/PLUGIN_DEVELOPMENT_COMPLETE_GUIDE.md) | 插件开发完整指南 |
| [docs/QUICK_START.md](docs/QUICK_START.md) | 快速开始补充 |
| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) | 部署 |

### 前端共享包

- [gress-plugin-packages/README.md](gress-plugin-packages/README.md)
- [PLUGIN_BUILD_GUIDE.md](gress-plugin-packages/PLUGIN_BUILD_GUIDE.md)
- [plugin-dev-server/README.md](gress-plugin-packages/plugin-dev-server/README.md)

### Agent / Skill（可选）

- [docs/skill2/gress-plugin/SKILL.md](docs/skill2/gress-plugin/SKILL.md) — 后端插件开发
- [docs/skill2/gress-frontend-plugin/SKILL.md](docs/skill2/gress-frontend-plugin/SKILL.md) — 前端插件开发

---

## 🔌 插件开发（精要）

### 1. 包清单 `plugin.yml`（必配）

位于 `*-service/src/main/resources/plugin.yml`，构建时生成 `plugin.properties`：

```yaml
plugin:
  id: iam
  class: com.example.iam.IamApplicationPlugin
  name: 权限管理
  version: 1.0.0
  type: APPLICATION
  dependencies:
    - config-center@>=1.0.2
  ui:
    hasPanel: false   # 为 true 时启用 PanelManager 面板注入能力
    hasWidget: false
    menus: [...]
    # 路由、治理、扩展菜单等；前端 panels 在 UMD 工厂 extensions.panels 中声明
  config:
    up:
      login:
        password-rsa:
          privateKey: |
            -----BEGIN PRIVATE KEY-----
            ...
```

顶层还可有与 `plugin.config` 同级的块（如 `appstore:`），由 `PluginConfigLoader` 展平合并（顶层键可覆盖 `plugin.config` 同路径）。

### 2. 后端入口与扩展

```java
// PF4J 插件主类（plugin.class）
public class IamApplicationPlugin extends Plugin implements ApplicationPlugin {
    @Override
    public PluginType getType() { return PluginType.APPLICATION; }
}

// 工作流节点 / 带 jsPath 的扩展（@PluginSpec + @Extension）
@Extension
@PluginSpec(id = "http-request", name = "HTTP 请求", jsPath = "/js/up-frontend.umd.js")
public class HttpRequestTask implements Task { ... }
```

Controller 使用普通 Spring MVC 风格，由宿主统一暴露（路径常带 `/plugins/{pluginId}/...` 前缀，以具体插件为准）。

插件内注入配置：

```java
@Value("${up.login.passwordRsa.privateKey:}")
private String privateKey;
```

### 3. 前端工厂（生产 UMD）

```typescript
// index.ts — 打包为 UMD，挂载到 window.__GRESS_PLUGIN__
import type { PluginManifest } from '@keqi.gress/plugin-bridge'

export default function createPlugin(bridge: GressBridge, properties: Record<string, unknown>): PluginManifest {
  return {
    id: 'iam',
    name: '权限管理',
    version: '1.0.0',
    extensions: {
      routes: [{ path: '/plugins/iam/login', component: () => import('./views/LoginPage.vue'), meta: { requiresAuth: false } }],
      menus: [...]
    },
    lifecycle: {
      activate: async () => { /* 前端激活 */ },
      deactivate: async () => { /* 停用 */ }
    }
  }
}
```

敏感常量（如登录 RSA 公钥材料）可放在独立文件（例如 `constants/loginPasswordTransportMaterial.ts`），与后端 `plugin.yml` 私钥成对配置。

### 4. 构建与安装

- 后端：`mvn package` 产出插件 JAR，放入宿主 `plugins/` 或通过应用商店安装
- 前端：`vite build` → `*.umd.js`，路径写入 `@PluginSpec.jsPath` 或 `plugin.yml` UI 配置
- 本地联调：使用 `plugin-dev-server` + 宿主 `VITE_PLUGIN_LOCAL_PATH`

更完整步骤见 [docs/developer/05-plugin-development-practice.md](docs/developer/05-plugin-development-practice.md)。

---

## 📦 项目结构

```
gress/
├── gress-common/                 # 公共模块
├── gress-core/                   # 核心运行时
│   └── src/main/java/com/keqi/gress/core/
│       ├── plugins/              # 生命周期、PF4J、配置、扩展
│       ├── di/                   # PluginContainer、注解注入
│       ├── plugins/startup/      # PluginPackageStartupService
│       └── trigger/ workflow/    # 工作流与触发器
├── gress-plugin-api/
├── gress-bootstrap/
├── gress-plugin-build/
├── gress-plugin-parent/
├── gress-web/                    # Spring Boot 宿主
│   └── src/main/resources/
│       ├── application.yml
│       └── static/               # 集成构建后的 gress-fronted
├── gress-fronted/                # Vue 宿主（npm 工程）
│   └── src/
│       ├── bootstrap/            # pluginFramework 初始化
│       ├── core/                 # plugin-bridge、plugin-runtime、plugin-loader
│       └── stores/
├── gress-plugin-packages/        # npm 共享包
├── docs/developer/               # 权威开发文档
├── docs/skill2/                  # AI 辅助开发 skill
└── devops/                       # 单机/多机部署与种子插件
```

---

## 🛠️ 技术栈

### 后端

| 类别 | 技术 |
|------|------|
| 框架 | Spring Boot 3.2 |
| 插件加载 | PF4J 3.13 |
| ORM | MyBatis-Plus 3.5、Flyway |
| 缓存/锁 | Caffeine、Redis（可选） |
| 消息 | RocketMQ（可选） |
| 文件 | x-file-storage |
| 工具 | Hutool、Guava、Fastjson2 |

### 前端

| 类别 | 技术 |
|------|------|
| 框架 | Vue 3.4、Vite 5 |
| UI | Naive UI |
| 状态/路由 | Pinia、Vue Router |
| HTTP | Axios（经 Bridge 封装） |
| 流程图 | Vue Flow |
| 编辑器 | Monaco Editor |

---

## 🎯 示例与周边仓库

### 线上演示

- 站点：[http://gress.keqi.life/](http://gress.keqi.life/)（登录：`test` / `36mpbEW18fX0`）
- 界面截图见上文 [界面示例](#-界面示例)

### 独立插件仓库

本仓库**不包含**所有业务插件源码。常见独立仓库示例：

| 仓库/目录 | 说明 |
|-----------|------|
| `gress-plugin-appstore` | 应用商店、插件安装 |
| `gress-plugin-iam` | IAM、登录、权限（RSA 传输密码、菜单治理） |
| `gress-plugin-config-center` | 配置中心 |

### 本地联调

```
http://localhost:3000/plugins/appstore/applications   # 开发前端（需已安装 appstore 插件 JAR）
http://localhost:8082/gress/swagger-ui.html           # API 文档
```

---

## 🔐 宿主安全能力（可选）

`gress-web` 的 `application.yml` 支持 OpenAPI 风格请求签名校验（与前端 `gress-fronted/src/utils/apiSign.ts` 一致）：

```yaml
gress:
  api-sign:
    enabled: false
    api-app-id: ${GRESS_API_APP_ID:}
    api-app-secret: ${GRESS_API_APP_SECRET:}
```

启用后请求需携带 `appId`、`method`（路径）、`timestamp`、`sign`（MD5）等头；详见 `ApiSignVerifyFilter`。

---

## 🤝 贡献

1. Fork 本仓库
2. 创建特性分支（`git checkout -b feature/AmazingFeature`）
3. 提交更改并补充 `docs/developer` 相关说明
4. 推送并开启 Pull Request

提交前请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)、运行相关模块编译/测试，并更新文档索引。

---

## 📄 许可证

[Apache License 2.0](LICENSE)

---

## 🙏 致谢

- [PF4J](https://pf4j.org/) — 插件 JAR 与类加载
- [Spring Boot](https://spring.io/projects/spring-boot)
- [Vue.js](https://vuejs.org/)
- [Naive UI](https://www.naiveui.com/)
- [Vue Flow](https://vueflow.dev/)

---

## 📞 联系

- **邮箱**: [xyjxust@gmail.com](mailto:xyjxust@gmail.com)

---

**[⬆ 回到顶部](#gress---企业级微内核插件系统平台)**

Made with ❤️ by Gress Team