Javascript
Một cách tiếp cận hợp lý đối với JavaScript - @Airbnb
Các Kiểu giá trị
1.1 Kiểu nguyên thủy: Khi bạn truy cập một giá trị kiểu nguyên thủy, bạn làm việc trực tiếp trên giá trị của nó.string
number
boolean
null
undefined
symbol
Sự thiếu hỗ trợ cho các
Symbol
không thể được lấp đầy bởi các bộ trợ năng một cách toàn diện, do đó, chúng không nên được sử dụng khi hướng đến các trình duyệt/môi trường không có hỗ trợ sẵn.
1.2 Kiểu phức tạp: Khi bạn truy cập một giá trị kiểu phức tạp, bạn làm việc trên tham chiếu giá trị của nó.
object
array
function
Các Tham chiếu
2.1 Sử dụng
const
đối với tất cả các tham chiếu; tránh sử dụngvar
. eslint:prefer-const
,no-const-assign
Tại sao? Điều này đảm bảo rằng bạn không thể gán lại các tham chiếu, việc có thể gây ra các lỗi và gây khó khăn cho sự đọc hiểu mã nguồn.
2.2 Nếu bạn bắt buộc phải gán lại các tham chiếu, sử dụng
let
, thay vìvar
. eslint:no-var
Tại sao?
let
thuộc phạm vi khối mà nó được khởi tạo, thay vì thuộc phạm vi hàm nhưvar
.2.3 Lưu ý rằng cả
let
vàconst
đều thuộc phạm vi khối.
Các Đối tượng
3.1 Sử dụng cú pháp nguyên văn
{}
để khởi tạo đối tượng. eslint:no-new-object
3.2 Sử dụng các tên được tính của thuộc tính
[key()]
khi tạo các đối tượng có các tên của thuộc tính là động.Tại sao? Chúng cho phép bạn định nghĩa tất cả các thuộc tính của một đối tượng cùng một chỗ.
3.3 Sử dụng cú pháp định nghĩa phương thức rút gọn để định nghĩa các phương thức của đối tượng. eslint:
object-shorthand
3.4 Sử dụng cú pháp định nghĩa thuộc tính rút gọn để định nghĩa các thuộc tính của đối tượng. eslint:
object-shorthand
Tại sao? Nó ngắn gọn và súc tích.
3.5 Gom tất cả các thuộc tính rút gọn ở trên cùng khi khai báo đối tượng.
Tại sao? Điều này giúp bạn dễ dàng biết được thuộc tính nào sử dụng cú pháp rút gọn.
3.6 Chỉ sử dụng dấu lược
' '
cho các thuộc tính có định danh không hợp lệ. eslint:quote-props
Tại sao? Nhìn chung, chúng ta sẽ thấy nó dễ đọc hơn nhiều. Nó cải thiện nhấn mạnh cú pháp, và nó cũng giúp việc tối ưu hóa bằng các trình thực thi JS hiệu quả hơn.
3.7 Không gọi các phương thức
Object.prototype
một cách trực tiếp, ví dụ nhưhasOwnProperty
,propertyIsEnumerable
, vàisPrototypeOf
. eslint:no-prototype-builtins
Tại sao? Những phương thức này có thể bị thay thế bởi các thuộc tính của một đối tượng - như
{ hasOwnProperty: false }
- hoặc, đối tượng có thể là một đối tượng rỗng (Object.create(null)
).3.8 Ưu tiên sử dụng toán tử liệt kê
...
so vớiObject.assign
để tạo bản sao nhanh của một đối tượng. Sử dụng toán tử còn-lại...
để tạo một đối tượng mới với một số thuộc tính đã bị loại bỏ
Các Mảng
4.1 Sử dụng cú pháp nguyên văn
[]
để khởi tạo mảng. eslint:no-array-constructor
4.2 Sử dụng Array#push, thay vì phép gán, để thêm các mục cho một mảng.
4.3 Sử dụng toán tử liệt kê
...
để sao nhanh một mảng.4.4 Để chuyển đổi một đối tượng khả duyệt thành một mảng, sử dụng toán tử liệt kê
...
thay vìArray.from
.4.5 Sử dụng
Array.from
để chuyển đổi một đối tượng giống-mảng thành một mảng.4.6 Sử dụng
Array.from
, thay vì toán tử liệt kê...
, để ánh xạ một đối tượng khả duyệt, vì nó không tạo ra một mảng trung gian.4.7 Sử dụng các lệnh
return
cho các hàm gọi lại dùng cho các phương thức của mảng. Được phép bỏ quareturn
nếu phần thân hàm chỉ gồm một câu lệnh trả về một biểu thức không có hiệu ứng phụ, theo quy tắc 8.2. eslint:array-callback-return
4.8 Sử dụng dấu ngắt dòng trước và sau các dấu đóng và mở ngoặc vuông nếu một mảng nằm trên nhiều dòng.
Trích xuất
5.1 Sử dụng trích xuất đối tượng khi truy cập và sử dụng nhiều thuộc tính của một đối tượng. eslint:
prefer-destructuring
Tại sao? Trích xuất giúp việc tạo các tham chiếu đến các thuộc tính trở nên dễ dàng hơn.
5.2 Hãy sử dụng trích xuất mảng. eslint:
prefer-destructuring
5.3 Sử dụng trích xuất đối tượng khi có nhiều giá trị trả về, thay vì trích xuất mảng.
Tại sao? Bạn có thể thêm các thuộc tính mới qua thời gian hay thay đổi thứ tự các thứ mà không lo làm hỏng các phép gọi trước đó.
Các Chuỗi
6.1 Sử dụng dấu lược cho các chuỗi. eslint:
quotes
6.2 Các chuỗi, dù khiến cho độ dài của dòng lớn hơn 100 ký tự, không nên được viết thành nhiều dòng sử dụng ghép chuỗi.
Tại sao? Các chuỗi bị chia nhỏ rất khó để làm việc cùng và khiến việc tìm kiếm trong mã nguồn trở nên khó hơn.
6.3 Khi xây dựng các chuỗi theo một chu trình, sử dụng mẫu chuỗi thay vì ghép chuỗi. eslint:
prefer-template
template-curly-spacing
Tại sao? Các mẫu chuỗi cho bạn một cú pháp súc tích, dễ đọc với các ngắt dòng và các tính năng ghép chuỗi phù hợp.
6.4 Không bao giờ sử dụng
eval()
cho một chuỗi, điều đó mở ra rất nhiều các lỗ hổng và rủi ro. eslint:no-eval
6.5 Không sử dụng các ký tự thoát trong một chuỗi khi không cần thiết. eslint:
no-useless-escape
Tại sao? Các dấu chéo ngược làm giảm tính khả đọc, vì thế chúng chỉ nên xuất hiện khi cần.
Các Hàm
7.1 Sử dụng biểu thức hàm hữu danh thay vì khai báo hàm. eslint:
func-style
Tại sao? Các khai báo hàm đều được kéo lên, đồng nghĩa với việc một hàm rất dễ có khả năng được sử dụng trước cả khi nó được định nghĩa trong tệp. Điều này làm giảm tính khả đọc và khả năng bảo trì. Nếu bạn thấy một hàm đủ lớn hoặc phức tạp đến mức ảnh hưởng đến việc đọc hiểu phần còn lại của tệp thì, có lẽ, nó nên được tách ra thành một mô-đun riêng! Đừng quên đặt tên cho biểu thức một cách rõ ràng, cho dù tên hàm có thể được suy ra từ tên biến chứa hàm đó (thường gặp ở các trình duyệt mới nhất hoặc các trình biên dịch như Babel). Điều này loại bỏ các nhận định liên quan đến ngăn xếp của một lỗi. (Cuộc thảo luận)
7.2 Đặt các biểu thức hàm gọi tức thời trong ngoặc. eslint:
wrap-iife
Tại sao? Một biểu thức hàm gọi tức thời mà một đơn vị riêng - đặt nó và dấu ngoặc dùng để gọi nó
()
trong ngoặc để biểu đạt nó một cách rõ ràng. Cũng cần biết là, trong cái thế giới mà mô-đun ngập tràn mọi nơi như bây giờ, bạn cũng chả mấy khi cần dùng đến biểu thức hàm gọi tức thời.7.3 Không bao giờ khai báo một hàm bên trong một khối không phải hàm (
if
,while
, v.v.). Thay vào đó, hãy gán hàm cho một biến. Các trình duyệt đều sẽ cho phép bạn làm điều đó, nhưng tiếc là, cách mà chúng diễn dịch là khác nhau. eslint:no-loop-func
7.4 Ghi chú: ECMA-262 định nghĩa một
khối
là tập hợp một hoặc một vài câu lệnh. Một khai báo hàm không phải là một câu lệnh.7.5 Không bao giờ đặt tên một tham số là
arguments
. Tham số này sẽ được ưu tiên hơn đối tượngarguments
được cung cấp cho mỗi phạm vi hàm.7.6 Không bao giờ sử dụng
arguments
, thay vào đó, hãy sử dụng cú pháp còn-lại...
. eslint:prefer-rest-params
Tại sao?
...
định rõ các đối số mà bạn muốn lấy. Thêm nữa, kết quả của còn-lại là một mảng đúng nghĩa, thay vì chỉ là giống-mảng nhưarguments
.7.7 Sử dụng tham số mặc định thay vì làm biến đổi các đối số truyền vào hàm.
7.8 Tránh gây ra hiệu ứng phụ với tham số mặc định.
Tại sao? Chúng khá là rối để có thể hình dung.
7.9 Luôn để các tham số mặc định ở sau cùng.
7.10 Không bao giờ sử dụng hàm tạo
Function
để tạo hàm. eslint:no-new-func
Tại sao? Tạo một hàm theo cách này cũng thực thi chuỗi giống như
eval()
vậy, thứ mà mở ra các lỗ hổng.7.11 Sử dụng các dấu cách giữa các bộ phận hàm. eslint:
space-before-function-paren
space-before-blocks
Tại sao? Sự đồng nhất vẫn cứ là tốt, và bạn không cần phải thêm hoặc bớt dấu cách khi không đặt tên hàm.
7.12 Không bao giờ làm biến đổi các tham số. eslint:
no-param-reassign
Tại sao? Việc can thiệp vào các đối tượng được truyền vào dưới dạng tham số có thể gây hiệu ứng phụ không mong muốn đối với biến tại tiến trình gọi.
7.13 Không bao giờ gán lại các tham số. eslint:
no-param-reassign
Tại sao? Việc gán lại các tham số có thể dẫn tới hành vi không mong muốn, đặc biệt là khi truy cập đối tượng
arguments
. Nó cũng có thể gây ra một số vấn đề về tối ưu hóa, nhất là trong V8.7.14 Ưu tiên sử dụng toán tử liệt kê
...
để gọi các hàm bất định. eslint:prefer-spread
Tại sao? Nó nhìn sáng sủa hơn, bạn không cần phải đặt ngữ cảnh, và bạn cũng đâu thể dễ dàng kết hợp
new
vớiapply
.7.15 Các hàm với các bộ phận hàm, hoặc các phép gọi, nằm trên nhiều dòng nên được căn đầu dòng như tất cả các danh sách nhiều dòng khác trong hướng dẫn này: với mỗi mục nằm trên một dòng riêng biệt, cùng với một dấu phẩy ngay sau mục cuối cùng. eslint:
function-paren-newline
Các Hàm mũi tên
8.1 Khi bạn phải sử dụng một hàm vô danh (như khi cần truyền một hàm gọi lại trên cùng dòng), sử dụng ký pháp hàm mũi tên. eslint:
prefer-arrow-callback
,arrow-spacing
Tại sao? Nó tạo ra một hàm thực thi trên ngữ cảnh của
this
, thường là thứ bạn cần, và nó rất súc tích.Khi nào thì không? Khi bạn có một hàm tương đối rắc rối, bạn cần phải chuyển lô-gíc của hàm đó sang biểu thức hàm hữu danh.
8.2 Nếu như phần thân hàm chỉ gồm một câu lệnh trả về một biểu thức mà không có hiệu ứng phụ, bỏ qua dấu ngoặc nhọn và sử dụng trả về ngầm định. Nếu không, giữ nguyên dấu ngoặc và sử dụng lệnh
return
. eslint:arrow-parens
,arrow-body-style
Tại sao? Cú pháp tiện lợi. Nó dễ đọc khi nhiều hàm nối chuỗi nhau.
8.3 Trong trường hợp biểu thức nằm trên nhiều dòng, nhóm nó trong ngoặc để dễ đọc hơn.
Tại sao? Nó cho thấy một cách rõ ràng điểm bắt đầu và kết thúc hàm.
8.4 Nếu hàm của bạn nhận một đối số và không sử dụng ngoặc nhọn, loại bỏ dấu ngoặc tròn. Nếu không, luôn luôn thêm ngoặc tròn trước và sau các đối số cho rõ ràng và nhất quán. Ghi chú: việc luôn sử dụng dấu ngoặc tròn được chấp nhận, khi đó, sử dụng tùy chọn “always” cho eslint. eslint:
arrow-parens
Tại sao? Nhìn bớt rối mắt.
8.5 Tránh gây dễ nhầm lẫn giữa cú pháp hàm mũi tên (
=>
) với các toán tử so sánh (<=
,>=
). eslint:no-confusing-arrow
8.6 Cách đặt vị trí của phần thân hàm mũi tên với trả về ngầm định. eslint:
implicit-arrow-linebreak
Các Lớp và các Hàm tạo
9.1 Luôn sử dụng
class
. Tránh việc can thiệp trực tiếp vàoprototype
.Tại sao? Cú pháp
class
súc tích, dễ hiểu và dễ hình dung.9.2 Sử dụng
extends
cho thừa kế.Tại sao? Nó là cách sẵn có để thừa kế nguyên mẫu mà không làm ảnh hưởng đến
instanceof
.9.3 Các phương thức, mỗi khi có thể, hãy trả về
this
để tiện cho việc nối chuỗi phương thức.9.4 Có thể viết phương thức
toString()
tùy ý, chỉ cần đảm bản nó hoạt động hoàn hảo và không gây ra các hiệu ứng phụ.9.5 Các lớp có một hàm tạo mặc định nếu không được chỉ định. Một hàm tạo rỗng, hoặc chỉ trỏ đến lớp cha, là không cần thiết. eslint:
no-useless-constructor
9.6 Tránh trùng lặp các thành viên của một lớp. eslint:
no-dupe-class-members
Tại sao? Với các khai báo thành viên bị lặp, khai báo cuối được tự động ưu tiên - việc có sự trùng lặp gần như chắc chắn là một lỗi.
Các Mô-đun
10.1 Luôn sử dụng mô-đun (
import
/export
) thay vì một hệ thống mô-đun phi chuẩn. Bạn luôn có thể dịch mã sang hệ thống mô-đun mà bạn thích.Tại sao? Mô-đun là tương lai, hãy cùng sử dụng tương lai ngay lúc này.
10.2 Không sử dụng ký tự đại diện để nhập.
Tại sao? Điều này đảm bảo bạn chỉ xuất mặc định một giá trị.
10.3 Và không xuất trực tiếp từ một lệnh nhập.
Tại sao? Mặc dù cấu trúc một dòng là súc tích, việc nhập một cách rõ ràng và xuất một cách rõ ràng làm cho mọi thứ nhất quán.
10.4 Chỉ nhập từ một đường dẫn ở chung một chỗ. eslint:
no-duplicate-imports
Tại sao? Có nhiều dòng nhập từ cùng một đường dẫn khiến mã nguồn trở nên khó bảo trì hơn.
10.5 Không xuất các ràng buộc có thể bị biến đổi. eslint:
import/no-mutable-exports
Tại sao? Sự biến đổi, nói chung, nên được tránh, nhưng đặc biệt là đối với trường hợp xuất các giá trị có thể bị biến đổi. Trong khi kỹ thuật này có thể là cần thiết trong một số trường hợp đặc biệt, nhìn chung, chỉ nên xuất các giá trị là hằng.
10.6 Trong các mô-đun chỉ có một địa chỉ xuất, ưu tiên xuất mặc định thay vì xuất hữu danh. eslint:
import/prefer-default-export
Tại sao? Nhằm khuyến khích các tệp chỉ xuất một giá trị, giúp mã nguồn dễ đọc và dễ bảo trì.
10.7 Đặt tất cả các lệnh
import
trên cùng. eslint:import/first
Tại sao? Vì các lệnh
import
được kéo lên, việc đặt tất cả chúng ở trên cùng nhằm ngăn chặn các hành vi không đáng có.10.8 Các lệnh nhập nhiều dòng nên được căn đầu dòng giống như các mảng hay đối tượng nguyên văn nhiều dòng.
Tại sao? Các đấu ngoặc nhọn đều có cùng các quy tắc căn đầu dòng như tất cả mọi khối ngoặc nhọn trong bản định hướng này, cùng với như dấu phẩy ở cuối.
10.9 Không cho phép cú pháp bộ tải Webpack trong các lệnh nhập mô-đun. eslint:
import/no-webpack-loader-syntax
Tại sao? Vì sử dụng cú pháp Webpack trong các lệnh nhập gom mã thành một bộ tổng hợp mô-đun. Ưu tiên sử dụng cú pháp bộ tải trong
webpack.config.js
.
Các Đối tượng duyệt và các Hàm sinh trị
11.1 Không sử dụng các đối tượng duyệt. Ưu tiên sử dụng các hàm bậc cao hơn của JavaScript thay vì các vòng lặp như
for-in
hayfor-of
. eslint:no-iterator
no-restricted-syntax
Tại sao? Điều này đảm bảo việc thực hiện quy tắc bất biến. Làm việc với các hàm thuần mà trả về các giá trị sẽ dễ tưởng tượng hơn so với các hiệu ứng phụ.
Sử dụng
map()
/every()
/filter()
/find()
/findIndex()
/reduce()
/some()
/ ... để duyệt qua một mảng, vàObject.keys()
/Object.values()
/Object.entries()
để tạo một mảng để bạn có thể duyệt qua một đối tượng.11.2 Không sử dụng các hàm sinh trị
function*
vào thời điểm này.Tại sao? Nó không thể được dịch mã sang ES5 một cách hoàn hảo.
11.3 Nếu bạn bắt buộc phải dùng các hàm sinh trị, hoặc bạn bỏ qua khuyến nghị của chúng tôi, hãy đảm bảo rằng bạn sử dụng dấu cách giữa các bộ phận hàm một cách hợp lý. eslint:
generator-star-spacing
Tại sao?
function
và*
là tạo thành một từ khóa riêng -*
không phải là từ khóa điều chỉnh chofunction
,function*
là một cấu tạo riêng biệt, khác vớifunction
.