读《代码整洁之道》- 函数名称应该表达其行为

Posted 2022-01-08 明明如月学长

一、背景

前一段时间听到周围有人认为：“函数名起的困惑无所谓，反正别人使用接口的时候也会看下源码的”，让我非常吃惊。

我一直也是认为，好的代码应该是看到函数名就应该知道含义，看到参数和返回值就应该可以放心使用，而不是非要去读源码才不会误用。

今天重读《代码整洁之道》，看到书中提到：函数名称应该表达其行为。

如果你必须查看函数的实现（或文档）才知道它是做什么的，就应该换个更好的函数名或者重新设计功能代码或者起个更贴切的名称。（原文翻译有些生硬，这里自己改了一下）

二、示例

比如只想查询用户的姓名、年龄、手机号，但是函数定义如下：

UserDO getUserSimpleById(Long id)

对应的SQL 语句如下：

<select id="getUserSimpleById" parameterType="java.lang.Long" resultMapping="baseResultMapping">
  SELECT name,age,phone FROM user WHERE id = #id
</select>

由于返回值 UserDO 包含很多字段，调用该函数拿到 UserDO 之后不看对应的 SQL 语句很难确定哪些属性被赋值。

但是将函数名改为 getUserNameAgePhoneById 又显得很啰嗦，如果再查几个属性怎么办？

UserDO getUserNameAgePhoneById(Long id)

可以定义返回值只包含查询的字段，这样不容易用错：

UserSimpleDO getSimpleById(Long id)

三、总结

函数名和做的事情不一致，很容易对使用者造成误解。
我们定义函数签名时，包括函数名，参数以及返回值都要仔细斟酌，不可马虎大意。

---

创作不易，如果本文对你有帮助，欢迎点赞、收藏加关注，你的支持和鼓励，是我创作的最大动力。