Go 每日一庫之 cast

時間  2020-02-06
標籤 每日 cast 简体版
原文   原文鏈接

簡介

今天咱們再來介紹 spf13 大神的另外一個庫cast。cast是一個小巧、實用的類型轉換庫，用於將一個類型轉爲另外一個類型。 最初開發cast是用在hugo中的。git

快速使用

先安裝：github

$ go get github.com/spf13/cast
複製代碼

後使用：golang

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實現了多種常見類型之間的相互轉換，返回最符合直覺的結果。例如：json

  • 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提供了兩組函數：bash

  • 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{}），而後使用類型斷言根據具體的類型來執行不一樣的轉換。若是沒法轉換，返回錯誤。app

// 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上。

ps: 本覺得春節就這麼幾天，偷個懶，沒想到。。。

參考

  1. cast GitHub 倉庫

我

個人博客

歡迎關注個人微信公衆號【GoUpUp】，共同窗習，一塊兒進步~

本文由博客一文多發平臺 OpenWrite 發佈！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程