如何寫出優(yōu)雅的JS 代碼
變量
使用有意義和可發(fā)音的變量名
// 不好的寫法
const yyyymmdstr = moment().format("YYYY/MM/DD");
// 好的寫法
const currentDate = moment().format("YYYY/MM/DD");
對(duì)同一類型的變量使用相同的詞匯
// 不好的寫法 getUserInfo(); getClientData(); getCustomerRecord(); // 好的寫法 getUser();
使用可搜索的名字
我們讀的會(huì)比我們寫的多得多，所以如果命名太過隨意不僅會(huì)給后續(xù)的維護(hù)帶來困難，也會(huì)傷害了讀我們代碼的開發(fā)者。讓你的變量名可被讀取，像buddy.js和ESLint這樣的工具可以幫助識(shí)別未命名的常量。
// 不好的寫法 // 86400000 的用途是什么？ setTimeout(blastOff, 86400000); // 好的寫法 const MILLISECONDS_IN_A_DAY = 86_400_000; setTimeout(blastOff, MILLISECONDS_IN_A_DAY);
使用解釋性變量
// 不好的寫法
const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityZipCode(
address.match(cityZipCodeRegex)[1],
address.match(cityZipCodeRegex)[2]
);
// 好的寫法
const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [_, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);
避免費(fèi)腦的猜測(cè)
顯式用于隱式
// 不好的寫法
const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(l => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// 等等，“l(fā)”又是什么？
dispatch(l);
// 好的寫法
const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(location => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch(location);
});
無需添加不必要的上下文
如果類名/對(duì)象名已經(jīng)說明了，就無需在變量名中重復(fù)。
// 不好的寫法
const Car = {
carMake: "Honda",
carModel: "Accord",
carColor: "Blue"
};
function paintCar(car) {
car.carColor = "Red";
}
// 好的寫法
const Car = {
make: "Honda",
model: "Accord",
color: "Blue"
};
function paintCar(car) {
car.color = "Red";
}
使用默認(rèn)參數(shù)代替邏輯或(與)運(yùn)算
// 不好的寫法
function createMicrobrewery(name) {
const breweryName = name || "Hipster Brew Co.";
// ...
}
// 好的寫法
function createMicrobrewery(name = "Hipster Brew Co.") {
// ...
}
函數(shù)
函數(shù)參數(shù)（理想情況下為2個(gè)或更少）
限制函數(shù)參數(shù)的數(shù)量是非常重要的，因?yàn)樗箿y(cè)試函數(shù)變得更容易。如果有三個(gè)以上的參數(shù)，就會(huì)導(dǎo)致組合爆炸，必須用每個(gè)單獨(dú)的參數(shù)測(cè)試大量不同的情況。
一個(gè)或兩個(gè)參數(shù)是理想的情況，如果可能，應(yīng)避免三個(gè)參數(shù)。 除此之外，還應(yīng)該合并。大多數(shù)情況下，大于三個(gè)參數(shù)可以用對(duì)象來代替。
// 不好的寫法
function createMenu(title, body, buttonText, cancellable) {
// ...
}
createMenu("Foo", "Bar", "Baz", true);
// 好的寫法
function createMenu({ title, body, buttonText, cancellable }) {
// ...
}
createMenu({
title: "Foo",
body: "Bar",
buttonText: "Baz",
cancellable: true
});
函數(shù)應(yīng)該只做一件事
這是目前為止軟件工程中最重要的規(guī)則。當(dāng)函數(shù)做不止一件事時(shí)，它們就更難組合、測(cè)試和推理?？梢詫⒁粋€(gè)函數(shù)隔離為一個(gè)操作時(shí)，就可以很容易地重構(gòu)它，代碼也會(huì)讀起來更清晰。
// 不好的寫法
function emailClients(clients) {
clients.forEach(client => {
const clientRecord = database.lookup(client);
if (clientRecord.isActive()) {
email(client);
}
});
}
// 好的寫法
function emailActiveClients(clients) {
clients.filter(isActiveClient).forEach(email);
}
function isActiveClient(client) {
const clientRecord = database.lookup(client);
return clientRecord.isActive();
}
函數(shù)名稱應(yīng)說明其作用
// 不好的寫法
function addToDate(date, month) {
// ...
}
const date = new Date();
// 從函數(shù)名稱很難知道添加什么
addToDate(date, 1);
// 好的寫法
function addMonthToDate(month, date) {
// ...
}
const date = new Date();
addMonthToDate(1, date);
函數(shù)應(yīng)該只有一個(gè)抽象層次
當(dāng)有一個(gè)以上的抽象層次函數(shù)，意味該函數(shù)做得太多了，需要將函數(shù)拆分可以實(shí)現(xiàn)可重用性和更簡單的測(cè)試。
// 不好的寫法
function parseBetterjsAlternative(code) {
const REGEXES = [
// ...
];
const statements = code.split(" ");
const tokens = [];
REGEXES.forEach(REGEX => {
statements.forEach(statement => {
// ...
});
});
const ast = [];
tokens.forEach(token => {
// lex...
});
ast.forEach(node => {
// parse...
});
}
// 好的寫法
function parseBetterJSAlternative(code) {
const tokens = tokenize(code);
const syntaxTree = parse(tokens);
syntaxTree.forEach(node => {
// parse...
});
}
function tokenize(code) {
const REGEXES = [
// ...
];
const statements = code.split(" ");
const tokens = [];
REGEXES.forEach(REGEX => {
statements.forEach(statement => {
tokens.push(/* ... */);
});
});
return tokens;
}
function parse(tokens) {
const syntaxTree = [];
tokens.forEach(token => {
syntaxTree.push(/* ... */);
});
return syntaxTree;
}
刪除重復(fù)的代碼
盡量避免重復(fù)的代碼，重復(fù)的代碼是不好的，它意味著如果我們需要更改某些邏輯，要改很多地方。
通常，有重復(fù)的代碼，是因?yàn)橛袃蓚€(gè)或多個(gè)稍有不同的事物，它們有很多共同點(diǎn)，但是它們之間的差異迫使我們編寫兩個(gè)或多個(gè)獨(dú)立的函數(shù)來完成許多相同的事情。 刪除重復(fù)的代碼意味著創(chuàng)建一個(gè)僅用一個(gè)函數(shù)/模塊/類就可以處理這組不同事物的抽象。
獲得正確的抽象是至關(guān)重要的，這就是為什么我們應(yīng)該遵循類部分中列出的SOLID原則。糟糕的抽象可能比重復(fù)的代碼更糟糕，所以要小心!說了這么多，如果你能做一個(gè)好的抽象，那就去做吧!不要重復(fù)你自己，否則你會(huì)發(fā)現(xiàn)自己在任何時(shí)候想要改變一件事的時(shí)候都要更新多個(gè)地方。
設(shè)計(jì)模式的六大原則有：
- Single Responsibility Principle：單一職責(zé)原則
- Open Closed Principle：開閉原則
- Liskov Substitution Principle：里氏替換原則
- Law of Demeter：迪米特法則
- Interface Segregation Principle：接口隔離原則
- Dependence Inversion Principle：依賴倒置原則
把這六個(gè)原則的首字母聯(lián)合起來（兩個(gè) L 算做一個(gè)）就是 SOLID （solid，穩(wěn)定的），其代表的含義就是這六個(gè)原則結(jié)合使用的好處：建立穩(wěn)定、靈活、健壯的設(shè)計(jì)。下面我們來分別看一下這六大設(shè)計(jì)原則。
不好的寫法
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);
});
}
好的寫法
function showEmployeeList(employees) {
employees.forEach(employee => {
const expectedSalary = employee.calculateExpectedSalary();
const experience = employee.getExperience();
const data = {
expectedSalary,
experience
};
switch (employee.type) {
case "manager":
data.portfolio = employee.getMBAProjects();
break;
case "developer":
data.githubLink = employee.getGithubLink();
break;
}
render(data);
});
}
使用Object.assign設(shè)置默認(rèn)對(duì)象
不好的寫法
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);
好的寫法
const menuConfig = {
title: "Order",
// User did not include 'body' key
buttonText: "Send",
cancellable: true
};
function createMenu(config) {
config = Object.assign(
{
title: "Foo",
body: "Bar",
buttonText: "Baz",
cancellable: true
},
config
);
// config now equals: {title: "Order", body: "Bar", buttonText: "Send", cancellable: true}
// ...
}
createMenu(menuConfig);
不要使用標(biāo)志作為函數(shù)參數(shù)
標(biāo)志告訴使用者，此函數(shù)可以完成多項(xiàng)任務(wù)，函數(shù)應(yīng)該做一件事。 如果函數(shù)遵循基于布爾的不同代碼路徑，請(qǐng)拆分它們。
// 不好的寫法
function createFile(name, temp) {
if (temp) {
fs.create(`./temp/${name}`);
} else {
fs.create(name);
}
}
// 好的寫法
function createFile(name) {
fs.create(name);
}
function createTempFile(name) {
createFile(`./temp/${name}`);
}
避免副作用(第一部分)
如果函數(shù)除了接受一個(gè)值并返回另一個(gè)值或多個(gè)值以外，不執(zhí)行任何其他操作，都會(huì)產(chǎn)生副作用。 副作用可能是寫入文件，修改某些全局變量，或者不小心將你的所有資金都匯給了陌生人。
不好的寫法
let name = "Ryan McDermott";
function splitIntoFirstAndLastName() {
name = name.split(" ");
}
splitIntoFirstAndLastName();
console.log(name); // ['Ryan', 'McDermott'];
好的寫法
function splitIntoFirstAndLastName(name) {
return name.split(" ");
}
const name = "Ryan McDermott";
const newName = splitIntoFirstAndLastName(name);
console.log(name); // 'Ryan McDermott';
console.log(newName); // ['Ryan', 'McDermott'];
避免副作用(第二部分)
在JavaScript中，原始類型值是按值傳遞，而對(duì)象/數(shù)組按引用傳遞。 對(duì)于對(duì)象和數(shù)組，如果有函數(shù)在購物車數(shù)組中進(jìn)行了更改（例如，通過添加要購買的商品），則使用該購物車數(shù)組的任何其他函數(shù)都將受到此添加的影響。 那可能很棒，但是也可能不好。 來想象一個(gè)糟糕的情況：
用戶單擊“購買”按鈕，該按鈕調(diào)用一個(gè)purchase函數(shù)，接著，該函數(shù)發(fā)出一個(gè)網(wǎng)絡(luò)請(qǐng)求并將cart數(shù)組發(fā)送到服務(wù)器。由于網(wǎng)絡(luò)連接不好，purchase函數(shù)必須不斷重試請(qǐng)求?，F(xiàn)在，如果在網(wǎng)絡(luò)請(qǐng)求開始之前，用戶不小心點(diǎn)擊了他們實(shí)際上不需要的項(xiàng)目上的“添加到購物車”按鈕，該怎么辦?如果發(fā)生這種情況，并且網(wǎng)絡(luò)請(qǐng)求開始，那么購買函數(shù)將發(fā)送意外添加的商品，因?yàn)樗幸粋€(gè)對(duì)購物車數(shù)組的引用，addItemToCart函數(shù)通過添加修改了這個(gè)購物車數(shù)組。
一個(gè)很好的解決方案是addItemToCart總是克隆cart數(shù)組，編輯它，然后返回克隆。這可以確保購物車引用的其他函數(shù)不會(huì)受到任何更改的影響。
關(guān)于這種方法有兩點(diǎn)需要注意：
1.可能在某些情況下，我們確實(shí)需要修改輸入對(duì)象，但是當(dāng)我們采用這種編程實(shí)踐時(shí)，會(huì)發(fā)現(xiàn)這種情況非常少見，大多數(shù)東西都可以被改造成沒有副作用。
2.就性能而言，克隆大對(duì)象可能會(huì)非常昂貴。 幸運(yùn)的是，在實(shí)踐中這并不是一個(gè)大問題，因?yàn)橛泻芏嗪馨舻膸焓惯@種編程方法能夠快速進(jìn)行，并且不像手動(dòng)克隆對(duì)象和數(shù)組那樣占用大量內(nèi)存。
// 不好的寫法
const addItemToCart = (cart, item) => {
cart.push({ item, date: Date.now() });
};
// 好的寫法
const addItemToCart = (cart, item) => {
return [...cart, { item, date: Date.now() }];
};
不要寫全局函數(shù)
污染全局變量在 JS 中是一種不好的做法，因?yàn)榭赡軙?huì)與另一個(gè)庫發(fā)生沖突，并且在他們的生產(chǎn)中遇到異常之前，API 的用戶將毫無用處。 讓我們考慮一個(gè)示例：如果想擴(kuò)展 JS 的原生Array方法以具有可以顯示兩個(gè)數(shù)組之間差異的diff方法，該怎么辦？ 可以將新函數(shù)寫入Array.prototype，但它可能與另一個(gè)嘗試執(zhí)行相同操作的庫發(fā)生沖突。 如果其他庫僅使用diff來查找數(shù)組的第一個(gè)元素和最后一個(gè)元素之間的區(qū)別怎么辦？ 這就是為什么只使用 ES6 類并簡單地?cái)U(kuò)展Array全局會(huì)更好的原因。
// 不好的寫法
Array.prototype.diff = function diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
};
// 好的寫法
class SuperArray extends Array {
diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
}
}
盡量使用函數(shù)式編程而非命令式
JavaScript不像Haskell那樣是一種函數(shù)式語言，但它具有函數(shù)式的風(fēng)格。函數(shù)式語言可以更簡潔、更容易測(cè)試。如果可以的話，盡量喜歡這種編程風(fēng)格。
不好的寫法
const programmerOutput = [
{
name: "Uncle Bobby",
linesOfCode: 500
},
{
name: "Suzie Q",
linesOfCode: 1500
},
{
name: "Jimmy Gosling",
linesOfCode: 150
},
{
name: "Gracie Hopper",
linesOfCode: 1000
}
];
let totalOutput = 0;
for (let i = 0; i < programmerOutput.length; i++) {
totalOutput += programmerOutput[i].linesOfCode;
}
好的寫法
const programmerOutput = [
{
name: "Uncle Bobby",
linesOfCode: 500
},
{
name: "Suzie Q",
linesOfCode: 1500
},
{
name: "Jimmy Gosling",
linesOfCode: 150
},
{
name: "Gracie Hopper",
linesOfCode: 1000
}
];
const totalOutput = programmerOutput.reduce(
(totalLines, output) => totalLines + output.linesOfCode,
0
);
封裝條件
// 不好的寫法
if (fsm.state === "fetching" && isEmpty(listNode)) {
// ...
}
// 好的寫法
function shouldShowSpinner(fsm, listNode) {
return fsm.state === "fetching" && isEmpty(listNode);
}
if (shouldShowSpinner(fsmInstance, listNodeInstance)) {
// ...
}
避免使用非條件
// 不好的寫法
function isDOMNodeNotPresent(node) {
// ...
}
if (!isDOMNodeNotPresent(node)) {
// ...
}
// 好的寫法
function isDOMNodePresent(node) {
// ...
}
if (isDOMNodePresent(node)) {
// ...
}
避免使用過多條件
這似乎是一個(gè)不可能完成的任務(wù)。一聽到這個(gè)，大多數(shù)人會(huì)說，“沒有if語句，我怎么能做任何事情呢?”答案是，你可以在許多情況下使用多態(tài)性來實(shí)現(xiàn)相同的任務(wù)。
第二個(gè)問題通常是，“那很好，但是我為什么要那樣做呢?”答案是上面講過一個(gè)概念:一個(gè)函數(shù)應(yīng)該只做一件事。當(dāng)具有if語句的類和函數(shù)時(shí)，這是在告訴你的使用者該函數(shù)執(zhí)行不止一件事情。
不好的寫法
class Airplane {
// ...
getCruisingAltitude() {
switch (this.type) {
case "777":
return this.getMaxAltitude() - this.getPassengerCount();
case "Air Force One":
return this.getMaxAltitude();
case "Cessna":
return this.getMaxAltitude() - this.getFuelExpenditure();
}
}
}
好的寫法
class Airplane {
// ...
}
class Boeing777 extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude() - this.getPassengerCount();
}
}
class AirForceOne extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude();
}
}
class Cessna extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude() - this.getFuelExpenditure();
}
}
避免類型檢查
JavaScript 是無類型的，這意味著函數(shù)可以接受任何類型的參數(shù)。 有時(shí)q我們會(huì)被這種自由所困擾，并且很想在函數(shù)中進(jìn)行類型檢查。 有很多方法可以避免這樣做。 首先要考慮的是一致的API。
// 不好的寫法
function travelToTexas(vehicle) {
if (vehicle instanceof Bicycle) {
vehicle.pedal(this.currentLocation, new Location("texas"));
} else if (vehicle instanceof Car) {
vehicle.drive(this.currentLocation, new Location("texas"));
}
}
// 好的寫法
function travelToTexas(vehicle) {
vehicle.move(this.currentLocation, new Location("texas"));
}
不要過度優(yōu)化
現(xiàn)代瀏覽器在運(yùn)行時(shí)做了大量的優(yōu)化工作。很多時(shí)候，如果你在優(yōu)化，那么你只是在浪費(fèi)時(shí)間。有很好的資源可以查看哪里缺乏優(yōu)化，我們只需要針對(duì)需要優(yōu)化的地方就行了。
// 不好的寫法
// 在舊的瀏覽器上，每一次使用無緩存“l(fā)ist.length”的迭代都是很昂貴的
// 會(huì)為“l(fā)ist.length”重新計(jì)算。在現(xiàn)代瀏覽器中，這是經(jīng)過優(yōu)化的
for (let i = 0, len = list.length; i < len; i++) {
// ...
}
// 好的寫法
for (let i = 0; i < list.length; i++) {
// ...
}
以上就是如何寫出優(yōu)雅的JS 代碼的詳細(xì)內(nèi)容，更多關(guān)于優(yōu)雅的JS 代碼的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
本篇文章主要是對(duì)js特殊字符過濾的示例代碼進(jìn)行了介紹，需要的朋友可以過來參考下，希望對(duì)大家有所幫助2014-03-03
這篇文章主要為大家詳細(xì)介紹了微信小程序?qū)崿F(xiàn)電子簽名功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-07-07
這篇文章主要給大家介紹了關(guān)于js中Generator函數(shù)的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或者使用Javascript具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
這篇文章主要介紹了JS獲取年月日時(shí)分秒的方法,結(jié)合實(shí)例形式分析了JS獲取具體時(shí)間的常犯錯(cuò)誤與相應(yīng)解決方法,需要的朋友可以參考下2016-11-11
JS實(shí)現(xiàn)淡藍(lán)色簡潔豎向Tab點(diǎn)擊切換效果
這篇文章主要介紹了JS實(shí)現(xiàn)淡藍(lán)色簡潔豎向Tab點(diǎn)擊切換效果,通過JavaScript相應(yīng)鼠標(biāo)事件實(shí)現(xiàn)非常簡單的css樣式切換,簡單實(shí)用,需要的朋友可以參考下2015-10-10
今天小編就為大家分享一篇layui按條件隱藏表格列的實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2019-09-09
關(guān)于Object.entries()方法的使用和實(shí)現(xiàn)方式
這篇文章主要介紹了關(guān)于Object.entries()方法的使用和實(shí)現(xiàn)方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-02-02
js數(shù)據(jù)類型轉(zhuǎn)換與流程控制操作實(shí)例分析
這篇文章主要介紹了js數(shù)據(jù)類型轉(zhuǎn)換與流程控制操作,結(jié)合實(shí)例形式分析了JavaScript數(shù)據(jù)類型轉(zhuǎn)換與流程控制相關(guān)原理、操作技巧與使用注意事項(xiàng),需要的朋友可以參考下2019-12-12
常見瀏覽器多長時(shí)間會(huì)提示“腳本運(yùn)行時(shí)間過長”總結(jié)
這篇文章主要介紹了常見瀏覽器多長時(shí)間會(huì)提示“腳本運(yùn)行時(shí)間過長”總結(jié),需要的朋友可以參考下2014-04-04
js完美實(shí)現(xiàn)@提到好友特效（兼容各大瀏覽器）
本文給大家分享的是一則使用javascript完美實(shí)現(xiàn)兼容各大瀏覽器的@好友自動(dòng)提示的特效，是根據(jù)百度貼吧的效果模仿來的，推薦給小伙伴們，希望大家能夠喜歡。2015-03-03