# Aether

**Repository Path**: yfengJ/aether

## Basic Information

- **Project Name**: Aether
- **Description**: 基于JetLinks的物联网整合项目
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-25
- **Last Updated**: 2026-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Aether

> 基于 [JetLinks 社区版](https://github.com/jetlinks/jetlinks-community) 学习改造的物联网基础平台统一父项目

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![Java](https://img.shields.io/badge/Java-21-orange.svg)
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.4.7-green.svg)

## 项目简介

Aether 是基于 JetLinks 社区版学习改造的物联网基础平台统一父项目，整合了以下核心模块：

- **hsweb-utils** - 基础工具库
- **hsweb-easy-orm** - 响应式 ORM 框架
- **hsweb-framework** - 企业级后台管理框架
- **reactor-ql** - SQL 驱动的响应式数据处理引擎
- **reactor-excel** - 响应式 Excel/CSV 导入导出
- **jetlinks** - JetLinks 核心模块（设备管理、协议适配、规则引擎）
- **jetlinks-plugin** - 插件化框架
- **jetlinks-sdk** - 设备 SDK
- **jetlinks-official-protocol** - 官方协议适配
- **jetlinks-community** - 社区版应用

## 技术栈

- **Java** - 21
- **Spring Boot** - 3.4.x
- **Spring WebFlux** - 响应式 Web 框架
- **R2DBC** - 响应式数据库驱动
- **Netty / Vert.x** - 高性能网络框架
- **Project Reactor** - 响应式编程
- **Redis** - 缓存
- **PostgreSQL / TimescaleDB** - 时序数据存储
- **Elasticsearch** - 全文检索（可选）

## 项目架构

```
Aether (统一父项目)
├── hsweb-utils          # 基础工具层
├── hsweb-easy-orm       # ORM 框架层
├── hsweb-framework       # 业务框架层
├── hsweb-expands        # 框架扩展
├── reactor-ql           # 数据处理引擎
├── reactor-excel        # Excel/CSV 导入导出
├── jetlinks             # 核心层
│   ├── rule-engine       # 规则引擎
│   ├── jetlinks-core     # 核心 API
│   └── jetlinks-supports # 默认实现
├── jetlinks-plugin       # 插件系统层
├── jetlinks-sdk         # SDK 层
├── jetlinks-official-protocol  # 官方协议层
└── jetlinks-community    # 社区应用层
    ├── jetlinks-components   # 组件库
    ├── jetlinks-manager      # 管理模块
    └── jetlinks-standalone  # 独立应用
```

## 核心特性

### 统一设备接入
- 支持 TCP/UDP/MQTT/HTTP 等多种协议
- 支持 TLS/DTLS 加密传输
- 统一设备管理和消息分发
- 灵活的协议适配扩展机制

### 规则引擎
- SQL 驱动的数据处理（Reactor QL）
- 可视化规则配置
- 设备告警和场景联动
- 支持自定义规则模型

### 响应式架构
- 基于 Spring WebFlux + Reactor
- 全异步非阻塞设计
- 高并发性能
- 统一的响应式数据访问

### 插件化
- 热插拔插件系统
- 动态扩展功能
- 插件隔离机制

## 快速开始

### 前置要求

- JDK 21+
- Maven 3.8+
- Redis 6+
- PostgreSQL 13+ 或 TimescaleDB

### 克隆项目

```bash
git clone https://gitee.com/yfengJ/aether.git
cd aether
```

### 构建项目

```bash
# 构建所有模块
mvn clean install

# 跳过测试
mvn clean install -DskipTests

# 构建指定模块
cd jetlinks-community/jetlinks-standalone
mvn clean package
```

### 运行项目

参考各子模块的 README 获取详细启动说明：

- [jetlinks-community](./jetlinks-community/README.md) - 完整 IoT 平台应用
- [reactor-ql](./reactor-ql/README.md) - 数据处理引擎
- [reactor-excel](./reactor-excel/README.md) - Excel/CSV 导入导出
- [jetlinks-plugin](./jetlinks-plugin/README.md) - 插件系统
- [hsweb-framework](./hsweb-framework/README.md) - 业务框架

## 模块说明

| 模块 | 说明 | 状态 |
|------|------|------|
| hsweb-utils | 基础工具类、缓存、并发封装 | ✅ |
| hsweb-easy-orm | R2DBC 的 ORM 封装，支持 H2/MySQL/PostgreSQL | ✅ |
| hsweb-framework | 响应式权限管理、数据权限、动态数据源 | ✅ |
| hsweb-expands | 框架扩展模块（安全、脚本、模板等）| ✅ |
| reactor-ql | 使用 SQL 描述响应式数据处理流程 | ✅ |
| reactor-excel | 响应式 Excel/CSV 导入导出 | ✅ |
| jetlinks-core | 设备注册中心、消息定义、协议 SPI | ✅ |
| jetlinks-supports | 核心模块的默认实现 | ✅ |
| rule-engine | 基于规则的响应式数据处理引擎 | ✅ |
| jetlinks-plugin | 响应式插件化框架 | ✅ |
| jetlinks-sdk | 设备接入 SDK | ✅ |
| jetlinks-official-protocol | 官方协议适配器 | ✅ |
| jetlinks-community | 完整的 IoT 平台应用 | ✅ |

## 开发指南

### 代码规范

- 遵循现有代码风格
- 使用 Java 21 特性（Record、Pattern Matching 等）
- 响应式编程最佳实践

### 提交规范

```
feat: 新功能
fix: 修复 bug
docs: 文档更新
style: 代码格式调整
refactor: 代码重构
test: 测试相关
chore: 构建/工具相关
```

## 致谢

本项目基于以下开源项目改造：

- [JetLinks 社区版](https://github.com/jetlinks/jetlinks-community) - 物联网基础平台
- [HSWeb Framework](https://github.com/hs-web/hsweb-framework) - 企业级框架
- [Reactor QL](https://github.com/jetlinks/reactor-ql) - SQL 驱动的响应式数据处理

感谢所有贡献者！

## 许可证

本项目基于 JetLinks 社区版学习改造，遵循 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) 许可协议。

- [查看完整 LICENSE](./LICENSE)
- [JetLinks 原始许可](https://github.com/jetlinks/jetlinks-community/blob/master/LICENSE)
- [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

## 联系方式

- **作者**: yifengJ (Vally)
- **邮箱**: zzyyfeng@gmail.com
- **仓库**: https://gitee.com/yfengJ/aether

## 项目说明

> ⚠️ **本项目仅用于学习目的**

本项目是学习改造项目，基于 JetLinks 社区版代码进行了调整和扩展。如需用于生产环境，请：

1. 遵守 Apache 2.0 许可协议
2. 保留原始版权声明
3. 标注修改内容
4. 不使用 JetLinks 商标

## Star History

[![Stargazers over time](https://starchart.cc/yfengJ/aether?variant=adaptive)](https://gitee.com/yfengJ/aether/stargazers)