zihluwang
5b7c24fb0d
Add English and Chinese docs for the OnixByte Toolbox monorepo covering all six modules: common-toolbox, crypto-toolbox, math-toolbox, tuple, identity-generator, and version-catalogue.
55 lines
1.9 KiB
Plaintext
55 lines
1.9 KiB
Plaintext
---
|
|
title: OnixByte Toolbox
|
|
---
|
|
|
|
## 介绍
|
|
|
|
OnixByte Toolbox 是一个面向 Java 应用的开发工具包，提供了一系列便捷、可复用的工具，帮助开发者高效编写代码。它由 OnixByte 设计和维护，采用 monorepo 架构，包含多个专用库，每个库解决一个特定的开发需求 — 从通用工具类和密码学，到数学计算和标识符生成。
|
|
|
|
该工具包已发布到 Maven Central，使用 `com.onixbyte` 作为 group ID。每个模块独立版本管理，可在任何 Java 17+ 项目中使用。
|
|
|
|
## 模块
|
|
|
|
| 模块 | Artifact ID | 描述 |
|
|
|---|---|---|
|
|
| Common Toolbox | `common-toolbox` | 日常工具类 — AES 加密、哈希、Base64、集合、分支、范围 |
|
|
| Crypto Toolbox | `crypto-toolbox` | RSA 和 ECDSA 算法的公私钥加载 |
|
|
| Math Toolbox | `math-toolbox` | 统计计算、百分位数分析、四分位数计算 |
|
|
| Tuple | `tuple` | 泛型二元组和三元组，含不可变版本 |
|
|
| Identity Generator | `identity-generator` | 雪花算法和顺序 UUID 唯一标识符生成 |
|
|
| Version Catalogue | `version-catalogue` | OnixByte 项目的集中式 Gradle 版本目录 |
|
|
|
|
## 安装
|
|
|
|
在构建配置中添加所需模块的依赖：
|
|
|
|
**Gradle (Kotlin DSL):**
|
|
|
|
```kotlin
|
|
implementation("com.onixbyte:common-toolbox:$version")
|
|
implementation("com.onixbyte:crypto-toolbox:$version")
|
|
implementation("com.onixbyte:math-toolbox:$version")
|
|
implementation("com.onixbyte:tuple:$version")
|
|
implementation("com.onixbyte:identity-generator:$version")
|
|
```
|
|
|
|
**Maven:**
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>com.onixbyte</groupId>
|
|
<artifactId>common-toolbox</artifactId>
|
|
<version>${version}</version>
|
|
</dependency>
|
|
```
|
|
|
|
可查阅[更新日志](https://codecrafters.org.cn/devkit/changelog)了解可用版本。
|
|
|
|
## 要求
|
|
|
|
- Java 17 或更高版本
|
|
|
|
## 许可证
|
|
|
|
OnixByte Toolbox 是采用 MIT 许可证发布的开源软件。
|