# jparent

**Repository Path**: huanminabc/jparent

## Basic Information

- **Project Name**: jparent
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-05
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, java自研组件

## README

# jparent 文档入口

`/docs` 是 `jparent` 工作区的统一文档入口。这个仓库是多项目 Maven 聚合工作区，不是单一应用，文档也按项目分目录维护。

## 工作区项目

### 启动框架与扩展

- [fast-boot](./fast-boot/README.md)
  - 容器、配置、生命周期、Web、ORM、测试支持、Maven 打包插件

### 基础库

- [jcommon](./jcommon/README.md)
  - 通用工具、反射、并发、文件、加密、线程池
- [jfast-cache](./jfast-cache/README.md)
  - 缓存统一 API、内存缓存、本地持久化扩展
- [jlambda-sql](./jlambda-sql/README.md)
  - SQL DSL、实体映射注解、JDBC 快速调用
- [jmapstruct-extend](./jmapstruct-extend/README.md)
  - MapStruct 转换接口约定与辅助注解
- [jnetty](./jnetty/README.md)
  - Netty 封装、TCP/HTTP/WebSocket 能力
- [jtimerwheel](./jtimerwheel/README.md)
  - 时间轮调度、解析器语法、Starter
- [null-chain](./null-chain/README.md)
  - 空值安全链式调用、NF 脚本、专题文档

## 推荐阅读顺序

### 只想用 fast-boot 写业务项目

1. [fast-boot](./fast-boot/README.md)
2. [启动生命周期说明](./fast-boot/startup-lifecycle.md)
3. [app-parent 与打包插件说明](./fast-boot/app-parent-与-plugin.md)
4. [fast-boot 模块地图与接入选择](./fast-boot/architecture/模块地图与接入选择.md)

### 想理解 ORM / SQL 这一层

1. [jlambda-sql](./jlambda-sql/README.md)
2. [实体映射与 Wrapper 约定](./jlambda-sql/usage/实体映射与Wrapper.md)
3. [fast-boot](./fast-boot/README.md)

### 想理解转换、缓存、调度等通用能力

- [jmapstruct-extend](./jmapstruct-extend/README.md)
- [jfast-cache](./jfast-cache/README.md)
- [jtimerwheel](./jtimerwheel/README.md)
- [jcommon](./jcommon/README.md)

## 当前重点专题

- [fast-boot 模块地图与接入选择](./fast-boot/architecture/模块地图与接入选择.md)
- [fast-boot Web 接入与路由模型](./fast-boot/usage/web-接入与路由模型.md)
- [fast-boot ORM 接入与 Manager 模式](./fast-boot/usage/orm-接入与Manager模式.md)
- [fast-boot Validation 校验模型](./fast-boot/usage/validation-校验模型.md)
- [fast-boot Redis 模块现状与边界](./fast-boot/usage/redis-模块现状与边界.md)
- [fast-boot MQ 模块结构与 RabbitMQ/Kafka/RocketMQ 接入](./fast-boot/usage/mq-模块结构与RabbitMQ接入.md)
- [fast-boot 配置绑定与早期基础设施初始化](./fast-boot/usage/配置绑定与早期基础设施初始化.md)
- [fast-boot MapStruct 集成层说明](./fast-boot/usage/mapstruct-集成层说明.md)
- [fast-boot TimerWheel 集成层说明](./fast-boot/usage/timerwheel-集成层说明.md)
- [fast-boot FastBootTest 测试启动模型](./fast-boot/usage/FastBootTest-测试启动模型.md)
- [fast-boot 启动报告与常见排障](./fast-boot/operations/启动报告与常见排障.md)
- [fast-boot extension-parent 与扩展模块元数据](./fast-boot/architecture/extension-parent-与扩展模块元数据.md)
- [jlambda-sql 实体映射与 Wrapper 约定](./jlambda-sql/usage/实体映射与Wrapper.md)
- [jmapstruct-extend 转换接口约定](./jmapstruct-extend/usage/转换接口约定.md)
- [jfast-cache 模块拆分与使用选择](./jfast-cache/usage/模块拆分与使用选择.md)
- [jnetty 服务端与 HTTP 接入](./jnetty/usage/服务端与HTTP接入.md)
- [jtimerwheel 时间轮模型与调度语法](./jtimerwheel/architecture/时间轮模型与调度语法.md)

## 当前文档结构规则

文档统一放在 `/docs` 下，不再分散维护在模块根目录的 `README.md` 中。

推荐结构：

- `docs/<项目>/README.md`
  - 项目总览、模块地图、快速入口
- `docs/<项目>/architecture/`
  - 架构设计、生命周期、线程模型、内部机制
- `docs/<项目>/usage/`
  - 对外使用方式、配置说明、集成说明
- `docs/<项目>/operations/`
  - 排障、升级、发布、运行维护
- `docs/<项目>/adr/`
  - 需要长期保留的设计决策

## 迁移规则

- 新文档和改动后的文档统一进入 `/docs`
- 每个项目保留一个统一入口：`docs/<项目>/README.md`
- 旧 README 或旧 `doc/` 内容迁移完成后再删除
- 源码目录不再作为长期文档入口，除非该文件本身就是测试样例或生成产物的一部分

## 说明

- `fast-boot` 目前文档最完整，已经覆盖启动生命周期、业务回调、构建期索引、打包与瘦身策略
- 发布入口当前统一使用通用脚本 `scripts/release_manager.py`
  - 可先配合 `--dry-run` 预演版本变更、POM 同步和发布路径
- `null-chain` 历史专题最多，因此在 `docs/null-chain/` 下保留了多篇专题文档
- 仓库级协作规则放在根目录 [`AGENTS.md`](/Users/anminhu/java-project/jparent/AGENTS.md)，这里主要负责项目导航与文档归档入口