feat(Result): 扩展Result结构体功能并优化实现#93
Merged
Merged
Conversation
- 添加StructLayout特性优化内存布局 - 将Failure方法中的Exception替换为InvalidOperationException - 重构Equals方法提高比较逻辑的可读性 - 简化GetHashCode方法的哈希计算逻辑 - 更新ToString方法移除空值检查 - 新增Try方法用于安全执行可能抛出异常的操作 - 添加Map方法支持将Result成功状态映射到其他类型 - 实现Bind方法用于链式调用Result操作
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| C# |  |
Mar 10, 2026 1:10p.m. | Review ↗ |
| Secrets | |
Mar 10, 2026 1:10p.m. | Review ↗ |
审阅者指南在保持内部不变式和内存布局更严格的前提下，为函数式的 Result.Try、Map 和 Bind 链式调用的时序图sequenceDiagram
actor Client
participant Result
participant ActionDelegate
participant Result_T as Result~T~
Client->>Result: Try(action)
activate Result
Result->>ActionDelegate: Invoke()
activate ActionDelegate
ActionDelegate-->>Result: completes or throws
deactivate ActionDelegate
alt action succeeds
Result-->>Client: Result.Success()
else action throws ex
Result-->>Client: Result.Failure(ex)
end
deactivate Result
Client->>Result_T: Map(mapFunc) on success Result
activate Result_T
alt source IsSuccess
Result_T->>Result_T: mapFunc()
Result_T-->>Client: Success(mappedValue)
else source IsFailure
Result_T-->>Client: Failure(originalException)
end
deactivate Result_T
Client->>Result_T: Bind(bindFunc) on mapped Result
activate Result_T
alt source IsSuccess
Result_T->>Result_T: bindFunc()
Result_T-->>Client: Result~U~ from bindFunc
else source IsFailure
Result_T-->>Client: Failure(originalException)
end
deactivate Result_T
带单子工具的扩展 Result 结构体类图classDiagram
class Result {
- bool _isSuccess
- Exception _exception
+ bool IsSuccess
+ bool IsFailure
+ static Result Success()
+ static Result Failure(Exception ex)
+ static Result Failure(string message)
+ Result~A~ ToResult~A~(A value)
+ bool Equals(Result other)
+ int GetHashCode()
+ string ToString()
+ static Result Try(Action action)
+ Result~B~ Map~B~(Func~B~ func)
+ Result~B~ Bind~B~(Func~Result~B~~ func)
}
class Result~T~ {
- bool _isSuccess
- T _value
- Exception _exception
+ bool IsSuccess
+ bool IsFailure
+ T Value
+ static Result~T~ Success(T value)
+ static Result~T~ Failure(Exception ex)
+ bool Equals(Result~T~ other)
+ int GetHashCode()
+ string ToString()
}
Result <.. Result~T~ : used_by
文件级变更
提示与命令与 Sourcery 交互
自定义你的使用体验访问你的 控制面板 以：
获取帮助Original review guide in EnglishReviewer's GuideExtends the functional Result struct with monadic utilities and improved APIs while tightening its internal invariants and memory layout, including new Try/Map/Bind helpers and simplified equality, hashing, and formatting logic. Sequence diagram for Result.Try, Map, and Bind chainingsequenceDiagram
actor Client
participant Result
participant ActionDelegate
participant Result_T as Result~T~
Client->>Result: Try(action)
activate Result
Result->>ActionDelegate: Invoke()
activate ActionDelegate
ActionDelegate-->>Result: completes or throws
deactivate ActionDelegate
alt action succeeds
Result-->>Client: Result.Success()
else action throws ex
Result-->>Client: Result.Failure(ex)
end
deactivate Result
Client->>Result_T: Map(mapFunc) on success Result
activate Result_T
alt source IsSuccess
Result_T->>Result_T: mapFunc()
Result_T-->>Client: Success(mappedValue)
else source IsFailure
Result_T-->>Client: Failure(originalException)
end
deactivate Result_T
Client->>Result_T: Bind(bindFunc) on mapped Result
activate Result_T
alt source IsSuccess
Result_T->>Result_T: bindFunc()
Result_T-->>Client: Result~U~ from bindFunc
else source IsFailure
Result_T-->>Client: Failure(originalException)
end
deactivate Result_T
Class diagram for extended Result struct with monadic utilitiesclassDiagram
class Result {
- bool _isSuccess
- Exception _exception
+ bool IsSuccess
+ bool IsFailure
+ static Result Success()
+ static Result Failure(Exception ex)
+ static Result Failure(string message)
+ Result~A~ ToResult~A~(A value)
+ bool Equals(Result other)
+ int GetHashCode()
+ string ToString()
+ static Result Try(Action action)
+ Result~B~ Map~B~(Func~B~ func)
+ Result~B~ Bind~B~(Func~Result~B~~ func)
}
class Result~T~ {
- bool _isSuccess
- T _value
- Exception _exception
+ bool IsSuccess
+ bool IsFailure
+ T Value
+ static Result~T~ Success(T value)
+ static Result~T~ Failure(Exception ex)
+ bool Equals(Result~T~ other)
+ int GetHashCode()
+ string ToString()
}
Result <.. Result~T~ : used_by
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - 我发现了 1 个问题，并给出了一些高层次的反馈：
- 多个成员在失败时假设
_exception为非空（Equals、GetHashCode、ToString、Map、Bind），这会在default(Result)或任何未携带异常就创建的失败结果上导致异常；建议要么在实现中防御性地处理默认/无效状态，要么在构造时更严格地强制_exception非空的约束。 Try、Map和Bind接受委托参数，但没有对其进行校验；添加显式的空检查（例如ArgumentNullException.ThrowIfNull）可以让误用尽早失败，并避免在调用期间出现让人困惑的NullReferenceException。
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Several members assume `_exception` is non-null on failure (`Equals`, `GetHashCode`, `ToString`, `Map`, `Bind`), which can throw for `default(Result)` or any failure created without an exception; consider defensively handling the default/invalid state or enforcing non-null construction more strictly.
- `Try`, `Map`, and `Bind` accept delegate parameters but do not validate them; adding explicit null checks (e.g., `ArgumentNullException.ThrowIfNull`) would make misuse fail fast and avoid confusing `NullReferenceException`s during invocation.
## Individual Comments
### Comment 1
<location path="GFramework.Core/Functional/Result.cs" line_range="124-125" />
<code_context>
+ if (_isSuccess)
+ return true;
+
+ return _exception!.GetType() == other._exception!.GetType() &&
+ _exception.Message == other._exception.Message;
}
</code_context>
<issue_to_address>
**issue (bug_risk):** Relying on `_exception!` being non-null introduces a hidden invariant and potential NullReferenceExceptions.
This assumes that whenever `_isSuccess` is `false`, both `_exception` and `other._exception` are non-null, and relies on the null-forgiving operator here and in `GetHashCode`, `ToString`, `Map`, and `Bind`. If a failure `Result` is ever created with a null exception (e.g., via the private ctor or future changes), these members will throw `NullReferenceException` at use sites. Either (a) enforce the invariant at construction time (e.g., throw when `isSuccess == false && ex is null`), or (b) keep the comparison and hash code logic null-safe as before so the type is more robust to future changes and misuse.
</issue_to_address>帮我变得更有用！请在每条评论上点击 👍 或 👎，我会根据这些反馈改进后续的评审。
Original comment in English
Hey - I've found 1 issue, and left some high level feedback:
- Several members assume
_exceptionis non-null on failure (Equals,GetHashCode,ToString,Map,Bind), which can throw fordefault(Result)or any failure created without an exception; consider defensively handling the default/invalid state or enforcing non-null construction more strictly. Try,Map, andBindaccept delegate parameters but do not validate them; adding explicit null checks (e.g.,ArgumentNullException.ThrowIfNull) would make misuse fail fast and avoid confusingNullReferenceExceptions during invocation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Several members assume `_exception` is non-null on failure (`Equals`, `GetHashCode`, `ToString`, `Map`, `Bind`), which can throw for `default(Result)` or any failure created without an exception; consider defensively handling the default/invalid state or enforcing non-null construction more strictly.
- `Try`, `Map`, and `Bind` accept delegate parameters but do not validate them; adding explicit null checks (e.g., `ArgumentNullException.ThrowIfNull`) would make misuse fail fast and avoid confusing `NullReferenceException`s during invocation.
## Individual Comments
### Comment 1
<location path="GFramework.Core/Functional/Result.cs" line_range="124-125" />
<code_context>
+ if (_isSuccess)
+ return true;
+
+ return _exception!.GetType() == other._exception!.GetType() &&
+ _exception.Message == other._exception.Message;
}
</code_context>
<issue_to_address>
**issue (bug_risk):** Relying on `_exception!` being non-null introduces a hidden invariant and potential NullReferenceExceptions.
This assumes that whenever `_isSuccess` is `false`, both `_exception` and `other._exception` are non-null, and relies on the null-forgiving operator here and in `GetHashCode`, `ToString`, `Map`, and `Bind`. If a failure `Result` is ever created with a null exception (e.g., via the private ctor or future changes), these members will throw `NullReferenceException` at use sites. Either (a) enforce the invariant at construction time (e.g., throw when `isSuccess == false && ex is null`), or (b) keep the comparison and hash code logic null-safe as before so the type is more robust to future changes and misuse.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
- 在构造函数中添加强制不变式检查，确保失败状态必须携带非空异常 - 为Try方法添加空值验证，防止传入空委托导致异常 - 为Map方法添加空值验证，增强方法调用的安全性 - 为Bind方法添加空值验证，提升代码健壮性 - 重构Map和Bind方法结构，使其更清晰易读
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
通过为 Result 类型增加更多函数式辅助方法，并优化其在失败处理、相等性比较和表示方面的行为。
新特性：
改进：
Original summary in English
Summary by Sourcery
Extend the Result type with additional functional helpers and refine its behavior for failures, equality, and representation.
New Features:
Enhancements: