字符串的擴展 · web-knowledge

1. ### ` includes(), startsWith(), endsWith()` 傳統上，JavaScript 只有indexOf方法，可以用來確定一個字符串是否包含在另一個字符串中。ES6 又提供了三種新方法。 `includes()`：返回布爾值，表示是否找到了參數字符串。 `startsWith()`：返回布爾值，表示參數字符串是否在原字符串的頭部。 `endsWith()`：返回布爾值，表示參數字符串是否在原字符串的尾部。 ~~~ let s = 'Hello world!'; s.startsWith('Hello') // true s.endsWith('!') // true s.includes('o') // true ~~~ 這三個方法都支持第二個參數，表示開始搜索的位置。 ~~~ let s = 'Hello world!'; s.startsWith('world', 6) // true s.endsWith('Hello', 5) // true s.includes('Hello', 6) // false ~~~ 上面代碼表示，使用第二個參數n時，endsWith的行為與其他兩個方法有所不同。它針對前n個字符，而其他兩個方法針對從第n個位置直到字符串結束。 ### 2. `repeat()` repeat方法返回一個新字符串，表示將原字符串重復n次。 ~~~ 'x'.repeat(3) // "xxx" 'hello'.repeat(2) // "hellohello" 'na'.repeat(0) // "" ~~~ 參數如果是小數，會被取整。 `'na'.repeat(2.9) // "nana"` 如果repeat的參數是負數或者Infinity，會報錯。 ~~~ 'na'.repeat(Infinity) // RangeError 'na'.repeat(-1) // RangeError ~~~ 但是，如果參數是 0 到-1 之間的小數，則等同于 0，這是因為會先進行取整運算。0 到-1 之間的小數，取整以后等于-0，repeat視同為 0。 `'na'.repeat(-0.9) // ""` 參數NaN等同于 0。 `'na'.repeat(NaN) // ""` 如果repeat的參數是字符串，則會先轉換成數字。 ~~~ 'na'.repeat('na') // "" 'na'.repeat('3') // "nanana" ~~~ ### 3. `padStart()，padEnd()` ES2017 引入了字符串補全長度的功能。如果某個字符串不夠指定長度，會在頭部或尾部補全。padStart()用于頭部補全，padEnd()用于尾部補全。 ~~~ 'x'.padStart(5, 'ab') // 'ababx' 'x'.padStart(4, 'ab') // 'abax' 'x'.padEnd(5, 'ab') // 'xabab' 'x'.padEnd(4, 'ab') // 'xaba' ~~~ 上面代碼中，padStart和padEnd一共接受兩個參數，第一個參數用來指定字符串的最小長度，第二個參數是用來補全的字符串。如果原字符串的長度，等于或大于指定的最小長度，則返回原字符串。 ~~~ 'xxx'.padStart(2, 'ab') // 'xxx' 'xxx'.padEnd(2, 'ab') // 'xxx' ~~~ 如果用來補全的字符串與原字符串，兩者的長度之和超過了指定的最小長度，則會截去超出位數的補全字符串。 ~~~ 'abc'.padStart(10, '0123456789') // '0123456abc' ~~~ 如果省略第二個參數，默認使用空格補全長度。 ~~~ 'x'.padStart(4) // ' x' 'x'.padEnd(4) // 'x ' ~~~ padStart的常見用途是為數值補全指定位數。下面代碼生成 10 位的數值字符串。 ~~~ '1'.padStart(10, '0') // "0000000001" '12'.padStart(10, '0') // "0000000012" '123456'.padStart(10, '0') // "0000123456" ~~~ 另一個用途是提示字符串格式。 ~~~ '12'.padStart(10, 'YYYY-MM-DD') // "YYYY-MM-12" '09-12'.padStart(10, 'YYYY-MM-DD') // "YYYY-09-12" ~~~ ### 4. `matchAll()` matchAll方法返回一個正則表達式在當前字符串的所有匹配，詳見《正則的擴展》的一章。 ### 5. 模板字符串傳統的 JavaScript 語言，輸出模板通常是這樣寫的（下面使用了 jQuery 的方法）。 ~~~ $('#result').append( 'There are <b>' + basket.count + '</b> ' + 'items in your basket, ' + '<em>' + basket.onSale + '</em> are on sale!' ); ~~~ 上面這種寫法相當繁瑣不方便，ES6 引入了模板字符串解決這個問題。 ~~~ $('#result').append(` There are <b>${basket.count}</b> items in your basket, <em>${basket.onSale}</em> are on sale! `); ~~~ 模板字符串（template string）是增強版的字符串，用反引號（`）標識。它可以當作普通字符串使用，也可以用來定義多行字符串，或者在字符串中嵌入變量。 ~~~ // 普通字符串 `In JavaScript '\n' is a line-feed.` // 多行字符串 `In JavaScript this is not legal.` console.log(`string text line 1 string text line 2`); ~~~ ~~~ // 字符串中嵌入變量 let name = "Bob", time = "today"; `Hello ${name}, how are you ${time}?` ~~~ 上面代碼中的模板字符串，都是用反引號表示。如果在模板字符串中需要使用反引號，則前面要用反斜杠轉義。 `let greeting = `\`Yo\` World!`;` 如果使用模板字符串表示多行字符串，所有的空格和縮進都會被保留在輸出之中。 ~~~ $('#list').html(` <ul> <li>first</li> <li>second</li> </ul> `); ~~~ 上面代碼中，所有模板字符串的空格和換行，都是被保留的，比如<ul>標簽前面會有一個換行。如果你不想要這個換行，可以使用trim方法消除它。 ~~~ $('#list').html(` <ul> <li>first</li> <li>second</li> </ul> `.trim()); ~~~ 模板字符串中嵌入變量，需要將變量名寫在${}之中。 ~~~ function authorize(user, action) { if (!user.hasPrivilege(action)) { throw new Error( // 傳統寫法為 // 'User ' // + user.name // + ' is not authorized to do ' // + action // + '.' `User ${user.name} is not authorized to do ${action}.`); } } ~~~ 大括號內部可以放入任意的 JavaScript 表達式，可以進行運算，以及引用對象屬性。 ~~~ let x = 1; let y = 2; `${x} + ${y} = ${x + y}` // "1 + 2 = 3" `${x} + ${y * 2} = ${x + y * 2}` // "1 + 4 = 5" let obj = {x: 1, y: 2}; `${obj.x + obj.y}` // "3" ~~~ 模板字符串之中還能調用函數。 ~~~ function fn() { return "Hello World"; } `foo ${fn()} bar` // foo Hello World bar ~~~ 如果大括號中的值不是字符串，將按照一般的規則轉為字符串。比如，大括號中是一個對象，將默認調用對象的toString方法。如果模板字符串中的變量沒有聲明，將報錯。 ~~~ // 變量place沒有聲明 let msg = `Hello, ${place}`; // 報錯 ~~~ 由于模板字符串的大括號內部，就是執行 JavaScript 代碼，因此如果大括號內部是一個字符串，將會原樣輸出。 ~~~ `Hello ${'World'}` // "Hello World" ~~~ 模板字符串甚至還能嵌套。 ~~~ const tmpl = addrs => ` <table> ${addrs.map(addr => ` <tr><td>${addr.first}</td></tr> <tr><td>${addr.last}</td></tr> `).join('')} </table> `; ~~~ 上面代碼中，模板字符串的變量之中，又嵌入了另一個模板字符串，使用方法如下。 ~~~ const data = [ { first: '<Jane>', last: 'Bond' }, { first: 'Lars', last: '<Croft>' }, ]; console.log(tmpl(data)); // <table> // // <tr><td><Jane></td></tr> // <tr><td>Bond</td></tr> // // <tr><td>Lars</td></tr> // <tr><td><Croft></td></tr> // // </table> ~~~ 如果需要引用模板字符串本身，在需要時執行，可以像下面這樣寫。 ~~~ // 寫法一 let str = 'return ' + '`Hello ${name}!`'; let func = new Function('name', str); func('Jack') // "Hello Jack!" // 寫法二 let str = '(name) => `Hello ${name}!`'; let func = eval.call(null, str); func('Jack') // "Hello Jack!" ~~~ 實例：模板編譯下面，我們來看一個通過模板字符串，生成正式模板的實例。 ~~~ let template = ` <ul> <% for(let i=0; i < data.supplies.length; i++) { %> <li><%= data.supplies[i] %></li> <% } %> </ul> `; ~~~ 上面代碼在模板字符串之中，放置了一個常規模板。該模板使用`<%...%>`放置 JavaScript 代碼，使用`<%= ... %>`輸出 JavaScript 表達式。怎么編譯這個模板字符串呢？一種思路是將其轉換為 JavaScript 表達式字符串。 ~~~ echo('<ul>'); for(let i=0; i < data.supplies.length; i++) { echo('<li>'); echo(data.supplies[i]); echo('</li>'); }; echo('</ul>'); ~~~ 這個轉換使用正則表達式就行了。 ~~~ let evalExpr = /<%=(.+?)%>/g; let expr = /<%([\s\S]+?)%>/g; template = template .replace(evalExpr, '`); \n echo( $1 ); \n echo(`') .replace(expr, '`); \n $1 \n echo(`'); template = 'echo(`' + template + '`);'; ~~~ 然后，將template封裝在一個函數里面返回，就可以了。 ~~~ let script = `(function parse(data){ let output = ""; function echo(html){ output += html; } ${ template } return output; })`; return script; ~~~ 將上面的內容拼裝成一個模板編譯函數compile。 ~~~ function compile(template){ const evalExpr = /<%=(.+?)%>/g; const expr = /<%([\s\S]+?)%>/g; template = template .replace(evalExpr, '`); \n echo( $1 ); \n echo(`') .replace(expr, '`); \n $1 \n echo(`'); template = 'echo(`' + template + '`);'; let script = `(function parse(data){ let output = ""; function echo(html){ output += html; } ${ template } return output; })`; return script; } ~~~ compile函數的用法如下。 ~~~ let parse = eval(compile(template)); div.innerHTML = parse({ supplies: [ "broom", "mop", "cleaner" ] }); // <ul> // <li>broom</li> // <li>mop</li> // <li>cleaner</li> // </ul> ~~~ ### 6. 標簽模板模板字符串的功能，不僅僅是上面這些。它可以緊跟在一個函數名后面，該函數將被調用來處理這個模板字符串。這被稱為“標簽模板”功能（tagged template）。 ~~~ alert`123` // 等同于 alert(123) ~~~ 標簽模板其實不是模板，而是函數調用的一種特殊形式。“標簽”指的就是函數，緊跟在后面的模板字符串就是它的參數。但是，如果模板字符里面有變量，就不是簡單的調用了，而是會將模板字符串先處理成多個參數，再調用函數。 ~~~ let a = 5; let b = 10; tag`Hello ${ a + b } world ${ a * b }`; // 等同于 tag(['Hello ', ' world ', ''], 15, 50); ~~~ 上面代碼中，模板字符串前面有一個標識名tag，它是一個函數。整個表達式的返回值，就是tag函數處理模板字符串后的返回值。函數tag依次會接收到多個參數。 ~~~ function tag(stringArr, value1, value2){ // ... } // 等同于 function tag(stringArr, ...values){ // ... } ~~~ tag函數的第一個參數是一個數組，該數組的成員是模板字符串中那些沒有變量替換的部分，也就是說，變量替換只發生在數組的第一個成員與第二個成員之間、第二個成員與第三個成員之間，以此類推。 tag函數的其他參數，都是模板字符串各個變量被替換后的值。由于本例中，模板字符串含有兩個變量，因此tag會接受到value1和value2兩個參數。 tag函數所有參數的實際值如下。 ~~~ 第一個參數：['Hello ', ' world ', ''] 第二個參數: 15 第三個參數：50 ~~~ 也就是說，tag函數實際上以下面的形式調用。 `tag(['Hello ', ' world ', ''], 15, 50)` 我們可以按照需要編寫tag函數的代碼。下面是tag函數的一種寫法，以及運行結果。 ~~~ let a = 5; let b = 10; function tag(s, v1, v2) { console.log(s[0]); console.log(s[1]); console.log(s[2]); console.log(v1); console.log(v2); return "OK"; } tag`Hello ${ a + b } world ${ a * b}`; // "Hello " // " world " // "" // 15 // 50 // "OK" ~~~ 下面是一個更復雜的例子。 ~~~ let total = 30; let msg = passthru`The total is ${total} (${total*1.05} with tax)`; function passthru(literals) { let result = ''; let i = 0; while (i < literals.length) { result += literals[i++]; if (i < arguments.length) { result += arguments[i]; } } return result; } msg // "The total is 30 (31.5 with tax)" ~~~ 上面這個例子展示了，如何將各個參數按照原來的位置拼合回去。 passthru函數采用 rest 參數的寫法如下。 ~~~ function passthru(literals, ...values) { let output = ""; let index; for (index = 0; index < values.length; index++) { output += literals[index] + values[index]; } output += literals[index] return output; } ~~~ “標簽模板”的一個重要應用，就是過濾 HTML 字符串，防止用戶輸入惡意內容。 ~~~ let message = SaferHTML`<p>${sender} has sent you a message.</p>`; function SaferHTML(templateData) { let s = templateData[0]; for (let i = 1; i < arguments.length; i++) { let arg = String(arguments[i]); // Escape special characters in the substitution. s += arg.replace(/&/g, "&") .replace(/</g, "<") .replace(/>/g, ">"); // Don't escape special characters in the template. s += templateData[i]; } return s; } ~~~ 上面代碼中，sender變量往往是用戶提供的，經過SaferHTML函數處理，里面的特殊字符都會被轉義。 ~~~ let sender = '<script>alert("abc")</script>'; // 惡意代碼 let message = SaferHTML`<p>${sender} has sent you a message.</p>`; message // <p><script>alert("abc")</script> has sent you a message.</p> 標簽模板的另一個應用，就是多語言轉換（國際化處理）。 ~~~ ### 7. i18n `Welcome to ${siteName}, you are visitor number ${visitorNumber}!` `// "歡迎訪問xxx，您是第xxxx位訪問者！"` 模板字符串本身并不能取代 Mustache 之類的模板庫，因為沒有條件判斷和循環處理功能，但是通過標簽函數，你可以自己添加這些功能。 // 下面的hashTemplate函數 // 是一個自定義的模板處理函數 ~~~ let libraryHtml = hashTemplate` <ul> #for book in ${myBooks} <li><i>#{book.title}</i> by #{book.author}</li> #end </ul> `; 除此之外，你甚至可以使用標簽模板，在 JavaScript 語言之中嵌入其他語言。 jsx` <div> <input ref='input' onChange='${this.handleChange}' defaultValue='${this.state.value}' /> ${this.state.value} </div> ` ~~~ 上面的代碼通過jsx函數，將一個 DOM 字符串轉為 React 對象。你可以在 Github 找到jsx函數的具體實現。下面則是一個假想的例子，通過java函數，在 JavaScript 代碼之中運行 Java 代碼。 ~~~ java` class HelloWorldApp { public static void main(String[] args) { System.out.println(“Hello World!”); // Display the string. } } ` HelloWorldApp.main(); ~~~ 模板處理函數的第一個參數（模板字符串數組），還有一個raw屬性。 ~~~ console.log`123` // ["123", raw: Array[1]] ~~~ 上面代碼中，console.log接受的參數，實際上是一個數組。該數組有一個raw屬性，保存的是轉義后的原字符串。請看下面的例子。 ~~~ tag`First line\nSecond line` function tag(strings) { console.log(strings.raw[0]); // strings.raw[0] 為 "First line\\nSecond line" // 打印輸出 "First line\nSecond line" } ~~~ 上面代碼中，tag函數的第一個參數strings，有一個raw屬性，也指向一個數組。該數組的成員與strings數組完全一致。比如，strings數組是["First line\nSecond line"]，那么strings.raw數組就是["First line\\nSecond line"]。兩者唯一的區別，就是字符串里面的斜杠都被轉義了。比如，strings.raw 數組會將\n視為\\和n兩個字符，而不是換行符。這是為了方便取得轉義之前的原始模板而設計的。 String.raw() ES6 還為原生的 String 對象，提供了一個raw方法。 String.raw方法，往往用來充當模板字符串的處理函數，返回一個斜杠都被轉義（即斜杠前面再加一個斜杠）的字符串，對應于替換變量后的模板字符串。 ~~~ String.raw`Hi\n${2+3}!`; // 返回 "Hi\\n5!" String.raw`Hi\u000A!`; // 返回 "Hi\\u000A!" 如果原字符串的斜杠已經轉義，那么String.raw會進行再次轉義。 String.raw`Hi\\n` // 返回 "Hi\\\\n" ~~~ String.raw方法可以作為處理模板字符串的基本方法，它會將所有變量替換，而且對斜杠進行轉義，方便下一步作為字符串來使用。 String.raw方法也可以作為正常的函數使用。這時，它的第一個參數，應該是一個具有raw屬性的對象，且raw屬性的值應該是一個數組。 ~~~ String.raw({ raw: 'test' }, 0, 1, 2); // 't0e1s2t' // 等同于 String.raw({ raw: ['t','e','s','t'] }, 0, 1, 2); 作為函數，String.raw的代碼實現基本如下。 String.raw = function (strings, ...values) { let output = ''; let index; for (index = 0; index < values.length; index++) { output += strings.raw[index] + values[index]; } output += strings.raw[index] return output; } ~~~ 模板字符串的限制前面提到標簽模板里面，可以內嵌其他語言。但是，模板字符串默認會將字符串轉義，導致無法嵌入其他語言。舉例來說，標簽模板里面可以嵌入 LaTEX 語言。 ~~~ function latex(strings) { // ... } let document = latex` \newcommand{\fun}{\textbf{Fun!}} // 正常工作 \newcommand{\unicode}{\textbf{Unicode!}} // 報錯 \newcommand{\xerxes}{\textbf{King!}} // 報錯 Breve over the h goes \u{h}ere // 報錯 ` ~~~ 上面代碼中，變量document內嵌的模板字符串，對于 LaTEX 語言來說完全是合法的，但是 JavaScript 引擎會報錯。原因就在于字符串的轉義。模板字符串會將\u00FF和\u{42}當作 Unicode 字符進行轉義，所以\unicode解析時報錯；而\x56會被當作十六進制字符串轉義，所以\xerxes會報錯。也就是說，\u和\x在 LaTEX 里面有特殊含義，但是 JavaScript 將它們轉義了。為了解決這個問題，ES2018 放松了對標簽模板里面的字符串轉義的限制。如果遇到不合法的字符串轉義，就返回undefined，而不是報錯，并且從raw屬性上面可以得到原始字符串。 ~~~ function tag(strs) { strs[0] === undefined strs.raw[0] === "\\unicode and \\u{55}"; } tag`\unicode and \u{55}` ~~~ 上面代碼中，模板字符串原本是應該報錯的，但是由于放松了對字符串轉義的限制，所以不報錯了，JavaScript 引擎將第一個字符設置為undefined，但是raw屬性依然可以得到原始字符串，因此tag函數還是可以對原字符串進行處理。注意，這種對字符串轉義的放松，只在標簽模板解析字符串時生效，不是標簽模板的場合，依然會報錯。 `let bad = `bad escape sequence: \unicode`; // 報錯`