專案裡本來只是想擷取一段字串,順手用了 IDE 自動提示的 substr,以為它跟 substring 沒什麼差別。結果並非如此,以下逐一說明。
從起始索引位置開始,取出「指定數目」的字元。兩個參數分別是起始位 index 與擷取長度 length,這點是它與 substring 最關鍵的差異。
當 index 為非負整數:
a. 不傳任何參數時,回傳整個字串本身。
"abcdefg".substr() // -> "abcdefg"
b. 只傳 index 時,預設擷取到字串最後一位。
"abcdefg".substr(2) // -> "defg"
當 index 為負整數:
c. 負數起點會從字串尾端往前數,最後仍從前往後擷取。也就是說 substr(-2) 等同於 substr(長度 - 2)。
"abcdefg".substr(-2) // -> "fg",等同 "abcdefg".substr("abcdefg".length - 2)
擷取「兩個指定索引之間」的字元。兩個參數都是索引,索引從 0 起算,實際擷取長度是兩者之差,可以記成「含頭不含尾」。
"abcdefg".substring(2, 4) // -> "cd"
第一,第二個參數的含義完全不同:substr 是長度,substring 是結束位置。這是最容易出錯的地方,例如想得到 "cde" 三個字,substr(2, 3) 才對,寫成 substring(2, 3) 只會得到 "d"。
第二,substring 遇到負數或 NaN 會一律當成 0 處理,而 substr 則把負數視為從尾端起算,行為完全不同。
第三,substring 若傳入的 start 大於 end,會自動交換兩個參數再擷取;substr 沒有這個特性,起始點大於或等於長度時直接回傳空字串。
最後補充一點:substr 在 ECMAScript 中屬於附錄定義的 legacy 特性,雖然主流瀏覽器都支援,但新專案建議統一使用 substring,或語意更清楚的 slice——slice 的第二個參數是結束位置,且支援負索引從尾端計算,等於兼具兩者的優點又不會混淆。
"abcdefg".slice(2, 5) // -> "cde" "abcdefg".slice(-3) // -> "efg"