原文:https://juejin.cn/post/6844904056750620679
簡介
今天我們再來介紹 spf13 大神的另一個庫cast。cast
是一個小巧、實用的型別轉換庫,用於將一個型別轉為另一個型別。 最初開發cast
是用在hugo中的。
快速使用
先安裝:
$ go get github.com/spf13/cast
後使用:
package main
import (
"fmt"
"github.com/spf13/cast"
)
func main() {
// ToString
fmt.Println(cast.ToString("leedarjun")) // leedarjun
fmt.Println(cast.ToString(8)) // 8
fmt.Println(cast.ToString(8.31)) // 8.31
fmt.Println(cast.ToString([]byte("one time"))) // one time
fmt.Println(cast.ToString(nil)) // ""
var foo interface{} = "one more time"
fmt.Println(cast.ToString(foo)) // one more time
// ToInt
fmt.Println(cast.ToInt(8)) // 8
fmt.Println(cast.ToInt(8.31)) // 8
fmt.Println(cast.ToInt("8")) // 8
fmt.Println(cast.ToInt(true)) // 1
fmt.Println(cast.ToInt(false)) // 0
var eight interface{} = 8
fmt.Println(cast.ToInt(eight)) // 8
fmt.Println(cast.ToInt(nil)) // 0
}
實際上,cast
實現了多種常見型別之間的相互轉換,返回最符合直覺的結果。例如:
nil
轉為string
的結果為""
,而不是"nil"
;true
轉為string
的結果為"true"
,而true
轉為int
的結果為1
;interface{}
轉為其他型別,要看它裡面儲存的值型別。
這些型別包括所有的基本型別(整形、浮點型、布林值和字串)、空介面、nil
,時間(time.Time
)、時長(time.Duration
)以及它們的切片型別, 還有map[string]Type
(其中Type
為前面提到的型別):
byte bool float32 float64 string
int8 int16 int32 int64 int
uint8 uint16 uint32 uint64 uint
interface{} time.Time time.Duration nil
高階轉換
cast
提供了兩組函式:
ToType
(其中Type
可以為任何支援的型別),將引數轉換為Type
型別。如果無法轉換,返回Type
型別的零值或nil
;ToTypeE
以 E 結尾,返回轉換後的值和一個error
。這組函式可以區分引數中實際儲存了零值,還是轉換失敗了。
實現上大部分程式碼都類似,ToType
在內部呼叫ToTypeE
函式,返回結果並忽略錯誤。ToType
函式的實現在檔案cast.go
中, 而ToTypeE
函式的實現在檔案caste.go
中。
// cast/cast.go
func ToBool(i interface{}) bool {
v, _ := ToBoolE(i)
return v
}
// ToDuration casts an interface to a time.Duration type.
func ToDuration(i interface{}) time.Duration {
v, _ := ToDurationE(i)
return v
}
ToTypeE
函式都接受任意型別的引數(interface{}
),然後使用型別斷言根據具體的型別來執行不同的轉換。如果無法轉換,返回錯誤。
// cast/caste.go
func ToBoolE(i interface{}) (bool, error) {
i = indirect(i)
switch b := i.(type) {
case bool:
return b, nil
case nil:
return false, nil
case int:
if i.(int) != 0 {
return true, nil
}
return false, nil
case string:
return strconv.ParseBool(i.(string))
default:
return false, fmt.Errorf("unable to cast %#v of type %T to bool", i, i)
}
}
首先呼叫indirect
函式將引數中可能的指標去掉。如果型別本身不是指標,那麼直接返回。否則返回指標指向的值。 迴圈直到返回一個非指標的值:
// cast/caste.go
func indirect(a interface{}) interface{} {
if a == nil {
return nil
}
if t := reflect.TypeOf(a); t.Kind() != reflect.Ptr {
// Avoid creating a reflect.Value if it's not a pointer.
return a
}
v := reflect.ValueOf(a)
for v.Kind() == reflect.Ptr && !v.IsNil() {
v = v.Elem()
}
return v.Interface()
}
所以,下面程式碼輸出都是 8:
package main
import (
"fmt"
"github.com/spf13/cast"
)
func main() {
p := new(int)
*p = 8
fmt.Println(cast.ToInt(p)) // 8
pp := &p
fmt.Println(cast.ToInt(pp)) // 8
}
時間和時長轉換
時間型別的轉換程式碼如下:
func ToTimeE(i interface{}) (tim time.Time, err error) {
i = indirect(i)
switch v := i.(type) {
case time.Time:
return v, nil
case string:
return StringToDate(v)
case int:
return time.Unix(int64(v), 0), nil
case int64:
return time.Unix(v, 0), nil
case int32:
return time.Unix(int64(v), 0), nil
case uint:
return time.Unix(int64(v), 0), nil
case uint64:
return time.Unix(int64(v), 0), nil
case uint32:
return time.Unix(int64(v), 0), nil
default:
return time.Time{}, fmt.Errorf("unable to cast %#v of type %T to Time", i, i)
}
}
根據傳入的型別執行不同的處理:
- 如果是
time.Time
,直接返回; - 如果是整型,將引數作為時間戳(自 UTC 時間
1970.01.01 00:00:00
到現在的秒數)呼叫time.Unix
生成時間。Unix
接受兩個引數,第一個引數指定秒,第二個引數指定納秒; - 如果是字串,呼叫
StringToDate
函式依次嘗試以下面這些時間格式呼叫time.Parse
解析該字串。如果某個格式解析成功,則返回獲得的time.Time
。否則解析失敗,返回錯誤; - 其他任何型別都無法轉換為
time.Time
。
字串轉換為時間:
// cast/caste.go
func StringToDate(s string) (time.Time, error) {
return parseDateWith(s, []string{
time.RFC3339,
"2006-01-02T15:04:05", // iso8601 without timezone
time.RFC1123Z,
time.RFC1123,
time.RFC822Z,
time.RFC822,
time.RFC850,
time.ANSIC,
time.UnixDate,
time.RubyDate,
"2006-01-02 15:04:05.999999999 -0700 MST", // Time.String()
"2006-01-02",
"02 Jan 2006",
"2006-01-02T15:04:05-0700", // RFC3339 without timezone hh:mm colon
"2006-01-02 15:04:05 -07:00",
"2006-01-02 15:04:05 -0700",
"2006-01-02 15:04:05Z07:00", // RFC3339 without T
"2006-01-02 15:04:05Z0700", // RFC3339 without T or timezone hh:mm colon
"2006-01-02 15:04:05",
time.Kitchen,
time.Stamp,
time.StampMilli,
time.StampMicro,
time.StampNano,
})
}
func parseDateWith(s string, dates []string) (d time.Time, e error) {
for _, dateType := range dates {
if d, e = time.Parse(dateType, s); e == nil {
return
}
}
return d, fmt.Errorf("unable to parse date: %s", s)
}
時長型別的轉換程式碼如下:
// cast/caste.go
func ToDurationE(i interface{}) (d time.Duration, err error) {
i = indirect(i)
switch s := i.(type) {
case time.Duration:
return s, nil
case int, int64, int32, int16, int8, uint, uint64, uint32, uint16, uint8:
d = time.Duration(ToInt64(s))
return
case float32, float64:
d = time.Duration(ToFloat64(s))
return
case string:
if strings.ContainsAny(s, "nsuµmh") {
d, err = time.ParseDuration(s)
} else {
d, err = time.ParseDuration(s + "ns")
}
return
default:
err = fmt.Errorf("unable to cast %#v of type %T to Duration", i, i)
return
}
}
根據傳入的型別進行不同的處理:
- 如果是
time.Duration
型別,直接返回; - 如果是整型或浮點型,將其數值強制轉換為
time.Duration
型別,單位預設為ns
; - 如果是字串,分為兩種情況:如果字串中有時間單位符號
nsuµmh
,直接呼叫time.ParseDuration
解析;否則在字串後拼接ns
再呼叫time.ParseDuration
解析; - 其他型別解析失敗。
示例:
package main
import (
"fmt"
"time"
"github.com/spf13/cast"
)
func main() {
now := time.Now()
timestamp := 1579615973
timeStr := "2020-01-21 22:13:48"
fmt.Println(cast.ToTime(now)) // 2020-01-22 06:31:50.5068465 +0800 CST m=+0.000997701
fmt.Println(cast.ToTime(timestamp)) // 2020-01-21 22:12:53 +0800 CST
fmt.Println(cast.ToTime(timeStr)) // 2020-01-21 22:13:48 +0000 UTC
d, _ := time.ParseDuration("1m30s")
ns := 30000
strWithUnit := "130s"
strWithoutUnit := "130"
fmt.Println(cast.ToDuration(d)) // 1m30s
fmt.Println(cast.ToDuration(ns)) // 30µs
fmt.Println(cast.ToDuration(strWithUnit)) // 2m10s
fmt.Println(cast.ToDuration(strWithoutUnit)) // 130ns
}
轉換為切片
實際上,這些函式的實現基本類似。使用型別斷言判斷型別。如果就是要返回的型別,直接返回。否則根據型別進行相應的轉換。
我們主要分析兩個實現:ToIntSliceE
和ToStringSliceE
。ToBoolSliceE/ToDurationSliceE
與ToIntSliceE
基本相同。
首先是ToIntSliceE
:
func ToIntSliceE(i interface{}) ([]int, error) {
if i == nil {
return []int{}, fmt.Errorf("unable to cast %#v of type %T to []int", i, i)
}
switch v := i.(type) {
case []int:
return v, nil
}
kind := reflect.TypeOf(i).Kind()
switch kind {
case reflect.Slice, reflect.Array:
s := reflect.ValueOf(i)
a := make([]int, s.Len())
for j := 0; j < s.Len(); j++ {
val, err := ToIntE(s.Index(j).Interface())
if err != nil {
return []int{}, fmt.Errorf("unable to cast %#v of type %T to []int", i, i)
}
a[j] = val
}
return a, nil
default:
return []int{}, fmt.Errorf("unable to cast %#v of type %T to []int", i, i)
}
}
根據傳入引數的型別:
- 如果是
nil
,直接返回錯誤; - 如果是
[]int
,不用轉換,直接返回; - 如果傳入型別為切片或陣列,新建一個
[]int
,將切片或陣列中的每個元素轉為int
放到該[]int
中。最後返回這個[]int
; - 其他情況,不能轉換。
ToStringSliceE
:
func ToStringSliceE(i interface{}) ([]string, error) {
var a []string
switch v := i.(type) {
case []interface{}:
for _, u := range v {
a = append(a, ToString(u))
}
return a, nil
case []string:
return v, nil
case string:
return strings.Fields(v), nil
case interface{}:
str, err := ToStringE(v)
if err != nil {
return a, fmt.Errorf("unable to cast %#v of type %T to []string", i, i)
}
return []string{str}, nil
default:
return a, fmt.Errorf("unable to cast %#v of type %T to []string", i, i)
}
}
根據傳入的引數型別:
- 如果是
[]interface{}
,將該引數中每個元素轉為string
,返回結果切片; - 如果是
[]string
,不需要轉換,直接返回; - 如果是
interface{}
,將引數轉為string
,返回只包含這個值的切片; - 如果是
string
,呼叫strings.Fields
函式按空白符將引數拆分,返回拆分後的字串切片; - 其他情況,不能轉換。
示例:
package main
import (
"fmt"
"github.com/spf13/cast"
)
func main() {
sliceOfInt := []int{1, 3, 7}
arrayOfInt := [3]int{8, 12}
// ToIntSlice
fmt.Println(cast.ToIntSlice(sliceOfInt)) // [1 3 7]
fmt.Println(cast.ToIntSlice(arrayOfInt)) // [8 12 0]
sliceOfInterface := []interface{}{1, 2.0, "darjun"}
sliceOfString := []string{"abc", "dj", "pipi"}
stringFields := " abc def hij "
any := interface{}(37)
// ToStringSliceE
fmt.Println(cast.ToStringSlice(sliceOfInterface)) // [1 2 darjun]
fmt.Println(cast.ToStringSlice(sliceOfString)) // [abc dj pipi]
fmt.Println(cast.ToStringSlice(stringFields)) // [abc def hij]
fmt.Println(cast.ToStringSlice(any)) // [37]
}
轉為map[string]Type
型別
cast
庫能將傳入的引數轉為map[string]Type
型別,Type
為上面支援的型別。
其實只需要分析一個ToStringMapStringE
函式就可以了,其他的實現基本一樣。ToStringMapStringE
返回map[string]string
型別的值。
func ToStringMapStringE(i interface{}) (map[string]string, error) {
var m = map[string]string{}
switch v := i.(type) {
case map[string]string:
return v, nil
case map[string]interface{}:
for k, val := range v {
m[ToString(k)] = ToString(val)
}
return m, nil
case map[interface{}]string:
for k, val := range v {
m[ToString(k)] = ToString(val)
}
return m, nil
case map[interface{}]interface{}:
for k, val := range v {
m[ToString(k)] = ToString(val)
}
return m, nil
case string:
err := jsonStringToObject(v, &m)
return m, err
default:
return m, fmt.Errorf("unable to cast %#v of type %T to map[string]string", i, i)
}
}
根據傳入的引數型別:
- 如果是
map[string]string
,不用轉換,直接返回; - 如果是
map[string]interface{}
,將每個值轉為string
存入新的 map,最後返回新的 map; - 如果是
map[interface{}]string
,將每個鍵轉為string
存入新的 map,最後返回新的 map; - 如果是
map[interface{}]interface{}
,將每個鍵和值都轉為string
存入新的 map,最後返回新的 map; - 如果是
string
型別,cast
將它看成一個 JSON 串,解析這個 JSON 到map[string]string
,然後返回結果; - 其他情況,返回錯誤。
示例:
package main
import (
"fmt"
"github.com/spf13/cast"
)
func main() {
m1 := map[string]string {
"name": "darjun",
"job": "developer",
}
m2 := map[string]interface{} {
"name": "jingwen",
"age": 18,
}
m3 := map[interface{}]string {
"name": "pipi",
"job": "designer",
}
m4 := map[interface{}]interface{} {
"name": "did",
"age": 29,
}
jsonStr := `{"name":"bibi", "job":"manager"}`
fmt.Println(cast.ToStringMapString(m1)) // map[job:developer name:darjun]
fmt.Println(cast.ToStringMapString(m2)) // map[age:18 name:jingwen]
fmt.Println(cast.ToStringMapString(m3)) // map[job:designer name:pipi]
fmt.Println(cast.ToStringMapString(m4)) // map[job:designer name:pipi]
fmt.Println(cast.ToStringMapString(jsonStr)) // map[job:manager name:bibi]
}
總結
cast
庫能在幾乎所有常見型別之間轉換,使用非常方便。程式碼量也很小,有時間建議讀讀原始碼。
完整示例程式碼在GitHub上。