javascript
1.0.0
一种最合理的 JavaScript 方法
注意：本指南假设您使用 Babel，并要求您使用 babel-preset-airbnb 或同等产品。它还假设您正在应用程序中安装 shims/polyfills，使用 airbnb-browser-shims 或类似工具。
本指南也有其他语言版本。查看翻译
其他风格指南
1.1基元：当您访问基元类型时，您直接处理它的值。
stringnumberbooleannullundefinedsymbolbigint const foo = 1 ;
let bar = foo ;
bar = 9 ;
console . log ( foo , bar ) ; // => 1, 91.2复杂：当您访问复杂类型时，您将处理对其值的引用。
objectarrayfunction const foo = [ 1 , 2 ] ;
const bar = foo ;
bar [ 0 ] = 9 ;
console . log ( foo [ 0 ] , bar [ 0 ] ) ; // => 9, 9⬆ 回到顶部
2.1 对所有引用使用const ；避免使用var 。 eslint： prefer-const ， no-const-assign
为什么？这确保您无法重新分配引用，这可能会导致错误和难以理解的代码。
// bad
var a = 1 ;
var b = 2 ;
// good
const a = 1 ;
const b = 2 ; 2.2 如果必须重新分配引用，请使用let而不是var 。 eslint: no-var
为什么？
let是块作用域的，而不是像var一样是函数作用域的。
// bad
var count = 1 ;
if ( true ) {
count += 1 ;
}
// good, use the let.
let count = 1 ;
if ( true ) {
count += 1 ;
} 2.3 请注意， let和const都是块作用域，而var是函数作用域。
// const and let only exist in the blocks they are defined in.
{
let a = 1 ;
const b = 1 ;
var c = 1 ;
}
console . log ( a ) ; // ReferenceError
console . log ( b ) ; // ReferenceError
console . log ( c ) ; // Prints 1在上面的代码中，您可以看到引用a和b会产生 ReferenceError，而c包含数字。这是因为a和b是块作用域，而c是包含函数的作用域。
⬆ 回到顶部
3.1 使用文字语法创建对象。 eslint： no-new-object
// bad
const item = new Object ( ) ;
// good
const item = { } ;3.2 创建具有动态属性名称的对象时，使用计算属性名称。
为什么？它们允许您在一处定义对象的所有属性。
function getKey ( k ) {
return `a key named ${ k } ` ;
}
// bad
const obj = {
id : 5 ,
name : 'San Francisco' ,
} ;
obj [ getKey ( 'enabled' ) ] = true ;
// good
const obj = {
id : 5 ,
name : 'San Francisco' ,
[ getKey ( 'enabled' ) ] : true ,
} ; 3.3 使用对象方法简写。 eslint： object-shorthand
// bad
const atom = {
value : 1 ,
addValue : function ( value ) {
return atom . value + value ;
} ,
} ;
// good
const atom = {
value : 1 ,
addValue ( value ) {
return atom . value + value ;
} ,
} ; 3.4 使用属性值简写。 eslint： object-shorthand
为什么？它更短且具有描述性。
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
lukeSkywalker : lukeSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
} ;3.5 在对象声明的开头对速记属性进行分组。
为什么？使用简写更容易辨别哪些属性。
const anakinSkywalker = 'Anakin Skywalker' ;
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
episodeOne : 1 ,
twoJediWalkIntoACantina : 2 ,
lukeSkywalker ,
episodeThree : 3 ,
mayTheFourth : 4 ,
anakinSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
anakinSkywalker ,
episodeOne : 1 ,
twoJediWalkIntoACantina : 2 ,
episodeThree : 3 ,
mayTheFourth : 4 ,
} ; 3.6 仅引用无效标识符的属性。 eslint： quote-props
为什么？一般来说，我们主观上认为它更容易阅读。它改进了语法高亮，并且也更容易被许多 JS 引擎优化。
// bad
const bad = {
'foo' : 3 ,
'bar' : 4 ,
'data-blah' : 5 ,
} ;
// good
const good = {
foo : 3 ,
bar : 4 ,
'data-blah' : 5 ,
} ; 3.7 不要直接调用Object.prototype方法，例如hasOwnProperty 、 propertyIsEnumerable和isPrototypeOf 。 eslint： no-prototype-builtins
为什么？这些方法可能会受到相关对象的属性的影响 - 考虑
{ hasOwnProperty: false }- 或者，该对象可能是空对象 (Object.create(null))。在支持 ES2022 或使用诸如 https://npmjs.com/object.hasown 之类的 polyfill 的现代浏览器中，Object.hasOwn也可以用作Object.prototype.hasOwnProperty.call的替代品。
// bad
console . log ( object . hasOwnProperty ( key ) ) ;
// good
console . log ( Object . prototype . hasOwnProperty . call ( object , key ) ) ;
// better
const has = Object . prototype . hasOwnProperty ; // cache the lookup once, in module scope.
console . log ( has . call ( object , key ) ) ;
// best
console . log ( Object . hasOwn ( object , key ) ) ; // only supported in browsers that support ES2022
/* or */
import has from 'has' ; // https://www.npmjs.com/package/has
console . log ( has ( object , key ) ) ;
/* or */
console . log ( Object . hasOwn ( object , key ) ) ; // https://www.npmjs.com/package/object.hasown 3.8 对于浅复制对象，更喜欢使用对象扩展语法而不是Object.assign 。使用对象剩余参数语法来获取省略某些属性的新对象。 eslint： prefer-object-spread
// very bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( original , { c : 3 } ) ; // this mutates `original` ಠ_ಠ
delete copy . a ; // so does this
// bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( { } , original , { c : 3 } ) ; // copy => { a: 1, b: 2, c: 3 }
// good
const original = { a : 1 , b : 2 } ;
const copy = { ... original , c : 3 } ; // copy => { a: 1, b: 2, c: 3 }
const { a , ... noA } = copy ; // noA => { b: 2, c: 3 }⬆ 回到顶部
4.1 使用文字语法创建数组。 eslint： no-array-constructor
// bad
const items = new Array ( ) ;
// good
const items = [ ] ;4.2 使用Array#push而不是直接赋值来将项目添加到数组中。
const someStack = [ ] ;
// bad
someStack [ someStack . length ] = 'abracadabra' ;
// good
someStack . push ( 'abracadabra' ) ; 4.3 使用数组扩展...复制数组。
// bad
const len = items . length ;
const itemsCopy = [ ] ;
let i ;
for ( i = 0 ; i < len ; i += 1 ) {
itemsCopy [ i ] = items [ i ] ;
}
// good
const itemsCopy = [ ... items ] ; 4.4 要将可迭代对象转换为数组，请使用 spread ...而不是Array.from
const foo = document . querySelectorAll ( '.foo' ) ;
// good
const nodes = Array . from ( foo ) ;
// best
const nodes = [ ... foo ] ; 4.5 使用Array.from将类似数组的对象转换为数组。
const arrLike = { 0 : 'foo' , 1 : 'bar' , 2 : 'baz' , length : 3 } ;
// bad
const arr = Array . prototype . slice . call ( arrLike ) ;
// good
const arr = Array . from ( arrLike ) ; 4.6 使用Array.from而不是 spread ...来映射可迭代对象，因为它可以避免创建中间数组。
// bad
const baz = [ ... foo ] . map ( bar ) ;
// good
const baz = Array . from ( foo , bar ) ; 4.7 在数组方法回调中使用 return 语句。如果函数体由返回一个没有副作用的表达式的单个语句组成，则可以省略 return，如下 8.2 所示。 eslint： array-callback-return
// good
[ 1 , 2 , 3 ] . map ( ( x ) => {
const y = x + 1 ;
return x * y ;
} ) ;
// good
[ 1 , 2 , 3 ] . map ( ( x ) => x + 1 ) ;
// bad - no returned value means `acc` becomes undefined after the first iteration
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
} ) ;
// good
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
return flatten ;
} ) ;
// bad
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
} else {
return false ;
}
} ) ;
// good
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
}
return false ;
} ) ;4.8 如果数组有多行，则在左数组括号之后和右数组括号之前使用换行符
// bad
const arr = [
[ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ,
] ;
const objectInArray = [ {
id : 1 ,
} , {
id : 2 ,
} ] ;
const numberInArray = [
1 , 2 ,
] ;
// good
const arr = [ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] ;
const objectInArray = [
{
id : 1 ,
} ,
{
id : 2 ,
} ,
] ;
const numberInArray = [
1 ,
2 ,
] ;⬆ 回到顶部
5.1 访问和使用对象的多个属性时使用对象解构。 eslint： prefer-destructuring
为什么？解构使您无需为这些属性创建临时引用，也无需重复访问该对象。重复对象访问会产生更多重复代码，需要更多阅读，并产生更多出错机会。解构对象还提供了块中使用的对象结构的单一定义，而不需要读取整个块来确定使用的内容。
// bad
function getFullName ( user ) {
const firstName = user . firstName ;
const lastName = user . lastName ;
return ` ${ firstName } ${ lastName } ` ;
}
// good
function getFullName ( user ) {
const { firstName , lastName } = user ;
return ` ${ firstName } ${ lastName } ` ;
}
// best
function getFullName ( { firstName , lastName } ) {
return ` ${ firstName } ${ lastName } ` ;
} 5.2 使用数组解构。 eslint： prefer-destructuring
const arr = [ 1 , 2 , 3 , 4 ] ;
// bad
const first = arr [ 0 ] ;
const second = arr [ 1 ] ;
// good
const [ first , second ] = arr ;5.3 对多个返回值使用对象解构，而不是数组解构。
为什么？您可以随着时间的推移添加新属性或更改事物的顺序，而不会破坏调用站点。
// bad
function processInput ( input ) {
// then a miracle occurs
return [ left , right , top , bottom ] ;
}
// the caller needs to think about the order of return data
const [ left , __ , top ] = processInput ( input ) ;
// good
function processInput ( input ) {
// then a miracle occurs
return { left , right , top , bottom } ;
}
// the caller selects only the data they need
const { left , top } = processInput ( input ) ;⬆ 回到顶部
6.1 对字符串使用单引号'' 。 eslint： quotes
// bad
const name = "Capt. Janeway" ;
// bad - template literals should contain interpolation or newlines
const name = `Capt. Janeway` ;
// good
const name = 'Capt. Janeway' ;6.2 导致行超过 100 个字符的字符串不应使用字符串连接跨多行写入。
为什么？损坏的字符串使用起来很痛苦，并且使代码的可搜索性降低。
// bad
const errorMessage = 'This is a super long error that was thrown because
of Batman. When you stop to think about how Batman had anything to do
with this, you would get nowhere
fast.' ;
// bad
const errorMessage = 'This is a super long error that was thrown because ' +
'of Batman. When you stop to think about how Batman had anything to do ' +
'with this, you would get nowhere fast.' ;
// good
const errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.' ; 6.3 当以编程方式构建字符串时，使用模板字符串而不是串联。 eslint： prefer-template template-curly-spacing
为什么？模板字符串为您提供可读、简洁的语法，并具有适当的换行符和字符串插值功能。
// bad
function sayHi ( name ) {
return 'How are you, ' + name + '?' ;
}
// bad
function sayHi ( name ) {
return [ 'How are you, ' , name , '?' ] . join ( ) ;
}
// bad
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}
// good
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}eval() ；它打开了太多的漏洞。 eslint： no-eval 6.5 不要对字符串中不必要的字符进行转义。 eslint： no-useless-escape
为什么？反斜杠
