Read "the way to clean code" - function names should express their behavior

One 、 background

Some time ago, I heard that some people around me thought ：“ It doesn't matter how confused the function name is , Anyway, when others use the interface, they will also look at the source code ”, It surprised me very much .

I always thought , Good code should know the meaning when you see the function name , When you see the parameters and return values, you should be able to use them safely , Instead of having to read the source code to avoid misuse .

Reread today 《 Clean code 》, I see it in the book ： The function name should express its behavior .

If you have to look at the implementation of the function （ Or document ） Just know what it does , You should change a better function name, or redesign the function code, or give a more appropriate name .（ The translation of the original text is a little stiff , Here I changed it myself ）

Two 、 Example

For example, just want to query the user's name 、 Age 、 cell-phone number , But the function is defined as follows ：

UserDO getUserSimpleById(Long id)

Corresponding SQL The statement is as follows ：

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

Because of the return value UserDO Contains many fields , Call this function to get UserDO Then don't look at the corresponding SQL Statement is difficult to determine which attributes are assigned .

But change the function name to getUserNameAgePhoneById It seems very wordy again , What if you check a few more attributes ？

UserDO getUserNameAgePhoneById(Long id)

You can define a field whose return value contains only the query , This is not easy to use wrong ：

UserSimpleDO getSimpleById(Long id)

3、 ... and 、 summary

The function name is inconsistent with what you do , It's easy to misunderstand users .
When we define a function signature , Include function name , Parameters and return values should be carefully considered , Don't be careless .

---

It's not easy to create , If this article helps you , Welcome to thumb up 、 Collection and attention , Your support and encouragement , It's the biggest driving force of my creation .