作者：暗夜风线_371 | 来源：互联网 | 2016-02-27 02:24
编者按：本文由秦迪向「高可用架构」投稿，介绍编写好代码的思考与感悟。转载请注明来自高可用架构公众号「ArchNotes」。
秦迪，微博研发中心技术专家，2013 年加入微博，负责微博平台通讯系统的设计和研发、微博平台基础工具的开发和维护，并负责微博平台的架构改进工作，在工作中擅长排查复杂系统的各类疑难杂症。爱折腾，喜欢研究从内核到前端的所有方向，近几年重点关注大规模系统的架构设计和性能优化，重度代码洁癖：以 code review 为己任，重度工具控：有现成工具的问题就用工具解决，没有工具能解决的问题就写个工具解决。业余时间喜欢偶尔换个语言写代码放松一下。
“一个人工作了几年、做过很多项目、带过团队、发了一些文章，不一定能代表他代码写的好；反之，一个人代码写的好，其它方面的能力一般不会太差。” —— 秦迪
最近写了不少代码，review 了不少代码，也做了不少重构，总之是对着烂代码工作了几周。为了抒发一下这几周里好几次到达崩溃边缘的情绪，我决定写一篇文章谈一谈烂代码的那些事。这里是上篇，谈一谈烂代码产生的原因和现象。
1、写烂代码很容易
刚入程序员这行的时候经常听到一个观点：你要把精力放在 ABCD（需求文档/ 功能设计/架构设计/理解原理）上，写代码只是把想法翻译成编程语言而已，是一个没什么技术含量的事情。
当时的我在听到这种观点时会有一种近似于高冷的不屑：你们就是一群傻 X，根本不懂代码质量的重要性，这么下去迟早有一天会踩坑，呸。
可是几个月之后，他们似乎也没怎么踩坑。而随着编程技术一直在不断发展，带来了更多的我以前认为是傻 X 的人加入到程序员这个行业中来。
语言越来越高级、封装越来越完善，各种技术都在帮助程序员提高生产代码的效率，依靠层层封装，程序员真的不需要了解一丁点技术细节，只要把需求里的内容逐行翻译出来就可以了。
很多程序员不知道要怎么组织代码、怎么提升运行效率、底层是基于什么原理，他们写出来的是在我心目中一堆垃圾代码。但是那一坨垃圾代码竟然能正常工作。
即使我认为他们写的代码是垃圾，但是从不接触代码的人的视角来看（比如说你的 boss），代码编译过了，测试过了，上线运行了一个月都没出问题，你还想要奢求什么？
所以，即使不情愿，也必须承认，时至今日，写代码这件事本身没有那么难了。
2、烂代码终究是烂代码
但是偶尔有那么几次，写烂代码的人离职了之后，事情似乎又变得不一样了。
想要修改功能时却发现程序里充斥着各种无法理解的逻辑、改完之后莫名其妙的 bug 一个接一个，接手这个项目的人开始漫无目的的加班，并且原本一个挺乐观开朗的人渐渐的开始无法接受了。
我总结了几类经常被鄙视到的烂代码：
2.1 意义不明
能力差的程序员容易写出意义不明的代码，他们不知道自己究竟在做什么。
就像这样：
|
1
2
3
4
5
6
|
public void save() {
for(int i=0;i<100;i++) {
//防止保存失败，重试100次
document.save();
}
}
|
对于这类程序员，建议他们尽早转行。
2.2 不说人话
不说人话是新手最经常出现的问题，直接的表现就是写了一段很简单的代码，其他人却看不懂。
比如下面这段：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
public boolean getUrl(Long id) {
UserProfile up = us.getUser(ms.get(id).getMessage().aid);
if (up == null) {
return false;
}
if (up.type == 4 || ((up.id >> 2) & 1) == 1) {
return false;
}
if(Util.getUrl(up.description)) {
return true;
} else {
return false;
}
}
|
还有很多程序员喜欢复杂，各种宏定义、位运算之类写的天花乱坠，生怕代码让别人一下子看懂了会显得自己水平不够。
很多程序员喜欢简单的东西：简单的函数名、简单的变量名、代码里翻来覆去只用那么几个单词命名；能缩写就缩写、能省略就省略、能合并就合并。这类人写出来的代码里充斥着各种 g/s/gos/of/mss 之类的全世界没人懂的缩写，或者一长串不知道在做什么的连续调用。
简单的说，他们的代码是写给机器的，不是给人看的。
2.3 不恰当的组织
不恰当的组织是高级一些的烂代码，程序员在写过一些代码之后，有了基本的代码风格，但是对于规模大一些的工程的掌控能力不够，不知道代码应该如何解耦、分层和组织。
这种反模式的现象是经常会看到一段代码在工程里拷来拷去；某个文件里放了一大坨堆砌起来的代码；一个函数堆了几百上千行；或者一个简单的功能七拐八绕的调了几十个函数，在某个难以发现的猥琐的小角落里默默的调用了某些关键逻辑。
这类代码大多复杂度高，难以修改，经常一改就崩；而另一方面，创造了这些代码的人倾向于修改代码，畏惧创造代码，他们宁愿让原本复杂的代码一步步变得更复杂，也不愿意重新组织代码。当你面对一个几千行的类，问为什么不把某某逻辑提取出来的时候，他们会说：
“但是，那样就多了一个类了呀。”
2.4.假设和缺少抽象
相对于前面的例子，假设这种反模式出现的场景更频繁，花样更多，始作俑者也更难以自己意识到问题。比如：
|
1
2
3
4
|
public String loadString() {
File file = new File("c:/config.txt");
// read something
}
|
文件路径变更的时候，会把代码改成这样：
|
1
2
3
4
|
public String loadString(String name) {
File file = new File(name);
// read something
}
|
需要加载的内容更丰富的时候，会再变成这样：
|
1
2
3
4
5
6
7
8
|
public String loadString(String name) {
File file = new File(name);
// read something
}
public Integer loadInt(String name)
var cpro_id = "u6885494";
推荐阅读
-
本文介绍了Python中使用字典推导式和循环列表生成字典的方法，包括通过循环列表生成相应的字典，并给出了执行结果。详细讲解了代码实现过程。 ...
[详细]
蜡笔小新 2023-12-14 14:54:09
-
本文介绍了Python版Protobuf的安装和使用方法，包括版本选择、编译配置、示例代码等内容。通过学习本教程，您将了解如何在Python中使用Protobuf进行数据序列化和反序列化操作，以及相关的注意事项和技巧。 ...
[详细]
蜡笔小新 2023-12-14 09:27:58
-
-
本文介绍了sklearn数据集库中常用的数据集类型，包括玩具数据集和样本生成器。其中详细介绍了波士顿房价数据集，包含了波士顿506处房屋的13种不同特征以及房屋价格，适用于回归任务。 ...
[详细]
蜡笔小新 2023-12-13 17:45:15
-
转载请注明明桑AndroidAndroid5.0Loollipop作为Android最重要的版本之一，为我们带来了全新的界面风格和设计语言。看起来很受欢迎 ...
[详细]
蜡笔小新 2023-12-13 16:11:00
-
本文介绍了使用Go语言的GUI库lxn/walk实现菜单栏和工具栏的具体方法，包括消息窗口的产生、文件放置动作响应和提示框的应用。部分代码来自上一篇博客和lxn/walk官方示例。文章提供了学习GUI开发的实际案例和代码示例。 ...
[详细]
蜡笔小新 2023-12-12 20:56:55
-
本文讲解了从高级程序员到CTO的4次能力跃迁，以及如何选择适合的技术负责人。在初创期、发展期、成熟期的每个阶段，创业公司需要不同级别的技术负责人来实现复杂功能、解决技术难题、提高交付效率和质量。高级程序员的职责是实现复杂功能、编写核心代码、处理线上bug、解决技术难题。而技术经理则需要提高交付效率和质量。 ...
[详细]
蜡笔小新 2023-12-11 13:41:06
-
SpringBoot整合SpringSecurity+JWT实现单点登录,Go语言社区,Golang程序员人脉社 ...
[详细]
蜡笔小新 2023-12-11 08:21:41
-
简介怎样学习才能从一名Java初级程序员成长为一名合格的架构师，或者说一名合格的架构师应该有怎样的技术知识体系，这是不仅一个刚刚踏入职场的初级程序员也是工作一两年之后开始迷茫的程序 ...
[详细]
蜡笔小新 2023-10-16 19:11:34
-
前言最近看到很多应届生晒offer,稍有名气点的公司给出的价格都是一年30多W或者月薪20几k,相比之下工作几年的自己薪资确实很寒酸.根据我自己找工作经历,二线城市一般小公司招聘 ...
[详细]
蜡笔小新 2023-10-16 13:18:32
-
一、第四单元架构设计总结第一次作业由于需要按名查找类图模型，于是建立&quot;Class&quot;类进行管理由于方法具有参数导致类中存在二级结构 ...
[详细]
蜡笔小新 2023-10-16 10:17:11
-
OpenEdge已经更名为Baetyl。OpenEdge是百度云发布的国内首个开源边缘计算产品，可将云计算能力拓展至用户现场，提供临时离线、低延时的计算 ...
[详细]
蜡笔小新 2023-10-15 09:30:10
-
本文介绍了云原生边缘计算中的KubeEdge系统，该系统是一个开源系统，用于将容器化应用程序编排功能扩展到Edge的主机。它基于Kubernetes构建，并为网络应用程序提供基础架构支持。同时，KubeEdge具有离线模式、基于Kubernetes的节点、群集、应用程序和设备管理、资源优化等特点。此外，KubeEdge还支持跨平台工作，在私有、公共和混合云中都可以运行。同时，KubeEdge还提供数据管理和数据分析管道引擎的支持。最后，本文还介绍了KubeEdge系统生成证书的方法。 ...
[详细]
蜡笔小新 2023-12-14 16:49:01
-
文章目录1.需求描述2.问题描述正常状态：问题状态：3.解决方法1.需求描述使用Echats实现了一个中国地图：通过选择查询周期&#x ...
[详细]
蜡笔小新 2023-12-14 16:40:15
-
本文介绍了设计师伊振华受邀参与沈阳市智慧城市运行管理中心项目的整体设计，并以数字赋能和创新驱动高质量发展的理念，建设了集成、智慧、高效的一体化城市综合管理平台，促进了城市的数字化转型。该中心被称为当代城市的智能心脏，为沈阳市的智慧城市建设做出了重要贡献。 ...
[详细]
蜡笔小新 2023-12-14 16:35:39
-
2018年5月10-12日，第九届中国数据库技术大会（DTCC2018）将以“数领先机•智赢未来”为主题，设定2大主会场及20个技术专场，邀请来自国内外互联网、金融、教育等行业百余 ...
[详细]
蜡笔小新 2023-10-17 16:51:57
-
|
京公网安备 11010802041100号