
在面向对象与函数式编程实践中,为保持对象不可变性,常需基于当前实例创建新对象并局部更新属性;业界广泛采用 withXxx 或 with({...}) 命名约定,语义清晰、可读性强且具备跨语言一致性。
在面向对象与函数式编程实践中,为保持对象不可变性,常需基于当前实例创建新对象并局部更新属性;业界广泛采用 `withxxx` 或 `with({...})` 命名约定,语义清晰、可读性强且具备跨语言一致性。
当设计不可变(immutable)数据结构时,一个核心原则是:避免修改现有对象,而是通过拷贝+定制的方式生成新实例。此时,方法命名不仅要准确传达“新建”和“定制”双重语义,还需兼顾可读性、一致性与生态惯例。经过长期实践沉淀,with 前缀已成为该场景的事实标准(de facto convention)。
✅ 推荐命名方式:with 系列
1. 单字段更新:withAKey(value)、withBKey(value)
适用于链式调用(fluent interface)场景,提升可读性与类型安全(尤其在 TypeScript 中):
class MyNode {
constructor(public aKey: number = 0, public bKey: number = 0) {}
withAKey(aKey: number): MyNode {
return new MyNode(aKey, this.bKey);
}
withBKey(bKey: number): MyNode {
return new MyNode(this.aKey, bKey);
}
}
// 链式调用示例
const node = new MyNode(1, 0)
.withAKey(42)
.withBKey(99);
// → MyNode { aKey: 42, bKey: 99 }2. 批量更新:with(changes: Partial)
更灵活、符合 JavaScript/TypeScript 惯用法,支持任意属性组合更新:
class MyNode {
constructor(public aKey: number = 0, public bKey: number = 0) {}
with(changes: Partial<MyNode>): MyNode {
return new MyNode(
'aKey' in changes ? changes.aKey : this.aKey,
'bKey' in changes ? changes.bKey : this.bKey
);
}
}
// 使用示例
const nodeA = new MyNode(1, 0);
const nodeB = nodeA.with({ bKey: 1 }); // {aKey: 1, bKey: 1}
const nodeC = nodeA.with({ aKey: 5, bKey: 7 }); // {aKey: 5, bKey: 7}? 为什么是 with?
- 语义精准:“with X” 表达“在当前基础上附加/覆盖某属性”的意图,比 copyAndSet、cloneWith 更简洁;
- 生态统一:Java LocalDateTime.with(...)、C# records 的 with 表达式、Rust struct 更新语法 ..original、JavaScript Array.prototype.with() 及 Temporal API 均采用该范式;
- 无歧义:区别于 set(易联想到可变状态)、create(未体现继承关系)、update(暗示原地修改)等易混淆术语。
⚠️ 注意事项与最佳实践
- 避免混合命名:不要在同一类中同时提供 with() 和 copyWith()、derive() 等不同前缀,破坏接口一致性;
-
优先支持 Partial
类型 :在 TypeScript 中,为 with() 方法标注精确类型,可获得完整 IDE 支持与编译时检查; - 不替代构造函数:with 方法应始终基于 当前实例 构建,而非静态工厂(如 MyNode.with(...) 是反模式);
- 性能考量:若对象结构庞大,可结合 Object.assign 或结构展开优化,但切勿以牺牲不可变性为代价做浅拷贝陷阱(如 Object.assign({}, this, changes) 在含嵌套对象时仍可能共享引用)。
✅ 总结
with 不仅是一个命名,更是一种契约:它向调用者明确承诺——「我返回一个新对象,其状态由你指定的变更叠加在本实例之上」。遵循这一约定,你的 API 将天然具备可预测性、可组合性与跨语言亲和力。从今天起,在设计不可变对象的衍生构造方法时,请坚定选择 withXxx 或 with({...}) —— 简洁、专业、被时间验证。

















