大家好,我是煎魚。
在日常開發 Go 工程中,我們經常會用 fmt.Printf
或 fmt.Sprintf
去寫類似的拼裝字串的業務。
如下程式碼:
fmt.Printf("Hello Gopher %s, you are %d years old and you're favorite food is %s", name, age, favoriteFood)
這業務迭代迭代著,日積月累的,有一部分常變的拼裝邏輯會來越長。小小的電腦螢幕已經不足以讓程式碼在一行內顯示了。
有許多特性會把字串轉為變數,但後面那串又臭又長的變數依然無法簡單甩掉,因此有大部分同學會選擇把程式碼格式化了。
如下程式碼:
s := "Hello Gopher %s, you are %d years old and you're favorite food is %s"
fmt.Printf(
s,
name,
age,
favoriteFood,
)
你可能以為這是個例?實際並不,很多人都遇到了。
簡單字串插值
這在 Go issues 中社群討論了三四年了,@Ian Lance Taylor 發起了新提案《proposal: spec: add simple string interpolation similar to Swift》。希望能夠得到更多的討論,增加新特性解決這個問題。
這個新特性,類似於 Swift 中的字串插值的簡單版本。我們直接看例子:
fmt.Println("\(person.Name()) is \(person.Age()) years old")
fmt.Println("The time is \(time.Now().Round(0))")
對應的輸出結果:
Ken Thompson is 79 years old
The time is 2023-01-04 16:22:01.204034106 -0800 PST
提案計劃新增的 “字串插值”,規範如下:
- 新轉義語法:
\(xxxx)
,開頭是\(
,結尾是)
,成對出現。 - 在格式上,一個有效的
\(
,後面必須有一個表示式和一個尾部的)
,這樣才能生效。
上面的例子中,以下幾個都是字串插值:
\(person.Name())
\(person.Age())
\(time.Now().Round(0))
會有同學疑惑像 person
看起來就是結構體的是怎麼取值的?
Go 有一個神奇的約定方法,像結構體這型別別,如果有 String() string
方法,將會呼叫該方法以獲取字串值。
如果沒有 String 方法,需要是字串、整數、浮點數、複數、常量或布林值等型別,可以取值後格式化。否則將會報錯。
其他語言例子
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$}");
}
爭論矛盾點
當前的主要爭論點之一,像是 fmt.Sprintf
等方法也可以完成字串插值一模一樣的效果,為什麼還要新增這個功能特性(或是語法糖)?
主流觀點是現有的格式化字串的方法,在引數數量多了後,很容易出錯(例如:順序搞錯),也比較鬆散,一大坨程式碼。
在新增字串插值的特性/語法糖後,可以更好閱讀、更好修改,不需要過於依賴編寫變數的順序、更緊湊。
具體的例子如下,現有版本程式碼:
errorf(pos, "arguments to copy %s and %s have different element types %s and %s", x, &y, dst.elem, src.elem)
應用新特性後會變成:
error(pos, "arguments to copy \(x) and \(&y) have different element types \(dst.elem) and \(src.elem)")
總結
其實我們在工作中都經常遇到這個問題,甚至在 issues 中有同學反饋,他經常要寫 50 個以上引數的格式化引數,在 Go 這維護起來比較痛苦。
如果你是長期維護某幾個專案的開發者,不斷持續新增、變更的現有格式化字串的方法,和新增的字串插值。
在接下來的幾年中,你會選擇哪一個?或是有沒有新的想法?
文章持續更新,可以微信搜【腦子進煎魚了】閱讀,本文 GitHub github.com/eddycjy/blog 已收錄,學習 Go 語言可以看 Go 學習地圖和路線,歡迎 Star 催更。