THE CORE DEVELOPER HANDBOOK
每一步开发,
都有清楚的依据。
第一次接入,从环境准备与首个模块读起。带着任务来,搜索规则、接口与真实示例。
输入关键词,找到具体步骤、参数和示例。
准备同版本依赖,理解分层与数据归属,再验证完整业务链路。
START
开始开发
从环境准备到第一条业务链路,再进入真实应用验证。
CONCEPTS
架构与概念
理解分层、对象、运行时和生命周期。
DEVELOPMENT
开发规范
按同一套契约组织模块、查询、业务动作和测试。
规范与权威来源
按规则编号查找唯一正文,明确跨仓规范与冲突处理。
基于 Ineed-Core 的项目开发文档
从业务开发视角查找骨架、CRUD、格式、分层及数据栈指南。
业务模块骨架与目录结构约定
确定 Maven 分层、业务子模块与跨技术栈对齐范围。
代码格式与源码风格指南
统一 Java 格式、Javadoc、字段、日志和局部格式保护。
CRUD / Query 开发主路径
按能力组合创建、更新、查询和扩展条件,保持生命周期一致。
自定义业务与分层扩展指南
在既有分层中组织业务动作,明确事务和多实体协作。
删除钩子、分层日志与异常追踪规范
区分逻辑删除、物理删除、恢复、引用保护与日志责任。
契约、错误与国际化
保持输入输出、异常、错误码与国际化契约一致。
业务需求文档模板
在编码前填写对象、行为、状态、数据归属和验收条件。
开发约定反模式清单
对照常见反例定位分层、上下文、数据访问与验证问题。
测试与交付证据
分清契约测试、数据库、应用 HTTP 与前端端到端证据。
业务集成测试编写指南
按可观察业务结果组织正向、失败、权限与多栈验证。
前端接入与联调指南
核对接口、权限、状态能力、查询、分页和前端交互。
开发模式登录与权限诊断
在开发环境中建立真实身份,定位登录与权限接入问题。
DATA
数据访问
选择 JDBC、JPA、MyBatis-Flex 或 R2DBC 实现。
GUIDES
能力接入
租户、权限、事务、状态、缓存与事件的接入边界。
AI
AI 编码
从任务输入到交付验收,按需加载现行规范。
REFERENCE
框架参考
查阅模块、配置、扩展点、API 文档和当前支持范围。
Ineed-Core 内部文档
从框架维护视角进入模块、能力、事件和兼容性文档。
Ineed-Core 真实模块清单
按 Maven 聚合查阅真实模块,不把工作区统计当作 Core 数量。
Ineed-Core 模块能力地图
查找核心能力、主要接口与所属模块。
Ineed-Core 当前实现状态
区分已有实现、默认构建和仍需验证的可选能力。
Java 模块目录结构指南
统一 Java 模块与 Maven 工程的目录命名和职责。
配置参考
查阅配置默认值、外部设施前提和配置不生效的排查顺序。
扩展点速查
按扩展目标定位 Controller、Service、Manager 与仓储入口。
Ineed-Core 集成事件接入指南
查看内部事件、蒸馏事件、开关和监听器的具体接入契约。
Constant、ErrorCode 与 I18n 约定
遵守常量、错误码和语言资源约定,业务号段以全局登记为准。
模块 Constant 与 I18n 样板
参考模块常量与 I18n 样板,替换占位业务名称和资源。
API 文档使用指南
接入 OpenAPI 与 Scalar,核对展示开关和安全链。
API 兼容性治理策略
维护公共 API、兼容边界与迁移约定。
MAINTENANCE
维护与证据
维护文档来源,并区分历史验证与当前发行。