[译] JavaScript 简明代码 —— 最佳实践

时间  2019-11-08
标签 javascript 简明 代码 最佳 实践 栏目 JavaScript 繁體版
原文   原文链接

引言

若是你不仅是担忧你的代码是否能生效，还会关注代码自己及其如何编写，那你能够说你有在关注简明代码并在努力实践。专业的开发者会面向其将来和其余人而不只是为了机器编写代码。你写的任何代码都不会只写一次，而是会待在那等待将来维护代码的人，让他痛苦不堪。但愿那个将来的家伙不会是你。javascript

基于上述状况，简明代码能够被定义为代码以不言自明，易于理解且易于更改或扩展的方式编写。前端

回想一下有多少次你接手别人工做时的第一印象是下面几个 WTF 问题之一？java

“这 TM 是啥？”android

“你 TM 在这干了啥”ios

“这 TM 是干啥的？”git

有一个很火的图片描绘了上述场景。github

img

Robert C. Martin (Bob 叔叔) 的一句名言应该会启发你思考你的方式。编程

即便是糟糕的代码也能运行。可是若是代码不够简明，它会让开发组织陷入困境。后端

在本文中，重点将放在 JavaScript 上，可是原则能够应用于其余编程语言。编程语言

你要的干货来了 —— 简明代码最佳实践

1. 强类型检查

使用 === 而不是 ==

// 若是处理不当，它会在很大程度上影响程序逻辑。就像，你期待向左走，但因为某些缘由，你向右走了。
0 == false // true
0 === false // false
2 == "2" // true
2 === "2" // false

// 例子
const value = "500";
if (value === 500) {
  console.log(value);
  // 不会执行
}

if (value === "500") {
  console.log(value);
  // 会执行
}
复制代码

2. 变量

变量命名要直接代表其背后的意图。这种方式方便代码搜索而且易于他人理解。

糟糕示例：

let daysSLV = 10;
let y = new Date().getFullYear();

let ok;
if (user.age > 30) {
  ok = true;
}
复制代码

良好示例：

const MAX_AGE = 30;
let daysSinceLastVisit = 10;
let currentYear = new Date().getFullYear();

...

const isUserOlderThanAllowed = user.age > MAX_AGE;
复制代码

不要给变量名称添加没必要要的单词。

糟糕示例：

let nameValue;
let theProduct;
复制代码

良好示例：

let name;
let product;
复制代码

不要强制他人记住变量的上下文。

糟糕示例：

const users = ["John", "Marco", "Peter"];
users.forEach(u => {
  doSomething();
  doSomethingElse();
  // ...
  // ...
  // ...
  // ...
  // 这里有 WTF 场景：`u` TM 是啥？
  register(u);
});
复制代码

良好示例：

const users = ["John", "Marco", "Peter"];
users.forEach(user => {
  doSomething();
  doSomethingElse();
  // ...
  // ...
  // ...
  // ...
  register(user);
});
复制代码

不要添加没必要要的上下文。

糟糕示例：

const user = {
  userName: "John",
  userSurname: "Doe",
  userAge: "28"
};

...

user.userName;
复制代码

良好示例：

const user = {
  name: "John",
  surname: "Doe",
  age: "28"
};

...

user.name;
复制代码

3. 函数

使用长而具备描述性的名称。考虑到它表明某种行为，函数名称应该是暴露其背后意图的动词或者短语，参数也是如此。它们的名称应该代表它们要作什么。

糟糕示例：

function notif(user) {
  // implementation
}
复制代码

良好示例：

function notifyUser(emailAddress) {
  // implementation
}
复制代码

避免使用大量参数。理想状况下，函数参数不该该超过两个。参数越少，函数越易于测试。

糟糕示例：

function getUsers(fields, fromDate, toDate) {
  // implementation
}
复制代码

良好示例：

function getUsers({ fields, fromDate, toDate }) {
  // implementation
}

getUsers({
  fields: ['name', 'surname', 'email'],
  fromDate: '2019-01-01',
  toDate: '2019-01-18'
});
复制代码

使用默认参数代替条件语句。

糟糕示例：

function createShape(type) {
  const shapeType = type || "cube";
  // ...
}
复制代码

良好示例：

function createShape(type = "cube") {
  // ...
}
复制代码

一个函数应该只作一件事。禁止在单个函数中执行多个操做。

糟糕示例：

function notifyUsers(users) {
  users.forEach(user => {
    const userRecord = database.lookup(user);
    if (userRecord.isVerified()) {
      notify(user);
    }
  });
}
复制代码

良好示例：

function notifyVerifiedUsers(users) {
  users.filter(isUserVerified).forEach(notify);
}

function isUserVerified(user) {
  const userRecord = database.lookup(user);
  return userRecord.isVerified();
}
复制代码

使用 Object.assign 设置默认对象。

糟糕示例：

const shapeConfig = {
  type: "cube",
  width: 200,
  height: null
};

function createShape(config) {
  config.type = config.type || "cube";
  config.width = config.width || 250;
  config.height = config.width || 250;
}

createShape(shapeConfig);
复制代码

良好示例：

const shapeConfig = {
  type: "cube",
  width: 200
  // Exclude the 'height' key
};

function createShape(config) {
  config = Object.assign(
    {
      type: "cube",
      width: 250,
      height: 250
    },
    config
  );

  ...
}

createShape(shapeConfig);
复制代码

不要使用标志变量做为参数，由于这代表函数作了它不该该作的事。

糟糕示例：

function createFile(name, isPublic) {
  if (isPublic) {
    fs.create(`./public/${name}`);
  } else {
    fs.create(name);
  }
}
复制代码

良好示例：

function createFile(name) {
  fs.create(name);
}

function createPublicFile(name) {
  createFile(`./public/${name}`);
}
复制代码

不要污染全局变量。若是你要扩展一个已存在的对象，使用 ES 类继承而不是在原生对象的原型链上建立函数。

糟糕示例：

Array.prototype.myFunc = function myFunc() {
  // implementation
};
复制代码

良好示例：

class SuperArray extends Array {
  myFunc() {
    // implementation
  }
}
复制代码

4. 条件语句

避免使用否认条件。

糟糕示例：

function isUserNotBlocked(user) {
  // implementation
}

if (!isUserNotBlocked(user)) {
  // implementation
}
复制代码

良好示例：

function isUserBlocked(user) {
  // implementation
}

if (isUserBlocked(user)) {
  // implementation
}
复制代码

使用条件语句简写。这可能不那么重要，可是值得一提。仅将此方法用于布尔值，而且肯定该值不是 undefined 和 null。

糟糕示例：

if (isValid === true) {
  // do something...
}

if (isValid === false) {
  // do something...
}
复制代码

良好示例：

if (isValid) {
  // do something...
}

if (!isValid) {
  // do something...
}
复制代码

尽量避免条件语句，使用多态和继承。

糟糕示例：

class Car {
  // ...
  getMaximumSpeed() {
    switch (this.type) {
      case "Ford":
        return this.someFactor() + this.anotherFactor();
      case "Mazda":
        return this.someFactor();
      case "McLaren":
        return this.someFactor() - this.anotherFactor();
    }
  }
}
复制代码

良好示例：

class Car {
  // ...
}

class Ford extends Car {
  // ...
  getMaximumSpeed() {
    return this.someFactor() + this.anotherFactor();
  }
}

class Mazda extends Car {
  // ...
  getMaximumSpeed() {
    return this.someFactor();
  }
}

class McLaren extends Car {
  // ...
  getMaximumSpeed() {
    return this.someFactor() - this.anotherFactor();
  }
}
复制代码

5. ES 类

类是 JavaScript 中的新语法糖。一切都像以前使用原型同样如今只不过看起来不一样，而且你应该喜欢它们赛过 ES5 普通函数。

糟糕示例：

const Person = function(name) {
  if (!(this instanceof Person)) {
    throw new Error("Instantiate Person with `new` keyword");
  }

  this.name = name;
};

Person.prototype.sayHello = function sayHello() { /**/ };

const Student = function(name, school) {
  if (!(this instanceof Student)) {
    throw new Error("Instantiate Student with `new` keyword");
  }

  Person.call(this, name);
  this.school = school;
};

Student.prototype = Object.create(Person.prototype);
Student.prototype.constructor = Student;
Student.prototype.printSchoolName = function printSchoolName() { /**/ };
复制代码

良好示例：

class Person {
  constructor(name) {
    this.name = name;
  }

  sayHello() {
    /* ... */
  }
}

class Student extends Person {
  constructor(name, school) {
    super(name);
    this.school = school;
  }

  printSchoolName() {
    /* ... */
  }
}
复制代码

使用方法链。诸如 jQuery 和 Lodash 之类的不少库都使用这个模式。这样的话，你的代码就会减小冗余。在你的类中，只用在每一个函数末尾返回 this，而后你就能够在它上面链式调用更多的类方法了。

糟糕示例：

class Person {
  constructor(name) {
    this.name = name;
  }

  setSurname(surname) {
    this.surname = surname;
  }

  setAge(age) {
    this.age = age;
  }

  save() {
    console.log(this.name, this.surname, this.age);
  }
}

const person = new Person("John");
person.setSurname("Doe");
person.setAge(29);
person.save();
复制代码

良好示例：

class Person {
  constructor(name) {
    this.name = name;
  }

  setSurname(surname) {
    this.surname = surname;
    // Return this for chaining
    return this;
  }

  setAge(age) {
    this.age = age;
    // Return this for chaining
    return this;
  }

  save() {
    console.log(this.name, this.surname, this.age);
    // Return this for chaining
    return this;
  }
}

const person = new Person("John")
    .setSurname("Doe")
    .setAge(29)
    .save();
复制代码

6. 通用原则

通常来讲，你应该尽力不要重复本身的工做，意思是你不该该写重复代码，而且不要在你身后留下尾巴好比未使用的函数和死代码。

出于各类缘由，你最终可能会遇到重复的代码。例如，你有两个大体相同只有些许不一样的东西，它们不一样的特性或者时间紧迫使你单首创建了两个包含几乎相同代码的函数。在这种状况下删除重复代码意味着抽象化差别并在该层级上处理它们。

关于死代码，码如其名。它是在咱们代码库中不作任何事情的代码，在开发的某个阶段，你决定它再也不有用了。你应该在代码库中搜索这些部分而后删除全部不须要的函数和代码块。我能够给你的建议是一旦你决定再也不须要它，删除它。否则你就会忘了它的用途。

这有一张图代表你当时可能会有的感觉。

img

结语

这只是改进代码所能作的一小部分。在我看来，这里所说的原则是人们常常不遵循的原则。他们有过尝试，但因为各类缘由并不老是奏效。可能项目刚开始代码仍是整洁的，但当截止日期快到了，这些原则一般会被忽略，被移入“待办”或者“重构”部分。在那时候，客户宁愿让你遇上截止日期而不是写简明的代码。

就这样！

感谢阅读，下篇文章见。

若是发现译文存在错误或其余须要改进的地方，欢迎到 掘金翻译计划 对译文进行修改并 PR，也可得到相应奖励积分。文章开头的 本文永久连接 即为本文在 GitHub 上的 MarkDown 连接。

掘金翻译计划 是一个翻译优质互联网技术文章的社区，文章来源为 掘金 上的英文分享文章。内容覆盖 Android、iOS、前端、后端、区块链、产品、设计、人工智能等领域，想要查看更多优质译文请持续关注 掘金翻译计划、官方微博、知乎专栏。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程