命名规范:使用 with 前缀实现不可变对象的派生构造

酷杰姑娘_5821

酷杰姑娘_5821

2026-03-28

292人浏览

原创

命名规范:使用 with 前缀实现不可变对象的派生构造

在面向对象与函数式编程实践中,为保持对象不可变性,常需基于当前实例创建新对象并局部更新属性;业界广泛采用 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}</mynode>

? 为什么是 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({...}) —— 简洁、专业、被时间验证。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5586

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1349

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5504

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1020

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1976

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3845

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5053

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3320

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1068

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习