如何写出漂亮的代码

原文：github.com/ryanmcdermo…

说明：本文翻译自 github 上的一个项目，非全文搬运，只取部分精华。



如何提高代码的可读性、复用性、扩展性。我们将从以下四个方面讨论：

1、变量

2、函数

3、类

4、异步

一、变量

用有意义且常用的单词命名

// Bad: const yyyymmdstr = moment.format('YYYY/MM/DD');

// Good: const currentDate = moment.format('YYYY/MM/DD');

保持统一

对同一类型的变量使用相同的命名保持统一：

// Bad:

getUserInfo;

getClientData;

getCustomerRecord;

// Good: getUser

每个常量(全大写)都该命名

可以用 ESLint 检测代码中未命名的常量。

// Bad:

// 其他人知道 86400000 的意思吗？

setTimeout( blastOff, 86400000 );

// Good:

const MILLISECOND_IN_A_DAY = 86400000;

setTimeout( blastOff, MILLISECOND_IN_A_DAY );

避免无意义的命名

既然创建了一个 car 对象，就没有必要把它的颜色命名为 carColor。

// Bad:

const car = {

carMake: 'Honda',

carModel: 'Accord',

carColor: 'Blue' };

function paintCar( car ) {

car.carColor = 'Red'; }

// Good:

const car = {

make: 'Honda',

model: 'Accord',

color: 'Blue'

};

function paintCar( car ) {

car.color = 'Red';

}

传参使用默认值

// Bad:

function createMicrobrewery( name ) {

const breweryName = name || 'Hipster Brew Co.';

// ...

}

// Good:

function createMicrobrewery( name = 'Hipster Brew Co.' ) {

// ...

}

二、函数

函数参数( 最好 2 个或更少 )

如果参数超过两个，建议使用 ES6 的解构语法，不用考虑参数的顺序。

// Bad:

function createMenu( title, body, buttonText, cancellable ) {

// ...

}

// Good:

function createMenu( { title, body, buttonText, cancellable } ) {

// ...

}

createMenu({

title: 'Foo',

body: 'Bar',

buttonText: 'Baz',

cancellable: true

});

一个方法只做一件事情

这是一条在软件工程领域流传久远的规则。严格遵守这条规则会让你的代码可读性更好，也更容易重构。如果违反这个规则，那么代码会很难被测试或者重用。

// Bad:

function emailClients( clients ) {

clients.forEach( client => {

const clientRecord = database.lookup( client );

if ( clientRecord.isActive ) {

email( client );

}

});

}

// Good:

function emailActiveClients( clients ) {

clients

.filter( isActiveClient )

.forEach( email );

}

function isActiveClient( client ) {

const clientRecord = database.lookup( client );

return clientRecord.isActive;

}

函数名上体现它的作用

// Bad:

function addToDate( date, month ) {

// ...

}

const date = new Date;

// 很难知道是把什么加到日期中

addToDate( date, 1 );

// Good:

function addMonthToDate( month, date ) {

// ...

}

const date = new Date;

addMonthToDate( 1, date );

删除重复代码，合并相似函数

很多时候虽然是同一个功能，但由于一两个不同点，让你不得不写两个几乎相同的函数。

// Bad:

function showDeveloperList(developers) {

developers.forEach((developer) => {

const expectedSalary = developer.calculateExpectedSalary;

const experience = developer.getExperience;

const githubLink = developer.getGithubLink;

const data = {

expectedSalary,

experience,

githubLink

};

render(data);

});

}

function showManagerList(managers) {

managers.forEach((manager) => {

const expectedSalary = manager.calculateExpectedSalary;

const experience = manager.getExperience;

const portfolio = manager.getMBAProjects;

const data = {

expectedSalary,

experience,

portfolio

};

render(data);

});

}

// Good:

function showEmployeeList(employees) {

employees.forEach(employee => {

const expectedSalary = employee.calculateExpectedSalary;

const experience = employee.getExperience;

const data = {

expectedSalary,

experience,

};

switch(employee.type) {

case 'develop':

data.githubLink = employee.getGithubLink;

break

case 'manager':

data.portfolio = employee.getMBAProjects;

break

}

render(data);

})

}

使用 Object.assign 设置默认属性

// Bad:

const menuConfig = {

title: null,

body: 'Bar',

buttonText: null,

cancellable: true

};

function createMenu(config) {

config.title = config.title || 'Foo';

config.body = config.body || 'Bar';

config.buttonText = config.buttonText || 'Baz';

config.cancellable = config.cancellable !== undefined ? config.cancellable : true;

}

createMenu(menuConfig);

// Good:

const menuConfig = {

title: 'Order',

// 不包含 body

buttonText: 'Send',

cancellable: true

};

function createMenu(config) {

config = Object.assign({

title: 'Foo',

body: 'Bar',

buttonText: 'Baz',

cancellable: true

}, config);

// config : {title: "Order", body: "Bar", buttonText: "Send", cancellable: true}

// ...

}

createMenu(menuConfig);

尽量不要写全局方法

在 JavaScript 中，永远不要污染全局，会在生产环境中产生难以预料的 bug。举个例子，比如你在 Array.prototype 上新增一个 diff 方法来判断两个数组的不同。而你同事也打算做类似的事情，不过他的 diff 方法是用来判断两个数组首位元素的不同。很明显你们方法会产生冲突，遇到这类问题我们可以用 ES2015/ES6 的语法来对 Array 进行扩展。

// Bad:

Array.prototype.diff = function diff(comparisonArray) {

const hash = new Set(comparisonArray);

return this.filter(elem => !hash.has(elem));

};

// Good:

class SuperArray extends Array {

diff(comparisonArray) {

const hash = new Set(comparisonArray);

return this.filter(elem => !hash.has(elem));

}

}

尽量别用“非”条件句

// Bad:

function isDOMNodeNotPresent(node) {

// ...

}

if (!isDOMNodeNotPresent(node)) {

// ...

}

// Good:

function isDOMNodePresent(node) {

// ...

}

if (isDOMNodePresent(node)) {

// ...

}

不要过度优化

现代浏览器已经在底层做了很多优化，过去的很多优化方案都是无效的，会浪费你的时间。

// Bad:

// 现代浏览器已对此( 缓存 list.length )做了优化。

for (let i = 0, len = list.length; i < len; i++) {

// ...

}

// Good:

for (let i = 0; i < list.length; i++) {

// ...

}

删除弃用代码

这里没有实例代码，删除就对了

三、类

使用 ES6 的 class

在 ES6 之前，没有类的语法，只能用构造函数的方式模拟类，可读性非常差。

// Good:

// 动物

class Animal {

constructor(age) {

this.age = age

};

move {};

}

// 哺乳动物

class Mammal extends Animal{

constructor(age, furColor) {

super(age);

this.furColor = furColor;

};

liveBirth {};

}

// 人类

class Human extends Mammal{

constructor(age, furColor, languageSpoken) {

super(age, furColor);

this.languageSpoken = languageSpoken;

};

speak {};

}

使用链式调用

这种模式相当有用，可以在很多库中都有使用。它让你的代码简洁优雅。

class Car {

constructor(make, model, color) {

this.make = make;

this.model = model;

this.color = color;

}

setMake(make) {

this.make = make

}

setModel(model) {

this.model = model;

}

setColor(color) {

this.color = color;

}

save {

console.log(this.make, this.model, this.color);

}

}

// Bad:

const car = new Car('Ford','F-150','red');

car.setColor('pink');

car.save;

// Good:

class Car {

constructor(make, model, color) {

this.make = make;

this.model = model;

this.color = color;

}

setMake(make) {

this.make = make;

// NOTE: Returning this for chaining

return this;

}

setModel(model) {

this.model = model;

// NOTE: Returning this for chaining

return this;

}

setColor(color) {

this.color = color;

// NOTE: Returning this for chaining

return this;

}

save {

console.log(this.make, this.model, this.color);

// NOTE: Returning this for chaining

return this;

}

}

const car = new Car("Ford", "F-150", "red").setColor("pink").save;

四、异步

使用 promise 或者 Async/Await 代替回调

// Bad:

get('https://en.wikipedia.org/wiki/Robert_Cecil_Martin', (requestErr, response) => {

if (requestErr) {

console.error(requestErr);

}

else {

writeFile('article.html', response.body, (writeErr) => {

if (writeErr) {

console.error(writeErr);

}

else {

console.log('File written');

}

});

}

});

// Good:

get('https://en.wikipedia.org/wiki/Robert_Cecil_Martin')

.then((response) => {

return writeFile('article.html', response);

})

.then( => {

console.log('File written');

})

.catch((err) => {

console.error(err);

});

// perfect:

async function getCleanCodeArticle {

try {

const response = await get('https://en.wikipedia.org/wiki/Robert_Cecil_Martin');

await writeFile('article.html', response);

console.log('File written');

} catch(err) {

console.error(err);

}

}

最后

“我自己是一名从事了5年前端的老程序员，辞职目前在做讲师，今年年初我花了一个月整理了一份最适合2019年学习的web前端干货，从最基础的HTML+CSS+JS到移动端HTML5到各种框架都有整理，送给每一位前端小伙伴，这里是小白聚集地，欢迎初学和进阶中的小伙伴。"

加微信：webtutou123 （领取）

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,001评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,210评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 161,874评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,001评论 1赞 291
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,022评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,005评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,929评论 3赞 416
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,742评论 0赞 271
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,193评论 1赞 309
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1赞 346
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,305评论 5赞 342
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,911评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2赞 352