cyan

README

Synopsis

A modern, comprehensive and efficient utility library of Golang.

Features

• Comprehensive, efficient and reusable.
• Numerous utility functions, support string, slice, map, datetime, crypto...
• Only depend on the go standard and golang.org/x library.
• High unit test coverage for exported functions.

Encoding

Some utility functions can be used to handle conversion of different character encoding, such as gbk to utf8.

gbk := []byte{0xC4, 0xE3, 0xBA, 0xC3}   // 你好 in gbk
GbkToUtf8(gbk)                          // 你好 in utf8
Utf8ToGbk(utf8)                         // [196 227 186 195]

Some converting function to json.

student := struct {
    Hobby   string
    Age     int32
}{
    Hobby: "pingpopng",
    Age:   28,
}
encoding.ToIndentJSON(&student)
/*
output:
{
    "Hobby": "pingpopng",
    "Age": 28
}
*/

Net

Some utility functions can be used to handle network. For example you can use IPv4StrToU32() transform ipv4 string to uint32 value.

IsReservedIP("0.0.0.256")    // -1 invalid ip
IsReservedIP("39.156.69.79") // 0 public ip
IsReservedIP("127.0.0.1")    // 1 reserved ip

IPv4StrToU32("127.0.0.1")      // 2130706433
U32ToIPv4Str(2130706433)       // "127.0.0.1"
GetNativeEndian()              // LittleEndian
IsLittleEndian()               // true

Slice

Some useful utility functions can be used to handle slice.

// CRUD(Create Read Update Delete)
fib := []int{1, 1, 2, 3, 5, 8}
Insert(fib, 6, 13, 21)     // [1 1 2 3 5 8 13]
Delete(fib, 0)             // [1 2 3 5 8]
Replace(fib, 5, 6, 88)     // [1 1 2 3 5 88]
Indexes(fib, 1)            // [0 1]

Min([]int{1,2,3})                         // 1
Max([]int{1,2,3})                         // 3

Sum([]int{1,2,3})                         // 6
Sum([]uint{1,2,3})                        // 6
Sum([]float32{1.1, 2.2, 3.3})             // 6.6
Sum([]float64{1.1, 2.2, 3.3})             // 6.6

Unique([]int{1, 2, 2, 3})               // [1 2 3]
Unique([]uint{1, 2, 2, 3})              // [1 2 3]
Unique([]string{"a", "b", "b", "c"})    // [a b c]

Reverse([]int{1, 2, 3})                 // [3 2 1]
Reverse([]uint{1, 2, 3})                // [3 2 1]
Reverse([]string{"a", "b", "c"})        // [c b a]

ClearZero([]int{1, 2, 0, 3})                    // [1 2 3]
ClearZero([]string{"foo", "bar", "", "baz"})    // ["foo", "bar", "baz"]

// and so on.

String

Some utility functions can be used to handle string.

Split("a,b,c", ",")                    // []string{"a", "b", "c"}
SplitSeps("a,b|c", ",", "|")           // []string{"a", "b", "c"}
SplitSeps("a,bSEPc", ",", "SEP")       // []string{"a", "b", "c"}

Join([]int{1, 2, 3}, ",")              // "1,2,3"
Join([]string{"a", "", "b"}, ",")      // "a,,b"
JoinNonEmptyStrs(",", "a", "", "b")    // "a,b"

Reverse("abc")                         // "cba"

AlphanumericNum("108条梁山man")         // 6
AlphanumericNumV2("108条梁山man")       // 6
AlphanumericNumRegExp("108条梁山man")   // 6

Time

Some utility functions can be used to handle date and time.

tc := NewTimeCounter()
// your statements
tc.GetMs()                  // get the time cost in millisecond

GetNowDate()                // just a example, the same below. 2020-05-16
GetNowTime()                // 00:15:42
GetNowDateTime()            // 2020-05-16 00:15:42
GetNowDateTimeZ()           // 2020-05-16 00:15:42 +08:00

GetNowS()                   // 1589559342
GetNowMs()                  // 1589559342963
GetNowUs()                  // 1589559342963062
GetNowNs()                  // 1589559342964063200

GetDayBeginMoment(time.Now())  // 2020-05-16 00:00:00 +0800 CST
GetDayEndMoment(time.Now())    // 2020-05-16 23:59:59.999999999 +0800 CST

Type Conversion

Some utility functions can be used to convert one type to another type.

to basic types

// to string
ToAny[string]("foo")            // "foo"
ToAny[string](8)                // "8"
ToAny[string](8.31)             // "8.31"
ToAny[string]([]byte("foo"))    // "foo"
ToAny[string](nil)              // ""
ToAny[string](any("foo"))       // "foo"

// to int
ToAny[int](8)                  // 8
ToAny[int](8.31)               // 8
ToAny[int]("8")                // 8
ToAny[int](true)               // 1
ToAny[int](false)              // 0
ToAny[int](nil)                // 0
ToAny[int](any(8))             // 8

// to bool
ToAny[bool]("true")           // true
ToAny[bool]("false")          // false
ToAny[bool]("True")           // true
ToAny[bool]("False")          // false
ToAny[bool](1)                // true
ToAny[bool](0)                // false
ToAny[bool](nil)              // false
ToAny[bool](any(1))           // true

to set

// Convert bool slice or array to set.
bools := []bool{true, false, true}
ToSet[bool](bools)
ToSetE[bool](bools)

// Convert int slice or array to set.
ints := []int{1, 2, 3}
ToSet[int](ints)
ToSetE[int](ints)

// Convert string slice or array to set.
strs := []string{"foo", "bar", "baz"}
ToSet[string](strs)
ToSetE[string](strs)

// Split string to set.
SplitStrToSet("a,b,c", ",")  // map[a:{}, b:{}, c:{}]

to slice

// slice or array to any type slice.
ToSlice[string]("a b c")         // ["a","b","c"]
ToSliceE[string]("a b c")        // ["a","b","c"], nil
ToSlice[string]([]int{1, 2, 3})  // ["1","2","3"]
ToSliceE[string]([]int{1, 2, 3}) // ["1","2","3"],nil

// map keys or values to slice in random order.
ks, vs := MapToSlice(map[string]int{"foo":1, "bar":2, "baz":3})
ks, vs, _ := MapToSliceE(map[string]int{"foo":1, "bar":2, "baz":3})

slK, _ : = ks.([]string)
slV, _ : = vs.([]int)

// Split string to slice.
SplitStrToSlice[int]("1,2,3", ",")              // [1,2,3]
SplitStrToSliceE[int]("1,2,3", ",")             // [1,2,3], nil   
SplitStrToSlice[uint]("1,2,3", ",")             // [1,2,3]
SplitStrToSliceE[uint]("1,2,3", ",")            // [1,2,3], nil
SplitStrToSlice[float64]("1.1,2.2,3.3", ",")    // [1.1,2.2,3.3]
SplitStrToSliceE[float64]("1.1,2.2,3.3", ",")   // [1.1,2.2,3.3], nil
SplitStrToSlice[bool]("1,0,true,false", ",")    // [true,false,true,false]
SplitStrToSliceE[bool]("1,0,true,false", ",")   // [true,false,true,false], nil

// and so on.

to map

var st = struct {
    I int
    S string
}{I: 1, S: "a"}

// to map[string]any
StructToMap(st)         // map["I":1 "S":"a"]
StructToMapStr(st)      // map["I":"1" "S":"a"]

// json or other type to map[string]string
ToMapStr(`{"foo":"foo","bar":"bar","baz":"baz"}`)  // map["foo":"foo" "bar":"bar" "baz":"baz"]
ToMapStrE(`{"foo":"foo","bar":"bar","baz":"baz"}`) // map["foo":"foo" "bar":"bar" "baz":"baz"], nil

URL

Some utility functions can be used to handle URL.

var rawURL=`http://www.aspxfans.com:8080/news/index.asp?boardID=520&page=1&page=2#name`

RawUrlGetDomain(rawURL)    // "www.aspxfans.com"
RawUrlGetPort(rawURL)      // "8080"

RawURLGetParam(rawURL, "page")         // 1 <nil>
RawURLGetParams(rawURL, "page")        // [1 2] <nil>
RawURLGetAllParams(rawURL)             // map[boardID:[520] page:[1 2]] <nil>

RawURLAddParam(rawURL, "keyword", "dog")   // http://www.aspxfans.com:8080/news/index.asp?boardID=520&keyword=dog&page=1&page=2#name
RawURLDelParam(rawURL, "page")             // http://www.aspxfans.com:8080/news/index.asp?boardID=520#name
RawURLSetParam(rawURL, "boardID", "521")   // http://www.aspxfans.com:8080/news/index.asp?boardID=521&page=1&page=2#name

Crypto

Some utility functions can be used to create Hash, HMAC and crypt data.

// Hash functions.
Md5("")    // d41d8cd98f00b204e9800998ecf8427e
MD5("")    // D41D8CD98F00B204E9800998ECF8427E
Sha1("")   // da39a3ee5e6b4b0d3255bfef95601890afd80709
SHA1("")   // DA39A3EE5E6B4B0D3255BFEF95601890AFD80709
Sha224("") // d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f
SHA224("") // D14A028C2A3A2BC9476102BB288234C415A2B01F828EA62AC5B3E42F
Sha256("") // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
SHA256("") // E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855
Sha384("") // 38b060a751ac96384cd9327eb1b1e36a21fdb71114be07434c0cc7bf63f6e1da274edebfe76f65fbd51ad2f14898b95b
SHA384("") // 38B060A751AC96384CD9327EB1B1E36A21FDB71114BE07434C0CC7BF63F6E1DA274EDEBFE76F65FBD51AD2F14898B95B
Sha512("") // cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e
SHA512("") // CF83E1357EEFB8BDF1542850D66D8007D620E4050B5715DC83F4A921D36CE9CE47D0D13C5D85F2B0FF8318D2877EEC2F63B931BD47417A81A538327AF927DA3E

// HMAC functions.
HMACMd5("", "")    // 74e6f7298a9c2d168935f58c001bad88
HMACMD5("", "")    // 74E6F7298A9C2D168935F58C001BAD88
HMACSha1("", "")   // fbdb1d1b18aa6c08324b7d64b71fb76370690e1d
HMACSHA1("", "")   // FBDB1D1B18AA6C08324B7D64B71FB76370690E1D
HMACSha224("", "") // 5ce14f72894662213e2748d2a6ba234b74263910cedde2f5a9271524
HMACSHA224("", "") // 5CE14F72894662213E2748D2A6BA234B74263910CEDDE2F5A9271524
HMACSha256("", "") // b613679a0814d9ec772f95d778c35fc5ff1697c493715653c6c712144292c5ad
HMACSHA256("", "") // B613679A0814D9EC772F95D778C35FC5FF1697C493715653C6C712144292C5AD
HMACSha384("", "") // 6c1f2ee938fad2e24bd91298474382ca218c75db3d83e114b3d4367776d14d3551289e75e8209cd4b792302840234adc
HMACSHA384("", "") // 6C1F2EE938FAD2E24BD91298474382CA218C75DB3D83E114B3D4367776D14D3551289E75E8209CD4B792302840234ADC
HMACSha512("", "") // b936cee86c9f87aa5d3c6f2e84cb5a4239a5fe50480a6ec66b70ab5b1f4ac6730c6c515421b327ec1d69402e53dfb49ad7381eb067b338fd7b0cb22247225d47
HMACSHA512("", "") // B936CEE86C9F87AA5D3C6F2E84CB5A4239A5FE50480A6EC66B70AB5B1F4AC6730C6C515421B327EC1D69402E53DFB49AD7381EB067B338FD7B0CB22247225D47

// Encryption functions.
p := []byte("plaintext")
key8 := []byte("12345678")
Base64DESCBCEncrypt(p, key8) // UZS/y4By6ksePYMBbvZdig==
Base64DESCBCDecrypt(c, key8) // plaintext

key24 := []byte("12345678abcdefgh12345678")
Base64TriDESCBCEncrypt(p, key24) // dau0DzmDGQbHasZaOvxxwg==
Base64TriDESCBCDecrypt(c, key24) // plaintext

key16 := []byte("12345678abcdefgh")
Base64AESCBCEncrypt(p, key16) // A67NhD3RBiNaMgG6HTm8LQ==
Base64AESCBCDecrypt(c, key16)  // plaintext

// RSA encryption, decryption, sign and verify signature.
GenRsaKey(bits int) (prvkey, pubkey []byte, err error)
RsaEncrypt(pubkey, data []byte) ([]byte, error)
RsaDecrypt(prvkey, cipher []byte) ([]byte, error)
RsaSign(prvkey []byte, hash crypto.Hash, data []byte) ([]byte, error)
RsaVerifySign(pubkey []byte, hash crypto.Hash, data, sig []byte) error

Rand

Some utility functions to create a real non-negative random int number, specified length random string and so on.

GetRandInt()               // 2040723487295132865
GetRandIntn(100)           // 49
GetRandIntRange(0, 100)    // 44
GetRandByteSlice(3)        // [241 16 101]
GetRandStr(3)              // dAt
GetRandLowerStr(3)         // lts
GetRandUpperStr(3)         // YUT

File

Some utility functions to operate on the file.

// List contents of the directory.
ListDir()
ListFileNames()
ListDirEntryPaths()
ListDirEntryPathsSymlink()

// Check the file or directory.
IsExist()
IsDir()
IsDirE()
IsFile()
IsFileE()
IsSymlink()
IsSymlinkE()
IsShortcutFile()

// Create a file.
Create()
CreateFile()

// Clears a file content.
ClearFile()

// Gets file info.
FileMd5()
FileMd5Reader()
FileSize()
FileSizeFile()

// and so on.

Comparison

Some utility functions to handle comparison.

// Compare two any type value.
Cmp(888, 889)       // LT
Cmp(888, 888)       // EQ
Cmp(889, 888)       // GT
Cmp(88.8, 88.9)     // LT
Cmp(88.8, 88.8)     // EQ
Cmp(88.9, 88.8)     // GT
Cmp("abc", "b")     // LT
Cmp("abc", "abc")   // EQ
Cmp("b", "abc")     // GT

// Compare semantic version. 
b, _ := VerGTVer("1.0.5", "1.0.4")   // true
b, _ := VerLTVer("1.0.5", "2.0.4")   // true
b, _ := VerGEVer("2.0.4", "2.0.4")   // true
b, _ := VerLEVer("1.0.5", "1.0.5")   // true

Others

Some utility functions now unclassified. Of course, it may be classified and moved to a new subdirectory in the future.

// NO NOW.

How to Contribute

We really appreciate any code commits which make this lib powerful. Please follow the rules below to create your pull request.

1. Fork the repository.
2. Add and Commit your changes.
3. Push to your forked repository.
4. Create new pull request.

Summary

The above examples are just the tip of the iceberg. For more usage, please read the source code.

Due to the limited personal ability, you are welcome to criticize and correct. Of course, welcome to join in the construction of this library.

Star History