极客时间已完结课程限时免费阅读

21 | 你的代码为谁而写？

21 | 你的代码为谁而写？-极客时间

21 | 你的代码为谁而写？

2019-02-20 郑晔 来自北京
《10x程序员工作法》
课程介绍

讲述：郑晔

时长10:55大小9.97M

你好，我是郑晔。
关于“沟通反馈”的话题，我准备从代码开始讲起，毕竟我们程序员是靠代码与机器进行沟通的。
写代码是每个程序员的职责，程序员们都知道要把代码写好。但究竟什么叫写好呢？每个人的理解却是各有差异。

编写可维护的代码

初涉编程的程序员可能觉得能把功能实现出来的代码，就是好代码，这个阶段主要是基本功的学习，需要掌握的是各种算法、数据结构、典型的处理手法、常用的框架等等。
经过一段时间工作，日常工作所需的大多数代码，在你看来都是不在话下的。尤其像搜索和问答网站蓬勃发展之后，你甚至不需要像我初入职场时那样，记住很多常见的代码模式，现在往往是随手一搜，答案就有了。
再往后，更有追求的程序员会知道，仅仅实现功能是不够的，还需要写出可维护的代码。于是，这样的程序员就会找一些经典的书来看。
我在这方面的学习是从一本叫做《程序设计实践》（The Practice of Programming）的书开始的，这本书的作者是 Brian Kernighan 和 Rob Pike，这两个人都出身于大名鼎鼎的贝尔实验室，参与过 Unix 的开发。
写出可维护的代码并不难，它同样有方法可循。今天，我们用写代码中最简单的一件事，深入剖析怎样才能写出可维护的代码，这件事就是命名。

命名难题

计算机科学中只有两大难题：缓存失效和命名。
—— Phil Karlton
这是行业里流传的一个经典说法，无论是哪本写代码风格的书，都会把命名放在靠前的位置。
估计你开始写程序不久，就会有人告诉你不要用 a、b、c 做变量名，因为它没有意义；步入职场，就会有人扔给你一份编程规范，告诉你这是必须遵循的。
不管怎样，你知道命名是很重要的，但在你心目中，合格的命名是什么样的呢？
想必你知道，命名要遵循编码规范，比如：Java 风格的 camelCase，常量命名要用全大写。
但是，这类代码规范给出的要求，大多是格式上的要求。在我看来，这只是底线，不应该成为程序员的追求，因为现在很多编码规范的要求，都可以用静态检查工具进行扫描了。
我们的讨论要从名字的意义说起。作为程序员，我们大多数人理解为什么要避免起无意义的名字，但对于什么样的名字是有意义的，每个人的理解却是不同的。
名字起得是否够好，一个简单的评判标准是，拿着代码给人讲，你需要额外解释多少东西。
比如，我们在代码评审中会看到类似这样的场景：
评审者：这个叫 map 的变量是做什么用的？
程序员：它是用来存放账户信息的，它的键值是账户 ID，值就是对应的账户信息。
评审者：那为什么不直接命名成 accounts？
你知道评审者给出的这个建议是什么意思吗？如果不能一下子意识到，遇到类似的问题，你可能会和这个程序员一样委屈：这个变量本来就是一个 map，我把它命名成 map 怎么了？
变量的命名，实际上牵扯到一个重要问题，代码到底是给谁写的？

代码为谁而写？

任何人都能写出计算机能够理解的代码，只有好程序员才能写出人能够理解的代码。
—— Martin Fowler
代码固然是程序员与机器沟通的重要途径，但是，机器是直白的，你写的代码必须是符合某种规则的，这一点已经由编译器保证了，不符合规则的代码，你想运行，门都没有。
所以，只要你的代码是符合语言规则的，机器一定认。要让机器认，这并不难，你写得再奇怪它都认。行业里甚至有专门的混乱代码比赛。比如，著名的 IOCCC（The International Obfuscated C Code Contest，国际 C 语言混乱代码大赛）。
但是，我们写代码的目的是与人沟通，因为我们要在一个团队里与人协同工作。
与人沟通，就要用与人沟通的方式和语言写代码。人和机器不同，人需要理解的不仅是语言规则，还需要将业务背景融入其中，因为人的目的不是执行代码，而是要理解，甚至扩展和维护这段代码。
人要负责将业务问题和机器执行连接起来，缺少了业务背景是不可能写出好代码的。
我们在“为什么世界和你理解的不一样”这篇内容中就讲过，沟通的时候，输出时的编码器很重要，它是保证了信息输出准确性的关键。
很多程序员习惯的方式是用计算机的语言进行表达，就像前面这个例子里面的 map，这是一种数据结构的名字，是面向计算机的，而评审者给出的建议，把变量名改成 accounts，这是一个业务的名字。
虽然只是一个简单的名字修改，但从理解上，这是一步巨大的跨越，缩短了其他人理解这段代码所需填补的鸿沟，工作效率自然会得到提高。

用业务语言编程

写代码的时候，尽可能用业务语言，会让你转换一个思路。前面还只是一个简单的例子，我们再来看一个。
我们用最常用的电商下单过程来说，凭直觉我们会构建一个订单类 Order。什么东西会放在这个类里呢？
首先，商品信息应该在这个类里面，这听上去很合理。然后，既然是电商的订单，可能要送货，所以，应该有送货的信息，没问题吧。再来，买东西要支付，我们会选择一些支付方式，所以，还应该有支付信息。
就这样，你会发现这个订单类里面的信息会越来越多：会员信息可能也要加进去，折扣信息也可能会加入。
你是一个要维护这段代码的人，这个类会越来越庞大，每个修改都要到你这里来，不知不觉中，你就陷入了一个疲于奔命的状态。
如果只是站在让代码运行的角度，这几乎是一个无法解决的问题。我们只是觉得别扭，但没有好的解决方案，没办法，改就改呗！
但如果我们有了看业务的视角，我们会问一个问题，这些信息都放在“订单”是合理的吗？
我们可以与业务人员交流，询问这些信息到底在什么场景下使用。这时候你就会发现，商品信息主要的用途是下单环节，送货信息是在物流环节，而支付信息则用在支付环节。
有了这样的信息，你会知道一件事，虽然我们在用一个“订单”的概念，但实际上，在不同的场景下，用到信息是不同的。
所以，更好地做法是，把这个“订单”的概念拆分了，也就有了：交易订单、物流订单和支付订单。我们原来陷入的困境，就是因为我们没有业务知识，只能笼统地用订单去涵盖各种场景。
如果你在一个电商平台工作，这几个概念你可能并不陌生，但实际上，类似的错误我们在很多代码里都可以看到。
再举个例子，在很多系统里，大家特别喜欢一个叫“用户”的概念，也把很多信息塞到了“用户”里。但实际上，在不同的场景下，它也应该是不同的东西：比如，在项目管理软件中，它应该是项目管理员和项目成员，在借贷的场景下，它应该是借款方和贷款方等等。
要想把这些概念很好地区分出来，你得对业务语言有理解，为了不让自己“分裂”，最好的办法就是把这些概念在代码中体现出来，给出一个好的名字。这就要求你最好和业务人员使用同样的语言。
如果了解领域驱动设计（Domain Driven Design，DDD），你可能已经分辨出来了，我在这里说的实际上就是领域驱动设计。把不同的概念分解出来，这其实是限界上下文（Bounded Context）的作用，而在代码里尽可能使用业务语言，这是通用语言（Ubiquitous Language）的作用。
所以，一个好的命名需要你对业务知识有一个深入的理解，遗憾的是，这并不是程序员的强项，需要我们额外地学习，但这也是我们想写好代码的前提。现在，你已经理解了，取个好名字，并不是一件容易的事。

总结时刻

代码是程序员与机器沟通的桥梁，写好代码是每个程序员的追求，一个专业程序员，追求的不仅是实现功能，还要追求代码可维护。如果你想详细学习如何写好代码，我推荐你去读 Robert Martin 的《代码整洁之道》（Clean Code），这本书几乎覆盖了把代码写好的方方面面。
命名，是写程序中最基础，也是一个程序员从业余走向专业的门槛。我以命名为基础，给你解释了写好代码的提升路径。最初的层次是编写可以运行的代码，然后是编写符合代码规范的代码。
对于命名，最粗浅的理解是不要起无意义的名字，遵循编码规范。但名字起得是否够好，主要看是否还需要额外的解释。很多程序员起名字习惯于采用面向实现的名字，比如，采用数据结构的名字。
再进一步提升，编写代码是要写出人可以理解的代码。因为代码更重要的作用是人和人沟通的桥梁，起一个降低其他人理解门槛的名字才是好名字。
实际上，我们很多没写好的程序有一些原因就是名字起错，把一些概念混淆在一起了。想起好名字，就要学会用业务语言写代码，需要尽可能多地学习业务知识，把业务领域的名字用在代码中。
如果今天的内容你只能记住一件事，那请记住：用业务的语言写代码。
最后，我想请你思考一下，想要写好代码，还有哪些因素是你特别看重的？欢迎在留言区写下你的想法。
感谢阅读，如果你觉得这篇文章对你有帮助的话，也欢迎把它分享给你的朋友。
分享给需要的人，Ta购买本课程，你将得20元
生成海报并分享

赞 29

提建议

© 版权归极客邦科技所有，未经许可不得传播售卖。 页面已增加防盗追踪，如有侵权极客邦将依法追究其法律责任。
上一篇
20 | 为什么世界和你的理解不一样？
下一篇
22 | 轻量级沟通：你总是在开会吗？
unpreview
 写留言

精选留言(28)

  • Jxin
    2019-02-21
    可读性，可扩展性，性能，可维护性。我写代码围绕这 三点。老师讲的我认为可以划分在可读性。除了了老师讲的业务命名，可读性还有：适当的注释，方法内适当的拆分以保证方法内主流程简洁，减少多层嵌套判断，规避复杂判断条件，采用公司统一编码风格等等。扩展性：采用合适的设计模式，遵循各种规范协议，比如java的草案，采用主流框架，比如java的spring全家桶。性能：有意识的去减少网络io，规避长事务，敏感的时间复杂度和空间复杂度的变别能力，jvm的运行原理，快速精准的测试能力。可维护性：规范的日志记录（其他监控什么的跟编码无关了）。代码规范的书：阿里的<码出高效>和<阿里开发手册>很不错，推荐。
    展开

    作者回复: 很好的补充。 但我不是只在写可读性的角度，我讨论的是大家思维中的盲区。我知道，很多书和文章也会告诉你那些基本知识，我想给大家补充的是，一条主线，一条把这些知识贯穿起来的主线，这是你在别的书和文章中不容易找到的东西。缺少了这条线，你虽然很努力，出了问题依然不知道是哪出的问题。

    共 3 条评论
    38
  • 西西弗与卡夫卡
    2019-02-20
    在一些特定情况下，我还用中文甚至中文短句命过名。虽然看起来有些古怪，但考虑到如果不用中文就要用复杂的英文名还要辅助注释才能看明白，就两害取其轻了。毕竟代码是让以后的人看懂，不管是自己，还是交接给别人。另外，代码最好能在几十行以内。还有，可以通过写容易懂的测试代码来展示复杂代码所要表达的逻辑，有些时候比注释管用

    作者回复: 对程序员来说，加强英文学习是一项必修课。我们以为中文好用，一个原因是没找到好的英文说法。在我的实践中，我会先去找到这个领域模型的英文表达做成词汇表，然后再开始写代码。 用测试当注释倒也是我经常使用的手段。

    共 3 条评论
    21
  • 黒ウサギ
    2019-02-20
    英语是很重要，有时候定义一个属性名称，还得去理解一下类似的词的意思，比如说state和status，class和category之类的，还要考虑下哪个词短一些、哪个是领域内或者老外常用的、哪个更好让英语不好的人看懂(包括自己)……感觉对我这种英语不算好的人来说，挑个词挺花时间的(算强迫症吗？)

    作者回复: 多练习

    共 2 条评论
    13
  • 陈斯佳
    2019-08-09
    代码也是一门语言，语言的本质就是降低交流成本。

    作者回复: 能认识到前半段的程序员很多，认识到后半段的程序员就不多了。

    10
  • 梦倚栏杆
    2019-02-22
    order 这个例子举得特别形象，深有体会。我们这边就是写代码的时候一个地方把task名字占用了，然后其他地方的task懵逼了

    作者回复: 起名字难，难在起一个具体的名字，很多人太容易随手起一个通用的名字。

    10
  • TH
    2019-02-21
    领域驱动设计确实是写出合适的代码结构的一项训练，程序员会不由自主地按照自己的习惯，也就是按照计算机运行逻辑去设计代码，这样的代码很容易陷入难以维护的坑。在开始动手写代码之前跟用户交流清楚，理解设计的概念、流程、使用场景、特殊情况，这些都很重要。另外我特别关注的一点是可变项和不变项的分离，因为我们的业务场景对可扩展性要求很高

    作者回复: 分清可变和不变，这是很赞的做法！

    8
  • 行与修
    2019-02-20
    在了解业务的基础上，我觉得写好代码之前要做两个铺垫：设计和分解。设计可以是整体的，也可以是局部的，厘清思路为适度。分解即任务分解，保证代码铺开有章可循。新人入行，有了一闪而过的灵感往往就动手了，随着深入再往返折回很是忙碌，经验不足是客观存在的，但习惯还是早培养早受益，经验不足者那就做些简单的设计，等丰富了再做细致的设计就好，个人倾向于前面多花点时间。写代码要通俗易懂，条理清晰，阶段性项目内部review，让不同模块编写者来执行。另外我是不建议用中文命名的，此时用中文注释补充也未尝不可。
    展开

    作者回复: 有益的思考

    7
  • 马斯费油
    2019-03-13
    代码主要是为了写给人看的，而不是写给机器看的，只是顺便也能用机器执行而已

    作者回复: 这个说法很到位！

    5
  • 布衣骇客
    2019-02-21
    补课追上来了，写test，有注释，命名经常和接口作用相近类似，尽管有的时候命名会比较长，但是通俗易懂，加上简易几句中文解释，跑完junit，完成一个小小业务实现。刚好最近看了下代码整洁之道，老师也推荐了，确实很不错

    作者回复: 继续加油！

    4
  • 起风了
    2022-04-12
    人要负责将业务问题和机器执行连接起来，缺少了业务背景是不可能写出好代码的。
    1
  • zenk
    2021-07-02
    对，取好名字前提是问题分解的干净合理
    1
  • Jerry Wu
    2020-04-24
    注释也同等重要，应该要多加一句：用业务的语言写代码，用业务的语言写注释。

    作者回复: 对于写注释，我持保留意见。

    1
  • Jerry Wu
    2020-04-24
    你写的代码不但是别人看，你自己也在看。 如果过了一段时间，你自己都看不懂当初写的是啥，那工作量起码翻倍。 所以，除了命名，我在正式写代码前，把注释先写好。这样在改业务的时候，起码能节约四分之一的时间，直接找注释，不用从头到尾看代码。
    展开

    作者回复: 注释的话，见仁见智，除了一些需要解释的算法，注释很可能解释的是没写清楚的代码。

    共 3 条评论
    1
  • 时代先锋
    2020-03-26
    代码书写是程序员沟通得语言
    1
  • butterfly
    2019-05-22
    转golang的表示 golang好反人类，好些第三方库都是很简单的一个字母. 比如map m； request r 之类的
    共 1 条评论
    1
  • whhbbq
    2019-05-08
    【实际上，我们很多没写好的程序有一些原因就是名字起错，把一些概念混淆在一起了】 根本原因是概念混淆，老师讲出了为啥没有起好名字的深层次原因，受教受教！我之前理解的起一个好名字还是低了一个层次。
    1
  • 松鼠工作室
    2022-10-31 来自四川
    老师你好，我看了你不少的专栏和文章，然后上面看到你说你想补充的是给大家一条主线，通过这条主线去抓住各项知识，我可以不可以这么理解 1. 你所说的主线，其本质上，就是成长，一个程序猿的成长，从一个写代码到一个写好代码的程序员，这就是所谓的“道” 2. 你教的各种提高效率，或者代码规范之类的，这些都是“术” 我不知道可不可以这么理解，如果我理解有偏差，还请老师讲解一下，在这门课程中或者在你其他的课程中，所谓的主线是什么？所谓的大树的树根是什么？ 什么是树根，什么又是树叶？ 我们学习之树应该如何的快速的成长，又如何的培养自己强大的根茎，让树叶都能开的茂盛些？
    展开
  • 二饼
    2022-05-27
    这篇真的常看常新，我已经读了很多遍了，每次都有不同的感受。 作为一个初入职场的开发者，我对于好命名的理解也从不是abc，到一个具体的描述，再到一个符合英语语法能准确描述做什么。 不过迫于英语水平很一般，因此目前真正能实践的到的程度也仅限于描述在做什么（不怎么考虑英语语法）。 再结合老师这篇文章，也发现目前的命名喜欢或许细节，而不具体，这个也是我以后要首先改善的方面。
    展开
  • ubuntuMax
    2022-04-19
    代码本身能讲清业务逻辑是最好的，除非特别复杂的算法，一般还是把注释想说的话以代码本身来展现。 其实写代码和写文章是类似的，都是要表达清晰，文达。
  • ifelse
    2022-04-19
    代码命名有语义，能体现业务含义，最佳实践:用业余语言命名

    作者回复: 我建议用业务语言😂

    共 2 条评论