⚙️ CodeRabbit configuration file

**/*.java: ## 1. API 设计要求

• API 命名:
  • API 名称必须唯一,不能重复。
  • API 消息类需要继承 APIMessage;其返回类必须继承 APIReply 或 APIEvent,并在注释中用 @RestResponse 进行标注。
  • API 消息上必须添加注解 @RestRequest,并满足如下规范:
    • path:
      • 针对资源使用复数形式。
      • 当 path 中引用消息类变量时,使用 {variableName} 格式。
    • HTTP 方法对应:
      • 查询操作 → HttpMethod.GET
      • 更新操作 → HttpMethod.PUT
      • 创建操作 → HttpMethod.POST
      • 删除操作 → HttpMethod.DELETE
  • API 类需要实现 __example__ 方法以便生成 API 文档,并确保生成对应的 Groovy API Template 与 API Markdown 文件。

---

2. 命名与格式规范

• 类名:

  • 使用 UpperCamelCase 风格。
  • 特殊情况:
    • VO/AO/EO 类型类除外。
    • 抽象类采用 Abstract 或 Base 前缀/后缀。
    • 异常类应以 Exception 结尾。
    • 测试类需要以 Test 或 Case 结尾。

• 方法名、参数名、成员变量和局部变量:

  • 使用 lowerCamelCase 风格。

• 常量命名:

  • 全部大写,使用下划线分隔单词。
  • 要求表达清楚,避免使用含糊或不准确的名称。

• 包名:

  • 统一使用小写,使用点分隔符,每个部分应是一个具有自然语义的英文单词(参考 Spring 框架的结构)。

• 命名细节:

  • 避免在父子类或同一代码块中出现相同名字的成员或局部变量,防止混淆。
  • 命名缩写:
    • 不允许使用不必要的缩写,如:AbsSchedulerJob、condi、Fu 等。应使用完整单词提升可读性。

---

3. 编写自解释代码

• 意图表达:

  • 避免使用布尔型参数造成含义不明确。例如:
    • 对于 stopAgent(boolean ignoreError),建议拆分为不同函数(如 stopAgentIgnoreError()),或使用枚举表达操作类型。
  • 命名应尽量用完整的单词组合表达意图,并在名称中体现数据类型或用途(例如在常量与变量名称中,将类型词放在末尾)。

• 注释:

  • 代码应尽量做到自解释,对少于两行的说明可以直接写在代码中。
  • 对于较长的注释,需要仔细校对并随代码更新,确保内容正确。
  • 接口方法不应有多余的修饰符(例如 public),且必须配有有效的 Javadoc 注释。

---

4. 流程控制和结构优化

• if...else 的使用:

  • 应尽量减少 if...else 结构的使用,建议:
    • 限制嵌套层级最多为两层,且内层不应再出现 else 分支。
    • 尽早返回(Early Return),将条件判断中的处理逻辑提前结束或抽成独立方法。
    • 使用 Java Stream 或 Lambda 表达式代替冗长的循环与条件判断。

• 条件判断:

  • if 条件表达不宜过长或过于复杂,必要时可以将条件抽成 boolean 变量描述。

• 代码块长度:

  • 单个 if 代码块不宜超过一屏显示,以提高可读性和后续维护性。

---

5. 异常处理与日志

• 捕获异常的原则:
  • 对于可以通过预检查避免的 RuntimeException(如 NullPointerException、IndexOutOfBoundsException 等),不建议使用 try-catch 来进行处理。
  • 捕获异常应仅用于处理真正的意外情况,不应将异常逻辑当作正常流程控制。
  • 在必要时,应继续抛出异常,使上层业务处理者可以转换为用户友好的错误提示。
  • 使用 try-with-resources 语法管理资源,确保在 finally 块中正确关闭资源,并避免在 finally 中返回值。
    ...

Files:

• sdk/src/main/java/org/zstack/sdk/PrimaryStorageMigrateVmAction.java

Learnt from: MatheMatrix
Repo: MatheMatrix/zstack PR: 2763
File: sdk/src/main/java/org/zstack/sdk/UpdateHostKernelInterfaceAction.java:31-31
Timestamp: 2025年10月20日T11:27:25.928Z
Learning: UpdateHostKernelInterface API (`sdk/src/main/java/org/zstack/sdk/UpdateHostKernelInterfaceAction.java`) 在 PR #2763 时尚未被实际使用,因此对其参数约束的变更(如 name 字段从必需改为可选)不会造成破坏性影响。

Applied to files:

• sdk/src/main/java/org/zstack/sdk/PrimaryStorageMigrateVmAction.java