-
Notifications
You must be signed in to change notification settings - Fork 0
<fix>[core]: remove Platform.err methods with cause arg #3132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: zsv_4.10.28
Are you sure you want to change the base?
Conversation
Walkthrough删除 Platform 中若干接受 cause 的已弃用 err/operr/touterr 重载,重构 multiErr 系列以使用 .withCause(...) 链式调用;调整 toI18nString 的泛型签名;NFS 挂载超时路径改用 touterr(...).withCause(...) 保留原始错误为 cause。 Changes
Sequence Diagram(s)(本次变更为 API 清理与错误封装调整,控制流未引入跨多个组件的新交互,故省略序列图。) Estimated code review effort🎯 3 (中等) | ⏱️ ~20 分钟 Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Repository UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used📓 Path-based instructions (1)**/*.java⚙️ CodeRabbit configuration file
Files:
🧠 Learnings (2)📓 Common learnings📚 Learning: 2025-07-10T07:29:52.955ZApplied to files:
🔇 Additional comments (6)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
core/src/main/java/org/zstack/core/Platform.javaplugin/nfsPrimaryStorage/src/main/java/org/zstack/storage/primary/nfs/NfsPrimaryStorageKVMBackend.java
🧰 Additional context used
📓 Path-based instructions (1)
**/*.java
⚙️ 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:
plugin/nfsPrimaryStorage/src/main/java/org/zstack/storage/primary/nfs/NfsPrimaryStorageKVMBackend.javacore/src/main/java/org/zstack/core/Platform.java
🧠 Learnings (2)
📓 Common learnings
Learnt from: zstack-robot-1
Repo: MatheMatrix/zstack PR: 2360
File: network/src/main/java/org/zstack/network/l3/L3BasicNetwork.java:449-490
Timestamp: 2025-08-04T04:48:19.103Z
Learning: ZStack项目在cherry-pick操作中,即使发现了性能优化机会(如IP地址批量保存的内存优化),也严格遵循不做额外修改的政策,优先保证cherry-pick的完整性和一致性。
📚 Learning: 2025-07-10T07:29:52.955Z
Learnt from: ZStack-Robot
Repo: MatheMatrix/zstack PR: 2287
File: header/src/main/java/org/zstack/header/errorcode/ErrorCode.java:25-30
Timestamp: 2025-07-10T07:29:52.955Z
Learning: 在 ZStack 项目中,ErrorCodeList 正在进行渐进式弃用,而不是一次性完全移除。在过渡期间,ErrorCodeList 仍需要能够访问 ErrorCode 中的 causes 字段,因此 causes 字段使用 protected final 可见性是合理的设计选择,支持渐进式重构策略。
Applied to files:
core/src/main/java/org/zstack/core/Platform.java
🔇 Additional comments (2)
core/src/main/java/org/zstack/core/Platform.java (1)
988-1006: LGTM! 错误处理迁移正确这些
multiErr方法的重构正确地将错误原因从方法参数迁移到.withCause()链式调用,与项目中 ErrorCode 处理的渐进式重构策略一致。所有四个重载方法的实现都遵循了统一的模式,保持了原有的功能语义。根据学习记录,这是 ErrorCodeList 渐进式弃用过程的一部分,这些变更支持该重构策略。
plugin/nfsPrimaryStorage/src/main/java/org/zstack/storage/primary/nfs/NfsPrimaryStorageKVMBackend.java (1)
160-161: LGTM! 错误包装模式迁移正确超时错误处理正确地从旧模式
touterr(errorCode, ...)迁移到新模式touterr(...).withCause(errorCode),与 Platform.java 中移除带 cause 参数的方法变更保持一致。原始错误信息通过.withCause()正确地保留为错误原因链。
...PrimaryStorage/src/main/java/org/zstack/storage/primary/nfs/NfsPrimaryStorageKVMBackend.java
Outdated
Show resolved
Hide resolved
This patch is for zsv_4.10.28 Related: ZSV-10663 Change-Id: I6677687973686e6d727a6e677169726e6c727064
This patch is for zsv_4.10.28 Related: ZSV-5936 Change-Id: I6875687a616f797a656c70656d7469756f7a7266
cffebb9 to
442c45c
Compare
This patch is for zsv_4.10.28
Related: ZSV-10663
Change-Id: I6677687973686e6d727a6e677169726e6c727064
sync from gitlab !8947