#程序员自我修炼(一) - 如何编写合格代码(上)
#程序员自我修炼(一) - 如何编写合格代码(上)
ali安东尼 发表于5个月前
#程序员自我修炼(一) - 如何编写合格代码(上)
  • 发表于 5个月前
  • 阅读 3
  • 收藏 0
  • 点赞 0
  • 评论 0

腾讯云 技术升级10大核心产品年终让利>>>   

在文章的开头,我先给 “合格的代码” 来做个定义:

  • 满足要求定义的初始化规则
  • 代码清晰简洁,没有思维逆反的逻辑或者刻意为之的陷阱代码
  • 尽可能控制代码风险
  • 合理的代码注释
  • 合理的标准化接口定义合,杜绝误用或者滥用

我先从一个实际例子来说起。

有人可能会问:如果一个函数的长度被标准化要求严格限制在几十行以内,还不够清晰简洁么?可读性还会差么?

我给出的答案是:会的。

function clean(tags) {
  var dedupe = {};
  for (var i=0; i<tags.length; i++){
	 tags[i] = tags[i].trim();
	 var aTag = tags[i];

		if(dedupe[aTag]){
 			 var t =tags.splice(i,1);
 			 i--;
		} else {
 			 dedupe[aTag] = true;
		}
  }
  return tags;
}

大家仔细把这代码读两遍,看看能不能推断出它想干什么?

我相信大家很难一下子明白。因为,这段代码有机个反人类的地方:

首先,在循环中改变循环相关的变量 tags,因为 tags 被改变,连带循环的终止条件也变化。因此又改变了循环的自变量 i--(这个改动肯定是调试的时候发现不对,为了解决问题加上去的)。

通过这两个反人类的处理,这个十行多一点的代码成功让自己成为其烂无比的代码。这样的代码只能通过读懂(或者测试出)其要表达的逻辑,然后重写之。

另一类的代码写的足够清晰,但是不够简洁。

const ALPHABET = ['1', '2', '3', '4', '5', '6', '7', '8', '9',
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S',
'T', 'U', 'V', 'W', 'X', 'Y', 'Z'];

function randomCode(length) {
  const code = [];
  for (let i = 0; i < length; i++) {
const rand = Math.floor(Math.random() * 33);
code.push(ALPHABET[rand]);
  }
  return code.join('');
}

这段代码的问题相信大家能准确理解。虽然这个代码当然是可以进一步简化的,但基本上已经无法做更多有意义的重构。 其实,我希望大家要考虑的是,我们真的有必要自己撰写这样的高重用代码么?这种基本的问题必然已有前人妥善解决,比如说:randomstring 这个模块。

const randomstring = require('randomstring');
const randomCode = length => randomstring.generate({
  length, capitalization: 'uppercase',
});

有的人可能对于“拿来主义”有所不耻,认为必须要自己逐行逐字敲的代码才靠谱。但是,我们再来看看这段问题代码,其实它还有2个隐患:

  • 设计不通用,缺乏可扩展性。

    上述的代码如果哪天要改成小写字母、或者大小写混合怎么办?每次需求变动都涉及不少改动。

  • 缺乏可靠与稳定性。

    成熟的代码是经过充分测试的,如果你硬要重写,代价不仅仅是编码实现,更加重要的是需要再经过一轮严密而繁琐的测试。

严谨的代码设计、组织和合理利用第三方开源资源库,是编写合格代码必不可少的基本功。

想要学习更多的编程技巧,请继续关注后续的连载文章。

由睿江云提供,想了解更多,请登陆www.eflycloud.com

共有 人打赏支持
粉丝 3
博文 192
码字总数 173101
×
ali安东尼
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: