代码坏味道与重构之过长参数列表

1. 为什么过长参数列表是坏味道

过长参数列表是指函数入参过多或存在不必要的参数。它往往意味着函数功能不单一,抽象不合理,代码的封装性不够好,可能会引发以下问题:

  • 增加了函数的使用成本,过长的参数列表让使用者感到迷惑。好的函数,函数签名应该尽可能的简单。通常来说,函数参数越少,函数的使用成本越低。

  • 增加了函数的维护成本,函数签名不稳定,不易维护

2. 重构过长参数列表的目标

每一个函数都可以被当做一个 API,一个好的 API 应该:

  • 使用简单

  • 功能单一明确

  • 入参尽可能的简单,降低使用和维护成本。

建议函数参数不要超过5个,函数参数增加一个,函数的使用成本和维护成本就增加一级。

写函数时,充分思考抽像,合理封装,设计出优雅的 API(函数)。

简而言之,如非必要,勿增参数

当然,我们也不能极端,为了减少参数,为了封装,就直接传整个大对象进去,导致被调用对象与大对象的依赖关系,暴露了一些不该暴露给这个函数的信息,违背了最小知道原则

因此,我们是否要用对象替换参数,需要综合考虑依赖方向,最小知道原则、参数可维护性、API 的使用成本,权衡替换后的收益和代价,再做出决定。

3. 重构过长参数列表的技巧

场景处理方式
某些入参可以通过其他参数查询得到查询取代参数
某几个入参是一个对象的部分字段保持对象完整性
某几个参数存在关联性封装对象,引入参数对象
函数逻辑是针对某个入参对象属性的加工移动函数至合适的类
某些入参被用作控制代码逻辑的标记移除标记参数

快捷键操作:

操作快捷键
删除无用入参Alt + Del/Alt + Enter
添加入参Ctrl + F6/Alt +Enter
提取参数对象Ctrl + Alt + Shift + T -> Parameter Object
鼠标右键 -> refactor -> Parameter Object
抽取方法Ctrl + Alt + M
内联方法Ctrl + Alt + N
移动方法F6
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值