eliteforge-java-coding-spec
统一璀璨工坊 Java 编码规范，覆盖代码风格、注释规范、POJO/枚举/工具类、控制语句、日志、并发、MyBatis-Plus、事务、Spring、服务间调用、Maven、数据库、网关、接口管理、工程结构等。用户提到"Java规范""编码规范""代码风格""枚举写法""POJO规范""日志规范""事务处理""服务间调用""接口前缀""领域模型""Maven版本""国际化"时使用。
- Installs
- 40
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/cloudsen/eliteforge-skills --skill eliteforge-java-coding-spec- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads eliteforge-java-coding-spec automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
EliteForge Java 编码规范 v1.0.0
目标
在 Java 开发任务中，依据规范提供明确的决策指引：什么应该做、什么禁止做、什么必须用什么工具/写法。引用规范条款时给出对应的 spec 行号。
执行原则
-
命中即强制执行
规范中标注为"禁止"的条款，任何场景都不得妥协；标注为"必须"的条款不得降级替代。 -
代码示例优先取规范原文
需要示例时，先从references/java-coding-spec-v1.md中提取对应条款的原文示例，不自行臆造。 -
最小化加载
先用检索定位 spec 行号，再局部读取；避免整篇加载。 -
明确标注来源
回答中标注对应的 spec 条款编号（如§3.2 POJO类）。
快速检索
# 查看 spec 行号索引
cat references/toc.md
# 按关键字定位条款
rg -n "禁止|必须|推荐|使用|Spring|POJO|枚举|日志|事务|并发|MyBatis|服务间调用|Maven|国际化|网关|接口管理|工程" references/java-coding-spec-v1.md
# 按行号读取条款（示例：100-200行）
sed -n '100,200p' references/java-coding-spec-v1.md
高频问题映射
| 用户问题 | 规范条款 | 核心结论 |
|---|---|---|
| 枚举怎么写 | §3.3 | Enum后缀 + implements BizEnum + @Getter/@RequiredArgsConstructor |
| POJO 类怎么写 | §3.2 | UpperCamelCase + Serializable + serialVersionUID + @Accessors(chain=true) |
| 工具类用什么 | §3.4 | Apache Commons / JDK / 统一框架工具，禁止 hutool |
| 日志怎么打 | §3.6 | @Slf4j + 占位符，禁止 e.printStackTrace() |
| 循环里能调接口吗 | §3.5 | 禁止，必须封装批量接口 |
| 线程池怎么创建 | §3.7 | ThreadPoolExecutor + TransmittableThreadLocal，禁止 Executors |
| MyBatis-Plus 怎么用 | §3.8 | 禁用注解，复杂查询用 xml，keepGlobalFormat=true |
| 事务怎么处理 | §3.9 | public 方法，seata TCC，围住最小必要代码 |
| RestTemplate 能用吗 | §3.10 | 禁止，必须用 RestClient |
| Bean 怎么注入 | §3.10 | @RequiredArgsConstructor，禁止 @Autowired |
| 服务间调用用什么 | §3.11 | HttpExchangeClient + RestClient，统一框架 starter |
| Maven 版本要求 | §3.12 | JDK21 + Maven 3.9.10+ + maven wrapper |
| Controller 怎么分层 | §7.2/§7.3 | Param入参/Vo出参，分离 api/innerapi/openapi |
| 接口路径前缀 | §7.1 | /api 前端 /inner-api 内部 /open-api 开放 |
| 数据库表设计 | §4 | 主键 id + 审计字段 + tenant_id/archived/version 按需 |
| 国际化文件放哪 | §7.6 | biz/resources/i18n/ |
| smart-doc 配置 | §6 | smart-doc.json / smart-doc-innerapi.json / smart-doc-openapi.json |
| 数据库适配 SQL 放哪 | §7.7 | resources/mapper/{mysql,dm,kingbase,oceanbase}/ |
核心约束速查
禁止清单（任何场景均不得妥协）
| 禁止项 | 必须替代 | 条款 |
|---|---|---|
| hutool | Apache Commons / JDK / 统一框架工具 | §3.4 |
| e.printStackTrace() / System.out | @Slf4j + log 占位符 | §3.6 |
| 循环/递归里调接口 | 批量接口封装 | §3.5 |
| Executors 创建线程池 | ThreadPoolExecutor | §3.7 |
| RestTemplate | Spring6 RestClient | §3.10 |
| @Value 注解读 yaml | Properties 类 | §3.10 |
| @Select/@Insert/@Update 注解 | MyBatis xml | §3.8 |
| context-path | yaml 路由配置 | §3.10 |
| lambdaQuery 多次单表查询 | xml 复杂查询 | §3.8 |
| Controller 层写业务逻辑 | Manager/Service 层 | §3.10 |
| @author JavaDoc | @since | §3.1 |
| 覆盖方式替换框架 Configuration | 扩展类或 yaml 配置 | §3.10 |
必须清单
| 必须项 | 说明 | 条款 |
|---|---|---|
| serialVersionUID | POJO 实现 Serializable 时必须定义 | §3.2 |
| @Accessors(chain=true) | Vo/Param/Dto 必须 | §3.2 |
| @since | 新增内容必须标识版本 | §3.1 |
| JSpecify 注解 | @Nullable/@NonNull/@NullMarked | §3.1 |
| 每成员 javadoc | POJO 枚举字段必须 | §3.1/§3.2/§3.3 |
| BizEnum | 前端/Entity 用枚举必须实现 | §3.3 |
| ResVo<T> | Controller 和服务间调用统一响应 | §3.2/§3.11 |
| HttpExchangeClient | 服务间调用必须 | §3.11 |
| keepGlobalFormat=true | @TableField 必须 | §3.8 |
| 函数式 wrapper | MyBatis-Plus wrapper 必须 | §3.8 |
| seata TCC | 分布式事务必须 | §3.9 |
| JDK21 + Maven 3.9.10+ | 必须版本 | §3.12 |
| maven wrapper | 必须使用项目 wrapper | §3.12 |
| 审计字段 | 业务表必须有 | §4 |
| api/inner-api/open-api 前缀 | Controller 路径必须 | §7.1 |
| 前端接口 Param入参/Vo出参 | Controller 必须 | §7.2 |
| 内部接口 Param入参/Dto出参 | InnerController 必须 | §7.2 |
| 开放接口独立 Dto/Param | OpenController 必须 | §7.2 |
| 并发修改加 version | 数据库必须有乐观锁字段 | §4 |
工具链速查
| 场景 | 工具 | 条款 |
|---|---|---|
| 字符串拼接 | java.lang.String.join() | §3.4 |
| 集合判空 | CollectionUtils.isEmpty() / MapUtils.isEmpty() | §3.4 |
| 数组判空 | ArrayUtils.isEmpty() | §3.4 |
| 字符串判空 | StringUtils.isBlank() / isNotBlank() | §3.4 |
| 字符串相等 | Strings.CS.equals() / Strings.CI.equals() | §3.4 |
| 二维元组 | org.apache.commons.lang3.tuple.Pair<L,R> | §3.4 |
| 时间工具 | cn.cisdigital.elite.forge.infra.commons.util.TimeUtils | §3.4 |
| JSON 工具 | JsonUtils | §3.4 |
| 国际化 | I18nUtils | §3.4 |
| 上下文 | ContextStore | §3.4 |
| 服务间调用 | cisdigital-elite-forge-infra-httpexchange-spring-boot3-starter | §3.11 |
| 线程上下文 | TransmittableThreadLocal + TtlExecutors | §3.7 |
| 日期格式化 | DateTimeFormatter（非 SimpleDateFormat） | §3.7 |
分层模型速查
POJO 类分层
Entity → ORM 实体映射，实现 Serializable
Dto → 内部数据传输
Param → Controller 入参，必须 jsr 303 validation
Vo → Controller 出参
各层入参出参约束
| 层级 | 入参 | 出参 |
|---|---|---|
| repository | Param / Dto | Entity / Dto |
| service | Param / Dto | Dto / Vo |
| 前端接口 Controller | Param | Vo |
| 内部接口 InnerController | Param | Dto |
| 开放接口 OpenController | Param | Dto |
Maven 模块结构
<service>-model POJO + MapStruct
<service>-client HttpExchangeClient 接口定义
<service>-xxx-starter 业务相关 starter
<service>-xxx-sdk 业务相关 sdk
<service>-biz 业务模块（controller/service/repository）
<service>-boot 启动模块
biz 代码分层
- biz/common/exception
- biz/common/util
- biz/模块A/controller/{innerapi, api, openapi}
- biz/模块A/service/xxxService
- biz/模块A/repository/{mapper/xxxMapper, xxxRepository}
接口路径前缀
/api→ 前端接口（需网关鉴权）/inner-api→ 服务间内部调用（无需鉴权）/open-api→ 开放接口（需开放平台鉴权）
输出约束
- 回答时必须标注规范条款编号（§章节号）
- 涉及代码示例时，从
references/java-coding-spec-v1.md对应条款提取，不自行编写 - 涉及框架/工具选型时，优先引用统一框架能力，参见
eliteforge-framework-specification - 涉及版本号时引用规范原文，不臆造具体版本
- 规范未覆盖的场景，标注"需用户补充或需外部确认"
参考资料
- 规范全文（行号索引）：
references/toc.md - 规范全文：
references/java-coding-spec-v1.md
FAQ
What does the eliteforge-java-coding-spec skill do?
统一璀璨工坊 Java 编码规范，覆盖代码风格、注释规范、POJO/枚举/工具类、控制语句、日志、并发、MyBatis-Plus、事务、Spring、服务间调用、Maven、数据库、网关、接口管理、工程结构等。用户提到"Java规范""编码规范""代码风格""枚举写法""POJO规范""日志规范""事务处理""服务间调用""接口前缀""领域模型""Maven版本""国际化"时使用。
How do I install eliteforge-java-coding-spec?
Run npx skills add https://github.com/cloudsen/eliteforge-skills --skill eliteforge-java-coding-spec in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/eliteforge-java-coding-spec/ (personal) or .claude/skills/eliteforge-java-coding-spec/ (project).
Which AI agents can use eliteforge-java-coding-spec?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is eliteforge-java-coding-spec safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains eliteforge-java-coding-spec?
It is published by cloudsen in cloudsen/eliteforge-skills. It has 40 recorded installs.
More from cloudsen/eliteforge-skills
wechat-message-sender
cloudsen/eliteforge-skills
在 macOS 上通过微信桌面版向指定联系人发送文本消息。用户提供联系人名称和消息内容时使用，例如“给张三发微信：xxx”“打开微信给某人发送一句话”“用微信发送指定文本”。运行前必须已安装微信桌面版，并给当前终端或 Codex 辅助功能权限。执行时只做精确匹配：先搜索联系人，再校验当前会话标题与目标完全一致；匹配失败就停止，避免误发。
eliteforge-framework-specification
cloudsen/eliteforge-skills
Open the skill to read its SKILL.md instructions.
eliteforge-task-progress-tracker
cloudsen/eliteforge-skills
Open the skill to read its SKILL.md instructions.
eliteforge-java-uml
cloudsen/eliteforge-skills
Open the skill to read its SKILL.md instructions.
eliteforge-java-service-generator
cloudsen/eliteforge-skills
Open the skill to read its SKILL.md instructions.
eliteforge-frontend-generator
cloudsen/eliteforge-skills
Open the skill to read its SKILL.md instructions.
Popular backend & apis skills
find-skills
vercel-labs/skills
Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.
entra-app-registration
microsoft/azure-skills
Guides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE FOR: create app registration, register Azure AD app, configure OAuth, set up authentication, add API permissions, generate service principal, MSAL example, console app auth, Entra ID setup, Azure AD authentication. DO NOT USE FOR: Key Vault secrets (use azure-keyvault-expiration-audit), general Azure resource security guidance.
google-agents-cli-adk-code
google/agents-cli
This skill should be used when the user wants to "write agent code", "build an agent with ADK", "add a tool", "create a callback", "define an agent", "use state management" — in a project that needs ADK (Agent Development Kit) API patterns and code examples. It provides a quick reference for agent types, tool definitions, orchestration patterns, callbacks, state management, the graph Workflow API, and reference recipes to study. Do NOT use for scaffolding (use google-agents-cli-scaffold) or deployment (use google-agents-cli-deploy).
embedded-captions
heygen-com/hyperframes
Add captions or subtitles to an existing single-subject talking-head video without editing the footage. Use for plain verbatim captions, cinematic captions embedded behind the subject, VFX captions, “炸/特效/酷炫字幕,” or a named identity from the 35-style catalog. Route by visual identity, not by backend engine. The quiet anchor rail is the default; embed every word only when the user explicitly wants a fully cinematic treatment. The workflow runs locally end to end, including transcription and subject matting; split multi-shot footage before applying it.
entra-agent-id
microsoft/azure-skills
Provision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmipath, OBO, cross-tenant) including the Microsoft Entra SDK for AgentID sidecar. USE FOR: Agent Identity Blueprint, BlueprintPrincipal, agent OAuth, fmipath token exchange, agent OBO, Workload Identity Federation for agents, polyglot agent auth, Microsoft.Identity.Web.AgentIdentities. DO NOT USE FOR: standard Entra app registration (use entra-app-registration), Microsoft Foundry agent authoring (use microsoft-foundry).
neon
neondatabase/agent-skills
Overview of Neon, a complete set of cloud backend primitives around Lakebase Postgres: Auth, Object Storage, Functions, the AI Gateway, and Realtime. Start here to choose Neon for undecided login, files, APIs, and LLM calls, set up the CLI or MCP server, and follow the branch-first workflow. Use when building an app or backend on Neon, or when "Neon" or "Lakebase Postgres" is mentioned. Child skill neon-postgres wins for an existing DATABASEURL, SQL, schema, inspect, or search. Child skill neon-auth wins for login, users, sessions, identity routing, and Managed Better Auth setup. Child skill neon-realtime wins for live queries in reactive apps and agents. Also use for object storage, S3, buckets, serverless functions, function triggers, cron, AI gateway, LLM calls, realtime, logs, Loki, Grafana, observability, postgres, database, backend, Claimable Neon, neon.new, or a no-signup database.