01 | 缺乏业务含义的命名：如何精准命名？

1.实际工作时，去抓别人的命名规范其实挺不舒服的，显得自己爱计较，而且在缺少共同认知，一般人家也觉得你爱计较。 2.命名其实就是对抽象的定义。不能描述业务含义的命名往往是由于抽象的角度不正确或不明确引起的。设计建模时我们会说，业务驱动,认知先行。这里的认知先行就是要先建立与业务侧达成共识的模型（可以认为就是文中让产品看看能不能理解）。然后基于这个认知模型直接翻译成代码，不要扯什么实现和设计允许不一致，好的设计和实现应该就是一模一样的。这样翻译出来的代码，其行为和能力的定义（命名）自然是对应在业务特征上的。遗憾的是，大多数时候，在一个叫现实的东西面前，我不得不低下头，毕竟时间有限，测试支撑无力，在对项目没有足够认知之前，我们只能用最小的改动、最大的复用和差不多的命名去实现功能，设计和对齐认知的事情放到后面可能存在的重构上。（实现先行，设计随后）

老师提的命名不规范，在项目中全中。 还有项目总监写的这种代码 aaaaaa.updateFlight(airOrder, airOrderOld); 各种不规范命名。难受

老师，xxxMap这种命名表示映射关系，比如：书id与书的映射关系，不能命名为bookIdMap么？一时没想到好的命名，老师能给点建议么

老师好，我又又又来了。 18年末，我看了你的10X 工作法专栏，里面有提到过“代码的坏味道”碰巧那时候我刚读完重构第一版，对你专栏的的观点非常认同，几个月之后重构出了第二版，一半是好奇，一半是自己对优秀代码的向往把书买回来读完了。几个月前我看完了软件设计之美。这样一想三年过去了，自己在代码量有了更多的积累，每次回过去看那些重构的原则，都会有新的体会，写的时候依旧会犯迷糊，一个查询方法，是用 listXX，getXX还是queryXX呢，光是思考这些我都会想好一会，还有就是有时候写的时候觉得合适的，之后等整个功能完成回去检查时又觉得这样不好了。动手之前想的更多了。 期待后面课程。

今日总结： 1、命名要能描述功能（或方法）所做的事情，要用具体的（动词+名称）比如AddChapter 2、一个好的名字应该描述意图，而非细节，比如, StartTranslation 3、不能用技术术语命名，因为接口时稳定的，而实现时易变的，比如不能用 bookList 这样的命名就不够好，而应该用books 4、实际代码中，技术名称的出现，比如redis 代表的就是具体的技术实现，而应该用cache这样更广泛的词，和第一点正好相反 5、保持团队代码的统一，建立团队的词汇表，并进行代码评审，保证项目命名的统一，也能更好的让业务知识在项目成员中传递

唉，啥也白说了，都是眼泪啊..... 刚写代码时，老鸟通常会对菜鸟说教：你不要期望一次将代码写好，得注重健壮性（鲁棒性）、可读性、可维护性、可扩展性，多思考、常重构....多看书去看看《重构》《代码整洁之道》等等。然而你看他的提交记录除了改bug就没重构过！再看看他写的代码（后面举例），你会发现他推荐你看的书他其实没读完或者根本没读过！（类比于学算法让你看算法导论）当你再追问为什么不按书中/大厂规范做，他两手一滩说到不能教条要变通，脱离场景谈优化都是耍流氓——得按咱们团队规范写（其实没规范），我写的就符合规范！（我C，直接说照着你的代码风格写不就好了，非得套在一堆大道理凸显自己，事后分析起来仍旧是个笑话！其实，在大多数情况下，个体是无法对抗群体习惯的！） 1) 包名明明已经限定语义，赋值运算符右侧User后的后缀其实是可以省略。 左侧的变量名，在一般场景可以用dao/srv/repo表示，在聚合场景可能还得用userDao/chapterDao来区分。 UserDao userDao = dao.UserDao(); UserService userSrv = services.UserService(); UserRepository userRepo = repositories.UserRespository(); 这就完了？怎么可能！包名dao/model用单数而services和repositories用复数！对就是这么坑，这么任性！ 2）对于缩略词的命名：userId还是userID？Isbn还是ISBN 3）我的理解，api、service、repository这几层通常是面向业务的，应该使用面向业务的命名；dao层的业务就是和具体数据源打交道，所以命名可以是UpdateXXXByID，希望老师针对软件的每个分层给点命名建议，谢谢！

为了命名，和同事展开了很多争论： 原命名为$personsArray。 我的任务是重构。 我在重构过程中，我把变量换为Collection类型，变量名改为$persons。 同事给我review的建议：“应该把$persons改为$personCollection。1. 因为变量如之前的legacy代码的personArray，表明了这个变量的类型，所以，我们用$personCollection有助于其他人阅读和理解。 2. person的Collection可以是一个person为Collection，也可以是多个persons，于是这个变量不一定永远是复数persons。” 请问老师，怎么怼回去？感觉他们说得也有理啊…… 您的这些理论，有出处reference吗？

进入程序员这个行业，第一个使用的框架就是Rails，Rails在很多地方做了很好的约定，例如：Controller名字要用复数，Model名字要用单数，相对应的数据库表名名字要用复数等。老师课程中举的变量名bookList的例子，在Rails中约定的命名就是books。 现在已经不再使用ROR了，但是在动手之前还是会认真思考，尤其是有多种方式可以选择，拿不准要采用哪种的时候会想，如果这种场景在Rails下会怎样处理，这个时候通常心里就有答案了。 现在研发团队成员命名随心所欲。数据库字段驼峰式与蛇形式混合双打；字段名单复数不分，如：表示操作人的字段名定义为people；一个修改账号状态的方法里还会有更新这个账号下关联的其它业务的代码；Example.Criteria c1， Example.Criteria c2 这样的命名更是随处可见。每次读代码都是苦不堪言。

精准命名，体现业务含义，表名意图，不暴露细节，不使用技术用语

写了很多processXXXX