有没有一种简单的方法可以在不打印字符串的情况下在 Go 中格式化字符串?
我可以:
bar := "bar"
fmt.Printf("foo: %s", bar)
但我希望返回格式化的字符串而不是打印出来,这样我就可以进一步操作它。
我也可以做类似的事情:
s := "foo: " + bar
但是当格式字符串很复杂时,这变得难以阅读,并且当一个或多个部分不是字符串并且必须首先转换时很麻烦,比如
i := 25
s := "foo: " + strconv.Itoa(i)
有没有更简单的方法来做到这一点?
Sprintf 是您要查找的内容。
例子
fmt.Sprintf("foo: %s", bar)
您还可以在 Errors example 中看到它作为“围棋之旅”的一部分。
return fmt.Sprintf("at %v, %s", e.When, e.What)
1.简单的字符串
对于“简单”字符串(通常适合一行),最简单的解决方案是使用 fmt.Sprintf()
和朋友(fmt.Sprint()
、fmt.Sprintln()
)。这些类似于没有起始 S
字母的函数,但这些 Sxxx()
变体将结果作为 string
返回,而不是将它们打印到标准输出。
例如:
s := fmt.Sprintf("Hi, my name is %s and I'm %d years old.", "Bob", 23)
变量 s
将使用以下值初始化:
Hi, my name is Bob and I'm 23 years old.
提示:如果您只想连接不同类型的值,您可能不需要像 Sprint()
那样自动使用 Sprintf()
(它需要格式字符串)。看这个例子:
i := 23
s := fmt.Sprint("[age:", i, "]") // s will be "[age:23]"
对于仅连接 string
,您还可以使用 strings.Join()
,您可以在其中指定自定义分隔符 string
(放置在要连接的字符串之间)。
在 Go Playground 上试试这些。
2. 复杂的字符串(文档)
如果您尝试创建的字符串更复杂(例如,多行电子邮件),fmt.Sprintf()
的可读性和效率会降低(尤其是在您必须多次执行此操作时)。
为此,标准库提供了包 text/template
和 html/template
。这些包实现了用于生成文本输出的数据驱动模板。 html/template
用于生成对代码注入安全的 HTML 输出。它提供与包 text/template
相同的接口,并且只要输出为 HTML,就应该使用它而不是 text/template
。
使用 template
包基本上需要您以 string
值(可能源自文件,在这种情况下您只提供文件名)的形式提供静态模板,该模板可能包含静态文本,以及在引擎处理模板并生成输出时处理和执行。
您可以提供静态模板中包含/替换的参数,这些参数可以控制输出生成过程。此类参数的典型形式是可以嵌套的 struct
和 map
值。
例子:
例如,假设您要生成如下所示的电子邮件:
Hi [name]!
Your account is ready, your user name is: [user-name]
You have the following roles assigned:
[role#1], [role#2], ... [role#n]
要生成这样的电子邮件正文,您可以使用以下静态模板:
const emailTmpl = `Hi {{.Name}}!
Your account is ready, your user name is: {{.UserName}}
You have the following roles assigned:
{{range $i, $r := .Roles}}{{if $i}}, {{end}}{{.}}{{end}}
`
并提供这样的数据来执行它:
data := map[string]interface{}{
"Name": "Bob",
"UserName": "bob92",
"Roles": []string{"dbteam", "uiteam", "tester"},
}
通常,模板的输出会写入 io.Writer
,因此如果您希望结果为 string
,请创建并写入 bytes.Buffer
(实现 io.Writer
)。执行模板并获得结果为 string
:
t := template.Must(template.New("email").Parse(emailTmpl))
buf := &bytes.Buffer{}
if err := t.Execute(buf, data); err != nil {
panic(err)
}
s := buf.String()
这将产生预期的输出:
Hi Bob!
Your account is ready, your user name is: bob92
You have the following roles assigned:
dbteam, uiteam, tester
在 Go Playground 上试一试。
另请注意,从 Go 1.10 开始,bytes.Buffer
可以使用更新、更快、更专业的替代方案,即:strings.Builder
。用法非常相似:
builder := &strings.Builder{}
if err := t.Execute(builder, data); err != nil {
panic(err)
}
s := builder.String()
在 Go Playground 上试试这个。
注意:如果您提供 os.Stdout
作为目标(也实现 io.Writer
),您也可以显示模板执行的结果:
t := template.Must(template.New("email").Parse(emailTmpl))
if err := t.Execute(os.Stdout, data); err != nil {
panic(err)
}
这会将结果直接写入 os.Stdout
。在 Go Playground 上试试这个。
尝试使用 Sprintf()
;它不会打印输出,而是将其保存以备将来使用。看一下这个。
package main
import "fmt"
func main() {
address := "NYC"
fmt.Sprintf("I live in %v", address)
}
当您运行此代码时,它不会输出任何内容。但是,一旦您将 Sprintf()
分配给一个单独的变量,它就可以用于将来的目的。
package main
import "fmt"
func main() {
address := "NYC"
fmt.Sprintf("I live in %v", address)
var city = fmt.Sprintf("lives in %v", address)
fmt.Println("Michael",city)
}
在您的情况下,您需要使用 Sprintf() 作为格式字符串。
func Sprintf(format string, a ...interface{}) string
Sprintf 根据格式说明符格式化并返回结果字符串。
s := fmt.Sprintf("Good Morning, This is %s and I'm living here from last %d years ", "John", 20)
您的输出将是:
早上好,我是约翰,我过去 20 年来一直住在这里。
我已经创建了用于从模板格式化字符串的 go 项目(它允许以 C# 或 Python 样式格式化字符串,对于非常简单的情况来说只是第一个版本),你可以找到它这里https://github.com/Wissance/stringFormatter
它以下列方式工作:
func TestStrFormat(t *testing.T) {
strFormatResult, err := Format("Hello i am {0}, my age is {1} and i am waiting for {2}, because i am {0}!",
"Michael Ushakov (Evillord666)", "34", "\"Great Success\"")
assert.Nil(t, err)
assert.Equal(t, "Hello i am Michael Ushakov (Evillord666), my age is 34 and i am waiting for \"Great Success\", because i am Michael Ushakov (Evillord666)!", strFormatResult)
strFormatResult, err = Format("We are wondering if these values would be replaced : {5}, {4}, {0}", "one", "two", "three")
assert.Nil(t, err)
assert.Equal(t, "We are wondering if these values would be replaced : {5}, {4}, one", strFormatResult)
strFormatResult, err = Format("No args ... : {0}, {1}, {2}")
assert.Nil(t, err)
assert.Equal(t, "No args ... : {0}, {1}, {2}", strFormatResult)
}
func TestStrFormatComplex(t *testing.T) {
strFormatResult, err := FormatComplex("Hello {user} what are you doing here {app} ?", map[string]string{"user":"vpupkin", "app":"mn_console"})
assert.Nil(t, err)
assert.Equal(t, "Hello vpupkin what are you doing here mn_console ?", strFormatResult)
}
我来到这个页面专门寻找一种格式化错误字符串的方法。因此,如果有人需要帮助,您可以使用 fmt.Errorf()
功能。
方法签名是 func Errorf(format string, a ...interface{}) error
。它将格式化字符串作为满足 error
接口的值返回。
您可以在文档中查找更多详细信息 - https://golang.org/pkg/fmt/#Errorf。
我们可以通过具有 Format
支持的 define new Type
自定义一个新的 String 类型。
package main
import (
"fmt"
"text/template"
"strings"
)
type String string
func (s String) Format(data map[string]interface{}) (out string, err error) {
t := template.Must(template.New("").Parse(string(s)))
builder := &strings.Builder{}
if err = t.Execute(builder, data); err != nil {
return
}
out = builder.String()
return
}
func main() {
const tmpl = `Hi {{.Name}}! {{range $i, $r := .Roles}}{{if $i}}, {{end}}{{.}}{{end}}`
data := map[string]interface{}{
"Name": "Bob",
"Roles": []string{"dbteam", "uiteam", "tester"},
}
s ,_:= String(tmpl).Format(data)
fmt.Println(s)
}
注意:{{.}}
代表 {{range $i, $r := .Roles}} {{.}} {{end}}
中的 {{$r}}
除了使用 template.New
,您可以只使用带有 template.Template 的 new
:
package main
import (
"strings"
"text/template"
)
func format(s string, v interface{}) string {
t, b := new(template.Template), new(strings.Builder)
template.Must(t.Parse(s)).Execute(b, v)
return b.String()
}
func main() {
bar := "bar"
println(format("foo: {{.}}", bar))
i := 25
println(format("foo: {{.}}", i))
}
fmt.SprintF
函数返回一个字符串,您可以像使用 fmt.PrintF
一样格式化字符串