# jiu-ling

**Repository Path**: SimingZiling/jiu-ling

## Basic Information

- **Project Name**: jiu-ling
- **Description**: 玖靈工具集合，包含开发所需工具以及三方工具集合
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-09-08
- **Last Updated**: 2026-05-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jiu-ling

`jiu-ling` 是一个基于 Java 的多模块工具与三方能力集成工程，采用 Maven 多模块结构统一管理。

## 项目定位

该仓库用于：

- 提供通用基础能力（core、crypto、request、network 等）
- 提供业务扩展能力（office、orm、oss、qrcode、video 等）
- 提供三方平台能力封装（tripartite）

## 模块结构

当前主模块：

- `jiu-ling-core`
- `jiu-ling-crypto`
- `jiu-ling-email`
- `jiu-ling-network`
- `jiu-ling-request`
- `jiu-ling-tripartite`
- `jiu-ling-office`
- `jiu-ling-orm`
- `jiu-ling-oss`
- `jiu-ling-qrcode`
- `jiu-ling-video`

## 环境要求

- JDK 21
- Maven（推荐优先使用仓库根目录 `./mvnw`）

## 常用命令

在仓库根目录执行：

### 1. 全量编译

```bash
./mvnw clean package -DskipTests
```

### 2. 全量测试

```bash
./mvnw test -DskipTests=false
```

### 3. 指定模块构建（示例）

```bash
./mvnw -pl jiu-ling-core -am package -DskipTests
```

### 4. 指定模块测试（示例）

```bash
./mvnw -pl jiu-ling-core -am test -DskipTests=false
```

## 开发约定

- 参数校验优先复用 `Assertions` / `Verify`。
- 模块私有依赖优先在模块内 `pom` 显式维护版本。
- 异常体系优先继承 `JiuLingRuntimeException`。
- 方法 Javadoc 放在注解上方。
- 测试 `@DisplayName` 使用中文。

## 文档约定

- 各模块维护自己的 `README.md` 与 `AGENTS.md`。
- 聚合模块文档主要说明模块职责、子模块边界、构建命令与治理规则。