其實我們在工作中都經(jīng)常遇到這個問題,甚至在 issues 中有同學(xué)反饋,他經(jīng)常要寫 50 個以上參數(shù)的格式化參數(shù),在 Go 這維護起來比較痛苦。
大家好,我是煎魚。
在日常開發(fā) Go 工程中,我們經(jīng)常會用 fmt.Printf? 或 fmt.Sprintf 去寫類似的拼裝字符串的業(yè)務(wù)。
如下代碼:
fmt.Printf("Hello Gopher %s, you are %d years old and you're favorite food is %s", name, age, favoriteFood)
這業(yè)務(wù)迭代迭代著,日積月累的,有一部分常變的拼裝邏輯會來越長。小小的電腦顯示屏已經(jīng)不足以讓代碼在一行內(nèi)顯示了。
有許多特性會把字符串轉(zhuǎn)為變量,但后面那串又臭又長的變量依然無法簡單甩掉,因此有大部分同學(xué)會選擇把代碼格式化了。
如下代碼:
s := "Hello Gopher %s, you are %d years old and you're favorite food is %s"
fmt.Printf(
s,
name,
age,
favoriteFood,
)
你可能以為這是個例?實際并不,很多人都遇到了。
簡單字符串插值
這在 Go issues 中社區(qū)討論了三四年了,@Ian Lance Taylor 發(fā)起了新提案《proposal: spec: add simple string interpolation similar to Swift[1]》。希望能夠得到更多的討論,增加新特性解決這個問題。
這個新特性,類似于 Swift 中的字符串插值的簡單版本。我們直接看例子:
fmt.Println("\(person.Name()) is \(person.Age()) years old")
fmt.Println("The time is \(time.Now().Round(0))")
對應(yīng)的輸出結(jié)果:
Ken Thompson is 79 years old
The time is 2023-01-04 16:22:01.204034106 -0800 PST
提案計劃新增的 “字符串插值”,規(guī)范如下:
- 新轉(zhuǎn)義語法:\(xxxx),開頭是 \(,結(jié)尾是 ),成對出現(xiàn)。
- 在格式上,一個有效的 \(,后面必須有一個表達式和一個尾部的 ),這樣才能生效。
上面的例子中,以下幾個都是字符串插值:
\(person.Name())
\(person.Age())
\(time.Now().Round(0))
會有同學(xué)疑惑像 person 看起來就是結(jié)構(gòu)體的是怎么取值的?
Go 有一個神奇的約定方法,像結(jié)構(gòu)體這類類型,如果有 String() string 方法,將會調(diào)用該方法以獲取字符串值。
如果沒有 String 方法,需要是字符串、整數(shù)、浮點數(shù)、復(fù)數(shù)、常量或布爾值等類型,可以取值后格式化。否則將會報錯。
其他語言例子
Swift
let multiplier = 3
let message = "\(multiplier) times 2.5 is \(Double(multiplier) * 2.5)"
// message is "3 times 2.5 is 7.5"
Kotlin
var age = 21
println("My Age Is: $age")
C#
string name = "Mark";
var date = DateTime.Now;
Console.WriteLine($"Hello, {name}! Today is {date.DayOfWeek}, it's {date:HH:mm} now.");
Rust
let person = get_person();
println!("Hello, {person}!"); // captures the local `person`
println!("Hello, {}!", get_person()); // implicit position
println!("Hello, {0}!", get_person()); // explicit index
println!("Hello, {person}!", person = get_person()); // named
let (width, precision) = get_format();
for (name, score) in get_scores() {
println!("{name}: {score:width$.precision$}");
}
爭論矛盾點
當(dāng)前的主要爭論點之一,像是 fmt.Sprintf 等方法也可以完成字符串插值一模一樣的效果,為什么還要新增這個功能特性(或是語法糖)?
主流觀點是現(xiàn)有的格式化字符串的方法,在參數(shù)數(shù)量多了后,很容易出錯(例如:順序搞錯),也比較松散,一大坨代碼。
在新增字符串插值的特性/語法糖后,可以更好閱讀、更好修改,不需要過于依賴編寫變量的順序、更緊湊。
具體的例子如下,現(xiàn)有版本代碼:
errorf(pos, "arguments to copy %s and %s have different element types %s and %s", x, &y, dst.elem, src.elem)
應(yīng)用新特性后會變成:
error(pos, "arguments to copy \(x) and \(&y) have different element types \(dst.elem) and \(src.elem)")
總結(jié)
其實我們在工作中都經(jīng)常遇到這個問題,甚至在 issues 中有同學(xué)反饋,他經(jīng)常要寫 50 個以上參數(shù)的格式化參數(shù),在 Go 這維護起來比較痛苦。
如果你是長期維護某幾個項目的開發(fā)者,不斷持續(xù)新增、變更的現(xiàn)有格式化字符串的方法,和新增的字符串插值。
在接下來的幾年中,你會選擇哪一個?或是有沒有新的想法?