mirror of
https://github.com/duke-git/lancet.git
synced 2026-02-08 14:42:27 +08:00
Compare commits
160 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b6815224fd | ||
|
|
5931b882ee | ||
|
|
f8096e3585 | ||
|
|
979381bfb7 | ||
|
|
3e2c25f827 | ||
|
|
2c7bcc9fbb | ||
|
|
3a944ab12f | ||
|
|
387079d034 | ||
|
|
33e3631b72 | ||
|
|
b3149ea619 | ||
|
|
116ff284c3 | ||
|
|
0cb251f7b8 | ||
|
|
683def2242 | ||
|
|
d4a90f2869 | ||
|
|
be67de3b40 | ||
|
|
6898ed413e | ||
|
|
5dbdbcd651 | ||
|
|
ae0facd32d | ||
|
|
2d7e19fb87 | ||
|
|
24d4a03227 | ||
|
|
93fb089f6e | ||
|
|
2fe272f2ef | ||
|
|
77859ffa15 | ||
|
|
f83f47df3a | ||
|
|
885c08847d | ||
|
|
cc4a20751f | ||
|
|
b0d1d39452 | ||
|
|
02fa7bc8be | ||
|
|
433eb63b86 | ||
|
|
a2541dac03 | ||
|
|
690e746811 | ||
|
|
7cb97a26c5 | ||
|
|
39d373d37b | ||
|
|
1aefd6aa12 | ||
|
|
c7aa44b8a4 | ||
|
|
0e3dc68de5 | ||
|
|
4083e75ed4 | ||
|
|
1327eff62f | ||
|
|
eb24c37143 | ||
|
|
b7a6c91064 | ||
|
|
555e185871 | ||
|
|
cb0efc5cc7 | ||
|
|
7ac6816532 | ||
|
|
81c4216699 | ||
|
|
2e30389703 | ||
|
|
0e1d5cf04b | ||
|
|
4e2d84e4fc | ||
|
|
13ee045b99 | ||
|
|
f1fd4c876b | ||
|
|
cd63b2b18f | ||
|
|
bab9b4a6b3 | ||
|
|
b3c34578bf | ||
|
|
f26477904e | ||
|
|
85886cf618 | ||
|
|
a19a861552 | ||
|
|
96d57a6d24 | ||
|
|
b48155c249 | ||
|
|
41685022c0 | ||
|
|
4e7274ce05 | ||
|
|
2384b0e51f | ||
|
|
6b6b938d1e | ||
|
|
29d8987909 | ||
|
|
43fb3f1a06 | ||
|
|
34c28fece3 | ||
|
|
40c2402493 | ||
|
|
c965e79bfc | ||
|
|
eeadb1fecb | ||
|
|
1dd826f050 | ||
|
|
8b04aa5f31 | ||
|
|
6855fe0bce | ||
|
|
300be9e3dc | ||
|
|
384be2e2e9 | ||
|
|
1d71a0ad3a | ||
|
|
0e0ed316f1 | ||
|
|
961eedda04 | ||
|
|
f4881d2f49 | ||
|
|
a3eb269bdb | ||
|
|
e367123070 | ||
|
|
0f1d3fb553 | ||
|
|
a4658b2341 | ||
|
|
739113ef9e | ||
|
|
1629b861cd | ||
|
|
acce85557f | ||
|
|
05aefbaa62 | ||
|
|
6988fdc451 | ||
|
|
5963830879 | ||
|
|
134aded4d8 | ||
|
|
35780d9dc1 | ||
|
|
c40ac9bb9b | ||
|
|
51bd974cc9 | ||
|
|
0b93fbffd9 | ||
|
|
349f8b6c97 | ||
|
|
5899921054 | ||
|
|
ec19014578 | ||
|
|
1ad990ce9d | ||
|
|
8bb102cb6e | ||
|
|
e07d54d1da | ||
|
|
6f035f710e | ||
|
|
92967e0add | ||
|
|
6a1a0b8677 | ||
|
|
ca88687f3d | ||
|
|
aa64bf5bee | ||
|
|
a3399503f7 | ||
|
|
3ca096b4ac | ||
|
|
28317a1683 | ||
|
|
2ab898741d | ||
|
|
454efd486d | ||
|
|
efa20a97c4 | ||
|
|
25ef78bc64 | ||
|
|
261370e30d | ||
|
|
764a6fe107 | ||
|
|
f3749c52b9 | ||
|
|
f368854b2d | ||
|
|
c424b88d40 | ||
|
|
aeebd63eda | ||
|
|
22b3c4dd42 | ||
|
|
bd976642f6 | ||
|
|
e31fb28003 | ||
|
|
fd271fe176 | ||
|
|
6890bbfe05 | ||
|
|
24ae47a12f | ||
|
|
d8d85efedf | ||
|
|
ba73847b80 | ||
|
|
69453eba19 | ||
|
|
f147f78a41 | ||
|
|
bbfc5b7060 | ||
|
|
1f45937190 | ||
|
|
52c5a91606 | ||
|
|
49f62c3550 | ||
|
|
23701e6998 | ||
|
|
1199c30ef3 | ||
|
|
b0e17c7bc4 | ||
|
|
d3525dfe8f | ||
|
|
9da7115169 | ||
|
|
9cb9aa2f2f | ||
|
|
e4cd7dad35 | ||
|
|
31e08197d4 | ||
|
|
642d0b8077 | ||
|
|
25b2ae6b98 | ||
|
|
65719515bd | ||
|
|
3ffd81a98a | ||
|
|
f490ef2404 | ||
|
|
3438f3b18a | ||
|
|
73f4ae7b35 | ||
|
|
a8996933bf | ||
|
|
3905c0bde1 | ||
|
|
c7e961704d | ||
|
|
cb7df1b57d | ||
|
|
eeff28606e | ||
|
|
86d4b25a2b | ||
|
|
ad287ed99a | ||
|
|
df9de3065b | ||
|
|
71a2ea3f20 | ||
|
|
955f2e6de6 | ||
|
|
4aef9d6d22 | ||
|
|
4752725dd6 | ||
|
|
07d1704cb2 | ||
|
|
74d262e609 | ||
|
|
97e0789ea4 | ||
|
|
bc39b0887b |
4
.github/workflows/codecov.yml
vendored
4
.github/workflows/codecov.yml
vendored
@@ -1,11 +1,13 @@
|
|||||||
name: Test and coverage
|
name: test
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
# - v2
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
# - v2
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -3,4 +3,8 @@
|
|||||||
.DS_Store
|
.DS_Store
|
||||||
cryptor/*.txt
|
cryptor/*.txt
|
||||||
fileutil/*.txt
|
fileutil/*.txt
|
||||||
|
fileutil/*.zip
|
||||||
|
fileutil/*.link
|
||||||
|
fileutil/unzip/*
|
||||||
|
slice/testdata/*
|
||||||
cryptor/*.pem
|
cryptor/*.pem
|
||||||
694
README.md
694
README.md
@@ -1,44 +1,48 @@
|
|||||||
<div align="center">
|
<div align=center>
|
||||||
<h1 style="width: 100%; text-align: center;">Lancet</h1>
|
<img src="./logo.png" width="200" height="200"/>
|
||||||
<p style="font-size: 18px">
|
|
||||||
Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js.
|
|
||||||
</p>
|
|
||||||
<div align="center" style="text-align: center;">
|
|
||||||
|
|
||||||

|
<br/>
|
||||||
[](https://github.com/duke-git/lancet/releases)
|
|
||||||
|

|
||||||
|
[](https://github.com/duke-git/lancet/releases)
|
||||||
[](https://pkg.go.dev/github.com/duke-git/lancet)
|
[](https://pkg.go.dev/github.com/duke-git/lancet)
|
||||||
[](https://goreportcard.com/report/github.com/duke-git/lancet)
|
[](https://goreportcard.com/report/github.com/duke-git/lancet)
|
||||||
|
[](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
|
||||||
[](https://codecov.io/gh/duke-git/lancet)
|
[](https://codecov.io/gh/duke-git/lancet)
|
||||||
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
<p style="font-size: 20px">
|
||||||
|
Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js.
|
||||||
|
</p>
|
||||||
|
|
||||||
English | [简体中文](./README_zh-CN.md)
|
English | [简体中文](./README_zh-CN.md)
|
||||||
|
|
||||||
</div>
|
## Feature
|
||||||
|
|
||||||
### Feature
|
|
||||||
|
|
||||||
- 👏 Comprehensive, efficient and reusable.
|
- 👏 Comprehensive, efficient and reusable.
|
||||||
- 💪 140+ common go util functions, support string, slice, datetime, net, crypt...
|
- 💪 200+ go util functions, support string, slice, datetime, net, crypt...
|
||||||
- 💅 Only depend on the go standard library.
|
- 💅 Only depend on the go standard library.
|
||||||
- 🌍 Unit test for exery exported function.
|
- 🌍 Unit test for every exported function.
|
||||||
|
|
||||||
### Installation
|
## Installation
|
||||||
|
|
||||||
```go
|
```go
|
||||||
go get github.com/duke-git/lancet
|
go get github.com/duke-git/lancet
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage
|
## Usage
|
||||||
|
|
||||||
Lancet organizes the code into package structure, and you need to import the corresponding package name when use it. For example, if you use string-related functions,import the strutil package like below:
|
Lancet organizes the code into package structure, and you need to import the corresponding package name when use it. For example, if you use string-related functions,import the strutil package like below:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "github.com/duke-git/lancet/strutil"
|
import "github.com/duke-git/lancet/strutil"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example
|
## Example
|
||||||
|
|
||||||
Here takes the string function ReverseStr (reverse order string) as an example, and the strutil package needs to be imported.
|
Here takes the string function ReverseStr (reverse order string) as an example, and the strutil package needs to be imported.
|
||||||
|
|
||||||
@@ -57,446 +61,346 @@ func main() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### API Documentation
|
## API Documentation
|
||||||
|
### 1. Convertor package contains some functions for data convertion.
|
||||||
#### 1. convertor contains some functions for data convertion
|
|
||||||
|
|
||||||
- Support conversion between commonly used data types.
|
|
||||||
- Usage: import "github.com/duke-git/lancet/cryptor"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/convertor"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/convertor"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
s := "12.3"
|
|
||||||
f, err := convertor.ToFloat(s)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Errorf("error is %s", err.Error())
|
|
||||||
}
|
|
||||||
fmt.Println(f) // 12.3
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### Function list:
|
||||||
- Function list:
|
- [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB)
|
||||||
|
- [ColorRGBToHex](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorRGBToHex)
|
||||||
|
- [ToBool](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBool)
|
||||||
|
- [ToBytes](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBytes)
|
||||||
|
- [ToChar](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChar)
|
||||||
|
- [ToChannel](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChannel)
|
||||||
|
- [ToInt](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToInt)
|
||||||
|
- [ToJson](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToJson)
|
||||||
|
- [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToString)
|
||||||
|
- [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#StructToMap)
|
||||||
|
|
||||||
|
### 2. Cryptor package is for data encryption and decryption.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func ColorHexToRGB(colorHex string) (red, green, blue int) //convert color hex to color rgb
|
import "github.com/duke-git/lancet/cryptor"
|
||||||
func ColorRGBToHex(red, green, blue int) string //convert color rgb to color hex
|
|
||||||
func ToBool(s string) (bool, error) //convert string to a boolean
|
|
||||||
func ToBytes(data interface{}) ([]byte, error) //convert interface to bytes
|
|
||||||
func ToChar(s string) []string //convert string to char slice
|
|
||||||
func ToFloat(value interface{}) (float64, error) //convert value to float64, if input is not a float return 0.0 and error
|
|
||||||
func ToInt(value interface{}) (int64, error) //convert value to int64, if input is not a numeric format return 0 and error
|
|
||||||
func ToJson(value interface{}) (string, error) //convert value to a valid json string
|
|
||||||
func ToString(value interface{}) string //convert value to string
|
|
||||||
func StructToMap(value interface{}) (map[string]interface{}, error) //convert struct to map, only convert exported field, tag `json` should be set
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2. cryptor is for data encryption and decryption
|
#### Function list:
|
||||||
|
- [AesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesEcbEncrypt)
|
||||||
|
- [AesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesEcbDecrypt)
|
||||||
|
- [AesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCbcEncrypt)
|
||||||
|
- [AesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCbcDecrypt)
|
||||||
|
- [AesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCtrCrypt)
|
||||||
|
- [AesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCfbEncrypt)
|
||||||
|
- [AesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCfbDecrypt)
|
||||||
|
- [AesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesOfbEncrypt)
|
||||||
|
- [AesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesOfbDecrypt)
|
||||||
|
- [Base64StdEncode](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Base64StdEncode)
|
||||||
|
- [Base64StdDecode](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Base64StdDecode)
|
||||||
|
- [DesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesEcbEncrypt)
|
||||||
|
- [DesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesEcbDecrypt)
|
||||||
|
- [DesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCbcEncrypt)
|
||||||
|
- [DesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCbcDecrypt)
|
||||||
|
- [DesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCtrCrypt)
|
||||||
|
- [DesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCfbEncrypt)
|
||||||
|
- [DesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCfbDecrypt)
|
||||||
|
- [DesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesOfbEncrypt)
|
||||||
|
- [DesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesOfbDecrypt)
|
||||||
|
- [HmacMd5](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacMd5)
|
||||||
|
- [HmacSha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha1)
|
||||||
|
- [HmacSha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha256)
|
||||||
|
- [HmacSha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha512)
|
||||||
|
- [Md5String](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Md5String)
|
||||||
|
- [Md5File](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Md5File)
|
||||||
|
- [Sha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha1)
|
||||||
|
- [Sha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha256)
|
||||||
|
- [Sha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha512)
|
||||||
|
- [GenerateRsaKey](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#GenerateRsaKey)
|
||||||
|
- [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaEncrypt)
|
||||||
|
- [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaDecrypt)
|
||||||
|
|
||||||
|
### 3. Datetime package supports date and time format and compare.
|
||||||
|
|
||||||
- Support md5, hmac, aes, des, ras.
|
|
||||||
- Usage: import "github.com/duke-git/lancet/cryptor"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/datetime"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/cryptor"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
data := "hello"
|
|
||||||
key := "abcdefghijklmnop"
|
|
||||||
|
|
||||||
encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
|
|
||||||
decrypted := cryptor.AesCbcDecrypt(encrypted, []byte(key))
|
|
||||||
fmt.Println(string(decrypted)) // hello
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### Function list:
|
||||||
|
- [AddDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddDay)
|
||||||
|
- [AddHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddHour)
|
||||||
|
- [AddMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddMinute)
|
||||||
|
- [BeginOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMinute)
|
||||||
|
- [BeginOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfHour)
|
||||||
|
- [BeginOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfDay)
|
||||||
|
- [BeginOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfWeek)
|
||||||
|
- [BeginOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMonth)
|
||||||
|
- [BeginOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfYear)
|
||||||
|
- [EndOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMinute)
|
||||||
|
- [EndOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfHour)
|
||||||
|
- [EndOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfDay)
|
||||||
|
- [EndOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfWeek)
|
||||||
|
- [EndOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMonth)
|
||||||
|
- [EndOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfYear)
|
||||||
|
- [GetNowDate](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowDate)
|
||||||
|
- [GetNowTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowTime)
|
||||||
|
- [GetNowDateTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowDateTime)
|
||||||
|
- [GetZeroHourTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetZeroHourTimestamp)
|
||||||
|
- [GetNightTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNightTimestamp)
|
||||||
|
- [FormatTimeToStr](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatTimeToStr)
|
||||||
|
- [FormatStrToTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatStrToTime)
|
||||||
|
- [NewUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnix)
|
||||||
|
- [NewUnixNow](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnixNow)
|
||||||
|
- [NewFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewFormat)
|
||||||
|
- [NewISO8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewISO8601)
|
||||||
|
- [ToUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToUnix)
|
||||||
|
- [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormat)
|
||||||
|
- [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormatForTpl)
|
||||||
|
- [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToIso8601)
|
||||||
|
|
||||||
- Function list:
|
### 4. Fileutil package implements some basic functions for file operations.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func AesEcbEncrypt(data, key []byte) []byte //AES ECB encrypt
|
import "github.com/duke-git/lancet/fileutil"
|
||||||
func AesEcbDecrypt(encrypted, key []byte) []byte //AES ECB decrypt
|
|
||||||
func AesCbcEncrypt(data, key []byte) []byte //AES CBC encrypt
|
|
||||||
func AesCbcDecrypt(encrypted, key []byte) []byte //AES CBC decrypt
|
|
||||||
func AesCtrCrypt(data, key []byte) []byte //AES CTR encrypt / decrypt
|
|
||||||
func AesCfbEncrypt(data, key []byte) []byte //AES CFB encrypt
|
|
||||||
func AesCfbDecrypt(encrypted, key []byte) []byte //AES CFB decrypt
|
|
||||||
func AesOfbEncrypt(data, key []byte) []byte //AES OFB encrypt
|
|
||||||
func AesOfbDecrypt(data, key []byte) []byte //AES OFB decrypt
|
|
||||||
func Base64StdEncode(s string) string //base64 encode
|
|
||||||
func Base64StdDecode(s string) string //base64 decode
|
|
||||||
func DesCbcEncrypt(data, key []byte) []byte //DES CBC encrypt
|
|
||||||
func DesCbcDecrypt(encrypted, key []byte) []byte //DES CBC decrypt
|
|
||||||
func DesCtrCrypt(data, key []byte) []byte //DES CTR encrypt/decrypt
|
|
||||||
func DesCfbEncrypt(data, key []byte) []byte //DES CFB encrypt
|
|
||||||
func DesCfbDecrypt(encrypted, key []byte) []byte //DES CFB decrypt
|
|
||||||
func DesOfbEncrypt(data, key []byte) []byte //DES OFB encrypt
|
|
||||||
func DesOfbDecrypt(data, key []byte) []byte //DES OFB decrypt
|
|
||||||
func HmacMd5(data, key string) string //get hmac md5 value
|
|
||||||
func HmacSha1(data, key string) string //get hmac sha1 value
|
|
||||||
func HmacSha256(data, key string) string //get hmac sha256 value
|
|
||||||
func HmacSha512(data, key string) string //get hmac sha512 value
|
|
||||||
func Md5String(s string) string //return the md5 value of string
|
|
||||||
func Md5File(filename string) (string, error) //return the md5 value of file
|
|
||||||
func Sha1(data string) string //get sha1 value
|
|
||||||
func Sha256(data string) string //getsha256 value
|
|
||||||
func Sha512(data string) string //get sha512 value
|
|
||||||
func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) //generate RSA pem file
|
|
||||||
func RsaEncrypt(data []byte, pubKeyFileName string) []byte //RSA encrypt
|
|
||||||
func RsaDecrypt(data []byte, privateKeyFileName string) []byte //RSA decrypt
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 3. datetime parse and format datetime
|
#### Function list:
|
||||||
|
|
||||||
- Parse and format datetime
|
- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile)
|
||||||
- Usage: import "github.com/duke-git/lancet/datetime"
|
- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile)
|
||||||
|
- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir)
|
||||||
|
- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile)
|
||||||
|
- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode)
|
||||||
|
- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType)
|
||||||
|
- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist)
|
||||||
|
- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink)
|
||||||
|
- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir)
|
||||||
|
- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames)
|
||||||
|
- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile)
|
||||||
|
- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString)
|
||||||
|
- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine)
|
||||||
|
- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip)
|
||||||
|
- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip)
|
||||||
|
|
||||||
|
### 5. Formatter contains some functions for data formatting.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/formatter"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/datetime"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
now := time.Now()
|
|
||||||
s := datetime.FormatTimeToStr(now, "yyyy-mm-dd hh:mm:ss")
|
|
||||||
fmt.Println(s) // 2021-11-24 11:16:55
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### Function list:
|
||||||
|
- [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma)
|
||||||
|
|
||||||
- Function list:
|
### Function package can control the flow of function execution and support part of functional programming
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func AddDay(t time.Time, day int64) time.Time //add or sub days to time
|
import "github.com/duke-git/lancet/function"
|
||||||
func AddHour(t time.Time, hour int64) time.Time //add or sub hours to time
|
|
||||||
func AddMinute(t time.Time, minute int64) time.Time //add or sub minutes to time
|
|
||||||
func GetNowDate() string //get current date, format is yyyy-mm-dd
|
|
||||||
func GetNowTime() string //get current time, format is hh:mm:ss
|
|
||||||
func GetNowDateTime() string //get current date and time, format is yyyy-mm-dd hh:mm:ss
|
|
||||||
func GetZeroHourTimestamp() int64 //return timestamp of zero hour (timestamp of 00:00)
|
|
||||||
func GetNightTimestamp() int64 //return timestamp of zero hour (timestamp of 23:59)
|
|
||||||
func FormatTimeToStr(t time.Time, format string) string //convert time to string
|
|
||||||
func FormatStrToTime(str, format string) time.Time //convert string to time
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 4. fileutil basic functions for file operations
|
#### Function list:
|
||||||
|
- [After](https://github.com/duke-git/lancet/blob/main/docs/function.md#After)
|
||||||
|
- [Before](https://github.com/duke-git/lancet/blob/main/docs/function.md#Before)
|
||||||
|
- [Curry](https://github.com/duke-git/lancet/blob/main/docs/function.md#Curry)
|
||||||
|
- [Compose](https://github.com/duke-git/lancet/blob/main/docs/function.md#Compose)
|
||||||
|
- [Debounced](https://github.com/duke-git/lancet/blob/main/docs/function.md#Debounced)
|
||||||
|
- [Delay](https://github.com/duke-git/lancet/blob/main/docs/function.md#Delay)
|
||||||
|
- [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function.md#Watcher)
|
||||||
|
|
||||||
- Basic functions for file operations.
|
|
||||||
- Usage: import "github.com/duke-git/lancet/fileutil"
|
### 6. Mathutil package implements some functions for math calculation.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/mathutil"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/fileutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
fmt.Println(fileutil.IsDir("./")) // true
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Function list:
|
#### Function list:
|
||||||
|
- [Exponent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Exponent)
|
||||||
|
- [Fibonacci](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Fibonacci)
|
||||||
|
- [Factorial](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Factorial)
|
||||||
|
- [Percent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Percent)
|
||||||
|
- [RoundToFloat](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToFloat)
|
||||||
|
- [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToString)
|
||||||
|
- [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound)
|
||||||
|
|
||||||
|
|
||||||
|
### 7. Netutil package contains functions to get net information and send http request.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func ClearFile(path string) error //write empty string to path file
|
import "github.com/duke-git/lancet/netutil"
|
||||||
func CreateFile(path string) bool // create a file in path
|
|
||||||
func CopyFile(srcFilePath string, dstFilePath string) error //copy src file to dst file
|
|
||||||
func IsExist(path string) bool //checks if a file or directory exists
|
|
||||||
func IsDir(path string) bool //checks if the path is directy or not
|
|
||||||
func ListFileNames(path string) ([]string, error) //return all file names in the path
|
|
||||||
func RemoveFile(path string) error //remove the path file
|
|
||||||
func ReadFileToString(path string) (string, error) //return string of file content
|
|
||||||
func ReadFileByLine(path string)([]string, error) //read file content by line
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 5. formatter is for data format
|
#### Function list:
|
||||||
|
- [ConvertMapToQueryString](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ConvertMapToQueryString)
|
||||||
|
- [EncodeUrl](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#EncodeUrl)
|
||||||
|
- [GetInternalIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetInternalIp)
|
||||||
|
- [GetIps](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetIps)
|
||||||
|
- [GetMacAddrs](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetMacAddrs)
|
||||||
|
- [GetPublicIpInfo](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetPublicIpInfo)
|
||||||
|
- [GetRequestPublicIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetRequestPublicIp)
|
||||||
|
- [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsPublicIP)
|
||||||
|
- [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsInternalIP)
|
||||||
|
- [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpGet)
|
||||||
|
- [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpDelete)
|
||||||
|
- [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPost)
|
||||||
|
- [HttpPut](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPut)
|
||||||
|
- [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch)
|
||||||
|
- [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ParseHttpResponse)
|
||||||
|
|
||||||
- Contain some formatting function
|
### 8. Random package implements some basic functions to generate random int and string.
|
||||||
- Usage: import "github.com/duke-git/lancet/formatter"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/random"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/formatter"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
fmt.Println(formatter.Comma("12345", "")) // "12,345"
|
|
||||||
fmt.Println(formatter.Comma(12345.67, "¥")) // "¥12,345.67"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Function list:
|
#### Function list:
|
||||||
|
- [RandBytes](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandBytes)
|
||||||
|
- [RandInt](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandInt)
|
||||||
|
- [RandString](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandString)
|
||||||
|
- [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4)
|
||||||
|
|
||||||
|
### 9. Retry package is for executing a function repeatedly until it was successful or canceled by the context.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func Comma(v interface{}, symbol string) string //add comma to number by every 3 numbers from right. ahead by symbol char
|
import "github.com/duke-git/lancet/retry"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 6. function can control the function execution and support functional programming
|
#### Function list:
|
||||||
|
- [Context](https://github.com/duke-git/lancet/blob/main/docs/retry.md#Context)
|
||||||
|
- [Retry](https://github.com/duke-git/lancet/blob/main/docs/retry.md#Retry)
|
||||||
|
- [RetryFunc](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryFunc)
|
||||||
|
- [RetryDuration](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryDuration)
|
||||||
|
- [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryTimes)
|
||||||
|
|
||||||
- Control function execution and support functional programming.
|
### 10. Slice contains some functions to manipulate slice.
|
||||||
- Usage: import "github.com/duke-git/lancet/function"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/slice"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/function"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
var print = func(s string) {
|
|
||||||
fmt.Println(s)
|
|
||||||
}
|
|
||||||
function.Delay(2*time.Second, print, "hello world")
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Function list:
|
#### Function list:
|
||||||
|
- [AppendIfAbsent](https://github.com/duke-git/lancet/blob/main/docs/slice.md#AppendIfAbsent)
|
||||||
|
- [Contain](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Contain)
|
||||||
|
- [ContainSubSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ContainSubSlice)
|
||||||
|
- [Chunk](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Chunk)
|
||||||
|
- [Compact](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Compact)
|
||||||
|
- [Concat](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Concat)
|
||||||
|
- [Count](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Count)
|
||||||
|
- [Difference](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Difference)
|
||||||
|
- [DifferenceBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DifferenceBy)
|
||||||
|
- [DeleteByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DeleteByIndex)
|
||||||
|
- [Drop](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Drop)
|
||||||
|
- [Every](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Every)
|
||||||
|
- [Equal](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Equal)
|
||||||
|
- [EqualWith](https://github.com/duke-git/lancet/blob/main/docs/slice.md#EqualWith)
|
||||||
|
- [Filter](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Filter)
|
||||||
|
- [Find](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Find)
|
||||||
|
- [FindLast](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FindLast)
|
||||||
|
- [FlattenDeep](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FlattenDeep)
|
||||||
|
- [ForEach](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ForEach)
|
||||||
|
- [GroupBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#GroupBy)
|
||||||
|
- [IntSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#IntSlice)
|
||||||
|
- [IndexOf](https://github.com/duke-git/lancet/blob/main/docs/slice.md#IndexOf)
|
||||||
|
- [LastIndexOf](https://github.com/duke-git/lancet/blob/main/docs/slice.md#LastIndexOf)
|
||||||
|
- [InterfaceSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#InterfaceSlice)
|
||||||
|
- [Intersection](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Intersection)
|
||||||
|
- [InsertByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#InsertByIndex)
|
||||||
|
- [Map](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Map)
|
||||||
|
- [ReverseSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ReverseSlice)
|
||||||
|
- [Reduce](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Reduce)
|
||||||
|
- [Shuffle](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Shuffle)
|
||||||
|
- [SortByField](https://github.com/duke-git/lancet/blob/main/docs/slice.md#SortByField)
|
||||||
|
- [Some](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Some)
|
||||||
|
- [StringSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#StringSlice)
|
||||||
|
- [ToSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ToSlice)
|
||||||
|
- [ToSlicePointer](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ToSlice)
|
||||||
|
- [Unique](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Unique)
|
||||||
|
- [UniqueBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UniqueBy)
|
||||||
|
- [Union](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Union)
|
||||||
|
- [UpdateByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UpdateByIndex)
|
||||||
|
- [Without](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Without)
|
||||||
|
|
||||||
|
### 11. Strutil package contains some functions to manipulate string.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value //creates a function that invokes func once it's called n or more times
|
import "github.com/duke-git/lancet/strutil"
|
||||||
func Before(n int, fn interface{}) func(args ...interface{}) []reflect.Value //creates a function that invokes func once it's called less than n times
|
|
||||||
func (f Fn) Curry(i interface{}) func(...interface{}) interface{} //make a curryed function
|
|
||||||
func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) interface{} //compose the functions from right to left
|
|
||||||
func Delay(delay time.Duration, fn interface{}, args ...interface{}) //invoke function after delayed time
|
|
||||||
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool //invoke function every duration time, util close the returned bool chan
|
|
||||||
func (w *Watcher) Start() //start the watch timer.
|
|
||||||
func (w *Watcher) Stop() //stop the watch timer
|
|
||||||
func (w *Watcher) Reset() {} //reset the watch timer.
|
|
||||||
func (w *Watcher) GetElapsedTime() time.Duration //获取代码段运行时间
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 7. netutil is for net process
|
#### Function list:
|
||||||
|
|
||||||
- Ip and http request method.
|
- [After](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#After)
|
||||||
- Usage: import "github.com/duke-git/lancet/netutil".
|
- [AfterLast](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#AfterLast)
|
||||||
- The Http function params order:url, header, query string, body, httpclient.
|
- [Before](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Before)
|
||||||
|
- [BeforeLast](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#BeforeLast)
|
||||||
|
- [CamelCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#CamelCase)
|
||||||
|
- [Capitalize](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Capitalize)
|
||||||
|
- [IsString](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#IsString)
|
||||||
|
- [KebabCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#KebabCase)
|
||||||
|
- [LowerFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#LowerFirst)
|
||||||
|
- [UpperFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#UpperFirst)
|
||||||
|
- [PadEnd](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#PadEnd)
|
||||||
|
- [PadStart](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#PadStart)
|
||||||
|
- [ReverseStr](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#ReverseStr)
|
||||||
|
- [SnakeCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#SnakeCase)
|
||||||
|
- [SplitEx](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#SplitEx)
|
||||||
|
- [Wrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Wrap)
|
||||||
|
- [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Unwrap)
|
||||||
|
|
||||||
|
### 12. System package contain some functions about os, runtime, shell command.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/system"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/netutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
url := "https://gutendex.com/books?"
|
|
||||||
header := make(map[string]string)
|
|
||||||
header["Content-Type"] = "application/json"
|
|
||||||
queryParams := make(map[string]interface{})
|
|
||||||
queryParams["ids"] = "1"
|
|
||||||
|
|
||||||
resp, err := netutil.HttpGet(url, header, queryParams)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Function list:
|
#### Function list:
|
||||||
|
- [IsWindows](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsWindows)
|
||||||
|
- [IsLinux](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsLinux)
|
||||||
|
- [IsMac](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsMac)
|
||||||
|
- [GetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#GetOsEnv)
|
||||||
|
- [SetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#SetOsEnv)
|
||||||
|
- [RemoveOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#RemoveOsEnv)
|
||||||
|
- [CompareOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#CompareOsEnv)
|
||||||
|
- [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system.md#ExecCommand)
|
||||||
|
- [GetOsBits](https://github.com/duke-git/lancet/blob/main/docs/system.md#GetOsBits)
|
||||||
|
|
||||||
|
### 13. Validator package contains some functions for data validation.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func GetInternalIp() string //get internal ip
|
import "github.com/duke-git/lancet/validator"
|
||||||
func GetPublicIpInfo() (*PublicIpInfo, error) //get public ip info: country, region, isp, city, lat, lon, ip
|
|
||||||
func IsPublicIP(IP net.IP) bool //判断ip是否为公共ip
|
|
||||||
func HttpGet(url string, params ...interface{}) (*http.Response, error) //http get request
|
|
||||||
func HttpPost(url string, params ...interface{}) (*http.Response, error) //http post request
|
|
||||||
func HttpPut(url string, params ...interface{}) (*http.Response, error) //http put request
|
|
||||||
func HttpDelete(url string, params ...interface{}) (*http.Response, error) //http delete request
|
|
||||||
func HttpPatch(url string, params ...interface{}) (*http.Response, error) //http patch request
|
|
||||||
func ConvertMapToQueryString(param map[string]interface{}) string //convert map to url query string
|
|
||||||
func ParseHttpResponse(resp *http.Response, obj interface{}) error //decode http response to specified interface
|
|
||||||
```
|
```
|
||||||
|
#### Function list:
|
||||||
|
|
||||||
#### 8. random is for rand string and int generation
|
- [ContainChinese](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainChinese)
|
||||||
|
- [ContainLetter](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainLetter)
|
||||||
|
- [ContainLower](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainLower)
|
||||||
|
- [ContainUpper](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainUpper)
|
||||||
|
- [IsAlpha](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAlpha)
|
||||||
|
- [IsAllUpper](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAllUpper)
|
||||||
|
- [IsAllLower](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAllLower)
|
||||||
|
- [IsBase64](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsBase64)
|
||||||
|
- [IsChineseMobile](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChineseMobile)
|
||||||
|
- [IsChineseIdNum](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChineseIdNum)
|
||||||
|
- [IsChinesePhone](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChinesePhone)
|
||||||
|
- [IsCreditCard](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsCreditCard)
|
||||||
|
- [IsDns](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsDns)
|
||||||
|
- [IsEmail](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsEmail)
|
||||||
|
- [IsEmptyString](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsEmptyString)
|
||||||
|
- [IsFloatStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsFloatStr)
|
||||||
|
- [IsNumberStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsNumberStr)
|
||||||
|
- [IsJSON](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsJSON)
|
||||||
|
- [IsRegexMatch](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsRegexMatch)
|
||||||
|
- [IsIntStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIntStr)
|
||||||
|
- [IsIp](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIp)
|
||||||
|
- [IsIpV4](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIpV4)
|
||||||
|
- [IsIpV6](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIpV6)
|
||||||
|
- [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword)
|
||||||
|
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl)
|
||||||
|
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword)
|
||||||
|
|
||||||
|
|
||||||
- Generate random string and int.
|
## How to Contribute
|
||||||
- Usage: import "github.com/duke-git/lancet/random".
|
|
||||||
|
|
||||||
```go
|
I really appreciate any code commits which make lancet lib powerful. Please follow the rules below to create your pull request.
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
1. Fork the repository.
|
||||||
"fmt"
|
2. Create your feature branch.
|
||||||
"io/ioutil"
|
3. Commit your changes.
|
||||||
"log"
|
4. Push to the branch
|
||||||
"github.com/duke-git/lancet/random"
|
5. Create new pull request.
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
randStr := random.RandString(6)
|
|
||||||
fmt.Println(randStr)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func RandBytes(length int) []byte //generate random []byte
|
|
||||||
func RandInt(min, max int) int //generate random int
|
|
||||||
func RandString(length int) string //generate random string
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 9. slice is for process slice
|
|
||||||
|
|
||||||
- Contain function for process slice.
|
|
||||||
- Usage: import "github.com/duke-git/lancet/slice"
|
|
||||||
- Due to the unstable support of generic, most of the slice processing function parameter and return value is interface {}. After go generic is stable, the related functions will be refactored.
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/slice"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
nums := []int{1, 4, 3, 4, 6, 7, 3}
|
|
||||||
uniqueNums, _ := slice.IntSlice(slice.Unique(nums))
|
|
||||||
fmt.Println(uniqueNums) //[1 4 3 6 7]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func Contain(slice interface{}, value interface{}) bool //check if the value is in the slice or not
|
|
||||||
func Chunk(slice []interface{}, size int) [][]interface{} //creates an slice of elements split into groups the length of `size`.
|
|
||||||
func ConvertSlice(originalSlice interface{}, newSliceType reflect.Type) interface{} //convert originalSlice to newSliceType
|
|
||||||
func Difference(slice1, slice2 interface{}) interface{} //creates an slice of whose element not included in the other given slice
|
|
||||||
func DeleteByIndex(slice interface{}, start int, end ...int) (interface{}, error) //delete the element of slice from start index to end index - 1
|
|
||||||
func Drop(slice interface{}, n int) interface{} //creates a slice with `n` elements dropped from the beginning when n > 0, or `n` elements dropped from the ending when n < 0
|
|
||||||
func Every(slice, function interface{}) bool //return true if all of the values in the slice pass the predicate function, function signature should be func(index int, value interface{}) bool
|
|
||||||
func Filter(slice, function interface{}) interface{} //filter slice, function signature should be func(index int, value interface{}) bool
|
|
||||||
func Find(slice, function interface{}) (interface{}, bool) //iterates over elements of slice, returning the first one that passes a truth test on function.function signature should be func(index int, value interface{}) bool .
|
|
||||||
func FlattenDeep(slice interface{}) interface{} //flattens slice recursive
|
|
||||||
func IntSlice(slice interface{}) ([]int, error) //convert value to int slice
|
|
||||||
func InterfaceSlice(slice interface{}) []interface{} //convert value to interface{} slice
|
|
||||||
func Intersection(slices ...interface{}) interface{} //creates a slice of unique values that included by all slices.
|
|
||||||
func InsertByIndex(slice interface{}, index int, value interface{}) (interface{}, error) //insert the element into slice at index.
|
|
||||||
func Map(slice, function interface{}) interface{} //map lisce, function signature should be func(index int, value interface{}) interface{}
|
|
||||||
func ReverseSlice(slice interface{}) //revere slice
|
|
||||||
func Reduce(slice, function, zero interface{}) interface{} //reduce slice, function signature should be func(index int, value1, value2 interface{}) interface{}
|
|
||||||
func Shuffle(slice interface{}) interface{} //creates an slice of shuffled values
|
|
||||||
func SortByField(slice interface{}, field string, sortType ...string) error //sort struct slice by field
|
|
||||||
func Some(slice, function interface{}) bool //return true if any of the values in the list pass the predicate function, function signature should be func(index int, value interface{}) bool
|
|
||||||
func StringSlice(slice interface{}) []string //convert value to string slice
|
|
||||||
func Unique(slice interface{}) interface{} //remove duplicate elements in slice
|
|
||||||
func Union(slices ...interface{}) interface{} //Union creates a slice of unique values, in order, from all given slices. using == for equality comparisons.
|
|
||||||
func UpdateByIndex(slice interface{}, index int, value interface{}) (interface{}, error) //update the slice element at index.
|
|
||||||
func Without(slice interface{}, values ...interface{}) interface{} //creates a slice excluding all given values
|
|
||||||
func GroupBy(slice, function interface{}) (interface{}, interface{}) // groups slice into two categories
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 10. strutil is for processing string
|
|
||||||
|
|
||||||
- Contain functions to precess string
|
|
||||||
- Usage: import "github.com/duke-git/lancet/strutil"
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/strutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
str := "Foo-Bar"
|
|
||||||
camelCaseStr := strutil.CamelCase(str)
|
|
||||||
fmt.Println(camelCaseStr) //fooBar
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func After(s, char string) string //create substring in source string after position when char first appear
|
|
||||||
func AfterLast(s, char string) string //create substring in source string after position when char last appear
|
|
||||||
func Before(s, char string) string //create substring in source string before position when char first appear
|
|
||||||
func BeforeLast(s, char string) string //create substring in source string before position when char last appear
|
|
||||||
func CamelCase(s string) string //covert string to camelCase string. "foo bar" -> "fooBar"
|
|
||||||
func Capitalize(s string) string //convert the first character of a string to upper case, "fOO" -> "Foo"
|
|
||||||
func IsString(v interface{}) bool //check if the value data type is string or not
|
|
||||||
func KebabCase(s string) string //covert string to kebab-case, "foo_Bar" -> "foo-bar"
|
|
||||||
func LowerFirst(s string) string //convert the first character of string to lower case
|
|
||||||
func PadEnd(source string, size int, padStr string) string //pads string on the right side if it's shorter than size
|
|
||||||
func PadStart(source string, size int, padStr string) string//pads string on the left side if it's shorter than size
|
|
||||||
func ReverseStr(s string) string //return string whose char order is reversed to the given string
|
|
||||||
func SnakeCase(s string) string //covert string to snake_case "fooBar" -> "foo_bar"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 11. validator is for data validation
|
|
||||||
|
|
||||||
- Contain function for data validation.
|
|
||||||
- Usage: import "github.com/duke-git/lancet/validator".
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/validator"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
str := "Foo-Bar"
|
|
||||||
isAlpha := validator.IsAlpha(str)
|
|
||||||
fmt.Println(isAlpha) //false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func ContainChinese(s string) bool //check if the string contain mandarin chinese
|
|
||||||
func IsAlpha(s string) bool //checks if the string contains only letters (a-zA-Z)
|
|
||||||
func IsBase64(base64 string) bool //check if the string is base64 string
|
|
||||||
func IsChineseMobile(mobileNum string) bool //check if the string is chinese mobile number
|
|
||||||
func IsChineseIdNum(id string) bool //check if the string is chinese id number
|
|
||||||
func IsChinesePhone(phone string) bool //check if the string is chinese phone number
|
|
||||||
func IsCreditCard(creditCart string) bool //check if the string is credit card
|
|
||||||
func IsDns(dns string) bool //check if the string is dns
|
|
||||||
func IsEmail(email string) bool //check if the string is a email address
|
|
||||||
func IsEmptyString(s string) bool //check if the string is empty
|
|
||||||
func IsFloatStr(s string) bool //check if the string can convert to a float
|
|
||||||
func IsNumberStr(s string) bool //check if the string can convert to a number
|
|
||||||
func IsRegexMatch(s, regex string) bool //check if the string match the regexp
|
|
||||||
func IsIntStr(s string) bool //check if the string can convert to a integer
|
|
||||||
func IsIp(ipstr string) bool //check if the string is a ip address
|
|
||||||
func IsIpV4(ipstr string) bool //check if the string is a ipv4 address
|
|
||||||
func IsIpV6(ipstr string) bool //check if the string is a ipv6 address
|
|
||||||
func IsStrongPassword(password string, length int) bool //check if the string is strong password (alpha(lower+upper) + number + special chars(!@#$%^&*()?><))
|
|
||||||
func IsWeakPassword(password string) bool //check if the string is weak password(only letter or only number or letter + number)
|
|
||||||
```
|
|
||||||
689
README_zh-CN.md
689
README_zh-CN.md
@@ -1,37 +1,40 @@
|
|||||||
<div align="center">
|
<div align=center>
|
||||||
<h1 style="width: 100%; text-align: center;">Lancet</h1>
|
<img src="./logo.png" width="200" height="200"/>
|
||||||
<p style="font-size: 18px">
|
|
||||||
lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。
|
|
||||||
</p>
|
|
||||||
<div align="center" style="text-align: center;">
|
|
||||||
|
|
||||||

|
<br/>
|
||||||
[](https://github.com/duke-git/lancet/releases)
|
|
||||||
|

|
||||||
|
[](https://github.com/duke-git/lancet/releases)
|
||||||
[](https://pkg.go.dev/github.com/duke-git/lancet)
|
[](https://pkg.go.dev/github.com/duke-git/lancet)
|
||||||
[](https://goreportcard.com/report/github.com/duke-git/lancet)
|
[](https://goreportcard.com/report/github.com/duke-git/lancet)
|
||||||
|
[](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
|
||||||
[](https://codecov.io/gh/duke-git/lancet)
|
[](https://codecov.io/gh/duke-git/lancet)
|
||||||
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
<p style="font-size: 18px">
|
||||||
|
lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。
|
||||||
|
</p>
|
||||||
|
|
||||||
简体中文 | [English](./README.md)
|
简体中文 | [English](./README.md)
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### 特性
|
## 特性
|
||||||
|
|
||||||
- 👏 全面、高效、可复用
|
- 👏 全面、高效、可复用
|
||||||
- 💪 140+常用go工具函数,支持string、slice、datetime、net、crypt...
|
- 💪 200+常用go工具函数,支持string、slice、datetime、net、crypt...
|
||||||
- 💅 只依赖go标准库
|
- 💅 只依赖go标准库
|
||||||
- 🌍 所有导出函数单元测试覆盖率100%
|
- 🌍 所有导出函数单元测试覆盖率100%
|
||||||
|
|
||||||
### 安装
|
## 安装
|
||||||
|
|
||||||
```go
|
```go
|
||||||
go get github.com/duke-git/lancet
|
go get github.com/duke-git/lancet
|
||||||
```
|
```
|
||||||
|
|
||||||
### 用法
|
## 用法
|
||||||
|
|
||||||
lancet是以包的结构组织代码的,使用时需要导入相应的包名。例如:如果使用字符串相关函数,需要导入strutil包:
|
lancet是以包的结构组织代码的,使用时需要导入相应的包名。例如:如果使用字符串相关函数,需要导入strutil包:
|
||||||
|
|
||||||
@@ -39,7 +42,7 @@ lancet是以包的结构组织代码的,使用时需要导入相应的包名
|
|||||||
import "github.com/duke-git/lancet/strutil"
|
import "github.com/duke-git/lancet/strutil"
|
||||||
```
|
```
|
||||||
|
|
||||||
### 例子
|
## 例子
|
||||||
|
|
||||||
此处以字符串工具函数ReverseStr(逆序字符串)为例,需要导入strutil包:
|
此处以字符串工具函数ReverseStr(逆序字符串)为例,需要导入strutil包:
|
||||||
|
|
||||||
@@ -58,446 +61,346 @@ func main() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### API文档
|
## API文档
|
||||||
|
### 1. convertor转换器包支持一些常见的数据类型转换。
|
||||||
#### 1. convertor数据转换包
|
|
||||||
|
|
||||||
- 转换函数支持常用数据类型之间的转换
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/convertor"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/convertor"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/convertor"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
s := "12.3"
|
|
||||||
f, err := convertor.ToFloat(s)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Errorf("error is %s", err.Error())
|
|
||||||
}
|
|
||||||
fmt.Println(f) // 12.3
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### 函数列表:
|
||||||
- 函数列表:
|
- [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)
|
||||||
|
- [ColorRGBToHex](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorRGBToHex)
|
||||||
|
- [ToBool](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBool)
|
||||||
|
- [ToBytes](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBytes)
|
||||||
|
- [ToChar](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChar)
|
||||||
|
- [ToChannel](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChannel)
|
||||||
|
- [ToInt](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToInt)
|
||||||
|
- [ToJson](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToJson)
|
||||||
|
- [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToString)
|
||||||
|
- [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#StructToMap)
|
||||||
|
|
||||||
|
### 2. cryptor加密包支持数据加密和解密,获取md5,hash值。支持base64, md5, hmac, aes, des, rsa。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func ColorHexToRGB(colorHex string) (red, green, blue int) //颜色值16进制转rgb
|
import "github.com/duke-git/lancet/cryptor"
|
||||||
func ColorRGBToHex(red, green, blue int) string //颜色值rgb转16进制
|
|
||||||
func ToBool(s string) (bool, error) //字符串转成Bool
|
|
||||||
func ToBytes(data interface{}) ([]byte, error) //interface转成byte slice
|
|
||||||
func ToChar(s string) []string //字符串转成字符slice
|
|
||||||
func ToFloat(value interface{}) (float64, error) //interface转成float64
|
|
||||||
func ToInt(value interface{}) (int64, error) //interface转成int64
|
|
||||||
func ToJson(value interface{}) (string, error) //interface转成json string
|
|
||||||
func ToString(value interface{}) string //interface转成string
|
|
||||||
func StructToMap(value interface{}) (map[string]interface{}, error) //struct串转成map, 需要设置struct tag `json`
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2. cryptor加解密包
|
#### 函数列表:
|
||||||
|
- [AesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesEcbEncrypt)
|
||||||
|
- [AesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesEcbDecrypt)
|
||||||
|
- [AesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesCbcEncrypt)
|
||||||
|
- [AesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesCbcDecrypt)
|
||||||
|
- [AesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesCtrCrypt)
|
||||||
|
- [AesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesCfbEncrypt)
|
||||||
|
- [AesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesCfbDecrypt)
|
||||||
|
- [AesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesOfbEncrypt)
|
||||||
|
- [AesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#AesOfbDecrypt)
|
||||||
|
- [Base64StdEncode](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Base64StdEncode)
|
||||||
|
- [Base64StdDecode](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Base64StdDecode)
|
||||||
|
- [DesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesEcbEncrypt)
|
||||||
|
- [DesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesEcbDecrypt)
|
||||||
|
- [DesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesCbcEncrypt)
|
||||||
|
- [DesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesCbcDecrypt)
|
||||||
|
- [DesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesCtrCrypt)
|
||||||
|
- [DesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesCfbEncrypt)
|
||||||
|
- [DesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesCfbDecrypt)
|
||||||
|
- [DesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesOfbEncrypt)
|
||||||
|
- [DesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#DesOfbDecrypt)
|
||||||
|
- [HmacMd5](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#HmacMd5)
|
||||||
|
- [HmacSha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#HmacSha1)
|
||||||
|
- [HmacSha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#HmacSha256)
|
||||||
|
- [HmacSha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#HmacSha512)
|
||||||
|
- [Md5String](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Md5String)
|
||||||
|
- [Md5File](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Md5File)
|
||||||
|
- [Sha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Sha1)
|
||||||
|
- [Sha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Sha256)
|
||||||
|
- [Sha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#Sha512)
|
||||||
|
- [GenerateRsaKey](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#GenerateRsaKey)
|
||||||
|
- [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaEncrypt)
|
||||||
|
- [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaDecrypt)
|
||||||
|
|
||||||
|
### 3. datetime日期时间处理包,格式化日期,比较日期。
|
||||||
|
|
||||||
- 加密函数支持md5, hmac, aes, des, ras
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/cryptor"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/datetime"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/cryptor"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
data := "hello"
|
|
||||||
key := "abcdefghijklmnop"
|
|
||||||
|
|
||||||
encrypted := cryptor.AesCbcEncrypt([]byte(data), []byte(key))
|
|
||||||
decrypted := cryptor.AesCbcDecrypt(encrypted, []byte(key))
|
|
||||||
fmt.Println(string(decrypted)) // hello
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### 函数列表:
|
||||||
- 函数列表:
|
- [AddDay](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#AddDay)
|
||||||
|
- [AddHour](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#AddHour)
|
||||||
|
- [AddMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#AddMinute)
|
||||||
|
- [BeginOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMinute)
|
||||||
|
- [BeginOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfHour)
|
||||||
|
- [BeginOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfDay)
|
||||||
|
- [BeginOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfWeek)
|
||||||
|
- [BeginOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMonth)
|
||||||
|
- [BeginOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfYear)
|
||||||
|
- [EndOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMinute)
|
||||||
|
- [EndOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfHour)
|
||||||
|
- [EndOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfDay)
|
||||||
|
- [EndOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfWeek)
|
||||||
|
- [EndOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMonth)
|
||||||
|
- [EndOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfYear)
|
||||||
|
- [GetNowDate](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetNowDate)
|
||||||
|
- [GetNowTime](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetNowTime)
|
||||||
|
- [GetNowDateTime](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetNowDateTime)
|
||||||
|
- [GetZeroHourTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetZeroHourTimestamp)
|
||||||
|
- [GetNightTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#GetNightTimestamp)
|
||||||
|
- [FormatTimeToStr](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#FormatTimeToStr)
|
||||||
|
- [FormatStrToTime](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#FormatStrToTime)
|
||||||
|
- [NewUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewUnix)
|
||||||
|
- [NewUnixNow](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewUnixNow)
|
||||||
|
- [NewFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewFormat)
|
||||||
|
- [NewISO8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#NewISO8601)
|
||||||
|
- [ToUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToUnix)
|
||||||
|
- [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormat)
|
||||||
|
- [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormatForTpl)
|
||||||
|
- [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToIso8601)
|
||||||
|
### 4. fileutil包支持文件基本操作。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func AesEcbEncrypt(data, key []byte) []byte //AES ECB模式加密
|
import "github.com/duke-git/lancet/fileutil"
|
||||||
func AesEcbDecrypt(encrypted, key []byte) []byte //AES ECB模式解密
|
|
||||||
func AesCbcEncrypt(data, key []byte) []byte //AES CBC模式加密
|
|
||||||
func AesCbcDecrypt(encrypted, key []byte) []byte //AES CBC模式解密
|
|
||||||
func AesCtrCrypt(data, key []byte) []byte //AES CTR模式加密/解密
|
|
||||||
func AesCfbEncrypt(data, key []byte) []byte //AES CFB模式加密
|
|
||||||
func AesCfbDecrypt(encrypted, key []byte) []byte //AES CFB模式解密
|
|
||||||
func AesOfbEncrypt(data, key []byte) []byte //AES OFB模式加密
|
|
||||||
func AesOfbDecrypt(data, key []byte) []byte //AES OFB模式解密
|
|
||||||
func Base64StdEncode(s string) string //base64编码
|
|
||||||
func Base64StdDecode(s string) string //base64解码
|
|
||||||
func DesCbcEncrypt(data, key []byte) []byte //DES CBC模式加密
|
|
||||||
func DesCbcDecrypt(encrypted, key []byte) []byte //DES CBC模式解密
|
|
||||||
func DesCtrCrypt(data, key []byte) []byte //DES CTR模式加密/解密
|
|
||||||
func DesCfbEncrypt(data, key []byte) []byte //DES CFB模式加密
|
|
||||||
func DesCfbDecrypt(encrypted, key []byte) []byte //DES CFB模式解密
|
|
||||||
func DesOfbEncrypt(data, key []byte) []byte //DES OFB模式加密
|
|
||||||
func DesOfbDecrypt(data, key []byte) []byte //DES OFB模式解密
|
|
||||||
func HmacMd5(data, key string) string //获取hmac md5值
|
|
||||||
func HmacSha1(data, key string) string //获取hmac sha1值
|
|
||||||
func HmacSha256(data, key string) string //获取hmac sha256值
|
|
||||||
func HmacSha512(data, key string) string //获取hmac sha512值
|
|
||||||
func Md5String(s string) string //获取字符串md5值
|
|
||||||
func Md5File(filename string) (string, error) //获取文件md5值
|
|
||||||
func Sha1(data string) string //获取sha1值
|
|
||||||
func Sha256(data string) string //获取sha256值
|
|
||||||
func Sha512(data string) string //获取sha512值
|
|
||||||
func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) //生成RSA私钥文件
|
|
||||||
func RsaEncrypt(data []byte, pubKeyFileName string) []byte //RSA加密
|
|
||||||
func RsaDecrypt(data []byte, privateKeyFileName string) []byte //RSA解密
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 3. datetime日期时间处理包
|
#### 函数列表:
|
||||||
|
|
||||||
- 处理日期时间
|
- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile)
|
||||||
- 导入包:import "github.com/duke-git/lancet/datetime"
|
- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile)
|
||||||
|
- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir)
|
||||||
|
- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile)
|
||||||
|
- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode)
|
||||||
|
- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType)
|
||||||
|
- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsExist)
|
||||||
|
- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsLink)
|
||||||
|
- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsDir)
|
||||||
|
- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ListFileNames)
|
||||||
|
- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#RemoveFile)
|
||||||
|
- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileToString)
|
||||||
|
- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileByLine)
|
||||||
|
- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip)
|
||||||
|
- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip)
|
||||||
|
|
||||||
|
### 5. formatter格式化器包含一些数据格式化处理方法。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/formatter"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/datetime"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
now := time.Now()
|
|
||||||
s := datetime.FormatTimeToStr(now, "yyyy-mm-dd hh:mm:ss")
|
|
||||||
fmt.Println(s) // 2021-11-24 11:16:55
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
#### 函数列表:
|
||||||
|
- [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)
|
||||||
|
|
||||||
- 函数列表:
|
|
||||||
|
### function函数包控制函数执行流程,包含部分函数式编程。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func AddDay(t time.Time, day int64) time.Time //加减天数
|
import "github.com/duke-git/lancet/function"
|
||||||
func AddHour(t time.Time, hour int64) time.Time //加减小时数
|
|
||||||
func AddMinute(t time.Time, minute int64) time.Time //加减分钟数
|
|
||||||
func GetNowDate() string //获取当天日期 格式yyyy-mm-dd
|
|
||||||
func GetNowTime() string //获取当前时间 格式hh:mm:ss
|
|
||||||
func GetNowDateTime() string //获取当前日期时间 格式yyyy-mm-dd hh:mm:ss
|
|
||||||
func GetZeroHourTimestamp() int64 //获取当天零时时间戳(00:00)
|
|
||||||
func GetNightTimestamp() int64 //获取当天23时时间戳(23:59)
|
|
||||||
func FormatTimeToStr(t time.Time, format string) string //时间格式化字符串
|
|
||||||
func FormatStrToTime(str, format string) time.Time //字符串转换成时间
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 4. fileutil文件处理包
|
#### 函数列表:
|
||||||
|
- [After](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#After)
|
||||||
|
- [Before](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Before)
|
||||||
|
- [Curry](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Curry)
|
||||||
|
- [Compose](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Compose)
|
||||||
|
- [Debounced](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Debounced)
|
||||||
|
- [Delay](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Delay)
|
||||||
|
- [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Watcher)
|
||||||
|
|
||||||
- 文件处理常用函数
|
### 6. mathutil包实现了一些数学计算的函数。
|
||||||
- 导入包:import "github.com/duke-git/lancet/fileutil"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/mathutil"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/fileutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
fmt.Println(fileutil.IsDir("./")) // true
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- 函数列表:
|
#### Function list:
|
||||||
|
- [Exponent](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Exponent)
|
||||||
|
- [Fibonacci](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Fibonacci)
|
||||||
|
- [Factorial](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Factorial)
|
||||||
|
- [Percent](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Percent)
|
||||||
|
- [RoundToFloat](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToFloat)
|
||||||
|
- [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToString)
|
||||||
|
- [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound)
|
||||||
|
|
||||||
|
### 7. netutil网络包支持获取ip地址,发送http请求。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func ClearFile(path string) error //清空文件内容
|
import "github.com/duke-git/lancet/netutil"
|
||||||
func IsExist(path string) bool //判断文件/目录是否存在
|
|
||||||
func CreateFile(path string) bool //创建文件
|
|
||||||
func IsDir(path string) bool //判断是否为目录
|
|
||||||
func RemoveFile(path string) error //删除文件
|
|
||||||
func CopyFile(srcFilePath string, dstFilePath string) error //复制文件
|
|
||||||
func ListFileNames(path string) ([]string, error) //列出目录下所有文件名称
|
|
||||||
func ReadFileToString(path string) (string, error) //读取文件内容为字符串
|
|
||||||
func ReadFileByLine(path string)([]string, error) //按行读取文件内容
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 5. formatter格式化处理包
|
#### 函数列表:
|
||||||
|
- [ConvertMapToQueryString](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ConvertMapToQueryString)
|
||||||
|
- [EncodeUrl](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#EncodeUrl)
|
||||||
|
- [GetInternalIp](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#GetInternalIp)
|
||||||
|
- [GetIps](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetIps)
|
||||||
|
- [GetMacAddrs](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetMacAddrs)
|
||||||
|
- [GetPublicIpInfo](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#GetPublicIpInfo)
|
||||||
|
- [GetRequestPublicIp](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#GetRequestPublicIp)
|
||||||
|
- [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsPublicIP)
|
||||||
|
- [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsInternalIP)
|
||||||
|
- [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpGet)
|
||||||
|
- [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpDelete)
|
||||||
|
- [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPost)
|
||||||
|
- [HttpPut](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPut)
|
||||||
|
- [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch)
|
||||||
|
- [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse)
|
||||||
|
|
||||||
- 格式化相关处理函数
|
### 8. random随机数生成器包,可以生成随机[]bytes, int, string。
|
||||||
- 导入包:import "github.com/duke-git/lancet/formatter"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/random"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/formatter"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
fmt.Println(formatter.Comma("12345", "")) // "12,345"
|
|
||||||
fmt.Println(formatter.Comma(12345.67, "¥")) // "¥12,345.67"
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- 函数列表:
|
#### 函数列表:
|
||||||
|
- [RandBytes](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandBytes)
|
||||||
|
- [RandInt](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandInt)
|
||||||
|
- [RandString](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandString)
|
||||||
|
- [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4)
|
||||||
|
### 9. retry重试执行函数直到函数运行成功或被context cancel。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func Comma(v interface{}, symbol string) string //用逗号每隔3位分割数字/字符串
|
import "github.com/duke-git/lancet/retry"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 6. function包可以控制函数执行,支持部分函数式编程
|
#### 函数列表:
|
||||||
|
- [Context](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#Context)
|
||||||
|
- [Retry](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#Retry)
|
||||||
|
- [RetryFunc](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryFunc)
|
||||||
|
- [RetryDuration](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryDuration)
|
||||||
|
- [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryTimes)
|
||||||
|
|
||||||
- 控制函数执行,支持部分函数式编程
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/function"
|
### 10. slice包包含操作切片的方法集合。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/slice"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/duke-git/lancet/function"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
var print = func(s string) {
|
|
||||||
fmt.Println(s)
|
|
||||||
}
|
|
||||||
function.Delay(2*time.Second, print, "hello world")
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Function list:
|
#### 函数列表:
|
||||||
|
- [AppendIfAbsent](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#AppendIfAbsent)
|
||||||
|
- [Contain](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Contain)
|
||||||
|
- [ContainSubSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ContainSubSlice)
|
||||||
|
- [Chunk](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Chunk)
|
||||||
|
- [Compact](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Compact)
|
||||||
|
- [Concat](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Concat)
|
||||||
|
- [Count](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Count)
|
||||||
|
- [Difference](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Difference)
|
||||||
|
- [DifferenceBy](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#DifferenceBy)
|
||||||
|
- [DeleteByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#DeleteByIndex)
|
||||||
|
- [Drop](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Drop)
|
||||||
|
- [Every](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Every)
|
||||||
|
- [Equal](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Equal)
|
||||||
|
- [EqualWith](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#EqualWith)
|
||||||
|
- [Filter](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Filter)
|
||||||
|
- [Find](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Find)
|
||||||
|
- [FindLast](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#FindLast)
|
||||||
|
- [FlattenDeep](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FlattenDeep)
|
||||||
|
- [ForEach](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEach)
|
||||||
|
- [GroupBy](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#GroupBy)
|
||||||
|
- [IntSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#IntSlice)
|
||||||
|
- [IndexOf](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#IndexOf)
|
||||||
|
- [LastIndexOf](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#LastIndexOf)
|
||||||
|
- [InterfaceSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#InterfaceSlice)
|
||||||
|
- [Intersection](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Intersection)
|
||||||
|
- [InsertByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#InsertByIndex)
|
||||||
|
- [Map](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Map)
|
||||||
|
- [ReverseSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ReverseSlice)
|
||||||
|
- [Reduce](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Reduce)
|
||||||
|
- [Shuffle](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Shuffle)
|
||||||
|
- [SortByField](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#SortByField)
|
||||||
|
- [Some](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Some)
|
||||||
|
- [StringSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#StringSlice)
|
||||||
|
- [ToSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ToSlice)
|
||||||
|
- [ToSlicePointer](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ToSlice)
|
||||||
|
- [Unique](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Unique)
|
||||||
|
- [UniqueBy](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#UniqueBy)
|
||||||
|
- [Union](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Union)
|
||||||
|
- [UpdateByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#UpdateByIndex)
|
||||||
|
- [Without](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Without)
|
||||||
|
|
||||||
|
|
||||||
|
### 12. strutil包含处理字符串的相关函数。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value //创建一个函数, 只有在运行了n次之后才有效果
|
import "github.com/duke-git/lancet/strutil"
|
||||||
func Before(n int, fn interface{}) func(args ...interface{}) []reflect.Value //创建一个函数,调用不超过n次。 当n已经达到时,最后一个函数调用的结果将被记住并返回
|
|
||||||
func (f Fn) Curry(i interface{}) func(...interface{}) interface{} //函数柯里化
|
|
||||||
func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) interface{} //从右至左组合函数
|
|
||||||
func Delay(delay time.Duration, fn interface{}, args ...interface{}) //延迟调用函数
|
|
||||||
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool //每隔duration时间调用函数, 关闭返回通道可以停止调用
|
|
||||||
func (w *Watcher) Start() //开时watcher
|
|
||||||
func (w *Watcher) Stop() //开时watcher
|
|
||||||
func (w *Watcher) Reset() {} //重置代码watcher
|
|
||||||
func (w *Watcher) GetElapsedTime() time.Duration //get code excution elapsed time.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 7. netutil网络处理包
|
#### 函数列表:
|
||||||
|
|
||||||
- 处理ip, http请求相关函数
|
- [After](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#After)
|
||||||
- 导入包:import "github.com/duke-git/lancet/netutil"
|
- [AfterLast](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#AfterLast)
|
||||||
- http方法params参数顺序:header, query string, body, httpclient
|
- [Before](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Before)
|
||||||
|
- [BeforeLast](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#BeforeLast)
|
||||||
|
- [CamelCase](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#CamelCase)
|
||||||
|
- [Capitalize](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Capitalize)
|
||||||
|
- [IsString](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#IsString)
|
||||||
|
- [KebabCase](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#KebabCase)
|
||||||
|
- [LowerFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#LowerFirst)
|
||||||
|
- [UpperFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#UpperFirst)
|
||||||
|
- [PadEnd](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#PadEnd)
|
||||||
|
- [PadStart](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#PadStart)
|
||||||
|
- [ReverseStr](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#ReverseStr)
|
||||||
|
- [SnakeCase](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#SnakeCase)
|
||||||
|
- [SplitEx](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#SplitEx)
|
||||||
|
- [Wrap](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Wrap)
|
||||||
|
- [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Unwrap)
|
||||||
|
|
||||||
|
|
||||||
|
### 13. system包含os, runtime, shell command相关函数。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/system"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/netutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
url := "https://gutendex.com/books?"
|
|
||||||
header := make(map[string]string)
|
|
||||||
header["Content-Type"] = "application/json"
|
|
||||||
queryParams := make(map[string]interface{})
|
|
||||||
queryParams["ids"] = "1"
|
|
||||||
|
|
||||||
resp, err := netutil.HttpGet(url, header, queryParams)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- 函数列表:
|
#### 函数列表:
|
||||||
|
- [IsWindows](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#IsWindows)
|
||||||
|
- [IsLinux](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#IsLinux)
|
||||||
|
- [IsMac](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#IsMac)
|
||||||
|
- [GetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#GetOsEnv)
|
||||||
|
- [SetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#SetOsEnv)
|
||||||
|
- [RemoveOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#RemoveOsEnv)
|
||||||
|
- [CompareOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#CompareOsEnv)
|
||||||
|
- [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#ExecCommand)
|
||||||
|
- [GetOsBits](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#GetOsBits)
|
||||||
|
|
||||||
|
### 14. validator验证器包,包含常用字符串格式验证函数。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func GetInternalIp() string //获取内部ip
|
import "github.com/duke-git/lancet/validator"
|
||||||
func GetPublicIpInfo() (*PublicIpInfo, error) //获取公共ip信息: country, region, isp, city, lat, lon, ip
|
|
||||||
func IsPublicIP(IP net.IP) bool //判断ip是否为公共ip
|
|
||||||
func HttpGet(url string, params ...interface{}) (*http.Response, error) //http get请求
|
|
||||||
func HttpPost(url string, params ...interface{}) (*http.Response, error) //http post请求
|
|
||||||
func HttpPut(url string, params ...interface{}) (*http.Response, error) //http put请求
|
|
||||||
func HttpDelete(url string, params ...interface{}) (*http.Response, error) //http delete请求
|
|
||||||
func HttpPatch(url string, params ...interface{}) (*http.Response, error) //http patch请求
|
|
||||||
func ConvertMapToQueryString(param map[string]interface{}) string //将map转换成url query string
|
|
||||||
func ParseHttpResponse(resp *http.Response, obj interface{}) error //将http响应解码成特定interface
|
|
||||||
```
|
```
|
||||||
|
#### 函数列表:
|
||||||
|
|
||||||
#### 8. random随机数处理包
|
- [ContainChinese](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#ContainChinese)
|
||||||
|
- [ContainLetter](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#ContainLetter)
|
||||||
|
- [ContainLower](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#ContainLower)
|
||||||
|
- [ContainUpper](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#ContainUpper)
|
||||||
|
- [IsAlpha](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsAlpha)
|
||||||
|
- [IsAllUpper](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsAllUpper)
|
||||||
|
- [IsAllLower](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsAllLower)
|
||||||
|
- [IsBase64](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsBase64)
|
||||||
|
- [IsChineseMobile](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsChineseMobile)
|
||||||
|
- [IsChineseIdNum](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsChineseIdNum)
|
||||||
|
- [IsChinesePhone](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsChinesePhone)
|
||||||
|
- [IsCreditCard](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsCreditCard)
|
||||||
|
- [IsDns](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsDns)
|
||||||
|
- [IsEmail](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsEmail)
|
||||||
|
- [IsEmptyString](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsEmptyString)
|
||||||
|
- [IsFloatStr](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsFloatStr)
|
||||||
|
- [IsNumberStr](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsNumberStr)
|
||||||
|
- [IsJSON](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsJSON)
|
||||||
|
- [IsRegexMatch](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsRegexMatch)
|
||||||
|
- [IsIntStr](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsIntStr)
|
||||||
|
- [IsIp](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsIp)
|
||||||
|
- [IsIpV4](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsIpV4)
|
||||||
|
- [IsIpV6](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsIpV6)
|
||||||
|
- [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsStrongPassword)
|
||||||
|
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsUrl)
|
||||||
|
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword)
|
||||||
|
|
||||||
- 生成和处理随机数
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/random"
|
|
||||||
|
|
||||||
```go
|
## 如何贡献代码
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
非常感激任何的代码提交以使lancet的功能越来越强大。创建pull request时请遵守以下规则。
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/random"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
1. Fork lancet仓库。
|
||||||
randStr := random.RandString(6)
|
2. 创建自己的特性分支。
|
||||||
fmt.Println(randStr)
|
3. 提交变更。
|
||||||
}
|
4. Push分支。
|
||||||
```
|
5. 创建新的pull request。
|
||||||
|
|
||||||
- 函数列表:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func RandBytes(length int) []byte //生成随机[]byte
|
|
||||||
func RandInt(min, max int) int //生成随机int
|
|
||||||
func RandString(length int) string //生成随机string
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 9. slice切片操作包
|
|
||||||
|
|
||||||
- 切片操作相关函数
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/slice"
|
|
||||||
- 由于go目前对范型支持不稳定,slice处理函数参数和返回值大部分为interface{}, 待范型特性稳定后,会重构相关函数
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/slice"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
nums := []int{1, 4, 3, 4, 6, 7, 3}
|
|
||||||
uniqueNums, _ := slice.IntSlice(slice.Unique(nums))
|
|
||||||
fmt.Println(uniqueNums) //[1 4 3 6 7]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- 函数列表:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func Contain(slice interface{}, value interface{}) bool //判断slice是否包含value
|
|
||||||
func Chunk(slice []interface{}, size int) [][]interface{} //均分slice
|
|
||||||
func ConvertSlice(originalSlice interface{}, newSliceType reflect.Type) interface{} //将originalSlice转换为 newSliceType
|
|
||||||
func Difference(slice1, slice2 interface{}) interface{} //返回
|
|
||||||
func DeleteByIndex(slice interface{}, start int, end ...int) (interface{}, error) //删除切片中start到end位置的值
|
|
||||||
func Drop(slice interface{}, n int) interface{} //创建一个新切片,当n大于0时删除原切片前n个元素,当n小于0时删除原切片后n个元素
|
|
||||||
func Every(slice, function interface{}) bool //slice中所有元素都符合函数条件时返回true, 否则返回false. 函数签名:func(index int, value interface{}) bool
|
|
||||||
func Find(slice, function interface{}) (interface{}, bool)//查找slice中第一个符合条件的元素,函数签名:func(index int, value interface{}) bool
|
|
||||||
func Filter(slice, function interface{}) interface{} //过滤slice, 函数签名:func(index int, value interface{}) bool
|
|
||||||
func FlattenDeep(slice interface{}) interface{} //将slice递归为一维切片。
|
|
||||||
func IntSlice(slice interface{}) ([]int, error) //转成int切片
|
|
||||||
func InterfaceSlice(slice interface{}) []interface{} //转成interface{}切片
|
|
||||||
func Intersection(slices ...interface{}) interface{} //slice交集,去重
|
|
||||||
func InsertByIndex(slice interface{}, index int, value interface{}) (interface{}, error) //在切片中index位置插入value
|
|
||||||
func Map(slice, function interface{}) interface{} //遍历切片, 函数签名:func(index int, value interface{}) interface{}
|
|
||||||
func ReverseSlice(slice interface{}) //反转切片
|
|
||||||
func Reduce(slice, function, zero interface{}) interface{} //切片reduce操作, 函数签名:func(index int, value1, value2 interface{}) interface{}
|
|
||||||
func Shuffle(slice interface{}) interface{} //创建一个被打乱值的切片
|
|
||||||
func Some(slice, function interface{}) bool //slice中任意一个元素都符合函数条件时返回true, 否则返回false. 函数签名:func(index int, value interface{}) bool
|
|
||||||
func SortByField(slice interface{}, field string, sortType ...string) error //对struct切片进行排序
|
|
||||||
func StringSlice(slice interface{}) []string //转为string切片
|
|
||||||
func Unique(slice interface{}) interface{} //去重切片
|
|
||||||
func Union(slices ...interface{}) interface{} //slice并集, 去重
|
|
||||||
func UpdateByIndex(slice interface{}, index int, value interface{}) (interface{}, error) //在切片中index位置更新value
|
|
||||||
func Without(slice interface{}, values ...interface{}) interface{} //slice去除values
|
|
||||||
func GroupBy(slice, function interface{}) (interface{}, interface{}) //根据函数function的逻辑分slice为两组slice
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 10. strutil字符串处理包
|
|
||||||
|
|
||||||
- 字符串操作相关函数
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/strutil"
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/strutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
str := "Foo-Bar"
|
|
||||||
camelCaseStr := strutil.CamelCase(str)
|
|
||||||
fmt.Println(camelCaseStr) //fooBar
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- 函数列表:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func After(s, char string) string //截取字符串中char第一次出现之后的字符串
|
|
||||||
func AfterLast(s, char string) string //截取字符串中char最后一次出现之后的字符串
|
|
||||||
func Before(s, char string) string //截取字符串中char第一次出现之前的字符串
|
|
||||||
func BeforeLast(s, char string) string //截取字符串中char最后一次出现之前的字符串
|
|
||||||
func CamelCase(s string) string //字符串转为cameCase, "foo bar" -> "fooBar"
|
|
||||||
func Capitalize(s string) string //字符串转为Capitalize, "fOO" -> "Foo"
|
|
||||||
func IsString(v interface{}) bool //判断是否是字符串
|
|
||||||
func KebabCase(s string) string //字符串转为KebabCase, "foo_Bar" -> "foo-bar"
|
|
||||||
func LowerFirst(s string) string //字符串的第一个字母转为小写字母
|
|
||||||
func PadEnd(source string, size int, padStr string) string //字符串末尾填充size个字符
|
|
||||||
func PadStart(source string, size int, padStr string) string//字符串开头填充size个字符
|
|
||||||
func ReverseStr(s string) string //字符串逆袭
|
|
||||||
func SnakeCase(s string) string //字符串转为SnakeCase, "fooBar" -> "foo_bar"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 11. validator验证器包
|
|
||||||
|
|
||||||
- 数据校验相关函数
|
|
||||||
- 导入包:import "github.com/duke-git/lancet/validator"
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/validator"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
str := "Foo-Bar"
|
|
||||||
isAlpha := validator.IsAlpha(str)
|
|
||||||
fmt.Println(isAlpha) //false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- 函数列表:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func ContainChinese(s string) bool //判断字符串中是否含有中文字符
|
|
||||||
func IsAlpha(s string) bool //判断字符串是否只含有字母
|
|
||||||
func IsBase64(base64 string) bool //判断字符串是base64
|
|
||||||
func IsChineseMobile(mobileNum string) bool //判断字符串是否是手机号
|
|
||||||
func IsChineseIdNum(id string) bool //判断字符串是否是身份证号
|
|
||||||
func IsChinesePhone(phone string) bool //判断字符串是否是座机电话号码
|
|
||||||
func IsCreditCard(creditCart string) bool //判断字符串是否是信用卡
|
|
||||||
func IsDns(dns string) bool //判断字符串是否是DNS
|
|
||||||
func IsEmail(email string) bool //判断字符串是否是邮箱
|
|
||||||
func IsEmptyString(s string) bool //判断字符串是否为空
|
|
||||||
func IsFloatStr(s string) bool //判断字符串是否可以转成float
|
|
||||||
func IsNumberStr(s string) bool //判断字符串是否可以转成数字
|
|
||||||
func IsRegexMatch(s, regex string) bool //判断字符串是否match正则表达式
|
|
||||||
func IsIntStr(s string) bool //判断字符串是否可以转成整数
|
|
||||||
func IsIp(ipstr string) bool //判断字符串是否是ip
|
|
||||||
func IsIpV4(ipstr string) bool //判断字符串是否是ipv4
|
|
||||||
func IsIpV6(ipstr string) bool //判断字符串是否是ipv6
|
|
||||||
func IsStrongPassword(password string, length int) bool //判断字符串是否是强密码(大小写字母+数字+特殊字符)
|
|
||||||
func IsWeakPassword(password string) bool //判断字符串是否是弱密码(只有字母或数字)
|
|
||||||
```
|
|
||||||
@@ -6,9 +6,10 @@ package convertor
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"encoding/gob"
|
"encoding/binary"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"math"
|
||||||
"reflect"
|
"reflect"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -21,14 +22,44 @@ func ToBool(s string) (bool, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ToBytes convert interface to bytes
|
// ToBytes convert interface to bytes
|
||||||
func ToBytes(data interface{}) ([]byte, error) {
|
func ToBytes(value interface{}) ([]byte, error) {
|
||||||
var buf bytes.Buffer
|
v := reflect.ValueOf(value)
|
||||||
enc := gob.NewEncoder(&buf)
|
|
||||||
err := enc.Encode(data)
|
switch value.(type) {
|
||||||
if err != nil {
|
case int, int8, int16, int32, int64:
|
||||||
return nil, err
|
number := v.Int()
|
||||||
|
buf := bytes.NewBuffer([]byte{})
|
||||||
|
buf.Reset()
|
||||||
|
err := binary.Write(buf, binary.BigEndian, number)
|
||||||
|
return buf.Bytes(), err
|
||||||
|
case uint, uint8, uint16, uint32, uint64:
|
||||||
|
number := v.Uint()
|
||||||
|
buf := bytes.NewBuffer([]byte{})
|
||||||
|
buf.Reset()
|
||||||
|
err := binary.Write(buf, binary.BigEndian, number)
|
||||||
|
return buf.Bytes(), err
|
||||||
|
case float32:
|
||||||
|
number := float32(v.Float())
|
||||||
|
bits := math.Float32bits(number)
|
||||||
|
bytes := make([]byte, 4)
|
||||||
|
binary.BigEndian.PutUint32(bytes, bits)
|
||||||
|
return bytes, nil
|
||||||
|
case float64:
|
||||||
|
number := v.Float()
|
||||||
|
bits := math.Float64bits(number)
|
||||||
|
bytes := make([]byte, 8)
|
||||||
|
binary.BigEndian.PutUint64(bytes, bits)
|
||||||
|
return bytes, nil
|
||||||
|
case bool:
|
||||||
|
return strconv.AppendBool([]byte{}, v.Bool()), nil
|
||||||
|
case string:
|
||||||
|
return []byte(v.String()), nil
|
||||||
|
case []byte:
|
||||||
|
return v.Bytes(), nil
|
||||||
|
default:
|
||||||
|
newValue, err := json.Marshal(value)
|
||||||
|
return newValue, err
|
||||||
}
|
}
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ToChar convert string to char slice
|
// ToChar convert string to char slice
|
||||||
@@ -79,10 +110,10 @@ func ToString(value interface{}) string {
|
|||||||
func ToJson(value interface{}) (string, error) {
|
func ToJson(value interface{}) (string, error) {
|
||||||
res, err := json.Marshal(value)
|
res, err := json.Marshal(value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
res = []byte("")
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
return string(res), err
|
return string(res), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ToFloat convert value to a float64, if input is not a float return 0.0 and error
|
// ToFloat convert value to a float64, if input is not a float return 0.0 and error
|
||||||
@@ -198,3 +229,17 @@ func ColorRGBToHex(red, green, blue int) string {
|
|||||||
|
|
||||||
return "#" + r + g + b
|
return "#" + r + g + b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ToChannel convert a array of elements to a read-only channels
|
||||||
|
func ToChannel(array []interface{}) <-chan interface{} {
|
||||||
|
ch := make(chan interface{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
for _, item := range array {
|
||||||
|
ch <- item
|
||||||
|
}
|
||||||
|
close(ch)
|
||||||
|
}()
|
||||||
|
|
||||||
|
return ch
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,13 +2,14 @@ package convertor
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"reflect"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/duke-git/lancet/internal"
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestToChar(t *testing.T) {
|
func TestToChar(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToChar")
|
||||||
|
|
||||||
cases := []string{"", "abc", "1 2#3"}
|
cases := []string{"", "abc", "1 2#3"}
|
||||||
expected := [][]string{
|
expected := [][]string{
|
||||||
{""},
|
{""},
|
||||||
@@ -16,49 +17,51 @@ func TestToChar(t *testing.T) {
|
|||||||
{"1", " ", "2", "#", "3"},
|
{"1", " ", "2", "#", "3"},
|
||||||
}
|
}
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := ToChar(cases[i])
|
assert.Equal(expected[i], ToChar(cases[i]))
|
||||||
if !reflect.DeepEqual(res, expected[i]) {
|
|
||||||
internal.LogFailedTestInfo(t, "ToChar", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToBool(t *testing.T) {
|
func TestToBool(t *testing.T) {
|
||||||
cases := []string{"true", "True", "false", "False", "0", "1", "123"}
|
assert := internal.NewAssert(t, "TestToBool")
|
||||||
expected := []bool{true, true, false, false, false, true, false}
|
|
||||||
|
cases := []string{"1", "true", "True", "false", "False", "0", "123", "0.0", "abc"}
|
||||||
|
expected := []bool{true, true, true, false, false, false, false, false, false}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res, _ := ToBool(cases[i])
|
actual, _ := ToBool(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "ToBool", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToBytes(t *testing.T) {
|
func TestToBytes(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToBytes")
|
||||||
|
|
||||||
cases := []interface{}{
|
cases := []interface{}{
|
||||||
0,
|
0,
|
||||||
false,
|
false,
|
||||||
"1",
|
"1",
|
||||||
}
|
}
|
||||||
expected := [][]byte{
|
expected := [][]byte{
|
||||||
{3, 4, 0, 0},
|
{0, 0, 0, 0, 0, 0, 0, 0},
|
||||||
{3, 2, 0, 0},
|
{102, 97, 108, 115, 101},
|
||||||
{4, 12, 0, 1, 49},
|
{49},
|
||||||
}
|
}
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res, _ := ToBytes(cases[i])
|
actual, _ := ToBytes(cases[i])
|
||||||
fmt.Println(res)
|
assert.Equal(expected[i], actual)
|
||||||
if !reflect.DeepEqual(res, expected[i]) {
|
|
||||||
internal.LogFailedTestInfo(t, "ToBytes", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bytesData, err := ToBytes("abc")
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
t.Fail()
|
||||||
|
}
|
||||||
|
assert.Equal("abc", ToString(bytesData))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToInt(t *testing.T) {
|
func TestToInt(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToInt")
|
||||||
|
|
||||||
cases := []interface{}{"123", "-123", 123,
|
cases := []interface{}{"123", "-123", 123,
|
||||||
uint(123), uint8(123), uint16(123), uint32(123), uint64(123),
|
uint(123), uint8(123), uint16(123), uint32(123), uint64(123),
|
||||||
float32(12.3), float64(12.3),
|
float32(12.3), float64(12.3),
|
||||||
@@ -67,15 +70,14 @@ func TestToInt(t *testing.T) {
|
|||||||
expected := []int64{123, -123, 123, 123, 123, 123, 123, 123, 12, 12, 0, 0, 0}
|
expected := []int64{123, -123, 123, 123, 123, 123, 123, 123, 12, 12, 0, 0, 0}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res, _ := ToInt(cases[i])
|
actual, _ := ToInt(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "ToInt", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToFloat(t *testing.T) {
|
func TestToFloat(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToFloat")
|
||||||
|
|
||||||
cases := []interface{}{
|
cases := []interface{}{
|
||||||
"", "-1", "-.11", "1.23e3", ".123e10", "abc",
|
"", "-1", "-.11", "1.23e3", ".123e10", "abc",
|
||||||
int(0), int8(1), int16(-1), int32(123), int64(123),
|
int(0), int8(1), int16(-1), int32(123), int64(123),
|
||||||
@@ -86,22 +88,19 @@ func TestToFloat(t *testing.T) {
|
|||||||
0, 1, -1, 123, 123, 123, 123, 123, 123, 123, 12.3, 12.300000190734863}
|
0, 1, -1, 123, 123, 123, 123, 123, 123, 123, 12.3, 12.300000190734863}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res, _ := ToFloat(cases[i])
|
actual, _ := ToFloat(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "ToFloat", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToString(t *testing.T) {
|
func TestToString(t *testing.T) {
|
||||||
// map
|
assert := internal.NewAssert(t, "TestToString")
|
||||||
|
|
||||||
aMap := make(map[string]int)
|
aMap := make(map[string]int)
|
||||||
aMap["a"] = 1
|
aMap["a"] = 1
|
||||||
aMap["b"] = 2
|
aMap["b"] = 2
|
||||||
aMap["c"] = 3
|
aMap["c"] = 3
|
||||||
|
|
||||||
// struct
|
|
||||||
type TestStruct struct {
|
type TestStruct struct {
|
||||||
Name string
|
Name string
|
||||||
}
|
}
|
||||||
@@ -124,75 +123,39 @@ func TestToString(t *testing.T) {
|
|||||||
"[1,2,3]", "{\"a\":1,\"b\":2,\"c\":3}", "{\"Name\":\"TestStruct\"}", "hello"}
|
"[1,2,3]", "{\"a\":1,\"b\":2,\"c\":3}", "{\"Name\":\"TestStruct\"}", "hello"}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := ToString(cases[i])
|
actual := ToString(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "ToString", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
func TestToJson(t *testing.T) {
|
func TestToJson(t *testing.T) {
|
||||||
// map
|
assert := internal.NewAssert(t, "TestToJson")
|
||||||
aMap := make(map[string]int)
|
|
||||||
aMap["a"] = 1
|
|
||||||
aMap["b"] = 2
|
|
||||||
aMap["c"] = 3
|
|
||||||
|
|
||||||
mapJson := "{\"a\":1,\"b\":2,\"c\":3}"
|
var aMap = map[string]int{"a": 1, "b": 2, "c": 3}
|
||||||
r1, _ := ToJson(aMap)
|
mapJsonStr, _ := ToJson(aMap)
|
||||||
if r1 != mapJson {
|
assert.Equal("{\"a\":1,\"b\":2,\"c\":3}", mapJsonStr)
|
||||||
internal.LogFailedTestInfo(t, "ToJson", aMap, mapJson, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
// struct
|
|
||||||
type TestStruct struct {
|
type TestStruct struct {
|
||||||
Name string
|
Name string
|
||||||
}
|
}
|
||||||
aStruct := TestStruct{Name: "TestStruct"}
|
aStruct := TestStruct{Name: "TestStruct"}
|
||||||
structJson := "{\"Name\":\"TestStruct\"}"
|
structJsonStr, _ := ToJson(aStruct)
|
||||||
r2, _ := ToJson(aStruct)
|
assert.Equal("{\"Name\":\"TestStruct\"}", structJsonStr)
|
||||||
if r2 != structJson {
|
|
||||||
internal.LogFailedTestInfo(t, "ToJson", aMap, mapJson, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructToMap(t *testing.T) {
|
func TestStructToMap(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestStructToMap")
|
||||||
|
|
||||||
type People struct {
|
type People struct {
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
age int
|
age int
|
||||||
}
|
}
|
||||||
|
p := People{
|
||||||
p1 := People{
|
|
||||||
"test",
|
"test",
|
||||||
100,
|
100,
|
||||||
}
|
}
|
||||||
|
pm, _ := StructToMap(p)
|
||||||
pm1, _ := StructToMap(p1)
|
var expected = map[string]interface{}{"name": "test"}
|
||||||
m1 := make(map[string]interface{})
|
assert.Equal(expected, pm)
|
||||||
m1["name"] = "test"
|
|
||||||
//exp1["100"] = 100
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(pm1, m1) {
|
|
||||||
internal.LogFailedTestInfo(t, "StructToMap", p1, m1, pm1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
p2 := People{
|
|
||||||
"test",
|
|
||||||
100,
|
|
||||||
}
|
|
||||||
|
|
||||||
pm2, _ := StructToMap(p1)
|
|
||||||
m2 := make(map[string]interface{})
|
|
||||||
m2["name"] = "test"
|
|
||||||
m2["100"] = 100
|
|
||||||
|
|
||||||
if reflect.DeepEqual(pm2, m2) {
|
|
||||||
internal.LogFailedTestInfo(t, "StructToMap", p2, m2, pm2)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestColorHexToRGB(t *testing.T) {
|
func TestColorHexToRGB(t *testing.T) {
|
||||||
@@ -201,22 +164,34 @@ func TestColorHexToRGB(t *testing.T) {
|
|||||||
colorRGB := fmt.Sprintf("%d,%d,%d", r, g, b)
|
colorRGB := fmt.Sprintf("%d,%d,%d", r, g, b)
|
||||||
expected := "0,51,102"
|
expected := "0,51,102"
|
||||||
|
|
||||||
if colorRGB != expected {
|
assert := internal.NewAssert(t, "TestColorHexToRGB")
|
||||||
internal.LogFailedTestInfo(t, "ColorHexToRGB", colorHex, expected, colorRGB)
|
assert.Equal(expected, colorRGB)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestColorRGBToHex(t *testing.T) {
|
func TestColorRGBToHex(t *testing.T) {
|
||||||
r := 0
|
r := 0
|
||||||
g := 51
|
g := 51
|
||||||
b := 102
|
b := 102
|
||||||
colorRGB := fmt.Sprintf("%d,%d,%d", r, g, b)
|
|
||||||
colorHex := ColorRGBToHex(r, g, b)
|
colorHex := ColorRGBToHex(r, g, b)
|
||||||
expected := "#003366"
|
expected := "#003366"
|
||||||
|
|
||||||
if colorHex != expected {
|
assert := internal.NewAssert(t, "TestColorRGBToHex")
|
||||||
internal.LogFailedTestInfo(t, "ColorHexToRGB", colorRGB, expected, colorHex)
|
assert.Equal(expected, colorHex)
|
||||||
t.FailNow()
|
}
|
||||||
}
|
|
||||||
|
func TestToChannel(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToChannel")
|
||||||
|
|
||||||
|
ch := ToChannel([]interface{}{1, 2, 3})
|
||||||
|
val1, _ := <-ch
|
||||||
|
assert.Equal(1, val1)
|
||||||
|
|
||||||
|
val2, _ := <-ch
|
||||||
|
assert.Equal(2, val2)
|
||||||
|
|
||||||
|
val3, _ := <-ch
|
||||||
|
assert.Equal(3, val3)
|
||||||
|
|
||||||
|
_, ok := <-ch
|
||||||
|
assert.Equal(false, ok)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -54,14 +54,18 @@ func AesEcbDecrypt(encrypted, key []byte) []byte {
|
|||||||
// AesCbcEncrypt encrypt data with key use AES CBC algorithm
|
// AesCbcEncrypt encrypt data with key use AES CBC algorithm
|
||||||
// len(key) should be 16, 24 or 32
|
// len(key) should be 16, 24 or 32
|
||||||
func AesCbcEncrypt(data, key []byte) []byte {
|
func AesCbcEncrypt(data, key []byte) []byte {
|
||||||
// len(key) should be 16, 24 or 32
|
|
||||||
block, _ := aes.NewCipher(key)
|
block, _ := aes.NewCipher(key)
|
||||||
blockSize := block.BlockSize()
|
data = pkcs7Padding(data, block.BlockSize())
|
||||||
data = pkcs7Padding(data, blockSize)
|
|
||||||
blockMode := cipher.NewCBCEncrypter(block, key[:blockSize])
|
encrypted := make([]byte, aes.BlockSize+len(data))
|
||||||
|
iv := encrypted[:aes.BlockSize]
|
||||||
|
if _, err := io.ReadFull(rand.Reader, iv); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
mode := cipher.NewCBCEncrypter(block, iv)
|
||||||
|
mode.CryptBlocks(encrypted[aes.BlockSize:], data)
|
||||||
|
|
||||||
encrypted := make([]byte, len(data))
|
|
||||||
blockMode.CryptBlocks(encrypted, data)
|
|
||||||
return encrypted
|
return encrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -69,12 +73,14 @@ func AesCbcEncrypt(data, key []byte) []byte {
|
|||||||
// len(key) should be 16, 24 or 32
|
// len(key) should be 16, 24 or 32
|
||||||
func AesCbcDecrypt(encrypted, key []byte) []byte {
|
func AesCbcDecrypt(encrypted, key []byte) []byte {
|
||||||
block, _ := aes.NewCipher(key)
|
block, _ := aes.NewCipher(key)
|
||||||
blockSize := block.BlockSize()
|
|
||||||
blockMode := cipher.NewCBCDecrypter(block, key[:blockSize])
|
|
||||||
|
|
||||||
decrypted := make([]byte, len(encrypted))
|
iv := encrypted[:aes.BlockSize]
|
||||||
blockMode.CryptBlocks(decrypted, encrypted)
|
encrypted = encrypted[aes.BlockSize:]
|
||||||
decrypted = pkcs7UnPadding(decrypted)
|
|
||||||
|
mode := cipher.NewCBCDecrypter(block, iv)
|
||||||
|
mode.CryptBlocks(encrypted, encrypted)
|
||||||
|
|
||||||
|
decrypted := pkcs7UnPadding(encrypted)
|
||||||
return decrypted
|
return decrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -13,10 +13,8 @@ func TestAesEcbEncrypt(t *testing.T) {
|
|||||||
aesEcbEncrypt := AesEcbEncrypt([]byte(data), []byte(key))
|
aesEcbEncrypt := AesEcbEncrypt([]byte(data), []byte(key))
|
||||||
aesEcbDecrypt := AesEcbDecrypt(aesEcbEncrypt, []byte(key))
|
aesEcbDecrypt := AesEcbDecrypt(aesEcbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(aesEcbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestAesEcbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "AesEcbEncrypt/AesEcbDecrypt", data, data, string(aesEcbDecrypt))
|
assert.Equal(data, string(aesEcbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAesCbcEncrypt(t *testing.T) {
|
func TestAesCbcEncrypt(t *testing.T) {
|
||||||
@@ -26,10 +24,8 @@ func TestAesCbcEncrypt(t *testing.T) {
|
|||||||
aesCbcEncrypt := AesCbcEncrypt([]byte(data), []byte(key))
|
aesCbcEncrypt := AesCbcEncrypt([]byte(data), []byte(key))
|
||||||
aesCbcDecrypt := AesCbcDecrypt(aesCbcEncrypt, []byte(key))
|
aesCbcDecrypt := AesCbcDecrypt(aesCbcEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(aesCbcDecrypt) != data {
|
assert := internal.NewAssert(t, "TestAesCbcEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "AesCbcEncrypt/AesCbcDecrypt", data, data, string(aesCbcDecrypt))
|
assert.Equal(data, string(aesCbcDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAesCtrCrypt(t *testing.T) {
|
func TestAesCtrCrypt(t *testing.T) {
|
||||||
@@ -39,10 +35,8 @@ func TestAesCtrCrypt(t *testing.T) {
|
|||||||
aesCtrCrypt := AesCtrCrypt([]byte(data), []byte(key))
|
aesCtrCrypt := AesCtrCrypt([]byte(data), []byte(key))
|
||||||
aesCtrDeCrypt := AesCtrCrypt(aesCtrCrypt, []byte(key))
|
aesCtrDeCrypt := AesCtrCrypt(aesCtrCrypt, []byte(key))
|
||||||
|
|
||||||
if string(aesCtrDeCrypt) != data {
|
assert := internal.NewAssert(t, "TestAesCtrCrypt")
|
||||||
internal.LogFailedTestInfo(t, "AesCtrCrypt", data, data, string(aesCtrDeCrypt))
|
assert.Equal(data, string(aesCtrDeCrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAesCfbEncrypt(t *testing.T) {
|
func TestAesCfbEncrypt(t *testing.T) {
|
||||||
@@ -52,10 +46,8 @@ func TestAesCfbEncrypt(t *testing.T) {
|
|||||||
aesCfbEncrypt := AesCfbEncrypt([]byte(data), []byte(key))
|
aesCfbEncrypt := AesCfbEncrypt([]byte(data), []byte(key))
|
||||||
aesCfbDecrypt := AesCfbDecrypt(aesCfbEncrypt, []byte(key))
|
aesCfbDecrypt := AesCfbDecrypt(aesCfbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(aesCfbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestAesCfbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "AesCfbEncrypt/AesCfbDecrypt", data, data, string(aesCfbDecrypt))
|
assert.Equal(data, string(aesCfbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAesOfbEncrypt(t *testing.T) {
|
func TestAesOfbEncrypt(t *testing.T) {
|
||||||
@@ -65,8 +57,6 @@ func TestAesOfbEncrypt(t *testing.T) {
|
|||||||
aesOfbEncrypt := AesOfbEncrypt([]byte(data), []byte(key))
|
aesOfbEncrypt := AesOfbEncrypt([]byte(data), []byte(key))
|
||||||
aesOfbDecrypt := AesOfbDecrypt(aesOfbEncrypt, []byte(key))
|
aesOfbDecrypt := AesOfbDecrypt(aesOfbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(aesOfbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestAesOfbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "AesOfbEncrypt/AesOfbDecrypt", data, data, string(aesOfbDecrypt))
|
assert.Equal(data, string(aesOfbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@
|
|||||||
package cryptor
|
package cryptor
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bufio"
|
||||||
"crypto/hmac"
|
"crypto/hmac"
|
||||||
"crypto/md5"
|
"crypto/md5"
|
||||||
"crypto/sha1"
|
"crypto/sha1"
|
||||||
@@ -13,7 +14,9 @@ import (
|
|||||||
"crypto/sha512"
|
"crypto/sha512"
|
||||||
"encoding/base64"
|
"encoding/base64"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"io/ioutil"
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Base64StdEncode encode string with base64 encoding
|
// Base64StdEncode encode string with base64 encoding
|
||||||
@@ -36,14 +39,34 @@ func Md5String(s string) string {
|
|||||||
|
|
||||||
// Md5File return the md5 value of file
|
// Md5File return the md5 value of file
|
||||||
func Md5File(filename string) (string, error) {
|
func Md5File(filename string) (string, error) {
|
||||||
f, err := ioutil.ReadFile(filename)
|
if fileInfo, err := os.Stat(filename); err != nil {
|
||||||
|
return "", err
|
||||||
|
} else if fileInfo.IsDir() {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
file, err := os.Open(filename)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
defer file.Close()
|
||||||
|
|
||||||
h := md5.New()
|
hash := md5.New()
|
||||||
h.Write(f)
|
|
||||||
return hex.EncodeToString(h.Sum(nil)), nil
|
chunkSize := 65536
|
||||||
|
for buf, reader := make([]byte, chunkSize), bufio.NewReader(file); ; {
|
||||||
|
n, err := reader.Read(buf)
|
||||||
|
if err != nil {
|
||||||
|
if err == io.EOF {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
hash.Write(buf[:n])
|
||||||
|
}
|
||||||
|
|
||||||
|
checksum := fmt.Sprintf("%x", hash.Sum(nil))
|
||||||
|
return checksum, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// HmacMd5 return the hmac hash of string use md5
|
// HmacMd5 return the hmac hash of string use md5
|
||||||
|
|||||||
@@ -1,66 +1,36 @@
|
|||||||
package cryptor
|
package cryptor
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/duke-git/lancet/internal"
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestBase64StdEncode(t *testing.T) {
|
func TestBase64StdEncode(t *testing.T) {
|
||||||
s := "hello world"
|
assert := internal.NewAssert(t, "TestBase64StdEncode")
|
||||||
bs := Base64StdEncode(s)
|
assert.Equal("aGVsbG8gd29ybGQ=", Base64StdEncode("hello world"))
|
||||||
|
|
||||||
if bs != "aGVsbG8gd29ybGQ=" {
|
|
||||||
internal.LogFailedTestInfo(t, "Base64StdEncode", s, "aGVsbG8gd29ybGQ=", bs)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBase64StdDecode(t *testing.T) {
|
func TestBase64StdDecode(t *testing.T) {
|
||||||
bs := "aGVsbG8gd29ybGQ="
|
assert := internal.NewAssert(t, "TestBase64StdDecode")
|
||||||
s := Base64StdDecode(bs)
|
assert.Equal("hello world", Base64StdDecode("aGVsbG8gd29ybGQ="))
|
||||||
|
|
||||||
if s != "hello world" {
|
|
||||||
internal.LogFailedTestInfo(t, "Base64StdDecode", bs, "hello world=", s)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMd5String(t *testing.T) {
|
func TestMd5String(t *testing.T) {
|
||||||
s := "hello"
|
assert := internal.NewAssert(t, "TestMd5String")
|
||||||
smd5 := Md5String(s)
|
assert.Equal("5d41402abc4b2a76b9719d911017c592", Md5String("hello"))
|
||||||
expected := "5d41402abc4b2a76b9719d911017c592"
|
|
||||||
|
|
||||||
if smd5 != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "Md5String", s, expected, smd5)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMd5File(t *testing.T) {
|
func TestMd5File(t *testing.T) {
|
||||||
file, _ := os.Create("./hello.txt")
|
fileMd5, err := Md5File("./basic.go")
|
||||||
defer file.Close()
|
assert := internal.NewAssert(t, "TestMd5File")
|
||||||
file.WriteString("hello\n")
|
assert.IsNotNil(fileMd5)
|
||||||
|
assert.IsNil(err)
|
||||||
fileMd5, err := Md5File("./hello.txt")
|
|
||||||
if err != nil {
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
fmt.Println(fileMd5)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHmacMd5(t *testing.T) {
|
func TestHmacMd5(t *testing.T) {
|
||||||
s := "hello world"
|
assert := internal.NewAssert(t, "TestHmacMd5")
|
||||||
key := "12345"
|
assert.Equal("5f4c9faaff0a1ad3007d9ddc06abe36d", HmacMd5("hello world", "12345"))
|
||||||
hmacMd5 := HmacMd5(s, key)
|
|
||||||
expected := "5f4c9faaff0a1ad3007d9ddc06abe36d"
|
|
||||||
|
|
||||||
if hmacMd5 != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "HmacMd5", s, expected, hmacMd5)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHmacSha1(t *testing.T) {
|
func TestHmacSha1(t *testing.T) {
|
||||||
@@ -69,10 +39,8 @@ func TestHmacSha1(t *testing.T) {
|
|||||||
hmacSha1 := HmacSha1(s, key)
|
hmacSha1 := HmacSha1(s, key)
|
||||||
expected := "3826f812255d8683f051ee97346d1359234d5dbd"
|
expected := "3826f812255d8683f051ee97346d1359234d5dbd"
|
||||||
|
|
||||||
if hmacSha1 != expected {
|
assert := internal.NewAssert(t, "TestHmacSha1")
|
||||||
internal.LogFailedTestInfo(t, "HmacSha1", s, expected, hmacSha1)
|
assert.Equal(expected, hmacSha1)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHmacSha256(t *testing.T) {
|
func TestHmacSha256(t *testing.T) {
|
||||||
@@ -81,10 +49,8 @@ func TestHmacSha256(t *testing.T) {
|
|||||||
hmacSha256 := HmacSha256(s, key)
|
hmacSha256 := HmacSha256(s, key)
|
||||||
expected := "9dce2609f2d67d41f74c7f9efc8ccd44370d41ad2de52982627588dfe7289ab8"
|
expected := "9dce2609f2d67d41f74c7f9efc8ccd44370d41ad2de52982627588dfe7289ab8"
|
||||||
|
|
||||||
if hmacSha256 != expected {
|
assert := internal.NewAssert(t, "TestHmacSha256")
|
||||||
internal.LogFailedTestInfo(t, "HmacSha256", s, expected, hmacSha256)
|
assert.Equal(expected, hmacSha256)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHmacSha512(t *testing.T) {
|
func TestHmacSha512(t *testing.T) {
|
||||||
@@ -93,10 +59,8 @@ func TestHmacSha512(t *testing.T) {
|
|||||||
hmacSha512 := HmacSha512(s, key)
|
hmacSha512 := HmacSha512(s, key)
|
||||||
expected := "5b1563ac4e9b49c9ada8ccb232588fc4f0c30fd12f756b3a0b95af4985c236ca60925253bae10ce2c6bf9af1c1679b51e5395ff3d2826c0a2c7c0d72225d4175"
|
expected := "5b1563ac4e9b49c9ada8ccb232588fc4f0c30fd12f756b3a0b95af4985c236ca60925253bae10ce2c6bf9af1c1679b51e5395ff3d2826c0a2c7c0d72225d4175"
|
||||||
|
|
||||||
if hmacSha512 != expected {
|
assert := internal.NewAssert(t, "TestHmacSha512")
|
||||||
internal.LogFailedTestInfo(t, "HmacSha512", s, expected, hmacSha512)
|
assert.Equal(expected, hmacSha512)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSha1(t *testing.T) {
|
func TestSha1(t *testing.T) {
|
||||||
@@ -104,10 +68,8 @@ func TestSha1(t *testing.T) {
|
|||||||
sha1 := Sha1(s)
|
sha1 := Sha1(s)
|
||||||
expected := "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
|
expected := "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
|
||||||
|
|
||||||
if sha1 != expected {
|
assert := internal.NewAssert(t, "TestSha1")
|
||||||
internal.LogFailedTestInfo(t, "Sha1", s, expected, sha1)
|
assert.Equal(expected, sha1)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSha256(t *testing.T) {
|
func TestSha256(t *testing.T) {
|
||||||
@@ -115,10 +77,8 @@ func TestSha256(t *testing.T) {
|
|||||||
sha256 := Sha256(s)
|
sha256 := Sha256(s)
|
||||||
expected := "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
|
expected := "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
|
||||||
|
|
||||||
if sha256 != expected {
|
assert := internal.NewAssert(t, "TestSha256")
|
||||||
internal.LogFailedTestInfo(t, "Sha256", s, expected, sha256)
|
assert.Equal(expected, sha256)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSha512(t *testing.T) {
|
func TestSha512(t *testing.T) {
|
||||||
@@ -126,8 +86,6 @@ func TestSha512(t *testing.T) {
|
|||||||
sha512 := Sha512(s)
|
sha512 := Sha512(s)
|
||||||
expected := "309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f"
|
expected := "309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f"
|
||||||
|
|
||||||
if sha512 != expected {
|
assert := internal.NewAssert(t, "TestSha512")
|
||||||
internal.LogFailedTestInfo(t, "Sha512", s, expected, sha512)
|
assert.Equal(expected, sha512)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,10 +19,12 @@ func DesEcbEncrypt(data, key []byte) []byte {
|
|||||||
length := (len(data) + des.BlockSize) / des.BlockSize
|
length := (len(data) + des.BlockSize) / des.BlockSize
|
||||||
plain := make([]byte, length*des.BlockSize)
|
plain := make([]byte, length*des.BlockSize)
|
||||||
copy(plain, data)
|
copy(plain, data)
|
||||||
|
|
||||||
pad := byte(len(plain) - len(data))
|
pad := byte(len(plain) - len(data))
|
||||||
for i := len(data); i < len(plain); i++ {
|
for i := len(data); i < len(plain); i++ {
|
||||||
plain[i] = pad
|
plain[i] = pad
|
||||||
}
|
}
|
||||||
|
|
||||||
encrypted := make([]byte, len(plain))
|
encrypted := make([]byte, len(plain))
|
||||||
for bs, be := 0, cipher.BlockSize(); bs <= len(data); bs, be = bs+cipher.BlockSize(), be+cipher.BlockSize() {
|
for bs, be := 0, cipher.BlockSize(); bs <= len(data); bs, be = bs+cipher.BlockSize(), be+cipher.BlockSize() {
|
||||||
cipher.Encrypt(encrypted[bs:be], plain[bs:be])
|
cipher.Encrypt(encrypted[bs:be], plain[bs:be])
|
||||||
@@ -36,7 +38,7 @@ func DesEcbEncrypt(data, key []byte) []byte {
|
|||||||
func DesEcbDecrypt(encrypted, key []byte) []byte {
|
func DesEcbDecrypt(encrypted, key []byte) []byte {
|
||||||
cipher, _ := des.NewCipher(generateDesKey(key))
|
cipher, _ := des.NewCipher(generateDesKey(key))
|
||||||
decrypted := make([]byte, len(encrypted))
|
decrypted := make([]byte, len(encrypted))
|
||||||
//
|
|
||||||
for bs, be := 0, cipher.BlockSize(); bs < len(encrypted); bs, be = bs+cipher.BlockSize(), be+cipher.BlockSize() {
|
for bs, be := 0, cipher.BlockSize(); bs < len(encrypted); bs, be = bs+cipher.BlockSize(), be+cipher.BlockSize() {
|
||||||
cipher.Decrypt(decrypted[bs:be], encrypted[bs:be])
|
cipher.Decrypt(decrypted[bs:be], encrypted[bs:be])
|
||||||
}
|
}
|
||||||
@@ -53,12 +55,17 @@ func DesEcbDecrypt(encrypted, key []byte) []byte {
|
|||||||
// len(key) should be 8
|
// len(key) should be 8
|
||||||
func DesCbcEncrypt(data, key []byte) []byte {
|
func DesCbcEncrypt(data, key []byte) []byte {
|
||||||
block, _ := des.NewCipher(key)
|
block, _ := des.NewCipher(key)
|
||||||
blockSize := block.BlockSize()
|
data = pkcs7Padding(data, block.BlockSize())
|
||||||
data = pkcs7Padding(data, blockSize)
|
|
||||||
blockMode := cipher.NewCBCEncrypter(block, key[:blockSize])
|
encrypted := make([]byte, des.BlockSize+len(data))
|
||||||
|
iv := encrypted[:des.BlockSize]
|
||||||
|
if _, err := io.ReadFull(rand.Reader, iv); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
mode := cipher.NewCBCEncrypter(block, iv)
|
||||||
|
mode.CryptBlocks(encrypted[des.BlockSize:], data)
|
||||||
|
|
||||||
encrypted := make([]byte, len(data))
|
|
||||||
blockMode.CryptBlocks(encrypted, data)
|
|
||||||
return encrypted
|
return encrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -66,12 +73,14 @@ func DesCbcEncrypt(data, key []byte) []byte {
|
|||||||
// len(key) should be 8
|
// len(key) should be 8
|
||||||
func DesCbcDecrypt(encrypted, key []byte) []byte {
|
func DesCbcDecrypt(encrypted, key []byte) []byte {
|
||||||
block, _ := des.NewCipher(key)
|
block, _ := des.NewCipher(key)
|
||||||
blockSize := block.BlockSize()
|
|
||||||
blockMode := cipher.NewCBCDecrypter(block, key[:blockSize])
|
|
||||||
|
|
||||||
decrypted := make([]byte, len(encrypted))
|
iv := encrypted[:des.BlockSize]
|
||||||
blockMode.CryptBlocks(decrypted, encrypted)
|
encrypted = encrypted[des.BlockSize:]
|
||||||
decrypted = pkcs7UnPadding(decrypted)
|
|
||||||
|
mode := cipher.NewCBCDecrypter(block, iv)
|
||||||
|
mode.CryptBlocks(encrypted, encrypted)
|
||||||
|
|
||||||
|
decrypted := pkcs7UnPadding(encrypted)
|
||||||
return decrypted
|
return decrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,6 +114,7 @@ func DesCfbEncrypt(data, key []byte) []byte {
|
|||||||
|
|
||||||
stream := cipher.NewCFBEncrypter(block, iv)
|
stream := cipher.NewCFBEncrypter(block, iv)
|
||||||
stream.XORKeyStream(encrypted[des.BlockSize:], data)
|
stream.XORKeyStream(encrypted[des.BlockSize:], data)
|
||||||
|
|
||||||
return encrypted
|
return encrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -120,6 +130,7 @@ func DesCfbDecrypt(encrypted, key []byte) []byte {
|
|||||||
|
|
||||||
stream := cipher.NewCFBDecrypter(block, iv)
|
stream := cipher.NewCFBDecrypter(block, iv)
|
||||||
stream.XORKeyStream(encrypted, encrypted)
|
stream.XORKeyStream(encrypted, encrypted)
|
||||||
|
|
||||||
return encrypted
|
return encrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -139,6 +150,7 @@ func DesOfbEncrypt(data, key []byte) []byte {
|
|||||||
|
|
||||||
stream := cipher.NewOFB(block, iv)
|
stream := cipher.NewOFB(block, iv)
|
||||||
stream.XORKeyStream(encrypted[des.BlockSize:], data)
|
stream.XORKeyStream(encrypted[des.BlockSize:], data)
|
||||||
|
|
||||||
return encrypted
|
return encrypted
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,6 +173,6 @@ func DesOfbDecrypt(data, key []byte) []byte {
|
|||||||
mode.XORKeyStream(decrypted, data)
|
mode.XORKeyStream(decrypted, data)
|
||||||
|
|
||||||
decrypted = pkcs7UnPadding(decrypted)
|
decrypted = pkcs7UnPadding(decrypted)
|
||||||
return decrypted
|
|
||||||
|
|
||||||
|
return decrypted
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,10 +13,8 @@ func TestDesEcbEncrypt(t *testing.T) {
|
|||||||
desEcbEncrypt := DesEcbEncrypt([]byte(data), []byte(key))
|
desEcbEncrypt := DesEcbEncrypt([]byte(data), []byte(key))
|
||||||
desEcbDecrypt := DesEcbDecrypt(desEcbEncrypt, []byte(key))
|
desEcbDecrypt := DesEcbDecrypt(desEcbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(desEcbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestDesEcbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "DesEcbEncrypt/DesEcbDecrypt", data, data, string(desEcbDecrypt))
|
assert.Equal(data, string(desEcbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDesCbcEncrypt(t *testing.T) {
|
func TestDesCbcEncrypt(t *testing.T) {
|
||||||
@@ -26,10 +24,8 @@ func TestDesCbcEncrypt(t *testing.T) {
|
|||||||
desCbcEncrypt := DesCbcEncrypt([]byte(data), []byte(key))
|
desCbcEncrypt := DesCbcEncrypt([]byte(data), []byte(key))
|
||||||
desCbcDecrypt := DesCbcDecrypt(desCbcEncrypt, []byte(key))
|
desCbcDecrypt := DesCbcDecrypt(desCbcEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(desCbcDecrypt) != data {
|
assert := internal.NewAssert(t, "TestDesCbcEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "DesCbcEncrypt/DesCbcDecrypt", data, data, string(desCbcDecrypt))
|
assert.Equal(data, string(desCbcDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDesCtrCrypt(t *testing.T) {
|
func TestDesCtrCrypt(t *testing.T) {
|
||||||
@@ -39,10 +35,8 @@ func TestDesCtrCrypt(t *testing.T) {
|
|||||||
desCtrCrypt := DesCtrCrypt([]byte(data), []byte(key))
|
desCtrCrypt := DesCtrCrypt([]byte(data), []byte(key))
|
||||||
desCtrDeCrypt := DesCtrCrypt(desCtrCrypt, []byte(key))
|
desCtrDeCrypt := DesCtrCrypt(desCtrCrypt, []byte(key))
|
||||||
|
|
||||||
if string(desCtrDeCrypt) != data {
|
assert := internal.NewAssert(t, "TestDesCtrCrypt")
|
||||||
internal.LogFailedTestInfo(t, "DesCtrCrypt", data, data, string(desCtrDeCrypt))
|
assert.Equal(data, string(desCtrDeCrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDesCfbEncrypt(t *testing.T) {
|
func TestDesCfbEncrypt(t *testing.T) {
|
||||||
@@ -52,10 +46,8 @@ func TestDesCfbEncrypt(t *testing.T) {
|
|||||||
desCfbEncrypt := DesCfbEncrypt([]byte(data), []byte(key))
|
desCfbEncrypt := DesCfbEncrypt([]byte(data), []byte(key))
|
||||||
desCfbDecrypt := DesCfbDecrypt(desCfbEncrypt, []byte(key))
|
desCfbDecrypt := DesCfbDecrypt(desCfbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(desCfbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestDesCfbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "DesCfbEncrypt/DesCfbDecrypt", data, data, string(desCfbDecrypt))
|
assert.Equal(data, string(desCfbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDesOfbEncrypt(t *testing.T) {
|
func TestDesOfbEncrypt(t *testing.T) {
|
||||||
@@ -65,8 +57,6 @@ func TestDesOfbEncrypt(t *testing.T) {
|
|||||||
desOfbEncrypt := DesOfbEncrypt([]byte(data), []byte(key))
|
desOfbEncrypt := DesOfbEncrypt([]byte(data), []byte(key))
|
||||||
desOfbDecrypt := DesOfbDecrypt(desOfbEncrypt, []byte(key))
|
desOfbDecrypt := DesOfbDecrypt(desOfbEncrypt, []byte(key))
|
||||||
|
|
||||||
if string(desOfbDecrypt) != data {
|
assert := internal.NewAssert(t, "TestDesOfbEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "DesOfbEncrypt/DesOfbDecrypt", data, data, string(desOfbDecrypt))
|
assert.Equal(data, string(desOfbDecrypt))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,11 +14,11 @@ import (
|
|||||||
|
|
||||||
// GenerateRsaKey make a rsa private key, and return key file name
|
// GenerateRsaKey make a rsa private key, and return key file name
|
||||||
// Generated key file is `rsa_private.pem` and `rsa_public.pem` in current path
|
// Generated key file is `rsa_private.pem` and `rsa_public.pem` in current path
|
||||||
func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) {
|
func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) error {
|
||||||
// private key
|
// private key
|
||||||
privateKey, err := rsa.GenerateKey(rand.Reader, keySize)
|
privateKey, err := rsa.GenerateKey(rand.Reader, keySize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
derText := x509.MarshalPKCS1PrivateKey(privateKey)
|
derText := x509.MarshalPKCS1PrivateKey(privateKey)
|
||||||
@@ -41,7 +41,7 @@ func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) {
|
|||||||
|
|
||||||
derpText, err := x509.MarshalPKIXPublicKey(&publicKey)
|
derpText, err := x509.MarshalPKIXPublicKey(&publicKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
block = pem.Block{
|
block = pem.Block{
|
||||||
@@ -52,10 +52,12 @@ func GenerateRsaKey(keySize int, priKeyFile, pubKeyFile string) {
|
|||||||
//file,err = os.Create("rsa_public.pem")
|
//file,err = os.Create("rsa_public.pem")
|
||||||
file, err = os.Create(pubKeyFile)
|
file, err = os.Create(pubKeyFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
return err
|
||||||
}
|
}
|
||||||
pem.Encode(file, &block)
|
pem.Encode(file, &block)
|
||||||
file.Close()
|
file.Close()
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// RsaEncrypt encrypt data with ras algorithm
|
// RsaEncrypt encrypt data with ras algorithm
|
||||||
|
|||||||
@@ -7,13 +7,14 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestRsaEncrypt(t *testing.T) {
|
func TestRsaEncrypt(t *testing.T) {
|
||||||
GenerateRsaKey(4096, "rsa_private.pem", "rsa_public.pem")
|
err := GenerateRsaKey(4096, "rsa_private.pem", "rsa_public.pem")
|
||||||
|
if err != nil {
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
data := []byte("hello world")
|
data := []byte("hello world")
|
||||||
encrypted := RsaEncrypt(data, "rsa_public.pem")
|
encrypted := RsaEncrypt(data, "rsa_public.pem")
|
||||||
decrypted := RsaDecrypt(encrypted, "rsa_private.pem")
|
decrypted := RsaDecrypt(encrypted, "rsa_private.pem")
|
||||||
|
|
||||||
if string(data) != string(decrypted) {
|
assert := internal.NewAssert(t, "TestRsaEncrypt")
|
||||||
internal.LogFailedTestInfo(t, "RsaEncrypt/RsaDecrypt", string(data), string(data), string(decrypted))
|
assert.Equal(string(data), string(decrypted))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
60
datetime/conversion.go
Normal file
60
datetime/conversion.go
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
||||||
|
// Use of this source code is governed by MIT license.
|
||||||
|
|
||||||
|
package datetime
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUnixNow return unix timestamp of current time
|
||||||
|
func NewUnixNow() *theTime {
|
||||||
|
return &theTime{unix: time.Now().Unix()}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUnix return unix timestamp of specified time
|
||||||
|
func NewUnix(unix int64) *theTime {
|
||||||
|
return &theTime{unix: unix}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewFormat return unix timestamp of specified time string, t should be "yyyy-mm-dd hh:mm:ss"
|
||||||
|
func NewFormat(t string) (*theTime, error) {
|
||||||
|
timeLayout := "2006-01-02 15:04:05"
|
||||||
|
loc := time.FixedZone("CST", 8*3600)
|
||||||
|
tt, err := time.ParseInLocation(timeLayout, t, loc)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &theTime{unix: tt.Unix()}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewISO8601 return unix timestamp of specified iso8601 time string
|
||||||
|
func NewISO8601(iso8601 string) (*theTime, error) {
|
||||||
|
t, err := time.ParseInLocation(time.RFC3339, iso8601, time.UTC)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &theTime{unix: t.Unix()}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToUnix return unix timestamp
|
||||||
|
func (t *theTime) ToUnix() int64 {
|
||||||
|
return t.unix
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToFormat return the time string 'yyyy-mm-dd hh:mm:ss' of unix time
|
||||||
|
func (t *theTime) ToFormat() string {
|
||||||
|
return time.Unix(t.unix, 0).Format("2006-01-02 15:04:05")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToFormatForTpl return the time string which format is specified tpl
|
||||||
|
func (t *theTime) ToFormatForTpl(tpl string) string {
|
||||||
|
return time.Unix(t.unix, 0).Format(tpl)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToFormatForTpl return iso8601 time string
|
||||||
|
func (t *theTime) ToIso8601() string {
|
||||||
|
return time.Unix(t.unix, 0).Format(time.RFC3339)
|
||||||
|
}
|
||||||
54
datetime/conversion_test.go
Normal file
54
datetime/conversion_test.go
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
package datetime
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestToUnix(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToUnix")
|
||||||
|
|
||||||
|
tm1 := NewUnixNow()
|
||||||
|
unixTimestamp := tm1.ToUnix()
|
||||||
|
tm2 := NewUnix(unixTimestamp)
|
||||||
|
|
||||||
|
assert.Equal(tm1, tm2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToFormat(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToFormat")
|
||||||
|
|
||||||
|
tm, err := NewFormat("2022/03/18 17:04:05")
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
|
tm, err = NewFormat("2022-03-18 17:04:05")
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
t.Log("ToFormat -> ", tm.ToFormat())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToFormatForTpl(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToFormatForTpl")
|
||||||
|
|
||||||
|
tm, err := NewFormat("2022/03/18 17:04:05")
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
|
tm, err = NewFormat("2022-03-18 17:04:05")
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
t.Log("ToFormatForTpl -> ", tm.ToFormatForTpl("2006/01/02 15:04:05"))
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToIso8601(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToIso8601")
|
||||||
|
|
||||||
|
tm, err := NewISO8601("2022-03-18 17:04:05")
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
|
tm, err = NewISO8601("2006-01-02T15:04:05.999Z")
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
t.Log("ToIso8601 -> ", tm.ToIso8601())
|
||||||
|
}
|
||||||
@@ -110,3 +110,73 @@ func FormatStrToTime(str, format string) (time.Time, error) {
|
|||||||
|
|
||||||
return time.Parse(v, str)
|
return time.Parse(v, str)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BeginOfMinute return beginning minute time of day
|
||||||
|
func BeginOfMinute(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, t.Hour(), t.Minute(), 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfMinute return end minute time of day
|
||||||
|
func EndOfMinute(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, t.Hour(), t.Minute(), 59, int(time.Second-time.Nanosecond), t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// BeginOfHour return beginning hour time of day
|
||||||
|
func BeginOfHour(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, t.Hour(), 0, 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfHour return end hour time of day
|
||||||
|
func EndOfHour(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, t.Hour(), 59, 59, int(time.Second-time.Nanosecond), t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// BeginOfDay return beginning hour time of day
|
||||||
|
func BeginOfDay(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, 0, 0, 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfDay return end time of day
|
||||||
|
func EndOfDay(t time.Time) time.Time {
|
||||||
|
y, m, d := t.Date()
|
||||||
|
return time.Date(y, m, d, 23, 59, 59, int(time.Second-time.Nanosecond), t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// BeginOfWeek return beginning week, week begin from Sunday
|
||||||
|
func BeginOfWeek(t time.Time) time.Time {
|
||||||
|
y, m, d := t.AddDate(0, 0, 0-int(BeginOfDay(t).Weekday())).Date()
|
||||||
|
return time.Date(y, m, d, 0, 0, 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfWeek return end week time, week end with Saturday
|
||||||
|
func EndOfWeek(t time.Time) time.Time {
|
||||||
|
y, m, d := BeginOfWeek(t).AddDate(0, 0, 7).Add(-time.Nanosecond).Date()
|
||||||
|
return time.Date(y, m, d, 23, 59, 59, int(time.Second-time.Nanosecond), t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// BeginOfMonth return beginning of month
|
||||||
|
func BeginOfMonth(t time.Time) time.Time {
|
||||||
|
y, m, _ := t.Date()
|
||||||
|
return time.Date(y, m, 1, 0, 0, 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfMonth return end of month
|
||||||
|
func EndOfMonth(t time.Time) time.Time {
|
||||||
|
return BeginOfMonth(t).AddDate(0, 1, 0).Add(-time.Nanosecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BeginOfYear return beginning of year
|
||||||
|
func BeginOfYear(t time.Time) time.Time {
|
||||||
|
y, _, _ := t.Date()
|
||||||
|
return time.Date(y, time.January, 1, 0, 0, 0, 0, t.Location())
|
||||||
|
}
|
||||||
|
|
||||||
|
// EndOfYear return end of year
|
||||||
|
func EndOfYear(t time.Time) time.Time {
|
||||||
|
return BeginOfYear(t).AddDate(1, 0, 0).Add(-time.Nanosecond)
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,103 +1,72 @@
|
|||||||
package datetime
|
package datetime
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/duke-git/lancet/internal"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestAddDay(t *testing.T) {
|
func TestAddDay(t *testing.T) {
|
||||||
now := time.Now()
|
assert := internal.NewAssert(t, "TestAddDay")
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
after2Days := AddDay(now, 2)
|
after2Days := AddDay(now, 2)
|
||||||
diff1 := after2Days.Sub(now)
|
diff1 := after2Days.Sub(now)
|
||||||
if diff1.Hours() != 48 {
|
assert.Equal(float64(48), diff1.Hours())
|
||||||
internal.LogFailedTestInfo(t, "AddDay", now, 48, diff1.Hours())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
before2Days := AddDay(now, -2)
|
before2Days := AddDay(now, -2)
|
||||||
diff2 := before2Days.Sub(now)
|
diff2 := before2Days.Sub(now)
|
||||||
if diff2.Hours() != -48 {
|
assert.Equal(float64(-48), diff2.Hours())
|
||||||
internal.LogFailedTestInfo(t, "AddDay", now, -48, diff2.Hours())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
func TestAddHour(t *testing.T) {
|
|
||||||
now := time.Now()
|
|
||||||
|
|
||||||
|
func TestAddHour(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestAddHour")
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
after2Hours := AddHour(now, 2)
|
after2Hours := AddHour(now, 2)
|
||||||
diff1 := after2Hours.Sub(now)
|
diff1 := after2Hours.Sub(now)
|
||||||
if diff1.Hours() != 2 {
|
assert.Equal(float64(2), diff1.Hours())
|
||||||
internal.LogFailedTestInfo(t, "AddHour", now, 2, diff1.Hours())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
before2Hours := AddHour(now, -2)
|
before2Hours := AddHour(now, -2)
|
||||||
diff2 := before2Hours.Sub(now)
|
diff2 := before2Hours.Sub(now)
|
||||||
if diff2.Hours() != -2 {
|
assert.Equal(float64(-2), diff2.Hours())
|
||||||
internal.LogFailedTestInfo(t, "AddHour", now, -2, diff2.Hours())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAddMinute(t *testing.T) {
|
func TestAddMinute(t *testing.T) {
|
||||||
now := time.Now()
|
assert := internal.NewAssert(t, "TestAddMinute")
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
after2Minutes := AddMinute(now, 2)
|
after2Minutes := AddMinute(now, 2)
|
||||||
diff1 := after2Minutes.Sub(now)
|
diff1 := after2Minutes.Sub(now)
|
||||||
if diff1.Minutes() != 2 {
|
assert.Equal(float64(2), diff1.Minutes())
|
||||||
internal.LogFailedTestInfo(t, "AddMinute", now, 2, diff1.Minutes())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
before2Minutes := AddMinute(now, -2)
|
before2Minutes := AddMinute(now, -2)
|
||||||
diff2 := before2Minutes.Sub(now)
|
diff2 := before2Minutes.Sub(now)
|
||||||
if diff2.Minutes() != -2 {
|
assert.Equal(float64(-2), diff2.Minutes())
|
||||||
internal.LogFailedTestInfo(t, "AddMinute", now, -2, diff2.Minutes())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetNowDate(t *testing.T) {
|
func TestGetNowDate(t *testing.T) {
|
||||||
date := GetNowDate()
|
assert := internal.NewAssert(t, "TestGetNowDate")
|
||||||
expected := time.Now().Format("2006-01-02")
|
expected := time.Now().Format("2006-01-02")
|
||||||
if date != expected {
|
assert.Equal(expected, GetNowDate())
|
||||||
internal.LogFailedTestInfo(t, "GetNowDate", "", expected, date)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetNotTime(t *testing.T) {
|
func TestGetNotTime(t *testing.T) {
|
||||||
ts := GetNowTime()
|
assert := internal.NewAssert(t, "TestGetNotTime")
|
||||||
expected := time.Now().Format("15:04:05")
|
expected := time.Now().Format("15:04:05")
|
||||||
if ts != expected {
|
assert.Equal(expected, GetNowTime())
|
||||||
internal.LogFailedTestInfo(t, "GetNowTime", "", expected, ts)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetNowDateTime(t *testing.T) {
|
func TestGetNowDateTime(t *testing.T) {
|
||||||
ts := GetNowDateTime()
|
assert := internal.NewAssert(t, "TestGetNowDateTime")
|
||||||
expected := time.Now().Format("2006-01-02 15:04:05")
|
expected := time.Now().Format("2006-01-02 15:04:05")
|
||||||
if ts != expected {
|
assert.Equal(expected, GetNowDateTime())
|
||||||
internal.LogFailedTestInfo(t, "GetNowDateTime", "", expected, ts)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
//todo
|
|
||||||
//func TestGetZeroHourTimestamp(t *testing.T) {
|
|
||||||
// ts := GetZeroHourTimestamp()
|
|
||||||
// expected := time.Now().UTC().Unix() - 8*3600
|
|
||||||
// if ts != expected {
|
|
||||||
// utils.LogFailedTestInfo(t, "GetZeroHourTimestamp", "", expected, ts)
|
|
||||||
// t.FailNow()
|
|
||||||
// }
|
|
||||||
//}
|
|
||||||
|
|
||||||
func TestFormatTimeToStr(t *testing.T) {
|
func TestFormatTimeToStr(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestFormatTimeToStr")
|
||||||
|
|
||||||
datetime, _ := time.Parse("2006-01-02 15:04:05", "2021-01-02 16:04:08")
|
datetime, _ := time.Parse("2006-01-02 15:04:05", "2021-01-02 16:04:08")
|
||||||
cases := []string{
|
cases := []string{
|
||||||
"yyyy-mm-dd hh:mm:ss", "yyyy-mm-dd",
|
"yyyy-mm-dd hh:mm:ss", "yyyy-mm-dd",
|
||||||
@@ -110,16 +79,15 @@ func TestFormatTimeToStr(t *testing.T) {
|
|||||||
"16:04:08", "2021/01"}
|
"16:04:08", "2021/01"}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := FormatTimeToStr(datetime, cases[i])
|
actual := FormatTimeToStr(datetime, cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "FormatTimeToStr", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFormatStrToTime(t *testing.T) {
|
func TestFormatStrToTime(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestFormatStrToTime")
|
||||||
|
|
||||||
formats := []string{
|
formats := []string{
|
||||||
"2006-01-02 15:04:05", "2006-01-02",
|
"2006-01-02 15:04:05", "2006-01-02",
|
||||||
"02-01-06 15:04:05", "2006/01/02 15:04:05",
|
"02-01-06 15:04:05", "2006/01/02 15:04:05",
|
||||||
@@ -135,14 +103,131 @@ func TestFormatStrToTime(t *testing.T) {
|
|||||||
"2021/01"}
|
"2021/01"}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res, err := FormatStrToTime(datetimeStr[i], cases[i])
|
actual, err := FormatStrToTime(datetimeStr[i], cases[i])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
expected, _ := time.Parse(formats[i], datetimeStr[i])
|
expected, _ := time.Parse(formats[i], datetimeStr[i])
|
||||||
if res != expected {
|
assert.Equal(expected, actual)
|
||||||
internal.LogFailedTestInfo(t, "FormatTimeToStr", cases[i], expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBeginOfMinute(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfMinute")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 15, 48, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfMinute(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfMinute(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfMinute")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 15, 48, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfMinute(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginOfHour(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfHour")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 15, 0, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfHour(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfHour(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfHour")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 15, 59, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfHour(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginOfDay(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfDay")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 0, 0, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfDay(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfDay(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfDay")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 15, 23, 59, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfDay(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginOfWeek(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfWeek")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 13, 0, 0, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfWeek(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfWeek(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfWeek")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 19, 23, 59, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfWeek(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginOfMonth(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfMonth")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 1, 0, 0, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfMonth(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfMonth(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfMonth")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 2, 28, 23, 59, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfMonth(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginOfYear(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBeginOfYear")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 1, 1, 0, 0, 0, 0, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := BeginOfYear(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfYear(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEndOfYear")
|
||||||
|
|
||||||
|
expected := time.Date(2022, 12, 31, 23, 59, 59, 999999999, time.Local)
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
actual := EndOfYear(td)
|
||||||
|
|
||||||
|
assert.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|||||||
387
docs/convertor.md
Normal file
387
docs/convertor.md
Normal file
@@ -0,0 +1,387 @@
|
|||||||
|
# Convertor
|
||||||
|
Package convertor contains some functions for data type convertion.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/convertor/convertor.go](https://github.com/duke-git/lancet/blob/v1/convertor/convertor.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [ColorHexToRGB](#ColorHexToRGB)
|
||||||
|
- [ColorRGBToHex](#ColorRGBToHex)
|
||||||
|
- [ToBool](#ToBool)
|
||||||
|
- [ToBytes](#ToBytes)
|
||||||
|
- [ToChar](#ToChar)
|
||||||
|
- [ToChannel](#ToChannel)
|
||||||
|
- [ToInt](#ToInt)
|
||||||
|
- [ToJson](#ToJson)
|
||||||
|
- [ToString](#ToString)
|
||||||
|
- [StructToMap](#StructToMap)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ColorHexToRGB">ColorHexToRGB</span>
|
||||||
|
<p>Convert color hex to color rgb.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ColorHexToRGB(colorHex string) (red, green, blue int)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
colorHex := "#003366"
|
||||||
|
r, g, b := ColorHexToRGB(colorHex)
|
||||||
|
fmt.Println(r, g, b) //0,51,102
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ColorRGBToHex">ColorRGBToHex</span>
|
||||||
|
|
||||||
|
<p>Convert color rgb to color hex.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ColorRGBToHex(red, green, blue int) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
r := 0
|
||||||
|
g := 51
|
||||||
|
b := 102
|
||||||
|
colorHex := ColorRGBToHex(r, g, b)
|
||||||
|
|
||||||
|
fmt.Println(colorHex) //#003366
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToBool">ToBool</span>
|
||||||
|
|
||||||
|
<p>Convert string to a boolean value. Use strconv.ParseBool</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToBool(s string) (bool, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v1, _ := convertor.ToBool("1")
|
||||||
|
fmt.Println(v1) //true
|
||||||
|
|
||||||
|
v2, _ := convertor.ToBool("true")
|
||||||
|
fmt.Println(v2) //true
|
||||||
|
|
||||||
|
v3, _ := convertor.ToBool("True")
|
||||||
|
fmt.Println(v3) //true
|
||||||
|
|
||||||
|
v4, _ := convertor.ToBool("123")
|
||||||
|
fmt.Println(v4) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToBytes">ToBytes</span>
|
||||||
|
|
||||||
|
<p>Convert interface to byte slice.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToBytes(data interface{}) ([]byte, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
bytesData, err := convertor.ToBytes("0")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(bytesData) //[]bytes{3, 4, 0, 0}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToChar">ToChar</span>
|
||||||
|
|
||||||
|
<p>Convert string to char slice.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToChar(s string) []string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
chars := convertor.ToChar("")
|
||||||
|
fmt.Println(chars) //[]string{""}
|
||||||
|
|
||||||
|
chars = convertor.ToChar("abc")
|
||||||
|
fmt.Println(chars) //[]string{"a", "b", "c"}
|
||||||
|
|
||||||
|
chars = convertor.ToChar("1 2#3")
|
||||||
|
fmt.Println(chars) //[]string{"1", " ", "2", "#", "3"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToChannel">ToChannel</span>
|
||||||
|
|
||||||
|
<p>Convert a collection of elements to a read-only channels.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToChannel(array []interface{}) <-chan interface{}
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ch := convertor.ToChannel([]int{1, 2, 3})
|
||||||
|
|
||||||
|
val1, _ := <-ch
|
||||||
|
fmt.Println(val1) //1
|
||||||
|
|
||||||
|
val2, _ := <-ch
|
||||||
|
fmt.Println(val2) //2
|
||||||
|
|
||||||
|
val3, _ := <-ch
|
||||||
|
fmt.Println(val3) //3
|
||||||
|
|
||||||
|
_, ok := <-ch
|
||||||
|
fmt.Println(ok) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFloat">ToFloat</span>
|
||||||
|
|
||||||
|
<p>Convert interface to a float64 value. If param is a invalid floatable, will return 0 and error. </p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToFloat(value interface{}) (float64, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v, err := convertor.ToFloat("")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //strconv.ParseFloat: parsing "": invalid syntax
|
||||||
|
}
|
||||||
|
fmt.Println(v) //0
|
||||||
|
|
||||||
|
v, _ = convertor.ToFloat("-.11")
|
||||||
|
fmt.Println(v) //-0.11
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToInt">ToInt</span>
|
||||||
|
|
||||||
|
<p>Convert interface to a int64 value. If param is a invalid intable, will return 0 and error. </p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToInt(value interface{}) (int64, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v, err := convertor.ToInt("")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //strconv.ParseInt: parsing "": invalid syntax
|
||||||
|
}
|
||||||
|
fmt.Println(v) //0
|
||||||
|
|
||||||
|
v, _ = convertor.ToFloat(1.12)
|
||||||
|
fmt.Println(v) //1
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToJson">ToJson</span>
|
||||||
|
|
||||||
|
<p>Convert interface to json string. If param can't be converted, will return "" and error. </p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToJson(value interface{}) (string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var aMap = map[string]int{"a": 1, "b": 2, "c": 3}
|
||||||
|
jsonStr, _ := convertor.ToJson(aMap)
|
||||||
|
fmt.Printf("%q", jsonStr) //"{\"a\":1,\"b\":2,\"c\":3}"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToString">ToString</span>
|
||||||
|
|
||||||
|
<p>Convert interface to string. </p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToString(value interface{}) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Printf("%q", convertor.ToString(1)) //"1"
|
||||||
|
fmt.Printf("%q", convertor.ToString(1.1)) //"1.1"
|
||||||
|
fmt.Printf("%q", convertor.ToString([]int{1, 2, 3})) //"[1,2,3]"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="StructToMap">StructToMap</span>
|
||||||
|
|
||||||
|
<p>Convert struct to map, only convert exported field, struct field tag `json` should be set.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func StructToMap(value interface{}) (map[string]interface{}, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
type People struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
age int
|
||||||
|
}
|
||||||
|
p := People{
|
||||||
|
"test",
|
||||||
|
100,
|
||||||
|
}
|
||||||
|
pm, _ := convertor.StructToMap(p)
|
||||||
|
|
||||||
|
fmt.Printf("type: %T, value: %s", pm, pm) //type: map[string]interface {}, value: map[name:test]
|
||||||
|
}
|
||||||
|
```
|
||||||
390
docs/convertor_zh-CN.md
Normal file
390
docs/convertor_zh-CN.md
Normal file
@@ -0,0 +1,390 @@
|
|||||||
|
# Convertor
|
||||||
|
convertor转换器包支持一些常见的数据类型转换
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/convertor/convertor.go](https://github.com/duke-git/lancet/blob/v1/convertor/convertor.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
|
||||||
|
- [ColorHexToRGB](#ColorHexToRGB)
|
||||||
|
- [ColorRGBToHex](#ColorRGBToHex)
|
||||||
|
- [ToBool](#ToBool)
|
||||||
|
- [ToBytes](#ToBytes)
|
||||||
|
- [ToChar](#ToChar)
|
||||||
|
- [ToChannel](#ToChannel)
|
||||||
|
- [ToInt](#ToInt)
|
||||||
|
- [ToJson](#ToJson)
|
||||||
|
- [ToString](#ToString)
|
||||||
|
- [StructToMap](#StructToMap)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ColorHexToRGB">ColorHexToRGB</span>
|
||||||
|
<p>颜色值十六进制转rgb</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ColorHexToRGB(colorHex string) (red, green, blue int)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
colorHex := "#003366"
|
||||||
|
r, g, b := ColorHexToRGB(colorHex)
|
||||||
|
fmt.Println(r, g, b) //0,51,102
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ColorRGBToHex">ColorRGBToHex</span>
|
||||||
|
|
||||||
|
<p>颜色值rgb转十六进制</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ColorRGBToHex(red, green, blue int) string
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
r := 0
|
||||||
|
g := 51
|
||||||
|
b := 102
|
||||||
|
colorHex := ColorRGBToHex(r, g, b)
|
||||||
|
|
||||||
|
fmt.Println(colorHex) //#003366
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToBool">ToBool</span>
|
||||||
|
|
||||||
|
<p>字符串转布尔类型,使用strconv.ParseBool</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToBool(s string) (bool, error)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v1, _ := convertor.ToBool("1")
|
||||||
|
fmt.Println(v1) //true
|
||||||
|
|
||||||
|
v2, _ := convertor.ToBool("true")
|
||||||
|
fmt.Println(v2) //true
|
||||||
|
|
||||||
|
v3, _ := convertor.ToBool("True")
|
||||||
|
fmt.Println(v3) //true
|
||||||
|
|
||||||
|
v4, _ := convertor.ToBool("123")
|
||||||
|
fmt.Println(v4) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToBytes">ToBytes</span>
|
||||||
|
|
||||||
|
<p>interface转字节切片.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToBytes(data interface{}) ([]byte, error)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
bytesData, err := convertor.ToBytes("0")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(bytesData) //[]bytes{3, 4, 0, 0}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToChar">ToChar</span>
|
||||||
|
|
||||||
|
<p>字符串转字符切片</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToChar(s string) []string
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
chars := convertor.ToChar("")
|
||||||
|
fmt.Println(chars) //[]string{""}
|
||||||
|
|
||||||
|
chars = convertor.ToChar("abc")
|
||||||
|
fmt.Println(chars) //[]string{"a", "b", "c"}
|
||||||
|
|
||||||
|
chars = convertor.ToChar("1 2#3")
|
||||||
|
fmt.Println(chars) //[]string{"1", " ", "2", "#", "3"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToChannel">ToChannel</span>
|
||||||
|
|
||||||
|
<p>将切片转为只读channel</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToChannel(array []interface{}) <-chan interface{}
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ch := convertor.ToChannel([]int{1, 2, 3})
|
||||||
|
|
||||||
|
val1, _ := <-ch
|
||||||
|
fmt.Println(val1) //1
|
||||||
|
|
||||||
|
val2, _ := <-ch
|
||||||
|
fmt.Println(val2) //2
|
||||||
|
|
||||||
|
val3, _ := <-ch
|
||||||
|
fmt.Println(val3) //3
|
||||||
|
|
||||||
|
_, ok := <-ch
|
||||||
|
fmt.Println(ok) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFloat">ToFloat</span>
|
||||||
|
|
||||||
|
<p>将interface转成float64类型,如果参数无法转换,会返回0和error</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToFloat(value interface{}) (float64, error)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v, err := convertor.ToFloat("")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //strconv.ParseFloat: parsing "": invalid syntax
|
||||||
|
}
|
||||||
|
fmt.Println(v) //0
|
||||||
|
|
||||||
|
v, _ = convertor.ToFloat("-.11")
|
||||||
|
fmt.Println(v) //-0.11
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToInt">ToInt</span>
|
||||||
|
|
||||||
|
<p>将interface转成intt64类型,如果参数无法转换,会返回0和error</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToInt(value interface{}) (int64, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
v, err := convertor.ToInt("")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //strconv.ParseInt: parsing "": invalid syntax
|
||||||
|
}
|
||||||
|
fmt.Println(v) //0
|
||||||
|
|
||||||
|
v, _ = convertor.ToFloat(1.12)
|
||||||
|
fmt.Println(v) //1
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToJson">ToJson</span>
|
||||||
|
|
||||||
|
<p>将interface转成json字符串,如果参数无法转换,会返回""和error</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToJson(value interface{}) (string, error)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var aMap = map[string]int{"a": 1, "b": 2, "c": 3}
|
||||||
|
jsonStr, _ := convertor.ToJson(aMap)
|
||||||
|
fmt.Printf("%q", jsonStr) //"{\"a\":1,\"b\":2,\"c\":3}"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToString">ToString</span>
|
||||||
|
|
||||||
|
<p>将interface转成字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ToString(value interface{}) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Printf("%q", convertor.ToString(1)) //"1"
|
||||||
|
fmt.Printf("%q", convertor.ToString(1.1)) //"1.1"
|
||||||
|
fmt.Printf("%q", convertor.ToString([]int{1, 2, 3})) //"[1,2,3]"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="StructToMap">StructToMap</span>
|
||||||
|
|
||||||
|
<p>将struct转成map,只会转换struct中可导出的字段。struct中导出字段需要设置json tag标记</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func StructToMap(value interface{}) (map[string]interface{}, error)
|
||||||
|
```
|
||||||
|
<b>列子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/convertor"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
type People struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
age int
|
||||||
|
}
|
||||||
|
p := People{
|
||||||
|
"test",
|
||||||
|
100,
|
||||||
|
}
|
||||||
|
pm, _ := convertor.StructToMap(p)
|
||||||
|
|
||||||
|
fmt.Printf("type: %T, value: %s", pm, pm) //type: map[string]interface {}, value: map[name:test]
|
||||||
|
}
|
||||||
|
```
|
||||||
1033
docs/cryptor.md
Normal file
1033
docs/cryptor.md
Normal file
File diff suppressed because it is too large
Load Diff
1028
docs/cryptor_zh-CN.md
Normal file
1028
docs/cryptor_zh-CN.md
Normal file
File diff suppressed because it is too large
Load Diff
895
docs/datetime.md
Normal file
895
docs/datetime.md
Normal file
@@ -0,0 +1,895 @@
|
|||||||
|
# Datetime
|
||||||
|
Package datetime supports date and time format and compare.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go](https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [AddDay](#AddDay)
|
||||||
|
- [AddHour](#AddHour)
|
||||||
|
- [AddMinute](#AddMinute)
|
||||||
|
- [BeginOfMinute](#BeginOfMinute)
|
||||||
|
- [BeginOfHour](#BeginOfHour)
|
||||||
|
- [BeginOfDay](#BeginOfDay)
|
||||||
|
- [BeginOfWeek](#BeginOfWeek)
|
||||||
|
- [BeginOfMonth](#BeginOfMonth)
|
||||||
|
- [BeginOfYear](#BeginOfYear)
|
||||||
|
|
||||||
|
- [EndOfMinute](#EndOfMinute)
|
||||||
|
- [EndOfHour](#EndOfHour)
|
||||||
|
- [EndOfDay](#EndOfDay)
|
||||||
|
- [EndOfWeek](#EndOfWeek)
|
||||||
|
- [EndOfMonth](#EndOfMonth)
|
||||||
|
- [EndOfYear](#EndOfYear)
|
||||||
|
- [GetNowDate](#GetNowDate)
|
||||||
|
- [GetNowTime](#GetNowTime)
|
||||||
|
- [GetNowDateTime](#GetNowDateTime)
|
||||||
|
- [GetZeroHourTimestamp](#GetZeroHourTimestamp)
|
||||||
|
- [GetNightTimestamp](#GetNightTimestamp)
|
||||||
|
- [FormatTimeToStr](#FormatTimeToStr)
|
||||||
|
|
||||||
|
- [FormatStrToTime](#FormatStrToTime)
|
||||||
|
- [NewUnixNow](#NewUnixNow)
|
||||||
|
- [NewUnix](#NewUnix)
|
||||||
|
- [NewFormat](#NewFormat)
|
||||||
|
- [NewISO8601](#NewISO8601)
|
||||||
|
- [ToUnix](#ToUnix)
|
||||||
|
- [ToFormat](#ToFormat)
|
||||||
|
- [ToFormatForTpl](#ToFormatForTpl)
|
||||||
|
- [ToIso8601](#ToIso8601)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
## Note:
|
||||||
|
1. 'format' string param in func FormatTimeToStr and FormatStrToTime function should be one of flows:
|
||||||
|
- yyyy-mm-dd hh:mm:ss
|
||||||
|
- yyyy-mm-dd hh:mm
|
||||||
|
- yyyy-mm-dd hh
|
||||||
|
- yyyy-mm-dd
|
||||||
|
- yyyy-mm
|
||||||
|
- mm-dd
|
||||||
|
- dd-mm-yy hh:mm:ss
|
||||||
|
- yyyy/mm/dd hh:mm:ss
|
||||||
|
- yyyy/mm/dd hh:mm
|
||||||
|
- yyyy-mm-dd hh
|
||||||
|
- yyyy/mm/dd
|
||||||
|
- yyyy/mm
|
||||||
|
- mm/dd
|
||||||
|
- dd/mm/yy hh:mm:ss
|
||||||
|
- yyyy
|
||||||
|
- mm
|
||||||
|
- hh:mm:ss
|
||||||
|
- mm:ss
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AddDay">AddDay</span>
|
||||||
|
<p>Add or sub days to time.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddDay(t time.Time, day int64) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Days := datetime.AddDay(now, 2)
|
||||||
|
before2Days := datetime.AddDay(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Days, before2Days)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AddHour">AddHour</span>
|
||||||
|
<p>Add or sub hours to time.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddHour(t time.Time, hour int64) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Hours := datetime.AddHour(now, 2)
|
||||||
|
before2Hours := datetime.AddHour(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Hours, after2Hours)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="AddMinute">AddMinute</span>
|
||||||
|
<p>Add or sub minutes to time.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddMinute(t time.Time, minute int64) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Minute := datetime.AddMinute(now, 2)
|
||||||
|
before2Minute := datetime.AddMinute(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Minute, before2Minute)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfMinute">BeginOfMinute</span>
|
||||||
|
<p>Return beginning minute time of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfMinute(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfMinute(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:48:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfHour">BeginOfHour</span>
|
||||||
|
<p>Return zero time of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfHour(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfHour(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfDay">BeginOfDay</span>
|
||||||
|
<p>Return begin time of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfDay(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfDay(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfWeek">BeginOfWeek</span>
|
||||||
|
<p>Return beginning time of week, week begin from Sunday.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfWeek(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfWeek(td)
|
||||||
|
fmt.Println(bm) //2022-02-13 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfMonth">BeginOfMonth</span>
|
||||||
|
<p>Return beginning time of month</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfMonth(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfMonth(td)
|
||||||
|
fmt.Println(bm) //2022-02-01 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfYear">BeginOfYear</span>
|
||||||
|
<p>Return beginning time of year.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfYear(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfYear(td)
|
||||||
|
fmt.Println(bm) //2022-01-01 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfMinute">EndOfMinute</span>
|
||||||
|
<p>Return end time minute of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfMinute(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfMinute(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:48:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="EndOfHour">EndOfHour</span>
|
||||||
|
<p>Return end time hour of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfHour(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfHour(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="EndOfDay">EndOfDay</span>
|
||||||
|
<p>Return end time hour of day.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfDay(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfDay(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfWeek">EndOfWeek</span>
|
||||||
|
<p>Return end time of week, week end with Saturday.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfWeek(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfWeek(td)
|
||||||
|
fmt.Println(bm) //2022-02-19 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfMonth">EndOfMonth</span>
|
||||||
|
<p>Return end time of month</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfMonth(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfMonth(td)
|
||||||
|
fmt.Println(bm) //2022-02-28 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfYear">EndOfYear</span>
|
||||||
|
<p>Return beginning time of year.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfYear(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfYear(td)
|
||||||
|
fmt.Println(bm) //2022-12-31 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowDate">GetNowDate</span>
|
||||||
|
<p>Get current date string, format is yyyy-mm-dd.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowDate() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
currentDate := datetime.GetNowDate()
|
||||||
|
fmt.Println(currentDate) // 2022-01-28
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowTime">GetNowTime</span>
|
||||||
|
<p>Get current time string, format is hh:mm:ss.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowTime() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
currentTime := datetime.GetNowTime()
|
||||||
|
fmt.Println(currentDate) // 15:57:33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowDateTime">GetNowDateTime</span>
|
||||||
|
<p>Get current date time string, format is yyyy-mm-dd hh:mm:ss.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowDateTime() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
current := datetime.GetNowDateTime()
|
||||||
|
fmt.Println(current) // 2022-01-28 15:59:33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetZeroHourTimestamp">GetZeroHourTimestamp</span>
|
||||||
|
<p>Return timestamp of zero hour (timestamp of 00:00).</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetZeroHourTimestamp() int64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
zeroTime := datetime.GetZeroHourTimestamp()
|
||||||
|
fmt.Println(zeroTime) // 1643299200
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNightTimestamp">GetNightTimestamp</span>
|
||||||
|
<p>Return timestamp of zero hour (timestamp of 23:59).</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNightTimestamp() int64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
nightTime := datetime.GetNightTimestamp()
|
||||||
|
fmt.Println(nightTime) // 1643385599
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="FormatTimeToStr">FormatTimeToStr</span>
|
||||||
|
<p>Format time to string, `format` param specification see note 1.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FormatTimeToStr(t time.Time, format string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
timeStr := datetime.FormatTimeToStr(now, "yyyy/mm/dd hh:mm:ss")
|
||||||
|
fmt.Println(timeStr) //2022/01/28 16:07:44
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="FormatStrToTime">FormatStrToTime</span>
|
||||||
|
<p>Format string to time, `format` param specification see note 1.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FormatStrToTime(str, format string) (time.Time, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
time := datetime.FormatStrToTime("2006-01-02 15:04:05", "yyyy/mm/dd hh:mm:ss")
|
||||||
|
fmt.Println(time)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewUnixNow">NewUnixNow</span>
|
||||||
|
<p>Return unix timestamp of current time</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewUnixNow() *theTime
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnixNow()
|
||||||
|
fmt.Println(tm) //&{1647597438}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewUnix">NewUnix</span>
|
||||||
|
<p>Return unix timestamp of specified int64 value.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewUnix(unix int64) *theTime
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnix(1647597438)
|
||||||
|
fmt.Println(tm) //&{1647597438}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewFormat">NewFormat</span>
|
||||||
|
<p>Return unix timestamp of specified time string, t should be "yyyy-mm-dd hh:mm:ss".</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewFormat(t string) (*theTime, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, err := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
fmt.Println(tm) //&{1647594245}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewISO8601">NewISO8601</span>
|
||||||
|
<p>Return unix timestamp of specified iso8601 time string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewISO8601(iso8601 string) (*theTime, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, err := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
|
||||||
|
fmt.Println(tm) //&{1136214245}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToUnix">ToUnix</span>
|
||||||
|
<p>Return unix timestamp.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToUnix() int64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnixNow()
|
||||||
|
fmt.Println(tm.ToUnix()) //1647597438
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFormat">ToFormat</span>
|
||||||
|
<p>Return time string 'yyyy-mm-dd hh:mm:ss'.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToFormat() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
fmt.Println(tm.ToFormat()) //"2022-03-18 17:04:05"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFormatForTpl">ToFormatForTpl</span>
|
||||||
|
<p>Return the time string which format is specified tpl.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToFormatForTpl(tpl string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
ts := tm.ToFormatForTpl("2006/01/02 15:04:05")
|
||||||
|
fmt.Println(ts) //"2022/03/18 17:04:05"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToIso8601">ToIso8601</span>
|
||||||
|
<p>Return iso8601 time string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToIso8601() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
|
||||||
|
ts := tm.ToIso8601()
|
||||||
|
fmt.Println(ts) //"2006-01-02T23:04:05+08:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
895
docs/datetime_zh-CN.md
Normal file
895
docs/datetime_zh-CN.md
Normal file
@@ -0,0 +1,895 @@
|
|||||||
|
# Datetime
|
||||||
|
datetime日期时间处理包,格式化日期,比较日期。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go](https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [AddDay](#AddDay)
|
||||||
|
- [AddHour](#AddHour)
|
||||||
|
- [AddMinute](#AddMinute)
|
||||||
|
- [BeginOfMinute](#BeginOfMinute)
|
||||||
|
- [BeginOfHour](#BeginOfHour)
|
||||||
|
- [BeginOfDay](#BeginOfDay)
|
||||||
|
- [BeginOfWeek](#BeginOfWeek)
|
||||||
|
- [BeginOfMonth](#BeginOfMonth)
|
||||||
|
- [BeginOfYear](#BeginOfYear)
|
||||||
|
|
||||||
|
- [EndOfMinute](#EndOfMinute)
|
||||||
|
- [EndOfHour](#EndOfHour)
|
||||||
|
- [EndOfDay](#EndOfDay)
|
||||||
|
- [EndOfWeek](#EndOfWeek)
|
||||||
|
- [EndOfMonth](#EndOfMonth)
|
||||||
|
- [EndOfYear](#EndOfYear)
|
||||||
|
- [GetNowDate](#GetNowDate)
|
||||||
|
- [GetNowTime](#GetNowTime)
|
||||||
|
- [GetNowDateTime](#GetNowDateTime)
|
||||||
|
- [GetZeroHourTimestamp](#GetZeroHourTimestamp)
|
||||||
|
- [GetNightTimestamp](#GetNightTimestamp)
|
||||||
|
- [FormatTimeToStr](#FormatTimeToStr)
|
||||||
|
- [FormatStrToTime](#FormatStrToTime)
|
||||||
|
- [NewUnixNow](#NewUnixNow)
|
||||||
|
- [NewUnix](#NewUnix)
|
||||||
|
- [NewFormat](#NewFormat)
|
||||||
|
- [NewISO8601](#NewISO8601)
|
||||||
|
- [ToUnix](#ToUnix)
|
||||||
|
- [ToFormat](#ToFormat)
|
||||||
|
- [ToFormatForTpl](#ToFormatForTpl)
|
||||||
|
- [ToIso8601](#ToIso8601)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
## 注:
|
||||||
|
1. 方法FormatTimeToStr和FormatStrToTime中的format参数值需要传以下类型之一:
|
||||||
|
- yyyy-mm-dd hh:mm:ss
|
||||||
|
- yyyy-mm-dd hh:mm
|
||||||
|
- yyyy-mm-dd hh
|
||||||
|
- yyyy-mm-dd
|
||||||
|
- yyyy-mm
|
||||||
|
- mm-dd
|
||||||
|
- dd-mm-yy hh:mm:ss
|
||||||
|
- yyyy/mm/dd hh:mm:ss
|
||||||
|
- yyyy/mm/dd hh:mm
|
||||||
|
- yyyy-mm-dd hh
|
||||||
|
- yyyy/mm/dd
|
||||||
|
- yyyy/mm
|
||||||
|
- mm/dd
|
||||||
|
- dd/mm/yy hh:mm:ss
|
||||||
|
- yyyy
|
||||||
|
- mm
|
||||||
|
- hh:mm:ss
|
||||||
|
- mm:ss
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AddDay">AddDay</span>
|
||||||
|
<p>将日期加/减天数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddDay(t time.Time, day int64) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Days := datetime.AddDay(now, 2)
|
||||||
|
before2Days := datetime.AddDay(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Days, before2Days)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AddHour">AddHour</span>
|
||||||
|
<p>将日期加/减小时数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddHour(t time.Time, hour int64) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Hours := datetime.AddHour(now, 2)
|
||||||
|
before2Hours := datetime.AddHour(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Hours, after2Hours)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="AddMinute">AddMinute</span>
|
||||||
|
<p>将日期加/减分钟数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AddMinute(t time.Time, minute int64) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
after2Minute := datetime.AddMinute(now, 2)
|
||||||
|
before2Minute := datetime.AddMinute(now, -2)
|
||||||
|
|
||||||
|
fmt.Println(after2Minute, before2Minute)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfMinute">BeginOfMinute</span>
|
||||||
|
<p>返回指定时间的分钟开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfMinute(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfMinute(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:48:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfHour">BeginOfHour</span>
|
||||||
|
<p>返回指定时间的小时开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfHour(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfHour(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="BeginOfDay">BeginOfDay</span>
|
||||||
|
<p>返回指定时间的当天开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfDay(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfDay(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfWeek">BeginOfWeek</span>
|
||||||
|
<p>返回指定时间的星期开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfWeek(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfWeek(td)
|
||||||
|
fmt.Println(bm) //2022-02-13 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfMonth">BeginOfMonth</span>
|
||||||
|
<p>返回指定时间的当月开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfMonth(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfMonth(td)
|
||||||
|
fmt.Println(bm) //2022-02-01 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeginOfYear">BeginOfYear</span>
|
||||||
|
<p>返回指定时间的当年开始时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeginOfYear(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.BeginOfYear(td)
|
||||||
|
fmt.Println(bm) //2022-01-01 00:00:00 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfMinute">EndOfMinute</span>
|
||||||
|
<p>返回指定时间的分钟结束时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfMinute(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfMinute(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:48:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="EndOfHour">EndOfHour</span>
|
||||||
|
<p>返回指定时间的小时结束时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfHour(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfHour(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 15:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="EndOfDay">EndOfDay</span>
|
||||||
|
<p>返回指定时间的当天结束时间.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfDay(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfDay(td)
|
||||||
|
fmt.Println(bm) //2022-02-15 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfWeek">EndOfWeek</span>
|
||||||
|
<p>返回指定时间的星期结束时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfWeek(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfWeek(td)
|
||||||
|
fmt.Println(bm) //2022-02-19 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfMonth">EndOfMonth</span>
|
||||||
|
<p>返回指定时间的月份结束时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfMonth(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfMonth(td)
|
||||||
|
fmt.Println(bm) //2022-02-28 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EndOfYear">EndOfYear</span>
|
||||||
|
<p>返回指定时间的年份结束时间</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EndOfYear(t time.Time) time.Time
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local)
|
||||||
|
bm := datetime.EndOfYear(td)
|
||||||
|
fmt.Println(bm) //2022-12-31 23:59:59.999999999 +0800 CST
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowDate">GetNowDate</span>
|
||||||
|
<p>获取当天日期,返回格式:yyyy-mm-dd</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowDate() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
currentDate := datetime.GetNowDate()
|
||||||
|
fmt.Println(currentDate) // 2022-01-28
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowTime">GetNowTime</span>
|
||||||
|
<p>获取当时时间,返回格式:hh:mm:ss</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowTime() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
currentTime := datetime.GetNowTime()
|
||||||
|
fmt.Println(currentDate) // 15:57:33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNowDateTime">GetNowDateTime</span>
|
||||||
|
<p>获取当时日期和时间,返回格式:yyyy-mm-dd hh:mm:ss.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNowDateTime() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
current := datetime.GetNowDateTime()
|
||||||
|
fmt.Println(current) // 2022-01-28 15:59:33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetZeroHourTimestamp">GetZeroHourTimestamp</span>
|
||||||
|
<p>获取零时时间戳(timestamp of 00:00).</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetZeroHourTimestamp() int64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
zeroTime := datetime.GetZeroHourTimestamp()
|
||||||
|
fmt.Println(zeroTime) // 1643299200
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetNightTimestamp">GetNightTimestamp</span>
|
||||||
|
<p>获取午夜时间戳(timestamp of 23:59).</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetNightTimestamp() int64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
nightTime := datetime.GetNightTimestamp()
|
||||||
|
fmt.Println(nightTime) // 1643385599
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="FormatTimeToStr">FormatTimeToStr</span>
|
||||||
|
<p>将日期格式化成字符串,`format` 参数格式参考注<sup>1</sup></p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FormatTimeToStr(t time.Time, format string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
now := time.Now()
|
||||||
|
timeStr := datetime.FormatTimeToStr(now, "yyyy/mm/dd hh:mm:ss")
|
||||||
|
fmt.Println(timeStr) //2022/01/28 16:07:44
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="FormatStrToTime">FormatStrToTime</span>
|
||||||
|
<p>将字符串格式化成时间,`format` 参数格式参考注<sup>1</sup></p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FormatStrToTime(str, format string) (time.Time, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
time := datetime.FormatStrToTime("2006-01-02 15:04:05", "yyyy/mm/dd hh:mm:ss")
|
||||||
|
fmt.Println(time)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewUnixNow">NewUnixNow</span>
|
||||||
|
<p>创建一个当前时间的unix时间戳</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewUnixNow() *theTime
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnixNow()
|
||||||
|
fmt.Println(tm) //&{1647597438}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewUnix">NewUnix</span>
|
||||||
|
<p>创建一个unix时间戳</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewUnix(unix int64) *theTime
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnix(1647597438)
|
||||||
|
fmt.Println(tm) //&{1647597438}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewFormat">NewFormat</span>
|
||||||
|
<p>创建一个yyyy-mm-dd hh:mm:ss格式时间字符串的unix时间戳</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewFormat(t string) (*theTime, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, err := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
fmt.Println(tm) //&{1647594245}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="NewISO8601">NewISO8601</span>
|
||||||
|
<p>创建一个iso8601格式时间字符串的unix时间戳</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type theTime struct {
|
||||||
|
unix int64
|
||||||
|
}
|
||||||
|
func NewISO8601(iso8601 string) (*theTime, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, err := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
|
||||||
|
fmt.Println(tm) //&{1136214245}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToUnix">ToUnix</span>
|
||||||
|
<p>返回unix时间戳</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToUnix() int64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm := datetime.NewUnixNow()
|
||||||
|
fmt.Println(tm.ToUnix()) //1647597438
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFormat">ToFormat</span>
|
||||||
|
<p>返回格式'yyyy-mm-dd hh:mm:ss'的日期字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToFormat() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
fmt.Println(tm.ToFormat()) //"2022-03-18 17:04:05"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToFormatForTpl">ToFormatForTpl</span>
|
||||||
|
<p>返回tpl格式指定的日期字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToFormatForTpl(tpl string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewFormat("2022-03-18 17:04:05")
|
||||||
|
ts := tm.ToFormatForTpl("2006/01/02 15:04:05")
|
||||||
|
fmt.Println(ts) //"2022/03/18 17:04:05"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ToIso8601">ToIso8601</span>
|
||||||
|
<p>返回iso8601日期字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (t *theTime) ToIso8601() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/v2/datetime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
tm, _ := datetime.NewISO8601("2006-01-02T15:04:05.999Z")
|
||||||
|
ts := tm.ToIso8601()
|
||||||
|
fmt.Println(ts) //"2006-01-02T23:04:05+08:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
473
docs/fileutil.md
Normal file
473
docs/fileutil.md
Normal file
@@ -0,0 +1,473 @@
|
|||||||
|
# Fileutil
|
||||||
|
Package fileutil implements some basic functions for file operations.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/fileutil/file.go](https://github.com/duke-git/lancet/blob/v1/fileutil/file.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [ClearFile](#ClearFile)
|
||||||
|
- [CreateFile](#CreateFile)
|
||||||
|
|
||||||
|
- [CreateDir](#CreateDir)
|
||||||
|
- [CopyFile](#CopyFile)
|
||||||
|
- [FileMode](#FileMode)
|
||||||
|
- [MiMeType](#MiMeType)
|
||||||
|
- [IsExist](#IsExist)
|
||||||
|
- [IsLink](#IsLink)
|
||||||
|
- [IsDir](#IsDir)
|
||||||
|
- [ListFileNames](#ListFileNames)
|
||||||
|
- [RemoveFile](#RemoveFile)
|
||||||
|
- [ReadFileToString](#ReadFileToString)
|
||||||
|
- [ReadFileByLine](#ReadFileByLine)
|
||||||
|
- [Zip](#Zip)
|
||||||
|
- [UnZip](#UnZip)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ClearFile">ClearFile</span>
|
||||||
|
<p>Clear the file content, write empty string to the file.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ClearFile(path string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.ClearFile("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CreateDir">CreateDir</span>
|
||||||
|
<p>Create directory in absolute path. param `absPath` like /a/, /a/b/.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CreateDir(absPath string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.CreateDir("/a/")
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CreateFile">CreateFile</span>
|
||||||
|
<p>Create file in path. return true if create succeed.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CreateFile(path string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isCreatedSucceed := fileutil.CreateFile("./test.txt")
|
||||||
|
fmt.Println(isCreatedSucceed)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CopyFile">CopyFile</span>
|
||||||
|
<p>Copy src file to dest file. If dest file exist will overwrite it.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CopyFile(srcFilePath string, dstFilePath string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.CopyFile("./test.txt", "./test_copy.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="FileMode">FileMode</span>
|
||||||
|
<p>Return file mode infomation.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FileMode(path string) (fs.FileMode, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
mode, err := fileutil.FileMode("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(mode)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="MiMeType">MiMeType</span>
|
||||||
|
<p>Get file mime type, 'file' param's type should be string or *os.File.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func MiMeType(file interface{}) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
type1 := fileutil.MiMeType("./test.txt")
|
||||||
|
fmt.Println(type1) //text/plain; charset=utf-8
|
||||||
|
|
||||||
|
f, _ := os.Open("./file.go")
|
||||||
|
type2 := fileutil.MiMeType(f)
|
||||||
|
fmt.Println(type2) //text/plain; charset=utf-8
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsExist">IsExist</span>
|
||||||
|
<p>Checks if a file or directory exists.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsExist(path string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fileutil.CreateFile("./test.txt")
|
||||||
|
isFileExist := fileutil.IsExist("./test.txt")
|
||||||
|
fmt.Println(isFileExist) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsLink">IsLink</span>
|
||||||
|
<p>Checks if a file is symbol link or not.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsLink(path string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isLinkFile := fileutil.IsLink("./test.txt")
|
||||||
|
fmt.Println(isLinkFile) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsDir">IsDir</span>
|
||||||
|
<p>Checks if the path is directy or not.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsDir(path string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isDir := fileutil.IsDir("./")
|
||||||
|
fmt.Println(isDir) //true
|
||||||
|
|
||||||
|
isDir = fileutil.IsDir("./test.txt")
|
||||||
|
fmt.Println(isDir) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ListFileNames">ListFileNames</span>
|
||||||
|
<p>List all file names in given path.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ListFileNames(path string) ([]string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fileNames, _ := fileutil.ListFileNames("./")
|
||||||
|
fmt.Println(fileNames)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RemoveFile">RemoveFile</span>
|
||||||
|
<p>Remove the file of path.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RemoveFile(path string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.RemoveFile("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReadFileToString">ReadFileToString</span>
|
||||||
|
<p>Return string of file content.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReadFileToString(path string) (string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
path := "./test.txt"
|
||||||
|
fileutil.CreateFile(path)
|
||||||
|
|
||||||
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
f.WriteString("hello world")
|
||||||
|
|
||||||
|
content, _ := fileutil.ReadFileToString(path)
|
||||||
|
fmt.Println(content) //hello world
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReadFileByLine">ReadFileByLine</span>
|
||||||
|
<p>Read file line by line, and return slice of lines</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReadFileByLine(path string)([]string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
path := "./text.txt"
|
||||||
|
fileutil.CreateFile(path)
|
||||||
|
|
||||||
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
defer f.Close()
|
||||||
|
f.WriteString("hello\nworld")
|
||||||
|
|
||||||
|
contents, _ := fileutil.ReadFileByLine(path)
|
||||||
|
fmt.Println(contents) //[]string{"hello", "world"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Zip">Zip</span>
|
||||||
|
<p>Create a zip file of fpath, fpath could be a file or a directory.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Zip(fpath string, destPath string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.Zip("./test.txt", "./test.zip")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UnZip">UnZip</span>
|
||||||
|
<p>Unzip the file and save it to dest path.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UnZip(zipFile string, destPath string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.Zip("./test.zip", "./unzip/test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
472
docs/fileutil_zh-CN.md
Normal file
472
docs/fileutil_zh-CN.md
Normal file
@@ -0,0 +1,472 @@
|
|||||||
|
# Fileutil
|
||||||
|
fileutil包支持文件基本操作。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/fileutil/file.go](https://github.com/duke-git/lancet/blob/v1/fileutil/file.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [ClearFile](#ClearFile)
|
||||||
|
- [CreateFile](#CreateFile)
|
||||||
|
- [CreateDir](#CreateDir)
|
||||||
|
- [CopyFile](#CopyFile)
|
||||||
|
- [FileMode](#FileMode)
|
||||||
|
- [MiMeType](#MiMeType)
|
||||||
|
- [IsExist](#IsExist)
|
||||||
|
- [IsLink](#IsLink)
|
||||||
|
- [IsDir](#IsDir)
|
||||||
|
|
||||||
|
- [ListFileNames](#ListFileNames)
|
||||||
|
- [RemoveFile](#RemoveFile)
|
||||||
|
- [ReadFileToString](#ReadFileToString)
|
||||||
|
- [ReadFileByLine](#ReadFileByLine)
|
||||||
|
- [Zip](#Zip)
|
||||||
|
- [UnZip](#UnZip)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ClearFile">ClearFile</span>
|
||||||
|
<p>清空文件内容</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ClearFile(path string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.ClearFile("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CreateDir">CreateDir</span>
|
||||||
|
<p>使用绝对路径创建嵌套目录,例如/a/, /a/b/</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CreateDir(absPath string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.CreateDir("/a/")
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CreateFile">CreateFile</span>
|
||||||
|
<p>创建文件,创建成功返回true, 否则返回false</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CreateFile(path string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isCreatedSucceed := fileutil.CreateFile("./test.txt")
|
||||||
|
fmt.Println(isCreatedSucceed)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CopyFile">CopyFile</span>
|
||||||
|
<p>拷贝文件,会覆盖原有的拷贝文件</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CopyFile(srcFilePath string, dstFilePath string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.CopyFile("./test.txt", "./test_copy.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="FileMode">FileMode</span>
|
||||||
|
<p>获取文件mode信息</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func FileMode(path string) (fs.FileMode, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
mode, err := fileutil.FileMode("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(mode)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="MiMeType">MiMeType</span>
|
||||||
|
<p>获取文件mime类型, 'file'参数的类型必须是string或者*os.File</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func MiMeType(file interface{}) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
type1 := fileutil.MiMeType("./test.txt")
|
||||||
|
fmt.Println(type1) //text/plain; charset=utf-8
|
||||||
|
|
||||||
|
f, _ := os.Open("./file.go")
|
||||||
|
type2 := fileutil.MiMeType(f)
|
||||||
|
fmt.Println(type2) //text/plain; charset=utf-8
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsExist">IsExist</span>
|
||||||
|
<p>判断文件或目录是否存在</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsExist(path string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fileutil.CreateFile("./test.txt")
|
||||||
|
isFileExist := fileutil.IsExist("./test.txt")
|
||||||
|
fmt.Println(isFileExist) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsLink">IsLink</span>
|
||||||
|
<p>判断文件是否是符号链接</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsLink(path string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isLinkFile := fileutil.IsLink("./test.txt")
|
||||||
|
fmt.Println(isLinkFile) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsDir">IsDir</span>
|
||||||
|
<p>判断目录是否存在</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsDir(path string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isDir := fileutil.IsDir("./")
|
||||||
|
fmt.Println(isDir) //true
|
||||||
|
|
||||||
|
isDir = fileutil.IsDir("./test.txt")
|
||||||
|
fmt.Println(isDir) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ListFileNames">ListFileNames</span>
|
||||||
|
<p>返回目录下所有文件名</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ListFileNames(path string) ([]string, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fileNames, _ := fileutil.ListFileNames("./")
|
||||||
|
fmt.Println(fileNames)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RemoveFile">RemoveFile</span>
|
||||||
|
<p>删除文件</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RemoveFile(path string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.RemoveFile("./test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReadFileToString">ReadFileToString</span>
|
||||||
|
<p>读取文件内容并返回字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReadFileToString(path string) (string, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
path := "./test.txt"
|
||||||
|
fileutil.CreateFile(path)
|
||||||
|
|
||||||
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
f.WriteString("hello world")
|
||||||
|
|
||||||
|
content, _ := fileutil.ReadFileToString(path)
|
||||||
|
fmt.Println(content) //hello world
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReadFileByLine">ReadFileByLine</span>
|
||||||
|
<p>按行读取文件内容,返回字符串切片包含每一行</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReadFileByLine(path string)([]string, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
path := "./text.txt"
|
||||||
|
fileutil.CreateFile(path)
|
||||||
|
|
||||||
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
defer f.Close()
|
||||||
|
f.WriteString("hello\nworld")
|
||||||
|
|
||||||
|
contents, _ := fileutil.ReadFileByLine(path)
|
||||||
|
fmt.Println(contents) //[]string{"hello", "world"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Zip">Zip</span>
|
||||||
|
<p>zip压缩文件, fpath参数可以是文件或目录</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Zip(fpath string, destPath string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.Zip("./test.txt", "./test.zip")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UnZip">UnZip</span>
|
||||||
|
<p>zip解压缩文件并保存在目录中</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UnZip(zipFile string, destPath string) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/fileutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := fileutil.Zip("./test.zip", "./unzip/test.txt")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
53
docs/formatter.md
Normal file
53
docs/formatter.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# Formatter
|
||||||
|
formatter contains some functions for data formatting.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/formatter/formatter.go](https://github.com/duke-git/lancet/blob/v1/formatter/formatter.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/formatter"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [Comma](#Comma)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Comma">Comma</span>
|
||||||
|
<p>Add comma to number by every 3 numbers from right. ahead by symbol char.
|
||||||
|
Param should be number or numberic string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Comma(v interface{}, symbol string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/formatter"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(formatter.Comma("12345", "")) // "12,345"
|
||||||
|
fmt.Println(formatter.Comma(12345.67, "¥")) // "¥12,345.67"
|
||||||
|
}
|
||||||
|
```
|
||||||
52
docs/formatter_zh-CN.md
Normal file
52
docs/formatter_zh-CN.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# Formatter
|
||||||
|
formatter格式化器包含一些数据格式化处理方法。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/formatter/formatter.go](https://github.com/duke-git/lancet/blob/v1/formatter/formatter.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/formatter"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [Comma](#Comma)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Comma">Comma</span>
|
||||||
|
<p>用逗号每隔3位分割数字/字符串,签名添加符号。参数必须是数字或者可以转为数字的字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Comma(v interface{}, symbol string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/formatter"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(formatter.Comma("12345", "")) // "12,345"
|
||||||
|
fmt.Println(formatter.Comma(12345.67, "¥")) // "¥12,345.67"
|
||||||
|
}
|
||||||
|
```
|
||||||
364
docs/function.md
Normal file
364
docs/function.md
Normal file
@@ -0,0 +1,364 @@
|
|||||||
|
# Function
|
||||||
|
Package function can control the flow of function execution and support part of functional programming.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/function/function.go](https://github.com/duke-git/lancet/blob/v1/function/function.go)
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/function/watcher.go](https://github.com/duke-git/lancet/blob/v1/function/watcher.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [After](#After)
|
||||||
|
- [Before](#Before)
|
||||||
|
- [Curry](#Curry)
|
||||||
|
- [Compose](#Compose)
|
||||||
|
- [Debounced](#Debounced)
|
||||||
|
- [Delay](#Delay)
|
||||||
|
- [Watcher](#Watcher)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="After">After</span>
|
||||||
|
<p>Creates a function that invokes given func once it's called n or more times.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
arr := []string{"a", "b"}
|
||||||
|
f := function.After(len(arr), func(i int) int {
|
||||||
|
fmt.Println("last print")
|
||||||
|
return i
|
||||||
|
})
|
||||||
|
|
||||||
|
type cb func(args ...interface{}) []reflect.Value
|
||||||
|
print := func(i int, s string, fn cb) {
|
||||||
|
fmt.Printf("arr[%d] is %s \n", i, s)
|
||||||
|
fn(i)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println("arr is", arr)
|
||||||
|
for i := 0; i < len(arr); i++ {
|
||||||
|
print(i, arr[i], f)
|
||||||
|
}
|
||||||
|
|
||||||
|
//output:
|
||||||
|
// arr is [a b]
|
||||||
|
// arr[0] is a
|
||||||
|
// arr[1] is b
|
||||||
|
// last print
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Before">Before</span>
|
||||||
|
|
||||||
|
<p>creates a function that invokes func once it's called less than n times.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Before(n int, fn interface{}) func(args ...interface{}) []reflect.Value
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
assert := internal.NewAssert(t, "TestBefore")
|
||||||
|
|
||||||
|
arr := []string{"a", "b", "c", "d", "e"}
|
||||||
|
f := function.Before(3, func(i int) int {
|
||||||
|
return i
|
||||||
|
})
|
||||||
|
|
||||||
|
var res []int64
|
||||||
|
type cb func(args ...interface{}) []reflect.Value
|
||||||
|
appendStr := func(i int, s string, fn cb) {
|
||||||
|
v := fn(i)
|
||||||
|
res = append(res, v[0].Int())
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < len(arr); i++ {
|
||||||
|
appendStr(i, arr[i], f)
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := []int64{0, 1, 2, 2, 2}
|
||||||
|
assert.Equal(expected, res)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Curry">Curry</span>
|
||||||
|
|
||||||
|
<p>Make a curry function.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Fn func(...interface{}) interface{}
|
||||||
|
func (f Fn) Curry(i interface{}) func(...interface{}) interface{}
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
add := func(a, b int) int {
|
||||||
|
return a + b
|
||||||
|
}
|
||||||
|
var addCurry function.Fn = func(values ...interface{}) interface{} {
|
||||||
|
return add(values[0].(int), values[1].(int))
|
||||||
|
}
|
||||||
|
add1 := addCurry.Curry(1)
|
||||||
|
result := add1(2)
|
||||||
|
fmt.Println(result) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Compose">Compose</span>
|
||||||
|
|
||||||
|
<p>Compose the function list from right to left, then return the composed function.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) interface{}
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
add1 := func(v ...interface{}) interface{} {
|
||||||
|
return v[0].(int) + 1
|
||||||
|
}
|
||||||
|
add2 := func(v ...interface{}) interface{} {
|
||||||
|
return v[0].(int) + 2
|
||||||
|
}
|
||||||
|
|
||||||
|
add3 := function.Compose(add1, add2)
|
||||||
|
result := add3(1)
|
||||||
|
|
||||||
|
fmt.Println(result) //4
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Debounced">Debounced</span>
|
||||||
|
|
||||||
|
<p>Creates a debounced function that delays invoking fn until after wait duration have elapsed since the last time the debounced function was invoked.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Debounced(fn func(), duration time.Duration) func()
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
count := 0
|
||||||
|
add := func() {
|
||||||
|
count++
|
||||||
|
}
|
||||||
|
|
||||||
|
debouncedAdd := function.Debounced(add, 50*time.Microsecond)
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
fmt.Println(count) //1
|
||||||
|
|
||||||
|
function.debouncedAdd()
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
fmt.Println(count) //2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Delay">Delay</span>
|
||||||
|
|
||||||
|
<p>Invoke function after delayed time.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Delay(delay time.Duration, fn interface{}, args ...interface{})
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var print = func(s string) {
|
||||||
|
fmt.Println(count) //test delay
|
||||||
|
}
|
||||||
|
function.Delay(2*time.Second, print, "test delay")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Schedule">Schedule</span>
|
||||||
|
|
||||||
|
<p>Invoke function every duration time, until close the returned bool chan.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var res []string
|
||||||
|
appendStr := func(s string) {
|
||||||
|
res = append(res, s)
|
||||||
|
}
|
||||||
|
|
||||||
|
stop := function.Schedule(1*time.Second, appendStr, "*")
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
close(stop)
|
||||||
|
|
||||||
|
fmt.Println(res) //[* * * * *]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Watcher">Watcher</span>
|
||||||
|
|
||||||
|
<p>Watcher is used for record code excution time. can start/stop/reset the watch timer. get the elapsed time of function execution.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Watcher struct {
|
||||||
|
startTime int64
|
||||||
|
stopTime int64
|
||||||
|
excuting bool
|
||||||
|
}
|
||||||
|
func (w *Watcher) Start() //start the watcher
|
||||||
|
func (w *Watcher) Stop() //stop the watcher
|
||||||
|
func (w *Watcher) Reset() //reset the watcher
|
||||||
|
func (w *Watcher) GetElapsedTime() time.Duration //get the elapsed time of function execution
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
w := &function.Watcher{}
|
||||||
|
w.Start()
|
||||||
|
|
||||||
|
longRunningTask()
|
||||||
|
|
||||||
|
fmt.Println(w.excuting) //true
|
||||||
|
|
||||||
|
w.Stop()
|
||||||
|
|
||||||
|
eapsedTime := w.GetElapsedTime().Milliseconds()
|
||||||
|
fmt.Println(eapsedTime)
|
||||||
|
|
||||||
|
w.Reset()
|
||||||
|
|
||||||
|
fmt.Println(w.excuting) //false
|
||||||
|
|
||||||
|
fmt.Println(w.startTime) //0
|
||||||
|
fmt.Println(w.stopTime) //0
|
||||||
|
}
|
||||||
|
|
||||||
|
func longRunningTask() {
|
||||||
|
var slice []int64
|
||||||
|
for i := 0; i < 10000000; i++ {
|
||||||
|
slice = append(slice, int64(i))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
364
docs/function_zh-CN.md
Normal file
364
docs/function_zh-CN.md
Normal file
@@ -0,0 +1,364 @@
|
|||||||
|
# Function
|
||||||
|
function函数包控制函数执行流程,包含部分函数式编程。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/function/function.go](https://github.com/duke-git/lancet/blob/v1/function/function.go)
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/function/watcher.go](https://github.com/duke-git/lancet/blob/v1/function/watcher.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [After](#After)
|
||||||
|
- [Before](#Before)
|
||||||
|
- [Curry](#Curry)
|
||||||
|
- [Compose](#Compose)
|
||||||
|
- [Debounced](#Debounced)
|
||||||
|
- [Delay](#Delay)
|
||||||
|
- [Watcher](#Watcher)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="After">After</span>
|
||||||
|
<p>创建一个函数,当他被调用n或更多次之后将马上触发fn</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
arr := []string{"a", "b"}
|
||||||
|
f := function.After(len(arr), func(i int) int {
|
||||||
|
fmt.Println("last print")
|
||||||
|
return i
|
||||||
|
})
|
||||||
|
|
||||||
|
type cb func(args ...interface{}) []reflect.Value
|
||||||
|
print := func(i int, s string, fn cb) {
|
||||||
|
fmt.Printf("arr[%d] is %s \n", i, s)
|
||||||
|
fn(i)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println("arr is", arr)
|
||||||
|
for i := 0; i < len(arr); i++ {
|
||||||
|
print(i, arr[i], f)
|
||||||
|
}
|
||||||
|
|
||||||
|
//output:
|
||||||
|
// arr is [a b]
|
||||||
|
// arr[0] is a
|
||||||
|
// arr[1] is b
|
||||||
|
// last print
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Before">Before</span>
|
||||||
|
|
||||||
|
<p>创建一个函数,调用次数不超过n次,之后再调用这个函数,将返回一次最后调用fn的结果</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Before(n int, fn interface{}) func(args ...interface{}) []reflect.Value
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
assert := internal.NewAssert(t, "TestBefore")
|
||||||
|
|
||||||
|
arr := []string{"a", "b", "c", "d", "e"}
|
||||||
|
f := function.Before(3, func(i int) int {
|
||||||
|
return i
|
||||||
|
})
|
||||||
|
|
||||||
|
var res []int64
|
||||||
|
type cb func(args ...interface{}) []reflect.Value
|
||||||
|
appendStr := func(i int, s string, fn cb) {
|
||||||
|
v := fn(i)
|
||||||
|
res = append(res, v[0].Int())
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < len(arr); i++ {
|
||||||
|
appendStr(i, arr[i], f)
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := []int64{0, 1, 2, 2, 2}
|
||||||
|
assert.Equal(expected, res)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Curry">Curry</span>
|
||||||
|
|
||||||
|
<p>创建一个柯里化的函数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Fn func(...interface{}) interface{}
|
||||||
|
func (f Fn) Curry(i interface{}) func(...interface{}) interface{}
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
add := func(a, b int) int {
|
||||||
|
return a + b
|
||||||
|
}
|
||||||
|
var addCurry function.Fn = func(values ...interface{}) interface{} {
|
||||||
|
return add(values[0].(int), values[1].(int))
|
||||||
|
}
|
||||||
|
add1 := addCurry.Curry(1)
|
||||||
|
result := add1(2)
|
||||||
|
fmt.Println(result) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Compose">Compose</span>
|
||||||
|
|
||||||
|
<p>从右至左组合函数列表fnList, 返回组合后的函数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) interface{}
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
add1 := func(v ...interface{}) interface{} {
|
||||||
|
return v[0].(int) + 1
|
||||||
|
}
|
||||||
|
add2 := func(v ...interface{}) interface{} {
|
||||||
|
return v[0].(int) + 2
|
||||||
|
}
|
||||||
|
|
||||||
|
add3 := function.Compose(add1, add2)
|
||||||
|
result := add3(1)
|
||||||
|
|
||||||
|
fmt.Println(result) //4
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Debounced">Debounced</span>
|
||||||
|
|
||||||
|
<p>创建一个 debounced 函数,该函数延迟调用 fn 直到自上次调用 debounced 函数后等待持续时间过去。</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Debounced(fn func(), duration time.Duration) func()
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
count := 0
|
||||||
|
add := func() {
|
||||||
|
count++
|
||||||
|
}
|
||||||
|
|
||||||
|
debouncedAdd := function.Debounced(add, 50*time.Microsecond)
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
function.debouncedAdd()
|
||||||
|
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
fmt.Println(count) //1
|
||||||
|
|
||||||
|
function.debouncedAdd()
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
fmt.Println(count) //2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Delay">Delay</span>
|
||||||
|
|
||||||
|
<p>延迟delay时间后调用函数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Delay(delay time.Duration, fn interface{}, args ...interface{})
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var print = func(s string) {
|
||||||
|
fmt.Println(count) //test delay
|
||||||
|
}
|
||||||
|
function.Delay(2*time.Second, print, "test delay")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Schedule">Schedule</span>
|
||||||
|
|
||||||
|
<p>每次持续时间调用函数,直到关闭返回的 bool chan</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var res []string
|
||||||
|
appendStr := func(s string) {
|
||||||
|
res = append(res, s)
|
||||||
|
}
|
||||||
|
|
||||||
|
stop := function.Schedule(1*time.Second, appendStr, "*")
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
close(stop)
|
||||||
|
|
||||||
|
fmt.Println(res) //[* * * * *]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Watcher">Watcher</span>
|
||||||
|
|
||||||
|
<p>Watcher 用于记录代码执行时间。可以启动/停止/重置手表定时器。获取函数执行的时间。 </p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Watcher struct {
|
||||||
|
startTime int64
|
||||||
|
stopTime int64
|
||||||
|
excuting bool
|
||||||
|
}
|
||||||
|
func (w *Watcher) Start() //start the watcher
|
||||||
|
func (w *Watcher) Stop() //stop the watcher
|
||||||
|
func (w *Watcher) Reset() //reset the watcher
|
||||||
|
func (w *Watcher) GetElapsedTime() time.Duration //get the elapsed time of function execution
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/function"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
w := &function.Watcher{}
|
||||||
|
w.Start()
|
||||||
|
|
||||||
|
longRunningTask()
|
||||||
|
|
||||||
|
fmt.Println(w.excuting) //true
|
||||||
|
|
||||||
|
w.Stop()
|
||||||
|
|
||||||
|
eapsedTime := w.GetElapsedTime().Milliseconds()
|
||||||
|
fmt.Println(eapsedTime)
|
||||||
|
|
||||||
|
w.Reset()
|
||||||
|
|
||||||
|
fmt.Println(w.excuting) //false
|
||||||
|
|
||||||
|
fmt.Println(w.startTime) //0
|
||||||
|
fmt.Println(w.stopTime) //0
|
||||||
|
}
|
||||||
|
|
||||||
|
func longRunningTask() {
|
||||||
|
var slice []int64
|
||||||
|
for i := 0; i < 10000000; i++ {
|
||||||
|
slice = append(slice, int64(i))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
233
docs/mathutil.md
Normal file
233
docs/mathutil.md
Normal file
@@ -0,0 +1,233 @@
|
|||||||
|
# Mathutil
|
||||||
|
Package mathutil implements some functions for math calculation.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/mathutil/mathutil.go](https://github.com/duke-git/lancet/blob/v1/mathutil/mathutil.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Example:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [Exponent](#Exponent)
|
||||||
|
- [Fibonacci](#Fibonacci)
|
||||||
|
- [Factorial](#Factorial)
|
||||||
|
- [Percent](#Percent)
|
||||||
|
- [RoundToFloat](#RoundToFloat)
|
||||||
|
- [RoundToString](#RoundToString)
|
||||||
|
- [TruncRound](#TruncRound)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Exponent">Exponent</span>
|
||||||
|
<p>Calculate x to the nth power.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Exponent(x, n int64) int64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Exponent(10, 0)) //1
|
||||||
|
fmt.Println(mathutil.Exponent(10, 1)) //10
|
||||||
|
fmt.Println(mathutil.Exponent(10, 2)) //100
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Fibonacci">Fibonacci</span>
|
||||||
|
<p>Calculate the nth number of fibonacci sequence.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Fibonacci(first, second, n int) int
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 1)) //1
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 2)) //1
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 3)) //2
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 4)) //3
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 5)) //5
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Factorial">Factorial</span>
|
||||||
|
<p>Calculate the factorial of x.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Factorial(x uint) uint
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Factorial(0)) //1
|
||||||
|
fmt.Println(mathutil.Factorial(1)) //1
|
||||||
|
fmt.Println(mathutil.Factorial(2)) //2
|
||||||
|
fmt.Println(mathutil.Factorial(3)) //6
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Percent">Percent</span>
|
||||||
|
<p>calculate the percentage of val to total, retain n decimal places.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Percent(val, total float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Percent(1, 2, 2)) //1
|
||||||
|
fmt.Println(mathutil.Percent(0.1, 0.3, 2)) //33.33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RoundToFloat">RoundToFloat</span>
|
||||||
|
<p>Round float up to n decimal places.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RoundToFloat(x float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0, 0)) //0
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0, 1)) //0
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.124, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.125, 2)) //0.13
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.125, 3)) //0.125
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RoundToString">RoundToString</span>
|
||||||
|
<p>Round float up to n decimal places. will return string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RoundToString(x float64, n int) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.RoundToString(0, 0)) //"0"
|
||||||
|
fmt.Println(mathutil.RoundToString(0, 1)) //"0.0:
|
||||||
|
fmt.Println(mathutil.RoundToString(0.124, 2)) //"0.12"
|
||||||
|
fmt.Println(mathutil.RoundToString(0.125, 2)) //"0.13"
|
||||||
|
fmt.Println(mathutil.RoundToString(0.125, 3)) //"0.125"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="TruncRound">TruncRound</span>
|
||||||
|
<p>Round float off n decimal places.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func TruncRound(x float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.TruncRound(0, 0)) //0
|
||||||
|
fmt.Println(mathutil.TruncRound(0, 1)) //0
|
||||||
|
fmt.Println(mathutil.TruncRound(0.124, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.TruncRound(0.125, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.TruncRound(0.125, 3)) //0.125
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
234
docs/mathutil_zh-CN.md
Normal file
234
docs/mathutil_zh-CN.md
Normal file
@@ -0,0 +1,234 @@
|
|||||||
|
# Mathutil
|
||||||
|
mathutil包实现了一些数学计算的函数.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/mathutil/mathutil.go](https://github.com/duke-git/lancet/blob/v1/mathutil/mathutil.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [Exponent](#Exponent)
|
||||||
|
- [Fibonacci](#Fibonacci)
|
||||||
|
- [Factorial](#Factorial)
|
||||||
|
|
||||||
|
- [Percent](#Percent)
|
||||||
|
- [RoundToFloat](#RoundToFloat)
|
||||||
|
- [RoundToString](#RoundToString)
|
||||||
|
- [TruncRound](#TruncRound)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Exponent">Exponent</span>
|
||||||
|
<p>指数计算(x的n次方)</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Exponent(x, n int64) int64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Exponent(10, 0)) //1
|
||||||
|
fmt.Println(mathutil.Exponent(10, 1)) //10
|
||||||
|
fmt.Println(mathutil.Exponent(10, 2)) //100
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Fibonacci">Fibonacci</span>
|
||||||
|
<p>计算斐波那契数列的第n个数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Fibonacci(first, second, n int) int
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 1)) //1
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 2)) //1
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 3)) //2
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 4)) //3
|
||||||
|
fmt.Println(mathutil.Fibonacci(1, 1, 5)) //5
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Factorial">Factorial</span>
|
||||||
|
<p>计算阶乘</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Factorial(x uint) uint
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Factorial(0)) //1
|
||||||
|
fmt.Println(mathutil.Factorial(1)) //1
|
||||||
|
fmt.Println(mathutil.Factorial(2)) //2
|
||||||
|
fmt.Println(mathutil.Factorial(3)) //6
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Percent">Percent</span>
|
||||||
|
<p>计算百分比,保留n位小数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Percent(val, total float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.Percent(1, 2, 2)) //1
|
||||||
|
fmt.Println(mathutil.Percent(0.1, 0.3, 2)) //33.33
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RoundToFloat">RoundToFloat</span>
|
||||||
|
<p>四舍五入,保留n位小数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RoundToFloat(x float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0, 0)) //0
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0, 1)) //0
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.124, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.125, 2)) //0.13
|
||||||
|
fmt.Println(mathutil.RoundToFloat(0.125, 3)) //0.125
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RoundToString">RoundToString</span>
|
||||||
|
<p>四舍五入,保留n位小数,返回字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RoundToString(x float64, n int) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.RoundToString(0, 0)) //"0"
|
||||||
|
fmt.Println(mathutil.RoundToString(0, 1)) //"0.0:
|
||||||
|
fmt.Println(mathutil.RoundToString(0.124, 2)) //"0.12"
|
||||||
|
fmt.Println(mathutil.RoundToString(0.125, 2)) //"0.13"
|
||||||
|
fmt.Println(mathutil.RoundToString(0.125, 3)) //"0.125"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="TruncRound">TruncRound</span>
|
||||||
|
<p>截短n位小数(不进行四舍五入)</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func TruncRound(x float64, n int) float64
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/mathutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(mathutil.TruncRound(0, 0)) //0
|
||||||
|
fmt.Println(mathutil.TruncRound(0, 1)) //0
|
||||||
|
fmt.Println(mathutil.TruncRound(0.124, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.TruncRound(0.125, 2)) //0.12
|
||||||
|
fmt.Println(mathutil.TruncRound(0.125, 3)) //0.125
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
615
docs/netutil.md
Normal file
615
docs/netutil.md
Normal file
@@ -0,0 +1,615 @@
|
|||||||
|
# Netutil
|
||||||
|
Package netutil contains functions to get net information and send http request.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/netutil/net.go](https://github.com/duke-git/lancet/blob/v1/netutil/net.go)
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/netutil/http.go](https://github.com/duke-git/lancet/blob/v1/netutil/http.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [ConvertMapToQueryString](#ConvertMapToQueryString)
|
||||||
|
- [EncodeUrl](#EncodeUrl)
|
||||||
|
- [GetInternalIp](#GetInternalIp)
|
||||||
|
- [GetIps](#GetIps)
|
||||||
|
- [GetMacAddrs](#GetMacAddrs)
|
||||||
|
- [GetPublicIpInfo](#GetPublicIpInfo)
|
||||||
|
- [GetRequestPublicIp](#GetRequestPublicIp)
|
||||||
|
- [IsPublicIP](#IsPublicIP)
|
||||||
|
|
||||||
|
- [IsInternalIP](#IsInternalIP)
|
||||||
|
- [HttpGet](#HttpGet)
|
||||||
|
- [HttpDelete](#HttpDelete)
|
||||||
|
- [HttpPost](#HttpPost)
|
||||||
|
- [HttpPut](#HttpPut)
|
||||||
|
- [HttpPatch](#HttpPatch)
|
||||||
|
- [ParseHttpResponse](#ParseHttpResponse)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ConvertMapToQueryString">ConvertMapToQueryString</span>
|
||||||
|
<p>Convert map to url query string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ConvertMapToQueryString(param map[string]interface{}) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var m = map[string]interface{}{
|
||||||
|
"c": 3,
|
||||||
|
"a": 1,
|
||||||
|
"b": 2,
|
||||||
|
}
|
||||||
|
qs := netutil.ConvertMapToQueryString(m)
|
||||||
|
|
||||||
|
fmt.Println(qs) //a=1&b=2&c=3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EncodeUrl">EncodeUrl</span>
|
||||||
|
<p>Encode url query string values.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EncodeUrl(urlStr string) (string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
urlAddr := "http://www.lancet.com?a=1&b=[2]"
|
||||||
|
encodedUrl, err := netutil.EncodeUrl(urlAddr)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(encodedUrl) //http://www.lancet.com?a=1&b=%5B2%5D
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetInternalIp">GetInternalIp</span>
|
||||||
|
<p>Get internal ip information.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetInternalIp() string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
internalIp := netutil.GetInternalIp()
|
||||||
|
ip := net.ParseIP(internalIp)
|
||||||
|
|
||||||
|
fmt.Println(ip) //192.168.1.9
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetIps">GetIps</span>
|
||||||
|
<p>Get all ipv4 list.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetIps() []string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ips := netutil.GetIps()
|
||||||
|
fmt.Println(ips) //[192.168.1.9]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetMacAddrs">GetMacAddrs</span>
|
||||||
|
<p>Get all mac addresses list.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetMacAddrs() []string {
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
addrs := netutil.GetMacAddrs()
|
||||||
|
fmt.Println(addrs)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetPublicIpInfo">GetPublicIpInfo</span>
|
||||||
|
<p>Get public ip information.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetPublicIpInfo() (*PublicIpInfo, error)
|
||||||
|
type PublicIpInfo struct {
|
||||||
|
Status string `json:"status"`
|
||||||
|
Country string `json:"country"`
|
||||||
|
CountryCode string `json:"countryCode"`
|
||||||
|
Region string `json:"region"`
|
||||||
|
RegionName string `json:"regionName"`
|
||||||
|
City string `json:"city"`
|
||||||
|
Lat float64 `json:"lat"`
|
||||||
|
Lon float64 `json:"lon"`
|
||||||
|
Isp string `json:"isp"`
|
||||||
|
Org string `json:"org"`
|
||||||
|
As string `json:"as"`
|
||||||
|
Ip string `json:"query"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
publicIpInfo, err := netutil.GetPublicIpInfo()
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(publicIpInfo)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetRequestPublicIp">GetRequestPublicIp</span>
|
||||||
|
<p>Get http request public ip.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetRequestPublicIp(req *http.Request) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip := "36.112.24.10"
|
||||||
|
|
||||||
|
request1 := http.Request{
|
||||||
|
Method: "GET",
|
||||||
|
Header: http.Header{
|
||||||
|
"X-Forwarded-For": {ip},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
publicIp1 := netutil.GetRequestPublicIp(&request1)
|
||||||
|
fmt.Println(publicIp1) //36.112.24.10
|
||||||
|
|
||||||
|
request2 := http.Request{
|
||||||
|
Method: "GET",
|
||||||
|
Header: http.Header{
|
||||||
|
"X-Real-Ip": {ip},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
publicIp2 := netutil.GetRequestPublicIp(&request2)
|
||||||
|
fmt.Println(publicIp2) //36.112.24.10
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsPublicIP">IsPublicIP</span>
|
||||||
|
<p>Checks if a ip is public or not.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsPublicIP(IP net.IP) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip1 := net.ParseIP("192.168.0.1")
|
||||||
|
ip2 := net.ParseIP("36.112.24.10")
|
||||||
|
|
||||||
|
fmt.Println(netutil.IsPublicIP(ip1)) //false
|
||||||
|
fmt.Println(netutil.IsPublicIP(ip2)) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsInternalIP">IsInternalIP</span>
|
||||||
|
<p>Checks if an ip is intranet or not.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsInternalIP(IP net.IP) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/v2/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip1 := net.ParseIP("127.0.0.1")
|
||||||
|
ip2 := net.ParseIP("36.112.24.10")
|
||||||
|
|
||||||
|
fmt.Println(netutil.IsInternalIP(ip1)) //true
|
||||||
|
fmt.Println(netutil.IsInternalIP(ip2)) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpGet">HttpGet</span>
|
||||||
|
<p>Send http get request.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
|
// params[1] is query param which type should be url.Values or map[string]interface{},
|
||||||
|
// params[2] is post body which type should be []byte.
|
||||||
|
// params[3] is http client which type should be http.Client.
|
||||||
|
func HttpGet(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := netutil.HttpGet(url, header)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPost">HttpPost</span>
|
||||||
|
<p>Send http post request.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
|
// params[1] is query param which type should be url.Values or map[string]interface{},
|
||||||
|
// params[2] is post body which type should be []byte.
|
||||||
|
// params[3] is http client which type should be http.Client.
|
||||||
|
func HttpPost(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, "TestAddToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPost(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPut">HttpPut</span>
|
||||||
|
<p>Send http put request.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
|
// params[1] is query param which type should be url.Values or map[string]interface{},
|
||||||
|
// params[2] is post body which type should be []byte.
|
||||||
|
// params[3] is http client which type should be http.Client.
|
||||||
|
func HttpPut(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, 1, "TestPutToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPut(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpDelete">HttpDelete</span>
|
||||||
|
<p>Send http delete request.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
|
// params[1] is query param which type should be url.Values or map[string]interface{},
|
||||||
|
// params[2] is post body which type should be []byte.
|
||||||
|
// params[3] is http client which type should be http.Client.
|
||||||
|
func HttpDelete(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
resp, err := netutil.HttpDelete(url)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPatch">HttpPatch</span>
|
||||||
|
<p>Send http patch request.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
|
// params[1] is query param which type should be url.Values or map[string]interface{},
|
||||||
|
// params[2] is post body which type should be []byte.
|
||||||
|
// params[3] is http client which type should be http.Client.
|
||||||
|
func HttpPatch(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, 1, "TestPatchToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPatch(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ParseHttpResponse">ParseHttpResponse</span>
|
||||||
|
<p>Decode http response to specified interface.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ParseHttpResponse(resp *http.Response, obj interface{}) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := netutil.HttpGet(url, header)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Completed bool `json:"completed"`
|
||||||
|
}
|
||||||
|
|
||||||
|
toDoResp := &Todo{}
|
||||||
|
err = netutil.ParseHttpResponse(resp, toDoResp)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(toDoResp)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
615
docs/netutil_zh-CN.md
Normal file
615
docs/netutil_zh-CN.md
Normal file
@@ -0,0 +1,615 @@
|
|||||||
|
# Netutil
|
||||||
|
netutil网络包支持获取ip地址,发送http请求。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/netutil/net.go](https://github.com/duke-git/lancet/blob/v1/netutil/net.go)
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/netutil/http.go](https://github.com/duke-git/lancet/blob/v1/netutil/http.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [ConvertMapToQueryString](#ConvertMapToQueryString)
|
||||||
|
- [EncodeUrl](#EncodeUrl)
|
||||||
|
- [GetInternalIp](#GetInternalIp)
|
||||||
|
- [GetIps](#GetIps)
|
||||||
|
- [GetMacAddrs](#GetMacAddrs)
|
||||||
|
- [GetPublicIpInfo](#GetPublicIpInfo)
|
||||||
|
- [GetRequestPublicIp](#GetRequestPublicIp)
|
||||||
|
|
||||||
|
- [IsPublicIP](#IsPublicIP)
|
||||||
|
- [IsInternalIP](#IsInternalIP)
|
||||||
|
- [HttpGet](#HttpGet)
|
||||||
|
- [HttpDelete](#HttpDelete)
|
||||||
|
- [HttpPost](#HttpPost)
|
||||||
|
- [HttpPut](#HttpPut)
|
||||||
|
- [HttpPatch](#HttpPatch)
|
||||||
|
- [ParseHttpResponse](#ParseHttpResponse)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ConvertMapToQueryString">ConvertMapToQueryString</span>
|
||||||
|
<p>将map转换成http查询字符串.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ConvertMapToQueryString(param map[string]interface{}) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var m = map[string]interface{}{
|
||||||
|
"c": 3,
|
||||||
|
"a": 1,
|
||||||
|
"b": 2,
|
||||||
|
}
|
||||||
|
qs := netutil.ConvertMapToQueryString(m)
|
||||||
|
|
||||||
|
fmt.Println(qs) //a=1&b=2&c=3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="EncodeUrl">EncodeUrl</span>
|
||||||
|
<p>编码url query string的值</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func EncodeUrl(urlStr string) (string, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
urlAddr := "http://www.lancet.com?a=1&b=[2]"
|
||||||
|
encodedUrl, err := netutil.EncodeUrl(urlAddr)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
fmt.Println(encodedUrl) //http://www.lancet.com?a=1&b=%5B2%5D
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetInternalIp">GetInternalIp</span>
|
||||||
|
<p>获取内部ip</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetInternalIp() string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
internalIp := netutil.GetInternalIp()
|
||||||
|
ip := net.ParseIP(internalIp)
|
||||||
|
|
||||||
|
fmt.Println(ip) //192.168.1.9
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetIps">GetIps</span>
|
||||||
|
<p>获取ipv4地址列表</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetIps() []string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ips := netutil.GetIps()
|
||||||
|
fmt.Println(ips) //[192.168.1.9]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetMacAddrs">GetMacAddrs</span>
|
||||||
|
<p>获取mac地址列</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetMacAddrs() []string {
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
addrs := netutil.GetMacAddrs()
|
||||||
|
fmt.Println(addrs)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetPublicIpInfo">GetPublicIpInfo</span>
|
||||||
|
<p>获取公网ip信息</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetPublicIpInfo() (*PublicIpInfo, error)
|
||||||
|
type PublicIpInfo struct {
|
||||||
|
Status string `json:"status"`
|
||||||
|
Country string `json:"country"`
|
||||||
|
CountryCode string `json:"countryCode"`
|
||||||
|
Region string `json:"region"`
|
||||||
|
RegionName string `json:"regionName"`
|
||||||
|
City string `json:"city"`
|
||||||
|
Lat float64 `json:"lat"`
|
||||||
|
Lon float64 `json:"lon"`
|
||||||
|
Isp string `json:"isp"`
|
||||||
|
Org string `json:"org"`
|
||||||
|
As string `json:"as"`
|
||||||
|
Ip string `json:"query"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
publicIpInfo, err := netutil.GetPublicIpInfo()
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(publicIpInfo)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetRequestPublicIp">GetRequestPublicIp</span>
|
||||||
|
<p>获取http请求ip</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetRequestPublicIp(req *http.Request) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip := "36.112.24.10"
|
||||||
|
|
||||||
|
request1 := http.Request{
|
||||||
|
Method: "GET",
|
||||||
|
Header: http.Header{
|
||||||
|
"X-Forwarded-For": {ip},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
publicIp1 := netutil.GetRequestPublicIp(&request1)
|
||||||
|
fmt.Println(publicIp1) //36.112.24.10
|
||||||
|
|
||||||
|
request2 := http.Request{
|
||||||
|
Method: "GET",
|
||||||
|
Header: http.Header{
|
||||||
|
"X-Real-Ip": {ip},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
publicIp2 := netutil.GetRequestPublicIp(&request2)
|
||||||
|
fmt.Println(publicIp2) //36.112.24.10
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsPublicIP">IsPublicIP</span>
|
||||||
|
<p>判断ip是否是公共ip</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsPublicIP(IP net.IP) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip1 := net.ParseIP("192.168.0.1")
|
||||||
|
ip2 := net.ParseIP("36.112.24.10")
|
||||||
|
|
||||||
|
fmt.Println(netutil.IsPublicIP(ip1)) //false
|
||||||
|
fmt.Println(netutil.IsPublicIP(ip2)) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsInternalIP">IsInternalIP</span>
|
||||||
|
<p>判断ip是否是局域网ip.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsInternalIP(IP net.IP) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ip1 := net.ParseIP("127.0.0.1")
|
||||||
|
ip2 := net.ParseIP("36.112.24.10")
|
||||||
|
|
||||||
|
fmt.Println(netutil.IsInternalIP(ip1)) //true
|
||||||
|
fmt.Println(netutil.IsInternalIP(ip2)) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpGet">HttpGet</span>
|
||||||
|
<p>发送http get请求</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] http请求header,类型必须是http.Header或者map[string]string
|
||||||
|
// params[1] http查询字符串,类型必须是url.Values或者map[string]interface{}
|
||||||
|
// params[2] post请求体,类型必须是[]byte
|
||||||
|
// params[3] http client,类型必须是http.Client
|
||||||
|
func HttpGet(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := netutil.HttpGet(url, header)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPost">HttpPost</span>
|
||||||
|
<p>发送http post请求</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] http请求header,类型必须是http.Header或者map[string]string
|
||||||
|
// params[1] http查询字符串,类型必须是url.Values或者map[string]interface{}
|
||||||
|
// params[2] post请求体,类型必须是[]byte
|
||||||
|
// params[3] http client,类型必须是http.Client
|
||||||
|
func HttpPost(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, "TestAddToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPost(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPut">HttpPut</span>
|
||||||
|
<p>发送http put请求</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] http请求header,类型必须是http.Header或者map[string]string
|
||||||
|
// params[1] http查询字符串,类型必须是url.Values或者map[string]interface{}
|
||||||
|
// params[2] post请求体,类型必须是[]byte
|
||||||
|
// params[3] http client,类型必须是http.Client
|
||||||
|
func HttpPut(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, 1, "TestPutToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPut(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpDelete">HttpDelete</span>
|
||||||
|
<p>发送http delete请求</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] http请求header,类型必须是http.Header或者map[string]string
|
||||||
|
// params[1] http查询字符串,类型必须是url.Values或者map[string]interface{}
|
||||||
|
// params[2] post请求体,类型必须是[]byte
|
||||||
|
// params[3] http client,类型必须是http.Client
|
||||||
|
func HttpDelete(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
resp, err := netutil.HttpDelete(url)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="HttpPatch">HttpPatch</span>
|
||||||
|
<p>发送http patch请求</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
// params[0] http请求header,类型必须是http.Header或者map[string]string
|
||||||
|
// params[1] http查询字符串,类型必须是url.Values或者map[string]interface{}
|
||||||
|
// params[2] post请求体,类型必须是[]byte
|
||||||
|
// params[3] http client,类型必须是http.Client
|
||||||
|
func HttpPatch(url string, params ...interface{}) (*http.Response, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
todo := Todo{1, 1, "TestPatchToDo"}
|
||||||
|
bodyParams, _ := json.Marshal(todo)
|
||||||
|
|
||||||
|
resp, err := netutil.HttpPatch(url, header, nil, bodyParams)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
fmt.Println(body)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ParseHttpResponse">ParseHttpResponse</span>
|
||||||
|
<p>将http请求响应解码成特定struct值</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ParseHttpResponse(resp *http.Response, obj interface{}) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
url := "https://jsonplaceholder.typicode.com/todos/1"
|
||||||
|
header := map[string]string{
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := netutil.HttpGet(url, header)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
type Todo struct {
|
||||||
|
Id int `json:"id"`
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Completed bool `json:"completed"`
|
||||||
|
}
|
||||||
|
|
||||||
|
toDoResp := &Todo{}
|
||||||
|
err = netutil.ParseHttpResponse(resp, toDoResp)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(toDoResp)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
138
docs/random.md
Normal file
138
docs/random.md
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
# Random
|
||||||
|
Package random implements some basic functions to generate random int and string.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/random/random.go](https://github.com/duke-git/lancet/blob/v1/random/random.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [RandBytes](#RandBytes)
|
||||||
|
- [RandInt](#RandInt)
|
||||||
|
- [RandString](#RandString)
|
||||||
|
- [UUIdV4](#UUIdV4)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandBytes">RandBytes</span>
|
||||||
|
<p>Generate random byte slice.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandBytes(length int) []byte
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
randBytes := random.RandBytes(4)
|
||||||
|
fmt.Println(randBytes)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandInt">RandInt</span>
|
||||||
|
<p>Generate random int between min and max, may contain min, not max.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandInt(min, max int) int
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
rInt := random.RandInt(1, 10)
|
||||||
|
fmt.Println(rInt)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandString">RandInt</span>
|
||||||
|
<p>Generate random given length string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandString(length int) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
randStr := random.RandString(6)
|
||||||
|
fmt.Println(randStr)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UUIdV4">UUIdV4</span>
|
||||||
|
<p>Generate a random UUID of version 4 according to RFC 4122.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UUIdV4() (string, error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
uuid, err := random.UUIdV4()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Println(uuid)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
138
docs/random_zh-CN.md
Normal file
138
docs/random_zh-CN.md
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
# Random
|
||||||
|
random随机数生成器包,可以生成随机[]bytes, int, string。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/random/random.go](https://github.com/duke-git/lancet/blob/v1/random/random.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [RandBytes](#RandBytes)
|
||||||
|
- [RandInt](#RandInt)
|
||||||
|
- [RandString](#RandString)
|
||||||
|
- [UUIdV4](#UUIdV4)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandBytes">RandBytes</span>
|
||||||
|
<p>生成随机字节切片</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandBytes(length int) []byte
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
randBytes := random.RandBytes(4)
|
||||||
|
fmt.Println(randBytes)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandInt">RandInt</span>
|
||||||
|
<p>生成随机int, 范围[min, max)</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandInt(min, max int) int
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
rInt := random.RandInt(1, 10)
|
||||||
|
fmt.Println(rInt)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RandString">RandInt</span>
|
||||||
|
<p>生成随机给定长度的随机字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RandString(length int) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
randStr := random.RandString(6)
|
||||||
|
fmt.Println(randStr)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UUIdV4">UUIdV4</span>
|
||||||
|
<p>生成UUID v4字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UUIdV4() (string, error)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/random"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
uuid, err := random.UUIdV4()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Println(uuid)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
236
docs/retry.md
Normal file
236
docs/retry.md
Normal file
@@ -0,0 +1,236 @@
|
|||||||
|
# Retry
|
||||||
|
Package retry is for executing a function repeatedly until it was successful or canceled by the context.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/retry/retry.go](https://github.com/duke-git/lancet/blob/v1/retry/retry.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [Context](#Context)
|
||||||
|
- [Retry](#Retry)
|
||||||
|
- [RetryFunc](#RetryFunc)
|
||||||
|
- [RetryDuration](#RetryDuration)
|
||||||
|
- [RetryTimes](#RetryTimes)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Context">Context</span>
|
||||||
|
<p>Set retry context config, can cancel the retry with context.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Context(ctx context.Context)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ctx, cancel := context.WithCancel(context.TODO())
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number > 3 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber,
|
||||||
|
retry.RetryDuration(time.Microsecond*50),
|
||||||
|
retry.Context(ctx),
|
||||||
|
)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //retry is cancelled
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryFunc">RetryFunc</span>
|
||||||
|
<p>Function that retry executes.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type RetryFunc func() error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
var increaseNumber retry.RetryFunc
|
||||||
|
increaseNumber = func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryTimes">RetryTimes</span>
|
||||||
|
<p>Set times of retry. Default times is 5.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RetryTimes(n uint)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryTimes(2))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err) //2022/02/01 18:42:25 function main.main.func1 run failed after 2 times retry exit status 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryDuration">RetryDuration</span>
|
||||||
|
<p>Set duration of retries. Default duration is 3 second.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RetryDuration(d time.Duration)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Retry">Retry</span>
|
||||||
|
<p>Executes the retryFunc repeatedly until it was successful or canceled by the context.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Retry(retryFunc RetryFunc, opts ...Option) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
238
docs/retry_zh-CN.md
Normal file
238
docs/retry_zh-CN.md
Normal file
@@ -0,0 +1,238 @@
|
|||||||
|
# Retry
|
||||||
|
retry重试执行函数直到函数运行成功或被context cancel。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/retry/retry.go](https://github.com/duke-git/lancet/blob/v1/retry/retry.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [Context](#Context)
|
||||||
|
- [Retry](#Retry)
|
||||||
|
- [RetryFunc](#RetryFunc)
|
||||||
|
- [RetryDuration](#RetryDuration)
|
||||||
|
- [RetryTimes](#RetryTimes)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
|
||||||
|
## Document文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Context">Context</span>
|
||||||
|
<p>设置重试context参数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Context(ctx context.Context)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"lancet-demo/retry"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ctx, cancel := context.WithCancel(context.TODO())
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number > 3 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber,
|
||||||
|
retry.RetryDuration(time.Microsecond*50),
|
||||||
|
retry.Context(ctx),
|
||||||
|
)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err) //retry is cancelled
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryFunc">RetryFunc</span>
|
||||||
|
<p>被重试执行的函数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
type RetryFunc func() error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
var increaseNumber retry.RetryFunc
|
||||||
|
increaseNumber = func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryTimes">RetryTimes</span>
|
||||||
|
<p>设置重试次数,默认5</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RetryTimes(n uint)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryTimes(2))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err) //2022/02/01 18:42:25 function main.main.func1 run failed after 2 times retry exit status 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RetryDuration">RetryDuration</span>
|
||||||
|
<p>设置重试间隔时间,默认3秒</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RetryDuration(d time.Duration)
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Retry">Retry</span>
|
||||||
|
<p>重试执行函数retryFunc,直到函数运行成功,或被context停止</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Retry(retryFunc RetryFunc, opts ...Option) error
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"errors"
|
||||||
|
"log"
|
||||||
|
"github.com/duke-git/lancet/retry"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == 3 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := retry.Retry(increaseNumber, retry.RetryDuration(time.Microsecond*50))
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(number) //3
|
||||||
|
}
|
||||||
|
```
|
||||||
1194
docs/slice.md
Normal file
1194
docs/slice.md
Normal file
File diff suppressed because it is too large
Load Diff
1192
docs/slice_zh-CN.md
Normal file
1192
docs/slice_zh-CN.md
Normal file
File diff suppressed because it is too large
Load Diff
607
docs/strutil.md
Normal file
607
docs/strutil.md
Normal file
@@ -0,0 +1,607 @@
|
|||||||
|
# Strutil
|
||||||
|
Package strutil contains some functions to manipulate string.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/strutil/string.go](https://github.com/duke-git/lancet/blob/v1/strutil/string.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [After](#After)
|
||||||
|
- [AfterLast](#AfterLast)
|
||||||
|
- [Before](#Before)
|
||||||
|
- [BeforeLast](#BeforeLast)
|
||||||
|
- [CamelCase](#CamelCase)
|
||||||
|
- [Capitalize](#Capitalize)
|
||||||
|
- [IsString](#IsString)
|
||||||
|
- [KebabCase](#KebabCase)
|
||||||
|
- [LowerFirst](#LowerFirst)
|
||||||
|
- [UpperFirst](#UpperFirst)
|
||||||
|
- [PadEnd](#PadEnd)
|
||||||
|
- [PadStart](#PadStart)
|
||||||
|
- [ReverseStr](#ReverseStr)
|
||||||
|
- [SnakeCase](#SnakeCase)
|
||||||
|
- [Wrap](#Wrap)
|
||||||
|
|
||||||
|
- [Unwrap](#Unwrap)
|
||||||
|
- [SplitEx](#SplitEx)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="After">After</span>
|
||||||
|
<p>Creates substring in source string after position when char first appear.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func After(s, char string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.After("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.After("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //test/lancet
|
||||||
|
|
||||||
|
s3 := strutil.After("github.com/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // /lancet
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AfterLast">AfterLast</span>
|
||||||
|
<p>Creates substring in source string after position when char last appear.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AfterLast(s, char string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.AfterLast("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.AfterLast("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //lancet
|
||||||
|
|
||||||
|
s3 := strutil.AfterLast("github.com/test/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // /test/lancet
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Before">Before</span>
|
||||||
|
<p>Creates substring in source string before position when char first appear.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Before(s, char string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Before("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.Before("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //github.com
|
||||||
|
|
||||||
|
s3 := strutil.Before("github.com/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // github.com/
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeforeLast">BeforeLast</span>
|
||||||
|
<p>Creates substring in source string before position when char first appear.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeforeLast(s, char string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.BeforeLast("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.BeforeLast("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //github.com/test
|
||||||
|
|
||||||
|
s3 := strutil.BeforeLast("github.com/test/test/lancet", "test")
|
||||||
|
fmt.Println(s3) //github.com/test/
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CamelCase">CamelCase</span>
|
||||||
|
<p>Covert string to camelCase string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CamelCase(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.CamelCase("foo_bar")
|
||||||
|
fmt.Println(s1) //fooBar
|
||||||
|
|
||||||
|
s2 := strutil.CamelCase("Foo-Bar")
|
||||||
|
fmt.Println(s2) //fooBar
|
||||||
|
|
||||||
|
s3 := strutil.CamelCase("Foo&bar")
|
||||||
|
fmt.Println(s3) //fooBar
|
||||||
|
|
||||||
|
s4 := strutil.CamelCase("foo bar")
|
||||||
|
fmt.Println(s4) //fooBar
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Capitalize">Capitalize</span>
|
||||||
|
<p>Convert the first character of a string to upper case.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Capitalize(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Capitalize("foo")
|
||||||
|
fmt.Println(s1) //foo
|
||||||
|
|
||||||
|
s2 := strutil.Capitalize("Foo")
|
||||||
|
fmt.Println(s2) //foo
|
||||||
|
|
||||||
|
s3 := strutil.Capitalize("FOo"
|
||||||
|
fmt.Println(s3) //fOo
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsString">IsString</span>
|
||||||
|
<p>Check if the value's data type is string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsString(v interface{}) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(strutil.IsString("lancet")) //true
|
||||||
|
fmt.Println(strutil.IsString("")) //true
|
||||||
|
|
||||||
|
fmt.Println(strutil.IsString(1)) //false
|
||||||
|
fmt.Println(strutil.IsString("")) //false
|
||||||
|
fmt.Println(strutil.IsString([]string{})) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="KebabCase">KebabCase</span>
|
||||||
|
<p>Covert string to kebab-case.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func KebabCase(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.KebabCase("Foo Bar-")
|
||||||
|
fmt.Println(s1) //foo-bar
|
||||||
|
|
||||||
|
s2 := strutil.KebabCase("foo_Bar")
|
||||||
|
fmt.Println(s2) //foo-bar
|
||||||
|
|
||||||
|
s3 := strutil.KebabCase("fooBar")
|
||||||
|
fmt.Println(s3) //foo-bar
|
||||||
|
|
||||||
|
s4 := strutil.KebabCase("__FOO_BAR__")
|
||||||
|
fmt.Println(s4) //f-o-o-b-a-r
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="LowerFirst">LowerFirst</span>
|
||||||
|
<p>Convert the first character of string to lower case.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func LowerFirst(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.LowerFirst("foo")
|
||||||
|
fmt.Println(s1) //foo
|
||||||
|
|
||||||
|
s2 := strutil.LowerFirst("BAR")
|
||||||
|
fmt.Println(s2) //bAR
|
||||||
|
|
||||||
|
s3 := strutil.LowerFirst("FOo")
|
||||||
|
fmt.Println(s3) //fOo
|
||||||
|
|
||||||
|
s4 := strutil.LowerFirst("fOo大")
|
||||||
|
fmt.Println(s4) //fOo大
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UpperFirst">UpperFirst</span>
|
||||||
|
<p>Convert the first character of string to upper case.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UpperFirst(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.UpperFirst("foo")
|
||||||
|
fmt.Println(s1) //Foo
|
||||||
|
|
||||||
|
s2 := strutil.UpperFirst("bAR")
|
||||||
|
fmt.Println(s2) //BAR
|
||||||
|
|
||||||
|
s3 := strutil.UpperFirst("FOo")
|
||||||
|
fmt.Println(s3) //FOo
|
||||||
|
|
||||||
|
s4 := strutil.UpperFirst("fOo大")
|
||||||
|
fmt.Println(s4) //FOo大
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="PadEnd">PadEnd</span>
|
||||||
|
<p>Pads string on the right side if it's shorter than size.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func PadEnd(source string, size int, padStr string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.PadEnd("a", 1, "b")
|
||||||
|
fmt.Println(s1) //a
|
||||||
|
|
||||||
|
s2 := strutil.PadEnd("a", 2, "b")
|
||||||
|
fmt.Println(s2) //ab
|
||||||
|
|
||||||
|
s3 := strutil.PadEnd("abcd", 6, "mno")
|
||||||
|
fmt.Println(s3) //abcdmn
|
||||||
|
|
||||||
|
s4 := strutil.PadEnd("abc", 6, "ab")
|
||||||
|
fmt.Println(s4) //abcaba
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="PadStart">PadStart</span>
|
||||||
|
<p>Pads string on the left side if it's shorter than size.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func PadStart(source string, size int, padStr string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.PadStart("a", 1, "b")
|
||||||
|
fmt.Println(s1) //a
|
||||||
|
|
||||||
|
s2 := strutil.PadStart("a", 2, "b")
|
||||||
|
fmt.Println(s2) //ba
|
||||||
|
|
||||||
|
s3 := strutil.PadStart("abcd", 6, "mno")
|
||||||
|
fmt.Println(s3) //mnabcd
|
||||||
|
|
||||||
|
s4 := strutil.PadStart("abc", 6, "ab")
|
||||||
|
fmt.Println(s4) //abaabc
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReverseStr">ReverseStr</span>
|
||||||
|
<p>Return string whose char order is reversed to the given string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReverseStr(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.ReverseStr("abc")
|
||||||
|
fmt.Println(s1) //cba
|
||||||
|
|
||||||
|
s2 := strutil.ReverseStr("12345")
|
||||||
|
fmt.Println(s2) //54321
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SnakeCase">SnakeCase</span>
|
||||||
|
<p>Covert string to snake_case.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SnakeCase(s string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.SnakeCase("Foo Bar-")
|
||||||
|
fmt.Println(s1) //foo_bar
|
||||||
|
|
||||||
|
s2 := strutil.SnakeCase("foo_Bar")
|
||||||
|
fmt.Println(s2) //foo_bar
|
||||||
|
|
||||||
|
s3 := strutil.SnakeCase("fooBar")
|
||||||
|
fmt.Println(s3) //foo_bar
|
||||||
|
|
||||||
|
s4 := strutil.SnakeCase("__FOO_BAR__")
|
||||||
|
fmt.Println(s4) //f_o_o_b_a_r
|
||||||
|
|
||||||
|
s5 := strutil.SnakeCase("aBbc-s$@a&%_B.B^C")
|
||||||
|
fmt.Println(s5) //a_bbc_s_a_b_b_c
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Wrap">Wrap</span>
|
||||||
|
<p>Wrap a string with another string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Wrap(str string, wrapWith string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Wrap("ab", "")
|
||||||
|
fmt.Println(s1) //ab
|
||||||
|
|
||||||
|
s2 := strutil.Wrap("", "*")
|
||||||
|
fmt.Println(s2) //""
|
||||||
|
|
||||||
|
s3 := strutil.Wrap("ab", "*")
|
||||||
|
fmt.Println(s3) //*ab*
|
||||||
|
|
||||||
|
s4 := strutil.Wrap("ab", "\"")
|
||||||
|
fmt.Println(s4) //\"ab\"
|
||||||
|
|
||||||
|
s5 := strutil.Wrap("ab", "'")
|
||||||
|
fmt.Println(s5) //'ab'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Wrap">Wrap</span>
|
||||||
|
<p>Unwrap a given string from anther string. will change str value.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Unwrap(str string, wrapToken string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Unwrap("ab", "")
|
||||||
|
fmt.Println(s1) //ab
|
||||||
|
|
||||||
|
s2 := strutil.Unwrap("ab", "*")
|
||||||
|
fmt.Println(s2) //ab
|
||||||
|
|
||||||
|
s3 := strutil.Unwrap("**ab**", "*")
|
||||||
|
fmt.Println(s3) //*ab*
|
||||||
|
|
||||||
|
s4 := strutil.Unwrap("*ab", "*")
|
||||||
|
fmt.Println(s4) //*ab
|
||||||
|
|
||||||
|
s5 := strutil.Unwrap("***", "**")
|
||||||
|
fmt.Println(s5) //***
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SplitEx">SplitEx</span>
|
||||||
|
<p>Split a given string whether the result contains empty string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SplitEx(s, sep string, removeEmptyString bool) []string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
arr1 := strutil.SplitEx(" a b c ", "", true)
|
||||||
|
fmt.Println(arr1) //[]string{}
|
||||||
|
|
||||||
|
arr2 := strutil.SplitEx(" a b c ", " ", false)
|
||||||
|
fmt.Println(arr2) //[]string{"", "a", "b", "c", ""}
|
||||||
|
|
||||||
|
arr3 := strutil.SplitEx(" a b c ", " ", true)
|
||||||
|
fmt.Println(arr3) //[]string{"a", "b", "c"}
|
||||||
|
|
||||||
|
arr4 := strutil.SplitEx(" a = b = c = ", " = ", false)
|
||||||
|
fmt.Println(arr4) //[]string{" a", "b", "c", ""}
|
||||||
|
|
||||||
|
arr5 := strutil.SplitEx(" a = b = c = ", " = ", true)
|
||||||
|
fmt.Println(arr5) //[]string{" a", "b", "c"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
609
docs/strutil_zh-CN.md
Normal file
609
docs/strutil_zh-CN.md
Normal file
@@ -0,0 +1,609 @@
|
|||||||
|
# Strutil
|
||||||
|
strutil包含处理字符串的相关函数。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/strutil/string.go](https://github.com/duke-git/lancet/blob/v1/strutil/string.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [After](#After)
|
||||||
|
- [AfterLast](#AfterLast)
|
||||||
|
- [Before](#Before)
|
||||||
|
- [BeforeLast](#BeforeLast)
|
||||||
|
- [CamelCase](#CamelCase)
|
||||||
|
- [Capitalize](#Capitalize)
|
||||||
|
- [IsString](#IsString)
|
||||||
|
- [KebabCase](#KebabCase)
|
||||||
|
- [LowerFirst](#LowerFirst)
|
||||||
|
- [UpperFirst](#UpperFirst)
|
||||||
|
- [PadEnd](#PadEnd)
|
||||||
|
- [PadStart](#PadStart)
|
||||||
|
- [ReverseStr](#ReverseStr)
|
||||||
|
- [SnakeCase](#SnakeCase)
|
||||||
|
- [Wrap](#Wrap)
|
||||||
|
|
||||||
|
- [Unwrap](#Unwrap)
|
||||||
|
- [SplitEx](#SplitEx)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
|
||||||
|
## Documentation文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="After">After</span>
|
||||||
|
<p>截取源字符串中char首次出现时的位置之后的子字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func After(s, char string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.After("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.After("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //test/lancet
|
||||||
|
|
||||||
|
s3 := strutil.After("github.com/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // /lancet
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="AfterLast">AfterLast</span>
|
||||||
|
<p>截取源字符串中char最后一次出现时的位置之后的子字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func AfterLast(s, char string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.AfterLast("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.AfterLast("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //lancet
|
||||||
|
|
||||||
|
s3 := strutil.AfterLast("github.com/test/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // /lancet
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Before">Before</span>
|
||||||
|
<p>截取源字符串中char首次出现时的位置之前的子字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Before(s, char string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Before("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.Before("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //github.com
|
||||||
|
|
||||||
|
s3 := strutil.Before("github.com/test/lancet", "test")
|
||||||
|
fmt.Println(s3) // github.com/
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="BeforeLast">BeforeLast</span>
|
||||||
|
<p>截取源字符串中char最后一次出现时的位置之前的子字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func BeforeLast(s, char string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.BeforeLast("lancet", "")
|
||||||
|
fmt.Println(s1) //lancet
|
||||||
|
|
||||||
|
s2 := strutil.BeforeLast("github.com/test/lancet", "/")
|
||||||
|
fmt.Println(s2) //github.com/test
|
||||||
|
|
||||||
|
s3 := strutil.BeforeLast("github.com/test/test/lancet", "test")
|
||||||
|
fmt.Println(s3) //github.com/test/
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CamelCase">CamelCase</span>
|
||||||
|
<p>将字符串转换为驼峰式字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CamelCase(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.CamelCase("foo_bar")
|
||||||
|
fmt.Println(s1) //fooBar
|
||||||
|
|
||||||
|
s2 := strutil.CamelCase("Foo-Bar")
|
||||||
|
fmt.Println(s2) //fooBar
|
||||||
|
|
||||||
|
s3 := strutil.CamelCase("Foo&bar")
|
||||||
|
fmt.Println(s3) //fooBar
|
||||||
|
|
||||||
|
s4 := strutil.CamelCase("foo bar")
|
||||||
|
fmt.Println(s4) //fooBar
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Capitalize">Capitalize</span>
|
||||||
|
<p>将字符串的第一个字符转换为大写</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Capitalize(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Capitalize("foo")
|
||||||
|
fmt.Println(s1) //foo
|
||||||
|
|
||||||
|
s2 := strutil.Capitalize("Foo")
|
||||||
|
fmt.Println(s2) //foo
|
||||||
|
|
||||||
|
s3 := strutil.Capitalize("FOo"
|
||||||
|
fmt.Println(s3) //fOo
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsString">IsString</span>
|
||||||
|
<p>检查值的数据类型是否为字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsString(v interface{}) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(strutil.IsString("lancet")) //true
|
||||||
|
fmt.Println(strutil.IsString("")) //true
|
||||||
|
|
||||||
|
fmt.Println(strutil.IsString(1)) //false
|
||||||
|
fmt.Println(strutil.IsString("")) //false
|
||||||
|
fmt.Println(strutil.IsString([]string{})) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="KebabCase">KebabCase</span>
|
||||||
|
<p>将字符串转换为kebab-case</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func KebabCase(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.KebabCase("Foo Bar-")
|
||||||
|
fmt.Println(s1) //foo-bar
|
||||||
|
|
||||||
|
s2 := strutil.KebabCase("foo_Bar")
|
||||||
|
fmt.Println(s2) //foo-bar
|
||||||
|
|
||||||
|
s3 := strutil.KebabCase("fooBar")
|
||||||
|
fmt.Println(s3) //foo-bar
|
||||||
|
|
||||||
|
s4 := strutil.KebabCase("__FOO_BAR__")
|
||||||
|
fmt.Println(s4) //f-o-o-b-a-r
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="LowerFirst">LowerFirst</span>
|
||||||
|
<p>将字符串的第一个字符转换为小写</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func LowerFirst(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.LowerFirst("foo")
|
||||||
|
fmt.Println(s1) //foo
|
||||||
|
|
||||||
|
s2 := strutil.LowerFirst("BAR")
|
||||||
|
fmt.Println(s2) //bAR
|
||||||
|
|
||||||
|
s3 := strutil.LowerFirst("FOo")
|
||||||
|
fmt.Println(s3) //fOo
|
||||||
|
|
||||||
|
s4 := strutil.LowerFirst("fOo大")
|
||||||
|
fmt.Println(s4) //fOo大
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="UpperFirst">UpperFirst</span>
|
||||||
|
<p>将字符串的第一个字符转换为大写</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func UpperFirst(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.UpperFirst("foo")
|
||||||
|
fmt.Println(s1) //Foo
|
||||||
|
|
||||||
|
s2 := strutil.UpperFirst("bAR")
|
||||||
|
fmt.Println(s2) //BAR
|
||||||
|
|
||||||
|
s3 := strutil.UpperFirst("FOo")
|
||||||
|
fmt.Println(s3) //FOo
|
||||||
|
|
||||||
|
s4 := strutil.UpperFirst("fOo大")
|
||||||
|
fmt.Println(s4) //FOo大
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="PadEnd">PadEnd</span>
|
||||||
|
<p>如果字符串长度短于size,则在右侧填充字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func PadEnd(source string, size int, padStr string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.PadEnd("a", 1, "b")
|
||||||
|
fmt.Println(s1) //a
|
||||||
|
|
||||||
|
s2 := strutil.PadEnd("a", 2, "b")
|
||||||
|
fmt.Println(s2) //ab
|
||||||
|
|
||||||
|
s3 := strutil.PadEnd("abcd", 6, "mno")
|
||||||
|
fmt.Println(s3) //abcdmn
|
||||||
|
|
||||||
|
s4 := strutil.PadEnd("abc", 6, "ab")
|
||||||
|
fmt.Println(s4) //abcaba
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="PadStart">PadStart</span>
|
||||||
|
<p>如果字符串长度短于size,则在左侧填充字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func PadStart(source string, size int, padStr string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.PadStart("a", 1, "b")
|
||||||
|
fmt.Println(s1) //a
|
||||||
|
|
||||||
|
s2 := strutil.PadStart("a", 2, "b")
|
||||||
|
fmt.Println(s2) //ba
|
||||||
|
|
||||||
|
s3 := strutil.PadStart("abcd", 6, "mno")
|
||||||
|
fmt.Println(s3) //mnabcd
|
||||||
|
|
||||||
|
s4 := strutil.PadStart("abc", 6, "ab")
|
||||||
|
fmt.Println(s4) //abaabc
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ReverseStr">ReverseStr</span>
|
||||||
|
<p>返回字符顺序与给定字符串相反的字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ReverseStr(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.ReverseStr("abc")
|
||||||
|
fmt.Println(s1) //cba
|
||||||
|
|
||||||
|
s2 := strutil.ReverseStr("12345")
|
||||||
|
fmt.Println(s2) //54321
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SnakeCase">SnakeCase</span>
|
||||||
|
<p>将字符串转换为snake_case形式</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SnakeCase(s string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.SnakeCase("Foo Bar-")
|
||||||
|
fmt.Println(s1) //foo_bar
|
||||||
|
|
||||||
|
s2 := strutil.SnakeCase("foo_Bar")
|
||||||
|
fmt.Println(s2) //foo_bar
|
||||||
|
|
||||||
|
s3 := strutil.SnakeCase("fooBar")
|
||||||
|
fmt.Println(s3) //foo_bar
|
||||||
|
|
||||||
|
s4 := strutil.SnakeCase("__FOO_BAR__")
|
||||||
|
fmt.Println(s4) //f_o_o_b_a_r
|
||||||
|
|
||||||
|
s5 := strutil.SnakeCase("aBbc-s$@a&%_B.B^C")
|
||||||
|
fmt.Println(s5) //a_bbc_s_a_b_b_c
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Wrap">Wrap</span>
|
||||||
|
<p>用另一个字符串包裹一个字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Wrap(str string, wrapWith string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Wrap("ab", "")
|
||||||
|
fmt.Println(s1) //ab
|
||||||
|
|
||||||
|
s2 := strutil.Wrap("", "*")
|
||||||
|
fmt.Println(s2) //""
|
||||||
|
|
||||||
|
s3 := strutil.Wrap("ab", "*")
|
||||||
|
fmt.Println(s3) //*ab*
|
||||||
|
|
||||||
|
s4 := strutil.Wrap("ab", "\"")
|
||||||
|
fmt.Println(s4) //\"ab\"
|
||||||
|
|
||||||
|
s5 := strutil.Wrap("ab", "'")
|
||||||
|
fmt.Println(s5) //'ab'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Unwrap">Unwrap</span>
|
||||||
|
<p>用另一个字符串解开包裹一个字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Unwrap(str string, wrapToken string) string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s1 := strutil.Unwrap("ab", "")
|
||||||
|
fmt.Println(s1) //ab
|
||||||
|
|
||||||
|
s2 := strutil.Unwrap("ab", "*")
|
||||||
|
fmt.Println(s2) //ab
|
||||||
|
|
||||||
|
s3 := strutil.Unwrap("**ab**", "*")
|
||||||
|
fmt.Println(s3) //*ab*
|
||||||
|
|
||||||
|
s4 := strutil.Unwrap("*ab", "*")
|
||||||
|
fmt.Println(s4) //*ab
|
||||||
|
|
||||||
|
s5 := strutil.Unwrap("***", "**")
|
||||||
|
fmt.Println(s5) //***
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SplitEx">SplitEx</span>
|
||||||
|
<p>分割字符串为切片,removeEmptyString参数指定是否去除空字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SplitEx(s, sep string, removeEmptyString bool) []string
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/strutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
arr1 := strutil.SplitEx(" a b c ", "", true)
|
||||||
|
fmt.Println(arr1) //[]string{}
|
||||||
|
|
||||||
|
arr2 := strutil.SplitEx(" a b c ", " ", false)
|
||||||
|
fmt.Println(arr2) //[]string{"", "a", "b", "c", ""}
|
||||||
|
|
||||||
|
arr3 := strutil.SplitEx(" a b c ", " ", true)
|
||||||
|
fmt.Println(arr3) //[]string{"a", "b", "c"}
|
||||||
|
|
||||||
|
arr4 := strutil.SplitEx(" a = b = c = ", " = ", false)
|
||||||
|
fmt.Println(arr4) //[]string{" a", "b", "c", ""}
|
||||||
|
|
||||||
|
arr5 := strutil.SplitEx(" a = b = c = ", " = ", true)
|
||||||
|
fmt.Println(arr5) //[]string{" a", "b", "c"}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
263
docs/system.md
Normal file
263
docs/system.md
Normal file
@@ -0,0 +1,263 @@
|
|||||||
|
# System
|
||||||
|
Package system contains some functions about os, runtime, shell command.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/system/os.go](https://github.com/duke-git/lancet/blob/v1/system/os.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [IsWindows](#IsWindows)
|
||||||
|
- [IsLinux](#IsLinux)
|
||||||
|
- [IsMac](#IsMac)
|
||||||
|
- [GetOsEnv](#GetOsEnv)
|
||||||
|
- [SetOsEnv](#SetOsEnv)
|
||||||
|
- [RemoveOsEnv](#RemoveOsEnv)
|
||||||
|
- [CompareOsEnv](#CompareOsEnv)
|
||||||
|
- [ExecCommand](#ExecCommand)
|
||||||
|
- [GetOsBits](#GetOsBits)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsWindows">IsWindows</span>
|
||||||
|
<p>Check if current os is windows.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsWindows() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsWindows := system.IsWindows()
|
||||||
|
fmt.Println(isOsWindows)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsLinux">IsLinux</span>
|
||||||
|
<p>Check if current os is linux.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsLinux() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsLinux := system.IsLinux()
|
||||||
|
fmt.Println(isOsLinux)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsMac">IsMac</span>
|
||||||
|
<p>Check if current os is macos.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsMac() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsMac := system.IsMac
|
||||||
|
fmt.Println(isOsMac)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetOsEnv">GetOsEnv</span>
|
||||||
|
<p>Gets the value of the environment variable named by the key.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetOsEnv(key string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fooEnv := system.GetOsEnv("foo")
|
||||||
|
fmt.Println(fooEnv)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SetOsEnv">SetOsEnv</span>
|
||||||
|
<p>Sets the value of the environment variable named by the key.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SetOsEnv(key, value string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := system.SetOsEnv("foo", "foo_value")
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RemoveOsEnv">RemoveOsEnv</span>
|
||||||
|
<p>Remove a single environment variable.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RemoveOsEnv(key string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := system.RemoveOsEnv("foo")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CompareOsEnv">CompareOsEnv</span>
|
||||||
|
<p>Get env named by the key and compare it with comparedEnv.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CompareOsEnv(key, comparedEnv string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
system.SetOsEnv("foo", "foo_value")
|
||||||
|
res := system.CompareOsEnv("foo", "foo_value")
|
||||||
|
fmt.Println(res) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ExecCommand">CompareOsEnv</span>
|
||||||
|
<p>use shell /bin/bash -c(linux) or cmd (windows) to execute command.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ExecCommand(command string) (stdout, stderr string, err error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
out, errout, err := system.ExecCommand("ls")
|
||||||
|
fmt.Println(out)
|
||||||
|
fmt.Println(errout)
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetOsBits">GetOsBits</span>
|
||||||
|
<p>获取当前操作系统位数,返回32或64</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetOsBits() int
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
osBit := system.GetOsBits()
|
||||||
|
fmt.Println(osBit)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
263
docs/system_zh-CN.md
Normal file
263
docs/system_zh-CN.md
Normal file
@@ -0,0 +1,263 @@
|
|||||||
|
# System
|
||||||
|
system包含os, runtime, shell command相关函数。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/system/os.go](https://github.com/duke-git/lancet/blob/v1/system/os.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [IsWindows](#IsWindows)
|
||||||
|
- [IsLinux](#IsLinux)
|
||||||
|
- [IsMac](#IsMac)
|
||||||
|
- [GetOsEnv](#GetOsEnv)
|
||||||
|
- [SetOsEnv](#SetOsEnv)
|
||||||
|
- [RemoveOsEnv](#RemoveOsEnv)
|
||||||
|
- [CompareOsEnv](#CompareOsEnv)
|
||||||
|
- [ExecCommand](#ExecCommand)
|
||||||
|
- [GetOsBits](#GetOsBits)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsWindows">IsWindows</span>
|
||||||
|
<p>检查当前操作系统是否是windows</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsWindows() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsWindows := system.IsWindows()
|
||||||
|
fmt.Println(isOsWindows)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsLinux">IsLinux</span>
|
||||||
|
<p>检查当前操作系统是否是linux</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsLinux() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsLinux := system.IsLinux()
|
||||||
|
fmt.Println(isOsLinux)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsMac">IsMac</span>
|
||||||
|
<p>检查当前操作系统是否是macos</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsMac() bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
isOsMac := system.IsMac
|
||||||
|
fmt.Println(isOsMac)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetOsEnv">GetOsEnv</span>
|
||||||
|
<p>获取key命名的环境变量的值</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetOsEnv(key string) string
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fooEnv := system.GetOsEnv("foo")
|
||||||
|
fmt.Println(fooEnv)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="SetOsEnv">SetOsEnv</span>
|
||||||
|
<p>设置由key命名的环境变量的值</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func SetOsEnv(key, value string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := system.SetOsEnv("foo", "foo_value")
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="RemoveOsEnv">RemoveOsEnv</span>
|
||||||
|
<p>删除单个环境变量</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func RemoveOsEnv(key string) error
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
err := system.RemoveOsEnv("foo")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="CompareOsEnv">CompareOsEnv</span>
|
||||||
|
<p>获取key命名的环境变量值并与compareEnv进行比较</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func CompareOsEnv(key, comparedEnv string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
system.SetOsEnv("foo", "foo_value")
|
||||||
|
res := system.CompareOsEnv("foo", "foo_value")
|
||||||
|
fmt.Println(res) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ExecCommand">CompareOsEnv</span>
|
||||||
|
<p>使用shell /bin/bash -c(linux) 或 cmd (windows) 执行shell命令</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ExecCommand(command string) (stdout, stderr string, err error)
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
out, errout, err := system.ExecCommand("ls")
|
||||||
|
fmt.Println(out)
|
||||||
|
fmt.Println(errout)
|
||||||
|
fmt.Println(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="GetOsBits">GetOsBits</span>
|
||||||
|
<p>Get current os bits, 32bit or 64bit. return 32 or 64</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func GetOsBits() int
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/system"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
osBit := system.GetOsBits()
|
||||||
|
fmt.Println(osBit)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
799
docs/validator.md
Normal file
799
docs/validator.md
Normal file
@@ -0,0 +1,799 @@
|
|||||||
|
# Validator
|
||||||
|
Package validator contains some functions for data validation.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/validator/validator.go](https://github.com/duke-git/lancet/blob/v1/validator/validator.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [ContainChinese](#ContainChinese)
|
||||||
|
- [ContainLetter](#ContainLetter)
|
||||||
|
- [ContainLower](#ContainLower)
|
||||||
|
- [ContainUpper](#ContainUpper)
|
||||||
|
- [IsAlpha](#IsAlpha)
|
||||||
|
- [IsAllUpper](#IsAllUpper)
|
||||||
|
- [IsAllLower](#IsAllLower)
|
||||||
|
- [IsBase64](#IsBase64)
|
||||||
|
- [IsChineseMobile](#IsChineseMobile)
|
||||||
|
- [IsChineseIdNum](#IsChineseIdNum)
|
||||||
|
- [IsChinesePhone](#IsChinesePhone)
|
||||||
|
- [IsCreditCard](#IsCreditCard)
|
||||||
|
- [IsDns](#IsDns)
|
||||||
|
- [IsEmail](#IsEmail)
|
||||||
|
|
||||||
|
- [IsEmptyString](#IsEmptyString)
|
||||||
|
- [IsFloatStr](#IsFloatStr)
|
||||||
|
- [IsNumberStr](#IsNumberStr)
|
||||||
|
- [IsJSON](#IsJSON)
|
||||||
|
- [IsRegexMatch](#IsRegexMatch)
|
||||||
|
- [IsIntStr](#IsIntStr)
|
||||||
|
- [IsIp](#IsIp)
|
||||||
|
- [IsIpV4](#IsIpV4)
|
||||||
|
- [IsIpV6](#IsIpV6)
|
||||||
|
- [IsStrongPassword](#IsStrongPassword)
|
||||||
|
- [IsUrl](#IsUrl)
|
||||||
|
- [IsWeakPassword](#IsWeakPassword)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainChinese">ContainChinese</span>
|
||||||
|
<p>Check if the string contain mandarin chinese.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainChinese(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainChinese("你好")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainChinese("你好hello")
|
||||||
|
fmt.Println(res2) //true
|
||||||
|
|
||||||
|
res3 := validator.ContainChinese("hello")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainLetter">ContainLetter</span>
|
||||||
|
<p>Check if the string contain at least one letter.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainLetter(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainLetter("1bc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainLetter("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainLetter("&@#$%^&*")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainLower">ContainLower</span>
|
||||||
|
<p>Check if the string contain at least one lower case letter a-z.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainLower(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainLower("1bc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainLower("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainLower("1BC")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainUpper">ContainUpper</span>
|
||||||
|
<p>Check if the string contain at least one upper case letter A-Z.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainUpper(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainUpper("1bc")
|
||||||
|
fmt.Println(res1) //false
|
||||||
|
|
||||||
|
res2 := validator.ContainUpper("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainUpper("1BC")
|
||||||
|
fmt.Println(res3) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsAlpha">IsAlpha</span>
|
||||||
|
<p>Check if the string contains only letters (a-zA-Z).</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAlpha(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAlpha("abc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAlpha("1bc")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.IsAlpha("")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="IsAllUpper">IsAllUpper</span>
|
||||||
|
<p>Check if string is all upper case letters A-Z.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAllUpper(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAllUpper("ABC")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAllUpper("aBC")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsAllLower">IsAllLower</span>
|
||||||
|
<p>Check if string is all lower case letters a-z.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAllLower(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAllLower("abc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAllLower("abC")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsBase64">IsBase64</span>
|
||||||
|
<p>Check if the string is base64 string.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsBase64(base64 string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsBase64("aGVsbG8=")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsBase64("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChineseMobile">IsChineseMobile</span>
|
||||||
|
<p>Check if the string is valid chinese mobile number.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChineseMobile(mobileNum string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChineseMobile("13263527980")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChineseMobile("434324324")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChineseIdNum">IsChineseIdNum</span>
|
||||||
|
<p>Check if the string is chinese id number.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChineseIdNum(id string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChineseIdNum("210911192105130715")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChineseIdNum("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChinesePhone">IsChinesePhone</span>
|
||||||
|
<p>Check if the string is chinese phone number.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChinesePhone(phone string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChinesePhone("010-32116675")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChinesePhone("123-87562")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsCreditCard">IsCreditCard</span>
|
||||||
|
<p>Check if the string is credit card.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsCreditCard(creditCart string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsCreditCard("4111111111111111")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsCreditCard("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsDns">IsDns</span>
|
||||||
|
<p>Check if the string is valid dns.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsDns(dns string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsDns("abc.com")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsDns("a.b.com")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.IsDns("http://abc.com")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsEmail">IsEmail</span>
|
||||||
|
<p>Check if the string is email address.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsEmail(email string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsEmail("abc@xyz.com")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsEmail("a.b@@com")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsEmptyString">IsEmptyString</span>
|
||||||
|
<p>Check if the string is empty or not.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsEmptyString(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsEmptyString("")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsEmptyString("abc")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsFloatStr">IsFloatStr</span>
|
||||||
|
<p>Check if the string can convert to a float.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsFloatStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsFloatStr("")) //false
|
||||||
|
fmt.Println(validator.IsFloatStr("12a")) //false
|
||||||
|
fmt.Println(validator.IsFloatStr("3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("+3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("-3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("12")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsNumberStr">IsNumberStr</span>
|
||||||
|
<p>Check if the string can convert to a number.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsNumberStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsNumberStr("")) //false
|
||||||
|
fmt.Println(validator.IsNumberStr("12a")) //false
|
||||||
|
fmt.Println(validator.IsNumberStr("3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("+3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("-3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("+3e2")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsJSON">IsJSON</span>
|
||||||
|
<p>Check if the string is valid JSON.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsJSON(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsJSON("")) //false
|
||||||
|
fmt.Println(validator.IsJSON("abc")) //false
|
||||||
|
fmt.Println(validator.IsJSON("{}")) //true
|
||||||
|
fmt.Println(validator.IsJSON("[]")) //true
|
||||||
|
fmt.Println(validator.IsJSON("123")) //true
|
||||||
|
fmt.Println(validator.IsJSON("{\"name\": \"test\"}")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsRegexMatch">IsRegexMatch</span>
|
||||||
|
<p>Check if the string match the regexp.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsRegexMatch(s, regex string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsRegexMatch("abc", `^[a-zA-Z]+$`)) //true
|
||||||
|
fmt.Println(validator.IsRegexMatch("1ab", `^[a-zA-Z]+$`)) //false
|
||||||
|
fmt.Println(validator.IsRegexMatch("", `^[a-zA-Z]+$`)) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIntStr">IsIntStr</span>
|
||||||
|
<p>Check if the string can convert to a integer.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIntStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIntStr("+3")) //true
|
||||||
|
fmt.Println(validator.IsIntStr("-3")) //true
|
||||||
|
fmt.Println(validator.IsIntStr("3.")) //false
|
||||||
|
fmt.Println(validator.IsIntStr("abc")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIp">IsIp</span>
|
||||||
|
<p>Check if the string is a ip address.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIp(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIp("127.0.0.1")) //true
|
||||||
|
fmt.Println(validator.IsIp("::0:0:0:0:0:0:1")) //true
|
||||||
|
fmt.Println(validator.IsIp("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIp("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIpV4">IsIpV4</span>
|
||||||
|
<p>Check if the string is a ipv4 address.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIpV4(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIpV4("127.0.0.1")) //true
|
||||||
|
fmt.Println(validator.IsIpV4("::0:0:0:0:0:0:1")) //false
|
||||||
|
fmt.Println(validator.IsIpV4("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIpV4("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIpV6">IsIpV6</span>
|
||||||
|
<p>Check if the string is a ipv6 address.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIpV6(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIpV6("127.0.0.1")) //false
|
||||||
|
fmt.Println(validator.IsIpV6("::0:0:0:0:0:0:1")) //true
|
||||||
|
fmt.Println(validator.IsIpV6("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIpV6("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsStrongPassword">IsStrongPassword</span>
|
||||||
|
<p>Check if the string is strong password (alpha(lower+upper) + number + special chars(!@#$%^&*()?><)).</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsStrongPassword(password string, length int) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsStrongPassword("abc", 3)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abc123", 6)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC", 6)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC123@#$", 16)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC123@#$", 12)) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsUrl">IsUrl</span>
|
||||||
|
<p>Check if the string is url.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsUrl(str string) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsUrl("http://abc.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("abc.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("a.b.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("abc")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsWeakPassword">IsWeakPassword</span>
|
||||||
|
<p>Check if the string is weak password(only letter or only number or letter + number)
|
||||||
|
.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsWeakPassword(password string, length int) bool
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("123")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc123")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc123@#$")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
799
docs/validator_zh-CN.md
Normal file
799
docs/validator_zh-CN.md
Normal file
@@ -0,0 +1,799 @@
|
|||||||
|
# Validator
|
||||||
|
validator验证器包,包含常用字符串格式验证函数。
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
[https://github.com/duke-git/lancet/blob/v1/validator/validator.go](https://github.com/duke-git/lancet/blob/v1/validator/validator.go)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录:
|
||||||
|
- [ContainChinese](#ContainChinese)
|
||||||
|
- [ContainLetter](#ContainLetter)
|
||||||
|
- [ContainLower](#ContainLower)
|
||||||
|
- [ContainUpper](#ContainUpper)
|
||||||
|
- [IsAlpha](#IsAlpha)
|
||||||
|
- [IsAllUpper](#IsAllUpper)
|
||||||
|
- [IsAllLower](#IsAllLower)
|
||||||
|
- [IsBase64](#IsBase64)
|
||||||
|
- [IsChineseMobile](#IsChineseMobile)
|
||||||
|
- [IsChineseIdNum](#IsChineseIdNum)
|
||||||
|
- [IsChinesePhone](#IsChinesePhone)
|
||||||
|
- [IsCreditCard](#IsCreditCard)
|
||||||
|
- [IsDns](#IsDns)
|
||||||
|
- [IsEmail](#IsEmail)
|
||||||
|
|
||||||
|
- [IsEmptyString](#IsEmptyString)
|
||||||
|
- [IsFloatStr](#IsFloatStr)
|
||||||
|
- [IsNumberStr](#IsNumberStr)
|
||||||
|
- [IsJSON](#IsJSON)
|
||||||
|
- [IsRegexMatch](#IsRegexMatch)
|
||||||
|
- [IsIntStr](#IsIntStr)
|
||||||
|
- [IsIp](#IsIp)
|
||||||
|
- [IsIpV4](#IsIpV4)
|
||||||
|
- [IsIpV6](#IsIpV6)
|
||||||
|
- [IsStrongPassword](#IsStrongPassword)
|
||||||
|
- [IsUrl](#IsUrl)
|
||||||
|
- [IsWeakPassword](#IsWeakPassword)
|
||||||
|
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainChinese">ContainChinese</span>
|
||||||
|
<p>验证字符串是否包含中文字符</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainChinese(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainChinese("你好")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainChinese("你好hello")
|
||||||
|
fmt.Println(res2) //true
|
||||||
|
|
||||||
|
res3 := validator.ContainChinese("hello")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainLetter">ContainLetter</span>
|
||||||
|
<p>验证字符串是否包含至少一个英文字母</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainLetter(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainLetter("1bc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainLetter("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainLetter("&@#$%^&*")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainLower">ContainLower</span>
|
||||||
|
<p>验证字符串是否包含至少一个英文小写字母</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainLower(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainLower("1bc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.ContainLower("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainLower("1BC")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="ContainUpper">ContainUpper</span>
|
||||||
|
<p>验证字符串是否包含至少一个英文大写字母.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func ContainUpper(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.ContainUpper("1bc")
|
||||||
|
fmt.Println(res1) //false
|
||||||
|
|
||||||
|
res2 := validator.ContainUpper("123")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.ContainUpper("1BC")
|
||||||
|
fmt.Println(res3) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsAlpha">IsAlpha</span>
|
||||||
|
<p>验证字符串是否只包含英文字母</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAlpha(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAlpha("abc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAlpha("1bc")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.IsAlpha("")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### <span id="IsAllUpper">IsAllUpper</span>
|
||||||
|
<p>验证字符串是否全是大写英文字母</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAllUpper(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAllUpper("ABC")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAllUpper("aBC")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsAllLower">IsAllLower</span>
|
||||||
|
<p>验证字符串是否全是小写英文字母</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsAllLower(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsAllLower("abc")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsAllLower("abC")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsBase64">IsBase64</span>
|
||||||
|
<p>验证字符串是否是base64编码</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsBase64(base64 string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsBase64("aGVsbG8=")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsBase64("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChineseMobile">IsChineseMobile</span>
|
||||||
|
<p>验证字符串是否是中国手机号码</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChineseMobile(mobileNum string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChineseMobile("13263527980")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChineseMobile("434324324")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChineseIdNum">IsChineseIdNum</span>
|
||||||
|
<p>验证字符串是否是中国身份证号码</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChineseIdNum(id string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChineseIdNum("210911192105130715")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChineseIdNum("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsChinesePhone">IsChinesePhone</span>
|
||||||
|
<p>验证字符串是否是中国电话座机号码</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsChinesePhone(phone string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsChinesePhone("010-32116675")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsChinesePhone("123-87562")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsCreditCard">IsCreditCard</span>
|
||||||
|
<p>验证字符串是否是信用卡号码</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsCreditCard(creditCart string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsCreditCard("4111111111111111")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsCreditCard("123456")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsDns">IsDns</span>
|
||||||
|
<p>验证字符串是否是有效dns</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsDns(dns string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsDns("abc.com")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsDns("a.b.com")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
|
||||||
|
res3 := validator.IsDns("http://abc.com")
|
||||||
|
fmt.Println(res3) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsEmail">IsEmail</span>
|
||||||
|
<p>验证字符串是否是有效电子邮件地址</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsEmail(email string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsEmail("abc@xyz.com")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsEmail("a.b@@com")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsEmptyString">IsEmptyString</span>
|
||||||
|
<p>验证字符串是否是空字符串</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsEmptyString(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
res1 := validator.IsEmptyString("")
|
||||||
|
fmt.Println(res1) //true
|
||||||
|
|
||||||
|
res2 := validator.IsEmptyString("abc")
|
||||||
|
fmt.Println(res2) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsFloatStr">IsFloatStr</span>
|
||||||
|
<p>验证字符串是否是可以转换为浮点数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsFloatStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsFloatStr("")) //false
|
||||||
|
fmt.Println(validator.IsFloatStr("12a")) //false
|
||||||
|
fmt.Println(validator.IsFloatStr("3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("+3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("-3.")) //true
|
||||||
|
fmt.Println(validator.IsFloatStr("12")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsNumberStr">IsNumberStr</span>
|
||||||
|
<p>验证字符串是否是可以转换为数字</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsNumberStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsNumberStr("")) //false
|
||||||
|
fmt.Println(validator.IsNumberStr("12a")) //false
|
||||||
|
fmt.Println(validator.IsNumberStr("3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("+3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("-3.")) //true
|
||||||
|
fmt.Println(validator.IsNumberStr("+3e2")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsJSON">IsJSON</span>
|
||||||
|
<p>验证字符串是否是有效json</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsJSON(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsJSON("")) //false
|
||||||
|
fmt.Println(validator.IsJSON("abc")) //false
|
||||||
|
fmt.Println(validator.IsJSON("{}")) //true
|
||||||
|
fmt.Println(validator.IsJSON("[]")) //true
|
||||||
|
fmt.Println(validator.IsJSON("123")) //true
|
||||||
|
fmt.Println(validator.IsJSON("{\"name\": \"test\"}")) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsRegexMatch">IsRegexMatch</span>
|
||||||
|
<p>验证字符串是否可以匹配正则表达式</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsRegexMatch(s, regex string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsRegexMatch("abc", `^[a-zA-Z]+$`)) //true
|
||||||
|
fmt.Println(validator.IsRegexMatch("1ab", `^[a-zA-Z]+$`)) //false
|
||||||
|
fmt.Println(validator.IsRegexMatch("", `^[a-zA-Z]+$`)) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIntStr">IsIntStr</span>
|
||||||
|
<p>验证字符串是否是可以转换为整数</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIntStr(s string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIntStr("+3")) //true
|
||||||
|
fmt.Println(validator.IsIntStr("-3")) //true
|
||||||
|
fmt.Println(validator.IsIntStr("3.")) //false
|
||||||
|
fmt.Println(validator.IsIntStr("abc")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIp">IsIp</span>
|
||||||
|
<p>验证字符串是否是ip地址</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIp(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIp("127.0.0.1")) //true
|
||||||
|
fmt.Println(validator.IsIp("::0:0:0:0:0:0:1")) //true
|
||||||
|
fmt.Println(validator.IsIp("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIp("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIpV4">IsIpV4</span>
|
||||||
|
<p>验证字符串是否是ipv4地址</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIpV4(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIpV4("127.0.0.1")) //true
|
||||||
|
fmt.Println(validator.IsIpV4("::0:0:0:0:0:0:1")) //false
|
||||||
|
fmt.Println(validator.IsIpV4("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIpV4("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsIpV6">IsIpV6</span>
|
||||||
|
<p>验证字符串是否是ipv6地址</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsIpV6(ipstr string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsIpV6("127.0.0.1")) //false
|
||||||
|
fmt.Println(validator.IsIpV6("::0:0:0:0:0:0:1")) //true
|
||||||
|
fmt.Println(validator.IsIpV6("127.0.0")) //false
|
||||||
|
fmt.Println(validator.IsIpV6("127")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsStrongPassword">IsStrongPassword</span>
|
||||||
|
<p>验证字符串是否是强密码:(alpha(lower+upper) + number + special chars(!@#$%^&*()?><))</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsStrongPassword(password string, length int) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsStrongPassword("abc", 3)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abc123", 6)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC", 6)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC123@#$", 16)) //false
|
||||||
|
fmt.Println(validator.IsStrongPassword("abcABC123@#$", 12)) //true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsUrl">IsUrl</span>
|
||||||
|
<p>验证字符串是否是url</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsUrl(str string) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsUrl("http://abc.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("abc.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("a.b.com")) //true
|
||||||
|
fmt.Println(validator.IsUrl("abc")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="IsWeakPassword">IsWeakPassword</span>
|
||||||
|
<p>验证字符串是否是弱密码:(only letter or only number or letter + number)
|
||||||
|
.</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func IsWeakPassword(password string, length int) bool
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/validator"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("123")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc123")) //true
|
||||||
|
fmt.Println(validator.IsWeakPassword("abc123@#$")) //false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
154
fileutil/file.go
154
fileutil/file.go
@@ -5,11 +5,17 @@
|
|||||||
package fileutil
|
package fileutil
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"archive/zip"
|
||||||
"bufio"
|
"bufio"
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
|
"io/fs"
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
|
"path"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
// IsExist checks if a file or directory exists
|
// IsExist checks if a file or directory exists
|
||||||
@@ -35,6 +41,11 @@ func CreateFile(path string) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// CreateDir create directory in absolute path. param `absPath` like /a/, /a/b/
|
||||||
|
func CreateDir(absPath string) error {
|
||||||
|
return os.MkdirAll(path.Dir(absPath), os.ModePerm)
|
||||||
|
}
|
||||||
|
|
||||||
// IsDir checks if the path is directory or not
|
// IsDir checks if the path is directory or not
|
||||||
func IsDir(path string) bool {
|
func IsDir(path string) bool {
|
||||||
file, err := os.Stat(path)
|
file, err := os.Stat(path)
|
||||||
@@ -148,3 +159,146 @@ func ListFileNames(path string) ([]string, error) {
|
|||||||
|
|
||||||
return res, nil
|
return res, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Zip create zip file, fpath could be a single file or a directory
|
||||||
|
func Zip(fpath string, destPath string) error {
|
||||||
|
zipFile, err := os.Create(destPath)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer zipFile.Close()
|
||||||
|
|
||||||
|
archive := zip.NewWriter(zipFile)
|
||||||
|
defer archive.Close()
|
||||||
|
|
||||||
|
filepath.Walk(fpath, func(path string, info os.FileInfo, err error) error {
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
header, err := zip.FileInfoHeader(info)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
header.Name = strings.TrimPrefix(path, filepath.Dir(fpath)+"/")
|
||||||
|
|
||||||
|
if info.IsDir() {
|
||||||
|
header.Name += "/"
|
||||||
|
} else {
|
||||||
|
header.Method = zip.Deflate
|
||||||
|
}
|
||||||
|
|
||||||
|
writer, err := archive.CreateHeader(header)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if !info.IsDir() {
|
||||||
|
file, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
_, err = io.Copy(writer, file)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnZip unzip the file and save it to destPath
|
||||||
|
func UnZip(zipFile string, destPath string) error {
|
||||||
|
zipReader, err := zip.OpenReader(zipFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer zipReader.Close()
|
||||||
|
|
||||||
|
for _, f := range zipReader.File {
|
||||||
|
path := filepath.Join(destPath, f.Name)
|
||||||
|
if f.FileInfo().IsDir() {
|
||||||
|
os.MkdirAll(path, os.ModePerm)
|
||||||
|
} else {
|
||||||
|
if err = os.MkdirAll(filepath.Dir(path), os.ModePerm); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
inFile, err := f.Open()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer inFile.Close()
|
||||||
|
|
||||||
|
outFile, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
_, err = io.Copy(outFile, inFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsLink checks if a file is symbol link or not
|
||||||
|
func IsLink(path string) bool {
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return fi.Mode()&os.ModeSymlink != 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// FileMode return file's mode and permission
|
||||||
|
func FileMode(path string) (fs.FileMode, error) {
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return fi.Mode(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MiMeType return file mime type
|
||||||
|
// param `file` should be string(file path) or *os.File
|
||||||
|
func MiMeType(file interface{}) string {
|
||||||
|
var mediatype string
|
||||||
|
|
||||||
|
readBuffer := func(f *os.File) ([]byte, error) {
|
||||||
|
buffer := make([]byte, 512)
|
||||||
|
_, err := f.Read(buffer)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return buffer, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if filePath, ok := file.(string); ok {
|
||||||
|
f, err := os.Open(filePath)
|
||||||
|
if err != nil {
|
||||||
|
return mediatype
|
||||||
|
}
|
||||||
|
buffer, err := readBuffer(f)
|
||||||
|
if err != nil {
|
||||||
|
return mediatype
|
||||||
|
}
|
||||||
|
return http.DetectContentType(buffer)
|
||||||
|
}
|
||||||
|
|
||||||
|
if f, ok := file.(*os.File); ok {
|
||||||
|
buffer, err := readBuffer(f)
|
||||||
|
if err != nil {
|
||||||
|
return mediatype
|
||||||
|
}
|
||||||
|
return http.DetectContentType(buffer)
|
||||||
|
}
|
||||||
|
return mediatype
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,137 +2,222 @@ package fileutil
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"reflect"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/duke-git/lancet/internal"
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestIsExist(t *testing.T) {
|
func TestIsExist(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsExist")
|
||||||
|
|
||||||
cases := []string{"./", "./file.go", "./a.txt"}
|
cases := []string{"./", "./file.go", "./a.txt"}
|
||||||
expected := []bool{true, true, false}
|
expected := []bool{true, true, false}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := IsExist(cases[i])
|
actual := IsExist(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "IsExist", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCreateFile(t *testing.T) {
|
func TestCreateFile(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCreateFile")
|
||||||
|
|
||||||
f := "./text.txt"
|
f := "./text.txt"
|
||||||
if CreateFile(f) {
|
if CreateFile(f) {
|
||||||
file, err := os.Open(f)
|
file, err := os.Open(f)
|
||||||
if err != nil {
|
assert.IsNil(err)
|
||||||
internal.LogFailedTestInfo(t, "CreateFile", f, f, "create file error: "+err.Error())
|
assert.Equal(f, file.Name())
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
if file.Name() != f {
|
|
||||||
internal.LogFailedTestInfo(t, "CreateFile", f, f, file.Name())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
internal.LogFailedTestInfo(t, "CreateFile", f, f, "create file error")
|
|
||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
|
os.Remove(f)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreateDir(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCreateDir")
|
||||||
|
|
||||||
|
pwd, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
|
|
||||||
|
dirPath := pwd + "/a/"
|
||||||
|
err = CreateDir(dirPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(true, IsExist(dirPath))
|
||||||
|
os.Remove(dirPath)
|
||||||
|
assert.Equal(false, IsExist(dirPath))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsDir(t *testing.T) {
|
func TestIsDir(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsDir")
|
||||||
|
|
||||||
cases := []string{"./", "./a.txt"}
|
cases := []string{"./", "./a.txt"}
|
||||||
expected := []bool{true, false}
|
expected := []bool{true, false}
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := IsDir(cases[i])
|
actual := IsDir(cases[i])
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "IsDir", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRemoveFile(t *testing.T) {
|
func TestRemoveFile(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRemoveFile")
|
||||||
f := "./text.txt"
|
f := "./text.txt"
|
||||||
if CreateFile(f) {
|
if !IsExist(f) {
|
||||||
|
CreateFile(f)
|
||||||
err := RemoveFile(f)
|
err := RemoveFile(f)
|
||||||
if err != nil {
|
assert.IsNil(err)
|
||||||
internal.LogFailedTestInfo(t, "RemoveFile", f, f, err.Error())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
internal.LogFailedTestInfo(t, "RemoveFile", f, f, "create file error")
|
|
||||||
t.FailNow()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCopyFile(t *testing.T) {
|
func TestCopyFile(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCopyFile")
|
||||||
|
|
||||||
srcFile := "./text.txt"
|
srcFile := "./text.txt"
|
||||||
CreateFile(srcFile)
|
CreateFile(srcFile)
|
||||||
|
|
||||||
dstFile := "./text_copy.txt"
|
destFile := "./text_copy.txt"
|
||||||
|
|
||||||
err := CopyFile(srcFile, dstFile)
|
err := CopyFile(srcFile, destFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
file, err := os.Open(dstFile)
|
file, err := os.Open(destFile)
|
||||||
if err != nil {
|
assert.IsNil(err)
|
||||||
internal.LogFailedTestInfo(t, "CopyFile", srcFile, dstFile, "create file error: "+err.Error())
|
assert.Equal(destFile, file.Name())
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
if file.Name() != dstFile {
|
|
||||||
internal.LogFailedTestInfo(t, "CopyFile", srcFile, dstFile, file.Name())
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
os.Remove(srcFile)
|
||||||
|
os.Remove(destFile)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestListFileNames(t *testing.T) {
|
func TestListFileNames(t *testing.T) {
|
||||||
filesInCurrentPath, err := ListFileNames("../datetime/")
|
assert := internal.NewAssert(t, "TestListFileNames")
|
||||||
if err != nil {
|
|
||||||
t.FailNow()
|
filesInPath, err := ListFileNames("../datetime/")
|
||||||
}
|
assert.IsNil(err)
|
||||||
expected := []string{"datetime.go", "datetime_test.go"}
|
|
||||||
if !reflect.DeepEqual(filesInCurrentPath, expected) {
|
expected := []string{"conversion.go", "conversion_test.go", "datetime.go", "datetime_test.go"}
|
||||||
internal.LogFailedTestInfo(t, "ToChar", "./", expected, filesInCurrentPath)
|
assert.Equal(expected, filesInPath)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReadFileToString(t *testing.T) {
|
func TestReadFileToString(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestReadFileToString")
|
||||||
|
|
||||||
path := "./text.txt"
|
path := "./text.txt"
|
||||||
CreateFile(path)
|
CreateFile(path)
|
||||||
|
|
||||||
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
f.WriteString("hello world")
|
f.WriteString("hello world")
|
||||||
|
|
||||||
res, _ := ReadFileToString(path)
|
content, _ := ReadFileToString(path)
|
||||||
if res != "hello world" {
|
assert.Equal("hello world", content)
|
||||||
internal.LogFailedTestInfo(t, "ReadFileToString", path, "hello world", res)
|
|
||||||
}
|
os.Remove(path)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestClearFile(t *testing.T) {
|
func TestClearFile(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestClearFile")
|
||||||
|
|
||||||
path := "./text.txt"
|
path := "./text.txt"
|
||||||
CreateFile(path)
|
CreateFile(path)
|
||||||
|
|
||||||
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
defer f.Close()
|
||||||
|
|
||||||
f.WriteString("hello world")
|
f.WriteString("hello world")
|
||||||
|
|
||||||
CreateFile(path)
|
err := ClearFile(path)
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
res, _ := ReadFileToString(path)
|
content, _ := ReadFileToString(path)
|
||||||
if res != "" {
|
assert.Equal("", content)
|
||||||
internal.LogFailedTestInfo(t, "CreateFile", path, "", res)
|
|
||||||
}
|
os.Remove(path)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReadFileByLine(t *testing.T) {
|
func TestReadFileByLine(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestReadFileByLine")
|
||||||
|
|
||||||
path := "./text.txt"
|
path := "./text.txt"
|
||||||
CreateFile(path)
|
CreateFile(path)
|
||||||
|
|
||||||
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
f, _ := os.OpenFile(path, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
defer f.Close()
|
||||||
f.WriteString("hello\nworld")
|
f.WriteString("hello\nworld")
|
||||||
|
|
||||||
expected := []string{"hello", "world"}
|
expected := []string{"hello", "world"}
|
||||||
res, _ := ReadFileByLine(path)
|
actual, _ := ReadFileByLine(path)
|
||||||
if !reflect.DeepEqual(res, expected) {
|
assert.Equal(expected, actual)
|
||||||
internal.LogFailedTestInfo(t, "ReadFileByLine", path, expected, res)
|
|
||||||
}
|
os.Remove(path)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestZipAndUnZip(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestZipAndUnZip")
|
||||||
|
|
||||||
|
srcFile := "./text.txt"
|
||||||
|
CreateFile(srcFile)
|
||||||
|
|
||||||
|
file, _ := os.OpenFile(srcFile, os.O_WRONLY|os.O_TRUNC, 0777)
|
||||||
|
defer file.Close()
|
||||||
|
file.WriteString("hello\nworld")
|
||||||
|
|
||||||
|
zipFile := "./text.zip"
|
||||||
|
err := Zip(srcFile, zipFile)
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
unZipPath := "./unzip"
|
||||||
|
err = UnZip(zipFile, unZipPath)
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
unZipFile := "./unzip/text.txt"
|
||||||
|
assert.Equal(true, IsExist(unZipFile))
|
||||||
|
|
||||||
|
os.Remove(srcFile)
|
||||||
|
os.Remove(zipFile)
|
||||||
|
os.RemoveAll(unZipPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFileMode(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestFileMode")
|
||||||
|
|
||||||
|
srcFile := "./text.txt"
|
||||||
|
CreateFile(srcFile)
|
||||||
|
|
||||||
|
mode, err := FileMode(srcFile)
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
t.Log(mode)
|
||||||
|
|
||||||
|
os.Remove(srcFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsLink(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsLink")
|
||||||
|
|
||||||
|
srcFile := "./text.txt"
|
||||||
|
CreateFile(srcFile)
|
||||||
|
|
||||||
|
linkFile := "./text.link"
|
||||||
|
if !IsExist(linkFile) {
|
||||||
|
_ = os.Symlink(srcFile, linkFile)
|
||||||
|
}
|
||||||
|
assert.Equal(true, IsLink(linkFile))
|
||||||
|
|
||||||
|
assert.Equal(false, IsLink("./file.go"))
|
||||||
|
|
||||||
|
os.Remove(srcFile)
|
||||||
|
os.Remove(linkFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMiMeType(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestMiMeType")
|
||||||
|
|
||||||
|
f, _ := os.Open("./file.go")
|
||||||
|
assert.Equal("text/plain; charset=utf-8", MiMeType(f))
|
||||||
|
assert.Equal("text/plain; charset=utf-8", MiMeType("./file.go"))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,22 +7,17 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestComma(t *testing.T) {
|
func TestComma(t *testing.T) {
|
||||||
comma(t, "", "", "")
|
assert := internal.NewAssert(t, "TestComma")
|
||||||
comma(t, "aa", "", "")
|
|
||||||
comma(t, "aa.a", "", "")
|
|
||||||
comma(t, []int{1}, "", "")
|
|
||||||
comma(t, "123", "", "123")
|
|
||||||
comma(t, "12345", "", "12,345")
|
|
||||||
comma(t, 12345, "", "12,345")
|
|
||||||
comma(t, 12345, "$", "$12,345")
|
|
||||||
comma(t, 12345, "¥", "¥12,345")
|
|
||||||
comma(t, 12345.6789, "", "12,345.6789")
|
|
||||||
}
|
|
||||||
|
|
||||||
func comma(t *testing.T, test interface{}, symbol string, expected interface{}) {
|
assert.Equal("", Comma("", ""))
|
||||||
res := Comma(test, symbol)
|
assert.Equal("", Comma("aa", ""))
|
||||||
if res != expected {
|
assert.Equal("", Comma("aa.a", ""))
|
||||||
internal.LogFailedTestInfo(t, "Comma", test, expected, res)
|
assert.Equal("", Comma([]int{1}, ""))
|
||||||
t.FailNow()
|
assert.Equal("123", Comma("123", ""))
|
||||||
}
|
assert.Equal("12,345", Comma("12345", ""))
|
||||||
|
|
||||||
|
assert.Equal("12,345", Comma(12345, ""))
|
||||||
|
assert.Equal("$12,345", Comma(12345, "$"))
|
||||||
|
assert.Equal("¥12,345", Comma(12345, "¥"))
|
||||||
|
assert.Equal("12,345.6789", Comma(12345.6789, ""))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import (
|
|||||||
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value {
|
func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value {
|
||||||
// Catch programming error while constructing the closure
|
// Catch programming error while constructing the closure
|
||||||
mustBeFunction(fn)
|
mustBeFunction(fn)
|
||||||
|
|
||||||
return func(args ...interface{}) []reflect.Value {
|
return func(args ...interface{}) []reflect.Value {
|
||||||
n--
|
n--
|
||||||
if n < 1 {
|
if n < 1 {
|
||||||
@@ -66,14 +67,38 @@ func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) in
|
|||||||
|
|
||||||
// Delay make the function execution after delayed time
|
// Delay make the function execution after delayed time
|
||||||
func Delay(delay time.Duration, fn interface{}, args ...interface{}) {
|
func Delay(delay time.Duration, fn interface{}, args ...interface{}) {
|
||||||
|
// Catch programming error while constructing the closure
|
||||||
|
mustBeFunction(fn)
|
||||||
|
|
||||||
time.Sleep(delay)
|
time.Sleep(delay)
|
||||||
invokeFunc(fn, args...)
|
invokeFunc(fn, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Debounced creates a debounced function that delays invoking fn until after wait duration have elapsed since the last time the debounced function was invoked.
|
||||||
|
func Debounced(fn func(), duration time.Duration) func() {
|
||||||
|
// Catch programming error while constructing the closure
|
||||||
|
mustBeFunction(fn)
|
||||||
|
|
||||||
|
timer := time.NewTimer(duration)
|
||||||
|
timer.Stop()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-timer.C:
|
||||||
|
go fn()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return func() { timer.Reset(duration) }
|
||||||
|
}
|
||||||
|
|
||||||
// Schedule invoke function every duration time, util close the returned bool chan
|
// Schedule invoke function every duration time, util close the returned bool chan
|
||||||
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool {
|
func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool {
|
||||||
// Catch programming error while constructing the closure
|
// Catch programming error while constructing the closure
|
||||||
mustBeFunction(fn)
|
mustBeFunction(fn)
|
||||||
|
|
||||||
quit := make(chan bool)
|
quit := make(chan bool)
|
||||||
go func() {
|
go func() {
|
||||||
for {
|
for {
|
||||||
|
|||||||
@@ -6,6 +6,8 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestAfter(t *testing.T) {
|
func TestAfter(t *testing.T) {
|
||||||
@@ -32,6 +34,8 @@ func TestAfter(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestBefore(t *testing.T) {
|
func TestBefore(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestBefore")
|
||||||
|
|
||||||
arr := []string{"a", "b", "c", "d", "e"}
|
arr := []string{"a", "b", "c", "d", "e"}
|
||||||
f := Before(3, func(i int) int {
|
f := Before(3, func(i int) int {
|
||||||
return i
|
return i
|
||||||
@@ -40,7 +44,6 @@ func TestBefore(t *testing.T) {
|
|||||||
var res []int64
|
var res []int64
|
||||||
type cb func(args ...interface{}) []reflect.Value
|
type cb func(args ...interface{}) []reflect.Value
|
||||||
appendStr := func(i int, s string, fn cb) {
|
appendStr := func(i int, s string, fn cb) {
|
||||||
fmt.Printf("appendStr: arr[%d] is %s \n", i, s)
|
|
||||||
v := fn(i)
|
v := fn(i)
|
||||||
res = append(res, v[0].Int())
|
res = append(res, v[0].Int())
|
||||||
}
|
}
|
||||||
@@ -49,28 +52,26 @@ func TestBefore(t *testing.T) {
|
|||||||
appendStr(i, arr[i], f)
|
appendStr(i, arr[i], f)
|
||||||
}
|
}
|
||||||
|
|
||||||
expect := []int64{0, 1, 2, 2, 2}
|
expected := []int64{0, 1, 2, 2, 2}
|
||||||
if !reflect.DeepEqual(expect, res) {
|
assert.Equal(expected, res)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCurry(t *testing.T) {
|
func TestCurry(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCurry")
|
||||||
|
|
||||||
add := func(a, b int) int {
|
add := func(a, b int) int {
|
||||||
return a + b
|
return a + b
|
||||||
}
|
}
|
||||||
var addCurry Fn = func(values ...interface{}) interface{} {
|
var addCurry Fn = func(values ...interface{}) interface{} {
|
||||||
return add(values[0].(int), values[1].(int))
|
return add(values[0].(int), values[1].(int))
|
||||||
}
|
}
|
||||||
|
|
||||||
add1 := addCurry.Curry(1)
|
add1 := addCurry.Curry(1)
|
||||||
v := add1(2)
|
assert.Equal(3, add1(2))
|
||||||
if v != 3 {
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCompose(t *testing.T) {
|
func TestCompose(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCompose")
|
||||||
|
|
||||||
toUpper := func(a ...interface{}) interface{} {
|
toUpper := func(a ...interface{}) interface{} {
|
||||||
return strings.ToUpper(a[0].(string))
|
return strings.ToUpper(a[0].(string))
|
||||||
}
|
}
|
||||||
@@ -78,27 +79,47 @@ func TestCompose(t *testing.T) {
|
|||||||
return strings.ToLower(a[0].(string))
|
return strings.ToLower(a[0].(string))
|
||||||
}
|
}
|
||||||
|
|
||||||
expect := toUpper(toLower("aBCde"))
|
expected := toUpper(toLower("aBCde"))
|
||||||
cf := Compose(toUpper, toLower)
|
cf := Compose(toUpper, toLower)
|
||||||
res := cf("aBCde")
|
res := cf("aBCde")
|
||||||
|
|
||||||
if res != expect {
|
assert.Equal(expected, res)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDelay(t *testing.T) {
|
func TestDelay(t *testing.T) {
|
||||||
var print = func(s string) {
|
var print = func(s string) {
|
||||||
fmt.Println(s)
|
t.Log(s)
|
||||||
}
|
}
|
||||||
Delay(2*time.Second, print, "test delay")
|
Delay(2*time.Second, print, "test delay")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDebounced(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestDebounced")
|
||||||
|
|
||||||
|
count := 0
|
||||||
|
add := func() {
|
||||||
|
count++
|
||||||
|
}
|
||||||
|
|
||||||
|
debouncedAdd := Debounced(add, 50*time.Microsecond)
|
||||||
|
debouncedAdd()
|
||||||
|
debouncedAdd()
|
||||||
|
debouncedAdd()
|
||||||
|
debouncedAdd()
|
||||||
|
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
assert.Equal(1, count)
|
||||||
|
|
||||||
|
debouncedAdd()
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
assert.Equal(2, count)
|
||||||
|
}
|
||||||
|
|
||||||
func TestSchedule(t *testing.T) {
|
func TestSchedule(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestSchedule")
|
||||||
|
|
||||||
var res []string
|
var res []string
|
||||||
appendStr := func(s string) {
|
appendStr := func(s string) {
|
||||||
fmt.Println(s)
|
|
||||||
res = append(res, s)
|
res = append(res, s)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -106,9 +127,6 @@ func TestSchedule(t *testing.T) {
|
|||||||
time.Sleep(5 * time.Second)
|
time.Sleep(5 * time.Second)
|
||||||
close(stop)
|
close(stop)
|
||||||
|
|
||||||
expect := []string{"*", "*", "*", "*", "*"}
|
expected := []string{"*", "*", "*", "*", "*"}
|
||||||
if !reflect.DeepEqual(expect, res) {
|
assert.Equal(expected, res)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
fmt.Println("done")
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,26 +2,31 @@ package function
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestWatcher(t *testing.T) {
|
func TestWatcher(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestWatcher")
|
||||||
|
|
||||||
w := &Watcher{}
|
w := &Watcher{}
|
||||||
w.Start()
|
w.Start()
|
||||||
|
|
||||||
longRunningTask()
|
longRunningTask()
|
||||||
|
|
||||||
if !w.excuting {
|
assert.Equal(true, w.excuting)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
w.Stop()
|
w.Stop()
|
||||||
|
|
||||||
eapsedTime := w.GetElapsedTime().Milliseconds()
|
eapsedTime := w.GetElapsedTime().Milliseconds()
|
||||||
t.Log("Elapsed Time (milsecond)", eapsedTime)
|
t.Log("Elapsed Time (milsecond)", eapsedTime)
|
||||||
|
|
||||||
if w.excuting {
|
assert.Equal(false, w.excuting)
|
||||||
t.FailNow()
|
|
||||||
}
|
w.Reset()
|
||||||
|
|
||||||
|
assert.Equal(int64(0), w.startTime)
|
||||||
|
assert.Equal(int64(0), w.stopTime)
|
||||||
}
|
}
|
||||||
|
|
||||||
func longRunningTask() {
|
func longRunningTask() {
|
||||||
|
|||||||
171
internal/assert.go
Normal file
171
internal/assert.go
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
||||||
|
// Use of this source code is governed by MIT license
|
||||||
|
|
||||||
|
// Package internal is for internal use.
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"runtime"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
compareNotEqual int = iota - 2
|
||||||
|
compareLess
|
||||||
|
compareEqual
|
||||||
|
compareGreater
|
||||||
|
)
|
||||||
|
|
||||||
|
// Assert is a simple implementation of assertion, only for internal usage
|
||||||
|
type Assert struct {
|
||||||
|
T *testing.T
|
||||||
|
CaseName string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewAssert return instance of Assert
|
||||||
|
func NewAssert(t *testing.T, caseName string) *Assert {
|
||||||
|
return &Assert{T: t, CaseName: caseName}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equal check if expected is equal with actual
|
||||||
|
func (a *Assert) Equal(expected, actual interface{}) {
|
||||||
|
if compare(expected, actual) != compareEqual {
|
||||||
|
makeTestFailed(a.T, a.CaseName, expected, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotEqual check if expected is not equal with actual
|
||||||
|
func (a *Assert) NotEqual(expected, actual interface{}) {
|
||||||
|
if compare(expected, actual) == compareEqual {
|
||||||
|
expectedInfo := fmt.Sprintf("not %v", expected)
|
||||||
|
makeTestFailed(a.T, a.CaseName, expectedInfo, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Greater check if expected is greate than actual
|
||||||
|
func (a *Assert) Greater(expected, actual interface{}) {
|
||||||
|
if compare(expected, actual) != compareGreater {
|
||||||
|
expectedInfo := fmt.Sprintf("> %v", expected)
|
||||||
|
makeTestFailed(a.T, a.CaseName, expectedInfo, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GreaterOrEqual check if expected is greate than or equal with actual
|
||||||
|
func (a *Assert) GreaterOrEqual(expected, actual interface{}) {
|
||||||
|
isGreatOrEqual := compare(expected, actual) == compareGreater || compare(expected, actual) == compareEqual
|
||||||
|
if !isGreatOrEqual {
|
||||||
|
expectedInfo := fmt.Sprintf(">= %v", expected)
|
||||||
|
makeTestFailed(a.T, a.CaseName, expectedInfo, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Less check if expected is less than actual
|
||||||
|
func (a *Assert) Less(expected, actual interface{}) {
|
||||||
|
if compare(expected, actual) != compareLess {
|
||||||
|
expectedInfo := fmt.Sprintf("< %v", expected)
|
||||||
|
makeTestFailed(a.T, a.CaseName, expectedInfo, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// LessOrEqual check if expected is less than or equal with actual
|
||||||
|
func (a *Assert) LessOrEqual(expected, actual interface{}) {
|
||||||
|
isLessOrEqual := compare(expected, actual) == compareLess || compare(expected, actual) == compareEqual
|
||||||
|
if !isLessOrEqual {
|
||||||
|
expectedInfo := fmt.Sprintf("<= %v", expected)
|
||||||
|
makeTestFailed(a.T, a.CaseName, expectedInfo, actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsNil check if value is nil
|
||||||
|
func (a *Assert) IsNil(value interface{}) {
|
||||||
|
if value != nil {
|
||||||
|
makeTestFailed(a.T, a.CaseName, nil, value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsNotNil check if value is not nil
|
||||||
|
func (a *Assert) IsNotNil(value interface{}) {
|
||||||
|
if value == nil {
|
||||||
|
makeTestFailed(a.T, a.CaseName, "not nil", value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// compare x and y return :
|
||||||
|
// x > y -> 1, x < y -> -1, x == y -> 0, x != y -> -2
|
||||||
|
func compare(x, y interface{}) int {
|
||||||
|
vx := reflect.ValueOf(x)
|
||||||
|
vy := reflect.ValueOf(y)
|
||||||
|
|
||||||
|
if vx.Type() != vy.Type() {
|
||||||
|
return compareNotEqual
|
||||||
|
}
|
||||||
|
|
||||||
|
switch vx.Kind() {
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
xInt := vx.Int()
|
||||||
|
yInt := vy.Int()
|
||||||
|
if xInt > yInt {
|
||||||
|
return compareGreater
|
||||||
|
}
|
||||||
|
if xInt == yInt {
|
||||||
|
return compareEqual
|
||||||
|
}
|
||||||
|
if xInt < yInt {
|
||||||
|
return compareLess
|
||||||
|
}
|
||||||
|
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||||
|
xUint := vx.Uint()
|
||||||
|
yUint := vy.Uint()
|
||||||
|
if xUint > yUint {
|
||||||
|
return compareGreater
|
||||||
|
}
|
||||||
|
if xUint == yUint {
|
||||||
|
return compareEqual
|
||||||
|
}
|
||||||
|
if xUint < yUint {
|
||||||
|
return compareLess
|
||||||
|
}
|
||||||
|
case reflect.Float32, reflect.Float64:
|
||||||
|
xFloat := vx.Float()
|
||||||
|
yFloat := vy.Float()
|
||||||
|
if xFloat > yFloat {
|
||||||
|
return compareGreater
|
||||||
|
}
|
||||||
|
if xFloat == yFloat {
|
||||||
|
return compareEqual
|
||||||
|
}
|
||||||
|
if xFloat < yFloat {
|
||||||
|
return compareLess
|
||||||
|
}
|
||||||
|
case reflect.String:
|
||||||
|
xString := vx.String()
|
||||||
|
yString := vy.String()
|
||||||
|
if xString > yString {
|
||||||
|
return compareGreater
|
||||||
|
}
|
||||||
|
if xString == yString {
|
||||||
|
return compareEqual
|
||||||
|
}
|
||||||
|
if xString < yString {
|
||||||
|
return compareLess
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
if reflect.DeepEqual(x, y) {
|
||||||
|
return compareEqual
|
||||||
|
}
|
||||||
|
return compareNotEqual
|
||||||
|
}
|
||||||
|
|
||||||
|
return compareNotEqual
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// logFailedInfo make test failed and log error info
|
||||||
|
func makeTestFailed(t *testing.T, caseName string, expected, actual interface{}) {
|
||||||
|
_, file, line, _ := runtime.Caller(2)
|
||||||
|
errInfo := fmt.Sprintf("Case %v failed. file: %v, line: %v, expected: %v, actual: %v.", caseName, file, line, expected, actual)
|
||||||
|
t.Error(errInfo)
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
50
internal/assert_test.go
Normal file
50
internal/assert_test.go
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAssert(t *testing.T) {
|
||||||
|
assert := NewAssert(t, "TestAssert")
|
||||||
|
assert.Equal(0, 0)
|
||||||
|
assert.NotEqual(1, 0)
|
||||||
|
|
||||||
|
assert.NotEqual("1", 1)
|
||||||
|
var uInt1 uint
|
||||||
|
var uInt2 uint
|
||||||
|
var uInt8 uint8
|
||||||
|
var uInt16 uint16
|
||||||
|
var uInt32 uint32
|
||||||
|
var uInt64 uint64
|
||||||
|
assert.NotEqual(uInt1, uInt8)
|
||||||
|
assert.NotEqual(uInt8, uInt16)
|
||||||
|
assert.NotEqual(uInt16, uInt32)
|
||||||
|
assert.NotEqual(uInt32, uInt64)
|
||||||
|
|
||||||
|
assert.Equal(uInt1, uInt2)
|
||||||
|
|
||||||
|
uInt1 = 1
|
||||||
|
uInt2 = 2
|
||||||
|
assert.Less(uInt1, uInt2)
|
||||||
|
|
||||||
|
assert.Greater(1, 0)
|
||||||
|
assert.GreaterOrEqual(1, 1)
|
||||||
|
assert.Less(0, 1)
|
||||||
|
assert.LessOrEqual(0, 0)
|
||||||
|
|
||||||
|
assert.Equal(0.1, 0.1)
|
||||||
|
assert.Greater(1.1, 0.1)
|
||||||
|
assert.Less(0.1, 1.1)
|
||||||
|
|
||||||
|
assert.Equal("abc", "abc")
|
||||||
|
assert.NotEqual("abc", "abd")
|
||||||
|
assert.Less("abc", "abd")
|
||||||
|
assert.Greater("abd", "abc")
|
||||||
|
|
||||||
|
assert.Equal([]int{1, 2, 3}, []int{1, 2, 3})
|
||||||
|
assert.NotEqual([]int{1, 2, 3}, []int{1, 2})
|
||||||
|
|
||||||
|
assert.IsNil(nil)
|
||||||
|
assert.IsNotNil("abc")
|
||||||
|
|
||||||
|
}
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
|
||||||
// Use of this source code is governed by MIT license
|
|
||||||
|
|
||||||
// Package internal is for internal use.
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// LogFailedTestInfo log test failed info for internal use
|
|
||||||
func LogFailedTestInfo(t *testing.T, testCase, input, expected, result interface{}) {
|
|
||||||
errInfo := fmt.Sprintf("Test case %v: input is %+v, expected %v, but result is %v", testCase, input, expected, result)
|
|
||||||
t.Error(errInfo)
|
|
||||||
}
|
|
||||||
92
mathutil/mathutil.go
Normal file
92
mathutil/mathutil.go
Normal file
@@ -0,0 +1,92 @@
|
|||||||
|
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
||||||
|
// Use of this source code is governed by MIT license
|
||||||
|
|
||||||
|
// Package mathutil implements some functions for math calculation.
|
||||||
|
package mathutil
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"math"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Exponent calculate x^n
|
||||||
|
func Exponent(x, n int64) int64 {
|
||||||
|
if n == 0 {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
t := Exponent(x, n/2)
|
||||||
|
|
||||||
|
if n%2 == 1 {
|
||||||
|
return t * t * x
|
||||||
|
}
|
||||||
|
|
||||||
|
return t * t
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fibonacci calculate fibonacci number before n
|
||||||
|
func Fibonacci(first, second, n int) int {
|
||||||
|
if n <= 0 {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
if n < 3 {
|
||||||
|
return 1
|
||||||
|
} else if n == 3 {
|
||||||
|
return first + second
|
||||||
|
} else {
|
||||||
|
return Fibonacci(second, first+second, n-1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Factorial calculate x!
|
||||||
|
func Factorial(x uint) uint {
|
||||||
|
var f uint = 1
|
||||||
|
for ; x > 1; x-- {
|
||||||
|
f *= x
|
||||||
|
}
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
// Percent calculate the percentage of val to total
|
||||||
|
func Percent(val, total float64, n int) float64 {
|
||||||
|
if total == 0 {
|
||||||
|
return float64(0)
|
||||||
|
}
|
||||||
|
tmp := val / total * 100
|
||||||
|
res := RoundToFloat(tmp, n)
|
||||||
|
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
// RoundToString round up to n decimal places
|
||||||
|
func RoundToString(x float64, n int) string {
|
||||||
|
tmp := math.Pow(10.0, float64(n))
|
||||||
|
x *= tmp
|
||||||
|
x = math.Round(x)
|
||||||
|
res := strconv.FormatFloat(x/tmp, 'f', n, 64)
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
// RoundToFloat round up to n decimal places
|
||||||
|
func RoundToFloat(x float64, n int) float64 {
|
||||||
|
tmp := math.Pow(10.0, float64(n))
|
||||||
|
x *= tmp
|
||||||
|
x = math.Round(x)
|
||||||
|
return x / tmp
|
||||||
|
}
|
||||||
|
|
||||||
|
// TruncRound round off n decimal places
|
||||||
|
func TruncRound(x float64, n int) float64 {
|
||||||
|
floatStr := fmt.Sprintf("%."+strconv.Itoa(n+1)+"f", x)
|
||||||
|
temp := strings.Split(floatStr, ".")
|
||||||
|
var newFloat string
|
||||||
|
if len(temp) < 2 || n >= len(temp[1]) {
|
||||||
|
newFloat = floatStr
|
||||||
|
} else {
|
||||||
|
newFloat = temp[0] + "." + temp[1][:n]
|
||||||
|
}
|
||||||
|
res, _ := strconv.ParseFloat(newFloat, 64)
|
||||||
|
return res
|
||||||
|
}
|
||||||
72
mathutil/mathutil_test.go
Normal file
72
mathutil/mathutil_test.go
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
package mathutil
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExponent(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestExponent")
|
||||||
|
|
||||||
|
assert.Equal(int64(1), Exponent(10, 0))
|
||||||
|
assert.Equal(int64(10), Exponent(10, 1))
|
||||||
|
assert.Equal(int64(100), Exponent(10, 2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFibonacci(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestFibonacci")
|
||||||
|
|
||||||
|
assert.Equal(0, Fibonacci(1, 1, 0))
|
||||||
|
assert.Equal(1, Fibonacci(1, 1, 1))
|
||||||
|
assert.Equal(1, Fibonacci(1, 1, 2))
|
||||||
|
assert.Equal(5, Fibonacci(1, 1, 5))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFactorial(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestFactorial")
|
||||||
|
|
||||||
|
assert.Equal(uint(1), Factorial(0))
|
||||||
|
assert.Equal(uint(1), Factorial(1))
|
||||||
|
assert.Equal(uint(2), Factorial(2))
|
||||||
|
assert.Equal(uint(6), Factorial(3))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPercent(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestPercent")
|
||||||
|
|
||||||
|
assert.Equal(float64(50), Percent(1, 2, 2))
|
||||||
|
assert.Equal(float64(33.33), Percent(0.1, 0.3, 2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRoundToFloat(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRoundToFloat")
|
||||||
|
|
||||||
|
assert.Equal(RoundToFloat(0, 0), float64(0))
|
||||||
|
assert.Equal(RoundToFloat(0, 1), float64(0))
|
||||||
|
assert.Equal(RoundToFloat(0.124, 2), float64(0.12))
|
||||||
|
assert.Equal(RoundToFloat(0.125, 2), float64(0.13))
|
||||||
|
assert.Equal(RoundToFloat(0.125, 3), float64(0.125))
|
||||||
|
assert.Equal(RoundToFloat(33.33333, 2), float64(33.33))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRoundToString(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRoundToString")
|
||||||
|
|
||||||
|
assert.Equal(RoundToString(0, 0), "0")
|
||||||
|
assert.Equal(RoundToString(0, 1), "0.0")
|
||||||
|
assert.Equal(RoundToString(0.124, 2), "0.12")
|
||||||
|
assert.Equal(RoundToString(0.125, 2), "0.13")
|
||||||
|
assert.Equal(RoundToString(0.125, 3), "0.125")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTruncRound(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestTruncRound")
|
||||||
|
|
||||||
|
assert.Equal(TruncRound(0, 0), float64(0))
|
||||||
|
assert.Equal(TruncRound(0, 1), float64(0))
|
||||||
|
assert.Equal(TruncRound(0.124, 2), float64(0.12))
|
||||||
|
assert.Equal(TruncRound(0.125, 2), float64(0.12))
|
||||||
|
assert.Equal(TruncRound(0.125, 3), float64(0.125))
|
||||||
|
assert.Equal(TruncRound(33.33333, 2), float64(33.33))
|
||||||
|
}
|
||||||
@@ -6,7 +6,8 @@
|
|||||||
// HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `url` is required.
|
// HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `url` is required.
|
||||||
// HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `params` is variable, the order is:
|
// HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `params` is variable, the order is:
|
||||||
// params[0] is header which type should be http.Header or map[string]string,
|
// params[0] is header which type should be http.Header or map[string]string,
|
||||||
// params[1] is query param which type should be url.Values or map[string]interface{},
|
// params[1] is query string param which type should be url.Values or map[string]string, when content-type header is
|
||||||
|
// multipart/form-data or application/x-www-form-urlencoded
|
||||||
// params[2] is post body which type should be []byte.
|
// params[2] is post body which type should be []byte.
|
||||||
// params[3] is http client which type should be http.Client.
|
// params[3] is http client which type should be http.Client.
|
||||||
package netutil
|
package netutil
|
||||||
@@ -2,9 +2,9 @@ package netutil
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"log"
|
"log"
|
||||||
|
"net/url"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/duke-git/lancet/internal"
|
"github.com/duke-git/lancet/internal"
|
||||||
@@ -23,7 +23,7 @@ func TestHttpGet(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHttpPost(t *testing.T) {
|
func TestHttpPost(t *testing.T) {
|
||||||
@@ -44,7 +44,30 @@ func TestHttpPost(t *testing.T) {
|
|||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHttpPostFormData(t *testing.T) {
|
||||||
|
apiUrl := "https://jsonplaceholder.typicode.com/todos"
|
||||||
|
header := map[string]string{
|
||||||
|
// "Content-Type": "application/x-www-form-urlencoded",
|
||||||
|
"Content-Type": "multipart/form-data",
|
||||||
|
}
|
||||||
|
type Todo struct {
|
||||||
|
UserId int `json:"userId"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
postData := url.Values{}
|
||||||
|
postData.Add("userId", "1")
|
||||||
|
postData.Add("title", "TestAddToDo")
|
||||||
|
|
||||||
|
resp, err := HttpPost(apiUrl, header, postData, nil)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHttpPut(t *testing.T) {
|
func TestHttpPut(t *testing.T) {
|
||||||
@@ -66,7 +89,7 @@ func TestHttpPut(t *testing.T) {
|
|||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHttpPatch(t *testing.T) {
|
func TestHttpPatch(t *testing.T) {
|
||||||
@@ -88,7 +111,7 @@ func TestHttpPatch(t *testing.T) {
|
|||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHttpDelete(t *testing.T) {
|
func TestHttpDelete(t *testing.T) {
|
||||||
@@ -99,22 +122,18 @@ func TestHttpDelete(t *testing.T) {
|
|||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
body, _ := ioutil.ReadAll(resp.Body)
|
body, _ := ioutil.ReadAll(resp.Body)
|
||||||
fmt.Println("response: ", resp.StatusCode, string(body))
|
t.Log("response: ", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConvertMapToQueryString(t *testing.T) {
|
func TestConvertMapToQueryString(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestConvertMapToQueryString")
|
||||||
|
|
||||||
var m = map[string]interface{}{
|
var m = map[string]interface{}{
|
||||||
"c": 3,
|
"c": 3,
|
||||||
"a": 1,
|
"a": 1,
|
||||||
"b": 2,
|
"b": 2,
|
||||||
}
|
}
|
||||||
|
assert.Equal("a=1&b=2&c=3", ConvertMapToQueryString(m))
|
||||||
expected := "a=1&b=2&c=3"
|
|
||||||
r := ConvertMapToQueryString(m)
|
|
||||||
if r != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "ConvertMapToQueryString", m, expected, r)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestParseResponse(t *testing.T) {
|
func TestParseResponse(t *testing.T) {
|
||||||
@@ -142,5 +161,5 @@ func TestParseResponse(t *testing.T) {
|
|||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
t.FailNow()
|
t.FailNow()
|
||||||
}
|
}
|
||||||
fmt.Println("response: ", toDoResp)
|
t.Log("response: ", toDoResp)
|
||||||
}
|
}
|
||||||
@@ -5,6 +5,8 @@ import (
|
|||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
// GetInternalIp return internal ipv4
|
// GetInternalIp return internal ipv4
|
||||||
@@ -47,6 +49,66 @@ func GetPublicIpInfo() (*PublicIpInfo, error) {
|
|||||||
return &ip, nil
|
return &ip, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetRequestPublicIp return the requested public ip
|
||||||
|
func GetRequestPublicIp(req *http.Request) string {
|
||||||
|
var ip string
|
||||||
|
for _, ip = range strings.Split(req.Header.Get("X-Forwarded-For"), ",") {
|
||||||
|
if ip = strings.TrimSpace(ip); ip != "" && !IsInternalIP(net.ParseIP(ip)) {
|
||||||
|
return ip
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ip = strings.TrimSpace(req.Header.Get("X-Real-Ip")); ip != "" && !IsInternalIP(net.ParseIP(ip)) {
|
||||||
|
return ip
|
||||||
|
}
|
||||||
|
|
||||||
|
if ip, _, _ = net.SplitHostPort(req.RemoteAddr); !IsInternalIP(net.ParseIP(ip)) {
|
||||||
|
return ip
|
||||||
|
}
|
||||||
|
|
||||||
|
return ip
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetIps return all ipv4 of system
|
||||||
|
func GetIps() []string {
|
||||||
|
var ips []string
|
||||||
|
|
||||||
|
addrs, err := net.InterfaceAddrs()
|
||||||
|
if err != nil {
|
||||||
|
return ips
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, addr := range addrs {
|
||||||
|
ipNet, isValid := addr.(*net.IPNet)
|
||||||
|
if isValid && !ipNet.IP.IsLoopback() {
|
||||||
|
if ipNet.IP.To4() != nil {
|
||||||
|
ips = append(ips, ipNet.IP.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ips
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMacAddrs get mac address
|
||||||
|
func GetMacAddrs() []string {
|
||||||
|
var macAddrs []string
|
||||||
|
|
||||||
|
nets, err := net.Interfaces()
|
||||||
|
if err != nil {
|
||||||
|
return macAddrs
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, net := range nets {
|
||||||
|
macAddr := net.HardwareAddr.String()
|
||||||
|
if len(macAddr) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
macAddrs = append(macAddrs, macAddr)
|
||||||
|
}
|
||||||
|
|
||||||
|
return macAddrs
|
||||||
|
}
|
||||||
|
|
||||||
// PublicIpInfo public ip info: country, region, isp, city, lat, lon, ip
|
// PublicIpInfo public ip info: country, region, isp, city, lat, lon, ip
|
||||||
type PublicIpInfo struct {
|
type PublicIpInfo struct {
|
||||||
Status string `json:"status"`
|
Status string `json:"status"`
|
||||||
@@ -82,3 +144,29 @@ func IsPublicIP(IP net.IP) bool {
|
|||||||
}
|
}
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IsInternalIP verify an ip is intranet or not
|
||||||
|
func IsInternalIP(IP net.IP) bool {
|
||||||
|
if IP.IsLoopback() {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if ip4 := IP.To4(); ip4 != nil {
|
||||||
|
return ip4[0] == 10 ||
|
||||||
|
(ip4[0] == 172 && ip4[1] >= 16 && ip4[1] <= 31) ||
|
||||||
|
(ip4[0] == 169 && ip4[1] == 254) ||
|
||||||
|
(ip4[0] == 192 && ip4[1] == 168)
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeUrl encode url
|
||||||
|
func EncodeUrl(urlStr string) (string, error) {
|
||||||
|
URL, err := url.Parse(urlStr)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
URL.RawQuery = URL.Query().Encode()
|
||||||
|
|
||||||
|
return URL.String(), nil
|
||||||
|
}
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ func doHttpRequest(method, reqUrl string, params ...interface{}) (*http.Response
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
case 3:
|
case 3:
|
||||||
|
|
||||||
err := setHeaderAndQueryAndBody(req, reqUrl, params[0], params[1], params[2])
|
err := setHeaderAndQueryAndBody(req, reqUrl, params[0], params[1], params[2])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -81,7 +82,21 @@ func setHeaderAndQueryAndBody(req *http.Request, reqUrl string, header, queryPar
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
err = setBodyByte(req, body)
|
if strings.Contains(req.Header.Get("Content-Type"), "multipart/form-data") || req.Header.Get("Content-Type") == "application/x-www-form-urlencoded" {
|
||||||
|
if formData, ok := queryParam.(url.Values); ok {
|
||||||
|
err = setBodyByte(req, []byte(formData.Encode()))
|
||||||
|
}
|
||||||
|
if formData, ok := queryParam.(map[string]string); ok {
|
||||||
|
postData := url.Values{}
|
||||||
|
for k, v := range formData {
|
||||||
|
postData.Set(k, v)
|
||||||
|
}
|
||||||
|
err = setBodyByte(req, []byte(postData.Encode()))
|
||||||
|
}
|
||||||
|
|
||||||
|
} else {
|
||||||
|
err = setBodyByte(req, body)
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -157,16 +172,13 @@ func setQueryParam(req *http.Request, reqUrl string, queryParam interface{}) err
|
|||||||
|
|
||||||
func setBodyByte(req *http.Request, body interface{}) error {
|
func setBodyByte(req *http.Request, body interface{}) error {
|
||||||
if body != nil {
|
if body != nil {
|
||||||
var bodyByte []byte
|
switch b := body.(type) {
|
||||||
if body != nil {
|
case []byte:
|
||||||
switch v := body.(type) {
|
req.Body = ioutil.NopCloser(bytes.NewReader(b))
|
||||||
case []byte:
|
req.ContentLength = int64(len(b))
|
||||||
bodyByte = v
|
default:
|
||||||
default:
|
return errors.New("body type should be []byte")
|
||||||
return errors.New("body type should be []byte")
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
req.Body = ioutil.NopCloser(bytes.NewReader(bodyByte))
|
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
package netutil
|
package netutil
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"net"
|
"net"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -9,23 +8,25 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestGetInternalIp(t *testing.T) {
|
func TestGetInternalIp(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestGetInternalIp")
|
||||||
|
|
||||||
internalIp := GetInternalIp()
|
internalIp := GetInternalIp()
|
||||||
ip := net.ParseIP(internalIp)
|
ip := net.ParseIP(internalIp)
|
||||||
if ip == nil {
|
assert.IsNotNil(ip)
|
||||||
internal.LogFailedTestInfo(t, "GetInternalIp", "GetInternalIp", "", ip)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetPublicIpInfo(t *testing.T) {
|
func TestGetPublicIpInfo(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestGetPublicIpInfo")
|
||||||
|
|
||||||
publicIpInfo, err := GetPublicIpInfo()
|
publicIpInfo, err := GetPublicIpInfo()
|
||||||
if err != nil {
|
assert.IsNil(err)
|
||||||
t.FailNow()
|
|
||||||
}
|
t.Logf("public ip info is: %+v \n", *publicIpInfo)
|
||||||
fmt.Printf("public ip info is: %+v \n", *publicIpInfo)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsPublicIP(t *testing.T) {
|
func TestIsPublicIP(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsPublicIP")
|
||||||
|
|
||||||
ips := []net.IP{
|
ips := []net.IP{
|
||||||
net.ParseIP("127.0.0.1"),
|
net.ParseIP("127.0.0.1"),
|
||||||
net.ParseIP("192.168.0.1"),
|
net.ParseIP("192.168.0.1"),
|
||||||
@@ -37,11 +38,17 @@ func TestIsPublicIP(t *testing.T) {
|
|||||||
expected := []bool{false, false, false, false, true}
|
expected := []bool{false, false, false, false, true}
|
||||||
|
|
||||||
for i := 0; i < len(ips); i++ {
|
for i := 0; i < len(ips); i++ {
|
||||||
res := IsPublicIP(ips[i])
|
actual := IsPublicIP(ips[i])
|
||||||
|
assert.Equal(expected[i], actual)
|
||||||
if res != expected[i] {
|
|
||||||
internal.LogFailedTestInfo(t, "IsPublicIP", ips[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGetIps(t *testing.T) {
|
||||||
|
ips := GetIps()
|
||||||
|
t.Log(ips)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetMacAddrs(t *testing.T) {
|
||||||
|
macAddrs := GetMacAddrs()
|
||||||
|
t.Log(macAddrs)
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ package random
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
crand "crypto/rand"
|
crand "crypto/rand"
|
||||||
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"math/rand"
|
"math/rand"
|
||||||
"time"
|
"time"
|
||||||
@@ -39,7 +40,7 @@ func RandInt(min, max int) int {
|
|||||||
// RandBytes generate random byte slice
|
// RandBytes generate random byte slice
|
||||||
func RandBytes(length int) []byte {
|
func RandBytes(length int) []byte {
|
||||||
if length < 1 {
|
if length < 1 {
|
||||||
return nil
|
return []byte{}
|
||||||
}
|
}
|
||||||
b := make([]byte, length)
|
b := make([]byte, length)
|
||||||
|
|
||||||
@@ -48,3 +49,18 @@ func RandBytes(length int) []byte {
|
|||||||
}
|
}
|
||||||
return b
|
return b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UUIdV4 generate a random UUID of version 4 according to RFC 4122
|
||||||
|
func UUIdV4() (string, error) {
|
||||||
|
uuid := make([]byte, 16)
|
||||||
|
|
||||||
|
n, err := io.ReadFull(crand.Reader, uuid)
|
||||||
|
if n != len(uuid) || err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
uuid[8] = uuid[8]&^0xc0 | 0x80
|
||||||
|
uuid[6] = uuid[6]&^0xf0 | 0x40
|
||||||
|
|
||||||
|
return fmt.Sprintf("%x-%x-%x-%x-%x", uuid[0:4], uuid[4:6], uuid[6:8], uuid[8:10], uuid[10:]), nil
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,15 +1,6 @@
|
|||||||
/*
|
|
||||||
* @Descripttion:
|
|
||||||
* @version: v1.0.0
|
|
||||||
* @Author: dudaodong@kingsoft.com
|
|
||||||
* @Date: 2021-11-29 11:43:28
|
|
||||||
* @LastEditors: dudaodong@kingsoft.com
|
|
||||||
* @LastEditTime: 2021-12-01 18:05:29
|
|
||||||
*/
|
|
||||||
package random
|
package random
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"reflect"
|
"reflect"
|
||||||
"regexp"
|
"regexp"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -18,54 +9,54 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestRandString(t *testing.T) {
|
func TestRandString(t *testing.T) {
|
||||||
randStr := RandString(6)
|
|
||||||
fmt.Println(randStr)
|
|
||||||
pattern := `^[a-zA-Z]+$`
|
pattern := `^[a-zA-Z]+$`
|
||||||
reg := regexp.MustCompile(pattern)
|
reg := regexp.MustCompile(pattern)
|
||||||
|
|
||||||
if len(randStr) != 6 || !reg.MatchString(randStr) {
|
randStr := RandString(6)
|
||||||
internal.LogFailedTestInfo(t, "RandString", "RandString(6)", "RandString(6) should be 6 letters ", randStr)
|
|
||||||
t.FailNow()
|
assert := internal.NewAssert(t, "TestRandString")
|
||||||
}
|
assert.Equal(6, len(randStr))
|
||||||
|
assert.Equal(true, reg.MatchString(randStr))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRandInt(t *testing.T) {
|
func TestRandInt(t *testing.T) {
|
||||||
res1 := RandInt(1, 10)
|
assert := internal.NewAssert(t, "TestRandInt")
|
||||||
if res1 < 1 || res1 >= 10 {
|
|
||||||
internal.LogFailedTestInfo(t, "RandInt", "RandInt(1, 10)", "RandInt(1, 10) should between [1, 10) ", res1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
res2 := RandInt(1, 1)
|
r1 := RandInt(1, 10)
|
||||||
if res2 != 1 {
|
assert.GreaterOrEqual(r1, 1)
|
||||||
internal.LogFailedTestInfo(t, "RandInt", "RandInt(1, 1)", "RandInt(1, 1) should be 1 ", res2)
|
assert.Less(r1, 10)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
res3 := RandInt(10, 1)
|
r2 := RandInt(1, 1)
|
||||||
if res3 < 1 || res3 >= 10 {
|
assert.Equal(1, r2)
|
||||||
internal.LogFailedTestInfo(t, "RandInt", "RandInt(10, 1)", "RandInt(10, 1) should between [1, 10) ", res3)
|
|
||||||
t.FailNow()
|
r3 := RandInt(10, 1)
|
||||||
}
|
assert.GreaterOrEqual(r1, 1)
|
||||||
|
assert.Less(r3, 10)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRandBytes(t *testing.T) {
|
func TestRandBytes(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRandBytes")
|
||||||
|
|
||||||
randBytes := RandBytes(4)
|
randBytes := RandBytes(4)
|
||||||
if len(randBytes) != 4 {
|
assert.Equal(4, len(randBytes))
|
||||||
internal.LogFailedTestInfo(t, "RandBytes", "RandBytes(4)", "RandBytes(4) should return 4 element of []bytes", randBytes)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
v := reflect.ValueOf(randBytes)
|
v := reflect.ValueOf(randBytes)
|
||||||
et := v.Type().Elem()
|
elemType := v.Type().Elem()
|
||||||
if v.Kind() != reflect.Slice || et.Kind() != reflect.Uint8 {
|
assert.Equal(reflect.Slice, v.Kind())
|
||||||
internal.LogFailedTestInfo(t, "RandBytes", "RandBytes(4)", "RandBytes(4) should return 4 element of []bytes", randBytes)
|
assert.Equal(reflect.Uint8, elemType.Kind())
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
randErr := RandBytes(0)
|
|
||||||
if randErr != nil {
|
|
||||||
internal.LogFailedTestInfo(t, "RandBytes", "RandBytes(0)", "RandBytes(0) should return nil", randErr)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
|
assert.Equal([]byte{}, RandBytes(0))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUUIdV4(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestUUIdV4")
|
||||||
|
|
||||||
|
uuid, err := UUIdV4()
|
||||||
|
if err != nil {
|
||||||
|
t.Log(err)
|
||||||
|
t.Fail()
|
||||||
|
}
|
||||||
|
|
||||||
|
isUUiDV4 := regexp.MustCompile(`^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`)
|
||||||
|
assert.Equal(true, isUUiDV4.MatchString(uuid))
|
||||||
}
|
}
|
||||||
|
|||||||
91
retry/retry.go
Normal file
91
retry/retry.go
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
||||||
|
// Use of this source code is governed by MIT license
|
||||||
|
|
||||||
|
// Package retry is for executing a function repeatedly until it was successful or canceled by the context.
|
||||||
|
package retry
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// DefaultRetryTimes times of retry
|
||||||
|
DefaultRetryTimes = 5
|
||||||
|
// DefaultRetryDuration time duration of two retries
|
||||||
|
DefaultRetryDuration = time.Second * 3
|
||||||
|
)
|
||||||
|
|
||||||
|
// RetryConfig is config for retry
|
||||||
|
type RetryConfig struct {
|
||||||
|
context context.Context
|
||||||
|
retryTimes uint
|
||||||
|
retryDuration time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetryFunc is function that retry executes
|
||||||
|
type RetryFunc func() error
|
||||||
|
|
||||||
|
// Option is for adding retry config
|
||||||
|
type Option func(*RetryConfig)
|
||||||
|
|
||||||
|
// RetryTimes set times of retry
|
||||||
|
func RetryTimes(n uint) Option {
|
||||||
|
return func(rc *RetryConfig) {
|
||||||
|
rc.retryTimes = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetryDuration set duration of retries
|
||||||
|
func RetryDuration(d time.Duration) Option {
|
||||||
|
return func(rc *RetryConfig) {
|
||||||
|
rc.retryDuration = d
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Context set retry context config
|
||||||
|
func Context(ctx context.Context) Option {
|
||||||
|
return func(rc *RetryConfig) {
|
||||||
|
rc.context = ctx
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Retry executes the retryFunc repeatedly until it was successful or canceled by the context
|
||||||
|
// The default times of retries is 5 and the default duration between retries is 3 seconds
|
||||||
|
func Retry(retryFunc RetryFunc, opts ...Option) error {
|
||||||
|
config := &RetryConfig{
|
||||||
|
retryTimes: DefaultRetryTimes,
|
||||||
|
retryDuration: DefaultRetryDuration,
|
||||||
|
context: context.TODO(),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(config)
|
||||||
|
}
|
||||||
|
|
||||||
|
var i uint
|
||||||
|
for i < config.retryTimes {
|
||||||
|
err := retryFunc()
|
||||||
|
if err != nil {
|
||||||
|
select {
|
||||||
|
case <-time.After(config.retryDuration):
|
||||||
|
case <-config.context.Done():
|
||||||
|
return errors.New("retry is cancelled")
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
|
||||||
|
funcPath := runtime.FuncForPC(reflect.ValueOf(retryFunc).Pointer()).Name()
|
||||||
|
lastSlash := strings.LastIndex(funcPath, "/")
|
||||||
|
funcName := funcPath[lastSlash+1:]
|
||||||
|
|
||||||
|
return fmt.Errorf("function %s run failed after %d times retry", funcName, i)
|
||||||
|
}
|
||||||
80
retry/retry_test.go
Normal file
80
retry/retry_test.go
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
package retry
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRetryFailed(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRetryFailed")
|
||||||
|
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := Retry(increaseNumber, RetryDuration(time.Microsecond*50))
|
||||||
|
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
assert.Equal(DefaultRetryTimes, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetrySucceeded(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestRetrySucceeded")
|
||||||
|
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number == DefaultRetryTimes {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := Retry(increaseNumber, RetryDuration(time.Microsecond*50))
|
||||||
|
|
||||||
|
assert.IsNil(err)
|
||||||
|
assert.Equal(DefaultRetryTimes, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetRetryTimes(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestSetRetryTimes")
|
||||||
|
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := Retry(increaseNumber, RetryDuration(time.Microsecond*50), RetryTimes(3))
|
||||||
|
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
assert.Equal(3, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCancelRetry(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestCancelRetry")
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.TODO())
|
||||||
|
var number int
|
||||||
|
increaseNumber := func() error {
|
||||||
|
number++
|
||||||
|
if number > 3 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
return errors.New("error occurs")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := Retry(increaseNumber,
|
||||||
|
RetryDuration(time.Microsecond*50),
|
||||||
|
Context(ctx),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
assert.Equal(4, number)
|
||||||
|
}
|
||||||
463
slice/slice.go
463
slice/slice.go
@@ -12,12 +12,10 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"unsafe"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Contain check if the value is in the iterable type or not
|
// Contain check if the value is in the iterable type or not
|
||||||
func Contain(iterableType interface{}, value interface{}) bool {
|
func Contain(iterableType interface{}, value interface{}) bool {
|
||||||
|
|
||||||
v := reflect.ValueOf(iterableType)
|
v := reflect.ValueOf(iterableType)
|
||||||
|
|
||||||
switch kind := reflect.TypeOf(iterableType).Kind(); kind {
|
switch kind := reflect.TypeOf(iterableType).Kind(); kind {
|
||||||
@@ -47,6 +45,30 @@ func Contain(iterableType interface{}, value interface{}) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ContainSubSlice check if the slice contain subslice or not
|
||||||
|
func ContainSubSlice(slice interface{}, subslice interface{}) bool {
|
||||||
|
super := sliceValue(slice)
|
||||||
|
sub := sliceValue(subslice)
|
||||||
|
|
||||||
|
if super.Type().Elem().Kind() != sub.Type().Elem().Kind() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
unique := make(map[interface{}]bool)
|
||||||
|
for i := 0; i < super.Len(); i++ {
|
||||||
|
v := super.Index(i).Interface()
|
||||||
|
unique[v] = true
|
||||||
|
}
|
||||||
|
for i := 0; i < sub.Len(); i++ {
|
||||||
|
v := sub.Index(i).Interface()
|
||||||
|
if !unique[v] {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// Chunk creates an slice of elements split into groups the length of `size`.
|
// Chunk creates an slice of elements split into groups the length of `size`.
|
||||||
func Chunk(slice []interface{}, size int) [][]interface{} {
|
func Chunk(slice []interface{}, size int) [][]interface{} {
|
||||||
var res [][]interface{}
|
var res [][]interface{}
|
||||||
@@ -80,34 +102,158 @@ func Chunk(slice []interface{}, size int) [][]interface{} {
|
|||||||
return res
|
return res
|
||||||
}
|
}
|
||||||
|
|
||||||
// Difference creates an slice of whose element not included in the other given slice
|
// Compact creates an slice with all falsey values removed. The values false, nil, 0, and "" are falsey
|
||||||
func Difference(slice1, slice2 interface{}) interface{} {
|
func Compact(slice interface{}) interface{} {
|
||||||
v := sliceValue(slice1)
|
sv := sliceValue(slice)
|
||||||
|
|
||||||
var indexes []int
|
var indexes []int
|
||||||
for i := 0; i < v.Len(); i++ {
|
for i := 0; i < sv.Len(); i++ {
|
||||||
vi := v.Index(i).Interface()
|
item := sv.Index(i).Interface()
|
||||||
if !Contain(slice2, vi) {
|
if item != nil && item != false && item != "" && item != 0 {
|
||||||
|
indexes = append(indexes, i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
res := reflect.MakeSlice(sv.Type(), len(indexes), len(indexes))
|
||||||
|
for i := range indexes {
|
||||||
|
res.Index(i).Set(sv.Index(indexes[i]))
|
||||||
|
}
|
||||||
|
|
||||||
|
return res.Interface()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Concat creates a new slice concatenating slice with any additional slices and/or values.
|
||||||
|
func Concat(slice interface{}, values ...interface{}) interface{} {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
size := sv.Len()
|
||||||
|
|
||||||
|
res := reflect.MakeSlice(sv.Type(), size, size)
|
||||||
|
for i := 0; i < size; i++ {
|
||||||
|
res.Index(i).Set(sv.Index(i))
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, v := range values {
|
||||||
|
if reflect.TypeOf(v).Kind() == reflect.Slice {
|
||||||
|
vv := reflect.ValueOf(v)
|
||||||
|
for i := 0; i < vv.Len(); i++ {
|
||||||
|
res = reflect.Append(res, vv.Index(i))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
res = reflect.Append(res, reflect.ValueOf(v))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res.Interface()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Difference creates an slice of whose element in slice1, not in slice2
|
||||||
|
func Difference(slice1, slice2 interface{}) interface{} {
|
||||||
|
sv := sliceValue(slice1)
|
||||||
|
|
||||||
|
var indexes []int
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
item := sv.Index(i).Interface()
|
||||||
|
if !Contain(slice2, item) {
|
||||||
indexes = append(indexes, i)
|
indexes = append(indexes, i)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
res := reflect.MakeSlice(v.Type(), len(indexes), len(indexes))
|
res := reflect.MakeSlice(sv.Type(), len(indexes), len(indexes))
|
||||||
for i := range indexes {
|
for i := range indexes {
|
||||||
res.Index(i).Set(v.Index(indexes[i]))
|
res.Index(i).Set(sv.Index(indexes[i]))
|
||||||
}
|
}
|
||||||
return res.Interface()
|
return res.Interface()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DifferenceBy it accepts iteratee which is invoked for each element of slice
|
||||||
|
// and values to generate the criterion by which they're compared.
|
||||||
|
// like lodash.js differenceBy: https://lodash.com/docs/4.17.15#differenceBy,
|
||||||
|
// the iteratee function signature should be func(index int, value interface{}) interface{}.
|
||||||
|
func DifferenceBy(slice interface{}, comparedSlice interface{}, iteratee interface{}) interface{} {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
smv := sliceValue(comparedSlice)
|
||||||
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
|
elemType := sv.Type().Elem()
|
||||||
|
if checkSliceCallbackFuncSignature(fn, elemType, nil) {
|
||||||
|
panic("iteratee function signature should be func(" + elemType.String() + ")" + elemType.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
slice1 := reflect.MakeSlice(sv.Type(), sv.Len(), sv.Len())
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
slice1.Index(i).Set(fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
slice2 := reflect.MakeSlice(smv.Type(), smv.Len(), smv.Len())
|
||||||
|
for i := 0; i < smv.Len(); i++ {
|
||||||
|
slice2.Index(i).Set(fn.Call([]reflect.Value{reflect.ValueOf(i), smv.Index(i)})[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
sliceAfterMap := slice1.Interface()
|
||||||
|
comparedSliceAfterMap := slice2.Interface()
|
||||||
|
|
||||||
|
res := reflect.MakeSlice(sv.Type(), 0, 0)
|
||||||
|
sm := sliceValue(sliceAfterMap)
|
||||||
|
for i := 0; i < sm.Len(); i++ {
|
||||||
|
item := sm.Index(i).Interface()
|
||||||
|
if !Contain(comparedSliceAfterMap, item) {
|
||||||
|
res = reflect.Append(res, sv.Index(i))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res.Interface()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equal checks if two slices are equal: the same length and all elements' order and value are equal
|
||||||
|
func Equal(slice1, slice2 interface{}) bool {
|
||||||
|
sv1 := sliceValue(slice1)
|
||||||
|
sv2 := sliceValue(slice2)
|
||||||
|
|
||||||
|
if sv1.Type().Elem() != sv2.Type().Elem() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if sv1.Len() != sv2.Len() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < sv1.Len(); i++ {
|
||||||
|
if sv1.Index(i).Interface() != sv2.Index(i).Interface() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// EqualWith checks if two slices are equal with comparator func
|
||||||
|
func EqualWith(slice1, slice2 interface{}, comparator interface{}) bool {
|
||||||
|
sv1 := sliceValue(slice1)
|
||||||
|
sv2 := sliceValue(slice2)
|
||||||
|
|
||||||
|
fn := functionValue(comparator)
|
||||||
|
// elemType1 := sv1.Type().Elem()
|
||||||
|
// elemType2 := sv2.Type().Elem()
|
||||||
|
// todo: check fn signature: func(a elemType1.Kind(), b elemType2.Kind()) bool
|
||||||
|
|
||||||
|
for i := 0; i < sv1.Len(); i++ {
|
||||||
|
flag := fn.Call([]reflect.Value{sv1.Index(i), sv2.Index(i)})[0]
|
||||||
|
if !flag.Bool() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// Every return true if all of the values in the slice pass the predicate function.
|
// Every return true if all of the values in the slice pass the predicate function.
|
||||||
// The function signature should be func(index int, value interface{}) bool .
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
func Every(slice, function interface{}) bool {
|
func Every(slice, function interface{}) bool {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(function)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
}
|
}
|
||||||
|
|
||||||
var currentLength int
|
var currentLength int
|
||||||
@@ -121,15 +267,37 @@ func Every(slice, function interface{}) bool {
|
|||||||
return currentLength == sv.Len()
|
return currentLength == sv.Len()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Some return true if any of the values in the list pass the predicate function.
|
// None return true if all the values in the slice mismatch the criteria
|
||||||
// The function signature should be func(index int, value interface{}) bool .
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
func Some(slice, function interface{}) bool {
|
func None(slice, iteratee interface{}) bool {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
|
}
|
||||||
|
|
||||||
|
var currentLength int
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
flag := fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0]
|
||||||
|
if !flag.Bool() {
|
||||||
|
currentLength++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return currentLength == sv.Len()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Some return true if any of the values in the list pass the predicate function.
|
||||||
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
|
func Some(slice, iteratee interface{}) bool {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
|
elemType := sv.Type().Elem()
|
||||||
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
}
|
}
|
||||||
|
|
||||||
has := false
|
has := false
|
||||||
@@ -144,40 +312,58 @@ func Some(slice, function interface{}) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Filter iterates over elements of slice, returning an slice of all elements `signature` returns truthy for.
|
// Filter iterates over elements of slice, returning an slice of all elements `signature` returns truthy for.
|
||||||
// The function signature should be func(index int, value interface{}) bool .
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
func Filter(slice, function interface{}) interface{} {
|
func Filter(slice, iteratee interface{}) interface{} {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
}
|
}
|
||||||
|
|
||||||
var indexes []int
|
res := reflect.MakeSlice(sv.Type(), 0, 0)
|
||||||
for i := 0; i < sv.Len(); i++ {
|
for i := 0; i < sv.Len(); i++ {
|
||||||
flag := fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0]
|
flag := fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0]
|
||||||
if flag.Bool() {
|
if flag.Bool() {
|
||||||
indexes = append(indexes, i)
|
res = reflect.Append(res, sv.Index(i))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
res := reflect.MakeSlice(sv.Type(), len(indexes), len(indexes))
|
|
||||||
for i := range indexes {
|
|
||||||
res.Index(i).Set(sv.Index(indexes[i]))
|
|
||||||
}
|
|
||||||
return res.Interface()
|
return res.Interface()
|
||||||
}
|
}
|
||||||
|
|
||||||
// GroupBy iterate over elements of the slice, each element will be group by criteria, returns two slices
|
// Count iterates over elements of slice, returns a count of all matched elements
|
||||||
// The function signature should be func(index int, value interface{}) bool .
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
func GroupBy(slice, function interface{}) (interface{}, interface{}) {
|
func Count(slice, iteratee interface{}) int {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
|
}
|
||||||
|
|
||||||
|
var counter int
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
flag := fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0]
|
||||||
|
if flag.Bool() {
|
||||||
|
counter++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return counter
|
||||||
|
}
|
||||||
|
|
||||||
|
// GroupBy iterate over elements of the slice, each element will be group by criteria, returns two slices
|
||||||
|
// The iteratee function signature should be func(index int, value interface{}) bool .
|
||||||
|
func GroupBy(slice, iteratee interface{}) (interface{}, interface{}) {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
|
elemType := sv.Type().Elem()
|
||||||
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
}
|
}
|
||||||
|
|
||||||
groupB := reflect.MakeSlice(sv.Type(), 0, 0)
|
groupB := reflect.MakeSlice(sv.Type(), 0, 0)
|
||||||
@@ -196,14 +382,14 @@ func GroupBy(slice, function interface{}) (interface{}, interface{}) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Find iterates over elements of slice, returning the first one that passes a truth test on function.
|
// Find iterates over elements of slice, returning the first one that passes a truth test on function.
|
||||||
// The function signature should be func(index int, value interface{}) bool .
|
// The predicate function signature should be func(index int, value interface{}) bool .
|
||||||
func Find(slice, function interface{}) (interface{}, bool) {
|
func Find(slice, predicate interface{}) (interface{}, bool) {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(predicate)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
panic("predicate function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
}
|
}
|
||||||
|
|
||||||
index := -1
|
index := -1
|
||||||
@@ -223,6 +409,34 @@ func Find(slice, function interface{}) (interface{}, bool) {
|
|||||||
return sv.Index(index).Interface(), true
|
return sv.Index(index).Interface(), true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// FindLast iterates over elements of slice from end to begin, returning the first one that passes a truth test on function.
|
||||||
|
// The function signature should be func(index int, value interface{}) bool .
|
||||||
|
func FindLast(slice, predicate interface{}) (interface{}, bool) {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
fn := functionValue(predicate)
|
||||||
|
|
||||||
|
elemType := sv.Type().Elem()
|
||||||
|
if checkSliceCallbackFuncSignature(fn, elemType, reflect.ValueOf(true).Type()) {
|
||||||
|
panic("predicate function signature should be func(int, " + elemType.String() + ")" + reflect.ValueOf(true).Type().String())
|
||||||
|
}
|
||||||
|
|
||||||
|
index := -1
|
||||||
|
for i := sv.Len() - 1; i >= 0; i-- {
|
||||||
|
flag := fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})[0]
|
||||||
|
if flag.Bool() {
|
||||||
|
index = i
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if index == -1 {
|
||||||
|
var none interface{}
|
||||||
|
return none, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return sv.Index(index).Interface(), true
|
||||||
|
}
|
||||||
|
|
||||||
// FlattenDeep flattens slice recursive
|
// FlattenDeep flattens slice recursive
|
||||||
func FlattenDeep(slice interface{}) interface{} {
|
func FlattenDeep(slice interface{}) interface{} {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
@@ -247,15 +461,31 @@ func flattenRecursive(value reflect.Value, result reflect.Value) reflect.Value {
|
|||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
// Map creates an slice of values by running each element of `slice` thru `function`.
|
// ForEach iterates over elements of slice and invokes function for each element
|
||||||
// The function signature should be func(index int, value interface{}) interface{}.
|
// The iteratee function signature should be func(index int, value interface{}).
|
||||||
func Map(slice, function interface{}) interface{} {
|
func ForEach(slice, iteratee interface{}) {
|
||||||
sv := sliceValue(slice)
|
sv := sliceValue(slice)
|
||||||
fn := functionValue(function)
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
elemType := sv.Type().Elem()
|
elemType := sv.Type().Elem()
|
||||||
if checkSliceCallbackFuncSignature(fn, elemType, nil) {
|
if checkSliceCallbackFuncSignature(fn, elemType, nil) {
|
||||||
panic("function param should be of type func(int, " + elemType.String() + ")" + elemType.String())
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + elemType.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
fn.Call([]reflect.Value{reflect.ValueOf(i), sv.Index(i)})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map creates an slice of values by running each element of `slice` thru `function`.
|
||||||
|
// The iteratee function signature should be func(index int, value interface{}) interface{}.
|
||||||
|
func Map(slice, iteratee interface{}) interface{} {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
fn := functionValue(iteratee)
|
||||||
|
|
||||||
|
elemType := sv.Type().Elem()
|
||||||
|
if checkSliceCallbackFuncSignature(fn, elemType, nil) {
|
||||||
|
panic("iteratee function signature should be func(int, " + elemType.String() + ")" + elemType.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
res := reflect.MakeSlice(sv.Type(), sv.Len(), sv.Len())
|
res := reflect.MakeSlice(sv.Type(), sv.Len(), sv.Len())
|
||||||
@@ -348,26 +578,6 @@ func IntSlice(slice interface{}) []int {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConvertSlice convert original slice to new data type element of slice.
|
|
||||||
func ConvertSlice(originalSlice interface{}, newSliceType reflect.Type) interface{} {
|
|
||||||
sv := sliceValue(originalSlice)
|
|
||||||
if newSliceType.Kind() != reflect.Slice {
|
|
||||||
panic(fmt.Sprintf("Invalid newSliceType(non-slice type of type %T)", newSliceType))
|
|
||||||
}
|
|
||||||
|
|
||||||
newSlice := reflect.New(newSliceType)
|
|
||||||
|
|
||||||
hdr := (*reflect.SliceHeader)(unsafe.Pointer(newSlice.Pointer()))
|
|
||||||
|
|
||||||
var newElemSize = int(sv.Type().Elem().Size()) / int(newSliceType.Elem().Size())
|
|
||||||
|
|
||||||
hdr.Cap = sv.Cap() * newElemSize
|
|
||||||
hdr.Len = sv.Len() * newElemSize
|
|
||||||
hdr.Data = sv.Pointer()
|
|
||||||
|
|
||||||
return newSlice.Elem().Interface()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeleteByIndex delete the element of slice from start index to end index - 1.
|
// DeleteByIndex delete the element of slice from start index to end index - 1.
|
||||||
// Delete i: s = append(s[:i], s[i+1:]...)
|
// Delete i: s = append(s[:i], s[i+1:]...)
|
||||||
// Delete i to j: s = append(s[:i], s[j:]...)
|
// Delete i to j: s = append(s[:i], s[j:]...)
|
||||||
@@ -431,7 +641,6 @@ func InsertByIndex(slice interface{}, index int, value interface{}) (interface{}
|
|||||||
return slice, errors.New("InvalidSliceIndex")
|
return slice, errors.New("InvalidSliceIndex")
|
||||||
}
|
}
|
||||||
|
|
||||||
// value is slice
|
|
||||||
vv := reflect.ValueOf(value)
|
vv := reflect.ValueOf(value)
|
||||||
if vv.Kind() == reflect.Slice {
|
if vv.Kind() == reflect.Slice {
|
||||||
if reflect.TypeOf(slice).Elem() != reflect.TypeOf(value).Elem() {
|
if reflect.TypeOf(slice).Elem() != reflect.TypeOf(value).Elem() {
|
||||||
@@ -441,7 +650,6 @@ func InsertByIndex(slice interface{}, index int, value interface{}) (interface{}
|
|||||||
return v.Interface(), nil
|
return v.Interface(), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// value is not slice
|
|
||||||
if reflect.TypeOf(slice).Elem() != reflect.TypeOf(value) {
|
if reflect.TypeOf(slice).Elem() != reflect.TypeOf(value) {
|
||||||
return slice, errors.New("InvalidValueType")
|
return slice, errors.New("InvalidValueType")
|
||||||
}
|
}
|
||||||
@@ -499,21 +707,28 @@ func Unique(slice interface{}) interface{} {
|
|||||||
for i := 0; i < len(temp); i++ {
|
for i := 0; i < len(temp); i++ {
|
||||||
res.Index(i).Set(reflect.ValueOf(temp[i]))
|
res.Index(i).Set(reflect.ValueOf(temp[i]))
|
||||||
}
|
}
|
||||||
|
|
||||||
return res.Interface()
|
return res.Interface()
|
||||||
|
}
|
||||||
|
|
||||||
// if use map filter, the result slice element order is random, not same as origin slice
|
// UniqueBy call iteratee func with every item of slice, then remove duplicated.
|
||||||
//mp := make(map[interface{}]bool)
|
// The iteratee function signature should be func(value interface{}) interface{}.
|
||||||
//for i := 0; i < sv.Len(); i++ {
|
func UniqueBy(slice, iteratee interface{}) interface{} {
|
||||||
// v := sv.Index(i).Interface()
|
sv := sliceValue(slice)
|
||||||
// mp[v] = true
|
fn := functionValue(iteratee)
|
||||||
//}
|
|
||||||
//
|
|
||||||
//var res []interface{}
|
|
||||||
//for k := range mp {
|
|
||||||
// res = append(res, mp[k])
|
|
||||||
//}
|
|
||||||
//return res
|
|
||||||
|
|
||||||
|
if sv.Len() == 0 {
|
||||||
|
return slice
|
||||||
|
}
|
||||||
|
|
||||||
|
res := reflect.MakeSlice(sv.Type(), sv.Len(), sv.Len())
|
||||||
|
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
val := fn.Call([]reflect.Value{sv.Index(i)})[0]
|
||||||
|
res.Index(i).Set(val)
|
||||||
|
}
|
||||||
|
|
||||||
|
return Unique(res.Interface())
|
||||||
}
|
}
|
||||||
|
|
||||||
// Union creates a slice of unique values, in order, from all given slices. using == for equality comparisons.
|
// Union creates a slice of unique values, in order, from all given slices. using == for equality comparisons.
|
||||||
@@ -619,18 +834,38 @@ func SortByField(slice interface{}, field string, sortType ...string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Create a less function based on the field's kind.
|
// Create a less function based on the field's kind.
|
||||||
var less func(a, b reflect.Value) bool
|
var compare func(a, b reflect.Value) bool
|
||||||
switch sf.Type.Kind() {
|
switch sf.Type.Kind() {
|
||||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
less = func(a, b reflect.Value) bool { return a.Int() < b.Int() }
|
if len(sortType) > 0 && sortType[0] == "desc" {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Int() > b.Int() }
|
||||||
|
} else {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Int() < b.Int() }
|
||||||
|
}
|
||||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||||
less = func(a, b reflect.Value) bool { return a.Uint() < b.Uint() }
|
if len(sortType) > 0 && sortType[0] == "desc" {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Uint() > b.Uint() }
|
||||||
|
} else {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Uint() < b.Uint() }
|
||||||
|
}
|
||||||
case reflect.Float32, reflect.Float64:
|
case reflect.Float32, reflect.Float64:
|
||||||
less = func(a, b reflect.Value) bool { return a.Float() < b.Float() }
|
if len(sortType) > 0 && sortType[0] == "desc" {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Float() > b.Float() }
|
||||||
|
} else {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Float() < b.Float() }
|
||||||
|
}
|
||||||
case reflect.String:
|
case reflect.String:
|
||||||
less = func(a, b reflect.Value) bool { return a.String() < b.String() }
|
if len(sortType) > 0 && sortType[0] == "desc" {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.String() > b.String() }
|
||||||
|
} else {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.String() < b.String() }
|
||||||
|
}
|
||||||
case reflect.Bool:
|
case reflect.Bool:
|
||||||
less = func(a, b reflect.Value) bool { return !a.Bool() && b.Bool() }
|
if len(sortType) > 0 && sortType[0] == "desc" {
|
||||||
|
compare = func(a, b reflect.Value) bool { return a.Bool() && !b.Bool() }
|
||||||
|
} else {
|
||||||
|
compare = func(a, b reflect.Value) bool { return !a.Bool() && b.Bool() }
|
||||||
|
}
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("field type %s not supported", sf.Type)
|
return fmt.Errorf("field type %s not supported", sf.Type)
|
||||||
}
|
}
|
||||||
@@ -644,12 +879,9 @@ func SortByField(slice interface{}, field string, sortType ...string) error {
|
|||||||
}
|
}
|
||||||
a = a.FieldByIndex(sf.Index)
|
a = a.FieldByIndex(sf.Index)
|
||||||
b = b.FieldByIndex(sf.Index)
|
b = b.FieldByIndex(sf.Index)
|
||||||
return less(a, b)
|
return compare(a, b)
|
||||||
})
|
})
|
||||||
|
|
||||||
if sortType[0] == "desc" {
|
|
||||||
ReverseSlice(slice)
|
|
||||||
}
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -675,3 +907,64 @@ func Without(slice interface{}, values ...interface{}) interface{} {
|
|||||||
|
|
||||||
return res.Interface()
|
return res.Interface()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IndexOf returns the index at which the first occurrence of a value is found in a slice or return -1
|
||||||
|
// if the value cannot be found.
|
||||||
|
func IndexOf(slice, value interface{}) int {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
if reflect.DeepEqual(sv.Index(i).Interface(), value) {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
|
||||||
|
// LastIndexOf returns the index at which the last occurrence of a value is found in a slice or return -1
|
||||||
|
// if the value cannot be found.
|
||||||
|
func LastIndexOf(slice, value interface{}) int {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
|
||||||
|
for i := sv.Len() - 1; i > 0; i-- {
|
||||||
|
if reflect.DeepEqual(sv.Index(i).Interface(), value) {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToSlicePointer returns a pointer to the slices of a variable parameter transformation
|
||||||
|
func ToSlicePointer(value ...interface{}) []*interface{} {
|
||||||
|
out := make([]*interface{}, len(value))
|
||||||
|
for i := range value {
|
||||||
|
out[i] = &value[i]
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToSlice returns a slices of a variable parameter transformation
|
||||||
|
func ToSlice(value ...interface{}) interface{} {
|
||||||
|
rv := reflect.ValueOf(value)
|
||||||
|
out := reflect.MakeSlice(rv.Type(), len(value), len(value))
|
||||||
|
for i := range value {
|
||||||
|
out.Index(i).Set(reflect.ValueOf(value[i]))
|
||||||
|
}
|
||||||
|
return out.Interface()
|
||||||
|
}
|
||||||
|
|
||||||
|
// AppendIfAbsent only absent append the value
|
||||||
|
func AppendIfAbsent(slice interface{}, value interface{}) interface{} {
|
||||||
|
sv := sliceValue(slice)
|
||||||
|
out := reflect.MakeSlice(sv.Type(), sv.Len(), sv.Len())
|
||||||
|
for i := 0; i < sv.Len(); i++ {
|
||||||
|
out.Index(i).Set(sv.Index(i))
|
||||||
|
}
|
||||||
|
if !Contain(slice, value) {
|
||||||
|
out = reflect.Append(out, reflect.ValueOf(value))
|
||||||
|
}
|
||||||
|
return out.Interface()
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,92 +8,93 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestContain(t *testing.T) {
|
func TestContain(t *testing.T) {
|
||||||
t1 := []string{"a", "b", "c", "d"}
|
assert := internal.NewAssert(t, "TestContain")
|
||||||
contain(t, t1, "a", true)
|
|
||||||
contain(t, t1, "e", false)
|
|
||||||
|
|
||||||
var t2 []string
|
assert.Equal(true, Contain([]string{"a", "b", "c"}, "a"))
|
||||||
contain(t, t2, "1", false)
|
assert.Equal(false, Contain([]string{"a", "b", "c"}, "d"))
|
||||||
|
assert.Equal(true, Contain([]string{""}, ""))
|
||||||
|
assert.Equal(false, Contain([]string{}, ""))
|
||||||
|
|
||||||
m := make(map[string]int)
|
var m = map[string]int{"a": 1}
|
||||||
m["a"] = 1
|
assert.Equal(true, Contain(m, "a"))
|
||||||
contain(t, m, "a", true)
|
assert.Equal(false, Contain(m, "b"))
|
||||||
contain(t, m, "b", false)
|
|
||||||
|
|
||||||
s := "hello"
|
assert.Equal(true, Contain("abc", "a"))
|
||||||
contain(t, s, "h", true)
|
assert.Equal(false, Contain("abc", "d"))
|
||||||
contain(t, s, "s", false)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func contain(t *testing.T, test interface{}, value interface{}, expected bool) {
|
func TestContainSubSlice(t *testing.T) {
|
||||||
res := Contain(test, value)
|
assert := internal.NewAssert(t, "TestContainSubSlice")
|
||||||
if res != expected {
|
assert.Equal(true, ContainSubSlice([]string{"a", "a", "b", "c"}, []string{"a", "a"}))
|
||||||
internal.LogFailedTestInfo(t, "Contain", test, expected, res)
|
assert.Equal(false, ContainSubSlice([]string{"a", "a", "b", "c"}, []string{"a", "d"}))
|
||||||
t.FailNow()
|
|
||||||
}
|
assert.Equal(true, ContainSubSlice([]int{1, 2, 3}, []int{1}))
|
||||||
|
assert.Equal(false, ContainSubSlice([]int{1, 2, 3}, []string{"a"}))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestChunk(t *testing.T) {
|
func TestChunk(t *testing.T) {
|
||||||
t1 := []string{"a", "b", "c", "d", "e"}
|
assert := internal.NewAssert(t, "TestChunk")
|
||||||
|
|
||||||
r1 := [][]interface{}{
|
arr := []string{"a", "b", "c", "d", "e"}
|
||||||
{"a"},
|
r1 := [][]interface{}{{"a"}, {"b"}, {"c"}, {"d"}, {"e"}}
|
||||||
{"b"},
|
assert.Equal(r1, Chunk(InterfaceSlice(arr), 1))
|
||||||
{"c"},
|
|
||||||
{"d"},
|
|
||||||
{"e"},
|
|
||||||
}
|
|
||||||
chunk(t, InterfaceSlice(t1), 1, r1)
|
|
||||||
|
|
||||||
r2 := [][]interface{}{
|
r2 := [][]interface{}{{"a", "b"}, {"c", "d"}, {"e"}}
|
||||||
{"a", "b"},
|
assert.Equal(r2, Chunk(InterfaceSlice(arr), 2))
|
||||||
{"c", "d"},
|
|
||||||
{"e"},
|
|
||||||
}
|
|
||||||
chunk(t, InterfaceSlice(t1), 2, r2)
|
|
||||||
|
|
||||||
r3 := [][]interface{}{
|
r3 := [][]interface{}{{"a", "b", "c"}, {"d", "e"}}
|
||||||
{"a", "b", "c"},
|
assert.Equal(r3, Chunk(InterfaceSlice(arr), 3))
|
||||||
{"d", "e"},
|
|
||||||
}
|
|
||||||
chunk(t, InterfaceSlice(t1), 3, r3)
|
|
||||||
|
|
||||||
r4 := [][]interface{}{
|
r4 := [][]interface{}{{"a", "b", "c", "d"}, {"e"}}
|
||||||
{"a", "b", "c", "d"},
|
assert.Equal(r4, Chunk(InterfaceSlice(arr), 4))
|
||||||
{"e"},
|
|
||||||
}
|
|
||||||
chunk(t, InterfaceSlice(t1), 4, r4)
|
|
||||||
|
|
||||||
r5 := [][]interface{}{
|
|
||||||
{"a"},
|
|
||||||
{"b"},
|
|
||||||
{"c"},
|
|
||||||
{"d"},
|
|
||||||
{"e"},
|
|
||||||
}
|
|
||||||
chunk(t, InterfaceSlice(t1), 5, r5)
|
|
||||||
|
|
||||||
|
r5 := [][]interface{}{{"a"}, {"b"}, {"c"}, {"d"}, {"e"}}
|
||||||
|
assert.Equal(r5, Chunk(InterfaceSlice(arr), 5))
|
||||||
}
|
}
|
||||||
|
|
||||||
func chunk(t *testing.T, test []interface{}, num int, expected [][]interface{}) {
|
func TestCompact(t *testing.T) {
|
||||||
res := Chunk(test, num)
|
assert := internal.NewAssert(t, "TesCompact")
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "Chunk", test, expected, res)
|
assert.Equal([]int{}, Compact([]int{0}))
|
||||||
t.FailNow()
|
assert.Equal([]int{1, 2, 3}, Compact([]int{0, 1, 2, 3}))
|
||||||
}
|
assert.Equal([]string{}, Compact([]string{""}))
|
||||||
|
assert.Equal([]string{" "}, Compact([]string{" "}))
|
||||||
|
assert.Equal([]string{"a", "b", "0"}, Compact([]string{"", "a", "b", "0"}))
|
||||||
|
assert.Equal([]bool{true, true}, Compact([]bool{false, true, true}))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConvertSlice(t *testing.T) {
|
func TestConcat(t *testing.T) {
|
||||||
//t1 := []string{"1","2"}
|
assert := internal.NewAssert(t, "Concat")
|
||||||
//aInt, _ := strconv.ParseInt("1", 10, 64)
|
|
||||||
//bInt, _ := strconv.ParseInt("2", 10, 64)
|
assert.Equal([]int{0}, Concat([]int{}, 0))
|
||||||
//expected :=[]int64{aInt, bInt}
|
assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, 4, 5))
|
||||||
//
|
assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4, 5}))
|
||||||
//a := ConvertSlice(t1, reflect.TypeOf(expected))
|
assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4}, []int{5}))
|
||||||
//if !reflect.DeepEqual(a, expected) {
|
assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4}, 5))
|
||||||
// utils.LogFailedTestInfo(t, "ConvertSlice", t1, expected, a)
|
}
|
||||||
// t.FailNow()
|
|
||||||
//}
|
func TestEqual(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEqual")
|
||||||
|
|
||||||
|
slice1 := []int{1, 2, 3}
|
||||||
|
slice2 := []int{1, 2, 3}
|
||||||
|
slice3 := []int{3, 2, 1}
|
||||||
|
|
||||||
|
assert.Equal(true, Equal(slice1, slice2))
|
||||||
|
assert.Equal(false, Equal(slice1, slice3))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEqualWith(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestEqualWith")
|
||||||
|
|
||||||
|
slice1 := []int{1, 2, 3}
|
||||||
|
slice2 := []int{2, 4, 6}
|
||||||
|
|
||||||
|
isDouble := func(a, b int) bool {
|
||||||
|
return b == a*2
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(true, EqualWith(slice1, slice2, isDouble))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestEvery(t *testing.T) {
|
func TestEvery(t *testing.T) {
|
||||||
@@ -101,42 +102,44 @@ func TestEvery(t *testing.T) {
|
|||||||
isEven := func(i, num int) bool {
|
isEven := func(i, num int) bool {
|
||||||
return num%2 == 0
|
return num%2 == 0
|
||||||
}
|
}
|
||||||
res := Every(nums, isEven)
|
|
||||||
if res != false {
|
assert := internal.NewAssert(t, "TestEvery")
|
||||||
internal.LogFailedTestInfo(t, "Every", nums, false, res)
|
assert.Equal(false, Every(nums, isEven))
|
||||||
t.FailNow()
|
}
|
||||||
|
|
||||||
|
func TestNone(t *testing.T) {
|
||||||
|
nums := []int{1, 2, 3, 5}
|
||||||
|
check := func(i, num int) bool {
|
||||||
|
return num%2 == 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
assert := internal.NewAssert(t, "TestNone")
|
||||||
|
assert.Equal(false, None(nums, check))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSome(t *testing.T) {
|
func TestSome(t *testing.T) {
|
||||||
nums := []int{1, 2, 3, 5}
|
nums := []int{1, 2, 3, 5}
|
||||||
isEven := func(i, num int) bool {
|
hasEven := func(i, num int) bool {
|
||||||
return num%2 == 0
|
return num%2 == 0
|
||||||
}
|
}
|
||||||
res := Some(nums, isEven)
|
|
||||||
if res != true {
|
assert := internal.NewAssert(t, "TestSome")
|
||||||
internal.LogFailedTestInfo(t, "Some", nums, true, res)
|
assert.Equal(true, Some(nums, hasEven))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFilter(t *testing.T) {
|
func TestFilter(t *testing.T) {
|
||||||
nums := []int{1, 2, 3, 4, 5}
|
nums := []int{1, 2, 3, 4, 5}
|
||||||
even := func(i, num int) bool {
|
isEven := func(i, num int) bool {
|
||||||
return num%2 == 0
|
return num%2 == 0
|
||||||
}
|
}
|
||||||
e1 := []int{2, 4}
|
|
||||||
r1 := Filter(nums, even)
|
assert := internal.NewAssert(t, "TestFilter")
|
||||||
if !reflect.DeepEqual(r1, e1) {
|
assert.Equal([]int{2, 4}, Filter(nums, isEven))
|
||||||
internal.LogFailedTestInfo(t, "Filter", nums, e1, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
type student struct {
|
type student struct {
|
||||||
name string
|
name string
|
||||||
age int
|
age int
|
||||||
}
|
}
|
||||||
|
|
||||||
students := []student{
|
students := []student{
|
||||||
{"a", 10},
|
{"a", 10},
|
||||||
{"b", 11},
|
{"b", 11},
|
||||||
@@ -144,8 +147,7 @@ func TestFilter(t *testing.T) {
|
|||||||
{"d", 13},
|
{"d", 13},
|
||||||
{"e", 14},
|
{"e", 14},
|
||||||
}
|
}
|
||||||
|
studentsOfAageGreat12 := []student{
|
||||||
e2 := []student{
|
|
||||||
{"d", 13},
|
{"d", 13},
|
||||||
{"e", 14},
|
{"e", 14},
|
||||||
}
|
}
|
||||||
@@ -153,12 +155,7 @@ func TestFilter(t *testing.T) {
|
|||||||
return s.age > 12
|
return s.age > 12
|
||||||
}
|
}
|
||||||
|
|
||||||
r2 := Filter(students, filterFunc)
|
assert.Equal(studentsOfAageGreat12, Filter(students, filterFunc))
|
||||||
if !reflect.DeepEqual(r2, e2) {
|
|
||||||
internal.LogFailedTestInfo(t, "Filter", students, e2, r2)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGroupBy(t *testing.T) {
|
func TestGroupBy(t *testing.T) {
|
||||||
@@ -167,22 +164,22 @@ func TestGroupBy(t *testing.T) {
|
|||||||
return (num % 2) == 0
|
return (num % 2) == 0
|
||||||
}
|
}
|
||||||
expectedEven := []int{2, 4, 6}
|
expectedEven := []int{2, 4, 6}
|
||||||
|
expectedOdd := []int{1, 3, 5}
|
||||||
even, odd := GroupBy(nums, evenFunc)
|
even, odd := GroupBy(nums, evenFunc)
|
||||||
|
|
||||||
t.Log("odd", odd)
|
assert := internal.NewAssert(t, "TestGroupBy")
|
||||||
|
assert.Equal(expectedEven, even)
|
||||||
|
assert.Equal(expectedOdd, odd)
|
||||||
|
}
|
||||||
|
|
||||||
t.Log("even", even)
|
func TestCount(t *testing.T) {
|
||||||
|
nums := []int{1, 2, 3, 4, 5, 6}
|
||||||
if !reflect.DeepEqual(IntSlice(even), expectedEven) {
|
evenFunc := func(i, num int) bool {
|
||||||
internal.LogFailedTestInfo(t, "GroupBy even", nums, expectedEven, even)
|
return (num % 2) == 0
|
||||||
t.FailNow()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
expectedOdd := []int{1, 3, 5}
|
assert := internal.NewAssert(t, "TestCount")
|
||||||
if !reflect.DeepEqual(IntSlice(odd), expectedOdd) {
|
assert.Equal(3, Count(nums, evenFunc))
|
||||||
internal.LogFailedTestInfo(t, "GroupBy odd", nums, expectedOdd, odd)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFind(t *testing.T) {
|
func TestFind(t *testing.T) {
|
||||||
@@ -195,10 +192,22 @@ func TestFind(t *testing.T) {
|
|||||||
t.Fatal("found nothing")
|
t.Fatal("found nothing")
|
||||||
}
|
}
|
||||||
|
|
||||||
if res != 2 {
|
assert := internal.NewAssert(t, "TestFind")
|
||||||
internal.LogFailedTestInfo(t, "Find", nums, 2, res)
|
assert.Equal(2, res)
|
||||||
t.FailNow()
|
}
|
||||||
|
|
||||||
|
func TestFindLast(t *testing.T) {
|
||||||
|
nums := []int{1, 2, 3, 4, 5}
|
||||||
|
even := func(i, num int) bool {
|
||||||
|
return num%2 == 0
|
||||||
}
|
}
|
||||||
|
res, ok := FindLast(nums, even)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("found nothing")
|
||||||
|
}
|
||||||
|
|
||||||
|
assert := internal.NewAssert(t, "TestFindLast")
|
||||||
|
assert.Equal(4, res)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFindFoundNothing(t *testing.T) {
|
func TestFindFoundNothing(t *testing.T) {
|
||||||
@@ -207,33 +216,42 @@ func TestFindFoundNothing(t *testing.T) {
|
|||||||
return num > 1
|
return num > 1
|
||||||
}
|
}
|
||||||
_, ok := Find(nums, findFunc)
|
_, ok := Find(nums, findFunc)
|
||||||
if ok {
|
// if ok {
|
||||||
t.Fatal("found something")
|
// t.Fatal("found something")
|
||||||
}
|
// }
|
||||||
|
assert := internal.NewAssert(t, "TestFindFoundNothing")
|
||||||
|
assert.Equal(false, ok)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFlattenDeep(t *testing.T) {
|
func TestFlattenDeep(t *testing.T) {
|
||||||
input := [][][]string{{{"a", "b"}}, {{"c", "d"}}}
|
input := [][][]string{{{"a", "b"}}, {{"c", "d"}}}
|
||||||
expected := []string{"a", "b", "c", "d"}
|
expected := []string{"a", "b", "c", "d"}
|
||||||
|
|
||||||
res := FlattenDeep(input)
|
assert := internal.NewAssert(t, "TestFlattenDeep")
|
||||||
if !reflect.DeepEqual(res, expected) {
|
assert.Equal(expected, FlattenDeep(input))
|
||||||
internal.LogFailedTestInfo(t, "FlattenDeep", input, expected, res)
|
}
|
||||||
t.FailNow()
|
|
||||||
}
|
func TestForEach(t *testing.T) {
|
||||||
|
numbers := []int{1, 2, 3, 4, 5}
|
||||||
|
expected := []int{3, 4, 5, 6, 7}
|
||||||
|
|
||||||
|
var numbersAddTwo []int
|
||||||
|
ForEach(numbers, func(index int, value int) {
|
||||||
|
numbersAddTwo = append(numbersAddTwo, value+2)
|
||||||
|
})
|
||||||
|
|
||||||
|
assert := internal.NewAssert(t, "TestForEach")
|
||||||
|
assert.Equal(expected, numbersAddTwo)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMap(t *testing.T) {
|
func TestMap(t *testing.T) {
|
||||||
s1 := []int{1, 2, 3, 4}
|
nums := []int{1, 2, 3, 4}
|
||||||
multiplyTwo := func(i, num int) int {
|
multiplyTwo := func(i, num int) int {
|
||||||
return num * 2
|
return num * 2
|
||||||
}
|
}
|
||||||
e1 := []int{2, 4, 6, 8}
|
|
||||||
r1 := Map(s1, multiplyTwo)
|
assert := internal.NewAssert(t, "TestMap")
|
||||||
if !reflect.DeepEqual(r1, e1) {
|
assert.Equal([]int{2, 4, 6, 8}, Map(nums, multiplyTwo))
|
||||||
internal.LogFailedTestInfo(t, "Map", s1, e1, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
type student struct {
|
type student struct {
|
||||||
name string
|
name string
|
||||||
@@ -244,8 +262,7 @@ func TestMap(t *testing.T) {
|
|||||||
{"b", 2},
|
{"b", 2},
|
||||||
{"c", 3},
|
{"c", 3},
|
||||||
}
|
}
|
||||||
|
studentsOfAdd10Aage := []student{
|
||||||
e2 := []student{
|
|
||||||
{"a", 11},
|
{"a", 11},
|
||||||
{"b", 12},
|
{"b", 12},
|
||||||
{"c", 13},
|
{"c", 13},
|
||||||
@@ -254,11 +271,8 @@ func TestMap(t *testing.T) {
|
|||||||
s.age += 10
|
s.age += 10
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
r2 := Map(students, mapFunc)
|
|
||||||
if !reflect.DeepEqual(r2, e2) {
|
assert.Equal(studentsOfAdd10Aage, Map(students, mapFunc))
|
||||||
internal.LogFailedTestInfo(t, "Filter", students, e2, r2)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReduce(t *testing.T) {
|
func TestReduce(t *testing.T) {
|
||||||
@@ -266,239 +280,163 @@ func TestReduce(t *testing.T) {
|
|||||||
{},
|
{},
|
||||||
{1},
|
{1},
|
||||||
{1, 2, 3, 4}}
|
{1, 2, 3, 4}}
|
||||||
|
|
||||||
expected := []int{0, 1, 10}
|
expected := []int{0, 1, 10}
|
||||||
|
|
||||||
f := func(i, v1, v2 int) int {
|
f := func(i, v1, v2 int) int {
|
||||||
return v1 + v2
|
return v1 + v2
|
||||||
}
|
}
|
||||||
|
|
||||||
|
assert := internal.NewAssert(t, "TestReduce")
|
||||||
|
|
||||||
for i := 0; i < len(cases); i++ {
|
for i := 0; i < len(cases); i++ {
|
||||||
res := Reduce(cases[i], f, 0)
|
actual := Reduce(cases[i], f, 0)
|
||||||
if res != expected[i] {
|
assert.Equal(expected[i], actual)
|
||||||
internal.LogFailedTestInfo(t, "Reduce", cases[i], expected[i], res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIntSlice(t *testing.T) {
|
func TestIntSlice(t *testing.T) {
|
||||||
var t1 []interface{}
|
var nums []interface{}
|
||||||
t1 = append(t1, 1, 2, 3, 4, 5)
|
nums = append(nums, 1, 2, 3)
|
||||||
expect := []int{1, 2, 3, 4, 5}
|
|
||||||
intSlice(t, t1, expect)
|
|
||||||
}
|
|
||||||
|
|
||||||
func intSlice(t *testing.T, test interface{}, expected []int) {
|
assert := internal.NewAssert(t, "TestIntSlice")
|
||||||
res := IntSlice(test)
|
assert.Equal([]int{1, 2, 3}, IntSlice(nums))
|
||||||
|
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "IntSlice", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStringSlice(t *testing.T) {
|
func TestStringSlice(t *testing.T) {
|
||||||
var t1 []interface{}
|
var strs []interface{}
|
||||||
t1 = append(t1, "a", "b", "c", "d", "e")
|
strs = append(strs, "a", "b", "c")
|
||||||
expect := []string{"a", "b", "c", "d", "e"}
|
|
||||||
stringSlice(t, t1, expect)
|
|
||||||
}
|
|
||||||
|
|
||||||
func stringSlice(t *testing.T, test interface{}, expected []string) {
|
assert := internal.NewAssert(t, "TestStringSlice")
|
||||||
res := StringSlice(test)
|
assert.Equal([]string{"a", "b", "c"}, StringSlice(strs))
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "StringSlice", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestInterfaceSlice(t *testing.T) {
|
func TestInterfaceSlice(t *testing.T) {
|
||||||
t1 := []string{"a", "b", "c", "d", "e"}
|
strs := []string{"a", "b", "c"}
|
||||||
expect := []interface{}{"a", "b", "c", "d", "e"}
|
expect := []interface{}{"a", "b", "c"}
|
||||||
interfaceSlice(t, t1, expect)
|
|
||||||
}
|
|
||||||
|
|
||||||
func interfaceSlice(t *testing.T, test interface{}, expected []interface{}) {
|
assert := internal.NewAssert(t, "TestInterfaceSlice")
|
||||||
res := InterfaceSlice(test)
|
assert.Equal(expect, InterfaceSlice(strs))
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "InterfaceSlice", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDeleteByIndex(t *testing.T) {
|
func TestDeleteByIndex(t *testing.T) {
|
||||||
origin := []string{"a", "b", "c", "d", "e"}
|
assert := internal.NewAssert(t, "TestDeleteByIndex")
|
||||||
|
|
||||||
t1 := []string{"a", "b", "c", "d", "e"}
|
t1 := []string{"a", "b", "c", "d", "e"}
|
||||||
r1 := []string{"b", "c", "d", "e"}
|
r1 := []string{"b", "c", "d", "e"}
|
||||||
deleteByIndex(t, origin, t1, 0, 0, r1)
|
a1, _ := DeleteByIndex(t1, 0)
|
||||||
|
assert.Equal(r1, a1)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c", "d", "e"}
|
t2 := []string{"a", "b", "c", "d", "e"}
|
||||||
r2 := []string{"a", "b", "c", "e"}
|
r2 := []string{"a", "b", "c", "e"}
|
||||||
deleteByIndex(t, origin, t1, 3, 0, r2)
|
a2, _ := DeleteByIndex(t2, 3)
|
||||||
|
assert.Equal(r2, a2)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c", "d", "e"}
|
t3 := []string{"a", "b", "c", "d", "e"}
|
||||||
r3 := []string{"a", "b", "c", "d"}
|
r3 := []string{"c", "d", "e"}
|
||||||
deleteByIndex(t, origin, t1, 4, 0, r3)
|
a3, _ := DeleteByIndex(t3, 0, 2)
|
||||||
|
assert.Equal(r3, a3)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c", "d", "e"}
|
t4 := []string{"a", "b", "c", "d", "e"}
|
||||||
r4 := []string{"c", "d", "e"}
|
r4 := []string{}
|
||||||
deleteByIndex(t, origin, t1, 0, 2, r4)
|
a4, _ := DeleteByIndex(t4, 0, 5)
|
||||||
|
assert.Equal(r4, a4)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c", "d", "e"}
|
t5 := []string{"a", "b", "c", "d", "e"}
|
||||||
r5 := []string{} // var r5 []string{} failed
|
_, err := DeleteByIndex(t5, 1, 1)
|
||||||
deleteByIndex(t, origin, t1, 0, 5, r5)
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
// failed
|
_, err = DeleteByIndex(t5, 0, 6)
|
||||||
//t1 = []string{"a", "b", "c", "d","e"}
|
assert.IsNotNil(err)
|
||||||
//r6 := []string{"a", "c", "d","e"}
|
|
||||||
//deleteByIndex(t, origin, t1, 1, 1, r6)
|
|
||||||
|
|
||||||
// failed
|
|
||||||
//t1 = []string{"a", "b", "c", "d","e"}
|
|
||||||
//r7 := []string{}
|
|
||||||
//deleteByIndex(t, origin, t1, 0, 6, r7)
|
|
||||||
}
|
|
||||||
|
|
||||||
func deleteByIndex(t *testing.T, origin, test interface{}, start, end int, expected interface{}) {
|
|
||||||
var res interface{}
|
|
||||||
var err error
|
|
||||||
if end != 0 {
|
|
||||||
res, err = DeleteByIndex(test, start, end)
|
|
||||||
} else {
|
|
||||||
res, err = DeleteByIndex(test, start)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
t.Error("DeleteByIndex Error: " + err.Error())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "DeleteByIndex", origin, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDrop(t *testing.T) {
|
func TestDrop(t *testing.T) {
|
||||||
drop(t, []int{}, 0, []int{})
|
assert := internal.NewAssert(t, "TestInterfaceSlice")
|
||||||
drop(t, []int{}, 1, []int{})
|
|
||||||
drop(t, []int{}, -1, []int{})
|
|
||||||
|
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, 0, []int{1, 2, 3, 4, 5})
|
assert.Equal([]int{}, Drop([]int{}, 0))
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, 1, []int{2, 3, 4, 5})
|
assert.Equal([]int{}, Drop([]int{}, 1))
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, 5, []int{})
|
assert.Equal([]int{}, Drop([]int{}, -1))
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, 6, []int{})
|
|
||||||
|
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, -1, []int{1, 2, 3, 4})
|
assert.Equal([]int{1, 2, 3, 4, 5}, Drop([]int{1, 2, 3, 4, 5}, 0))
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, -5, []int{})
|
assert.Equal([]int{2, 3, 4, 5}, Drop([]int{1, 2, 3, 4, 5}, 1))
|
||||||
drop(t, []int{1, 2, 3, 4, 5}, -6, []int{})
|
assert.Equal([]int{}, Drop([]int{1, 2, 3, 4, 5}, 5))
|
||||||
}
|
assert.Equal([]int{}, Drop([]int{1, 2, 3, 4, 5}, 6))
|
||||||
|
|
||||||
func drop(t *testing.T, test interface{}, n int, expected interface{}) {
|
assert.Equal([]int{1, 2, 3, 4}, Drop([]int{1, 2, 3, 4, 5}, -1))
|
||||||
res := Drop(test, n)
|
assert.Equal([]int{}, Drop([]int{1, 2, 3, 4, 5}, -6))
|
||||||
if !reflect.DeepEqual(res, expected) {
|
assert.Equal([]int{}, Drop([]int{1, 2, 3, 4, 5}, -6))
|
||||||
internal.LogFailedTestInfo(t, "Drop", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestInsertByIndex(t *testing.T) {
|
func TestInsertByIndex(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestInsertByIndex")
|
||||||
|
|
||||||
t1 := []string{"a", "b", "c"}
|
t1 := []string{"a", "b", "c"}
|
||||||
|
r1, _ := InsertByIndex(t1, 0, "1")
|
||||||
|
assert.Equal([]string{"1", "a", "b", "c"}, r1)
|
||||||
|
|
||||||
r1 := []string{"1", "a", "b", "c"}
|
r2, _ := InsertByIndex(t1, 1, "1")
|
||||||
insertByIndex(t, t1, 0, "1", r1)
|
assert.Equal([]string{"a", "1", "b", "c"}, r2)
|
||||||
|
|
||||||
r2 := []string{"a", "1", "b", "c"}
|
r3, _ := InsertByIndex(t1, 3, "1")
|
||||||
insertByIndex(t, t1, 1, "1", r2)
|
assert.Equal([]string{"a", "b", "c", "1"}, r3)
|
||||||
|
|
||||||
r3 := []string{"a", "b", "c", "1"}
|
r4, _ := InsertByIndex(t1, 0, []string{"1", "2", "3"})
|
||||||
insertByIndex(t, t1, 3, "1", r3)
|
assert.Equal([]string{"1", "2", "3", "a", "b", "c"}, r4)
|
||||||
|
|
||||||
r4 := []string{"1", "2", "3", "a", "b", "c"}
|
r5, _ := InsertByIndex(t1, 3, []string{"1", "2", "3"})
|
||||||
insertByIndex(t, t1, 0, []string{"1", "2", "3"}, r4)
|
assert.Equal([]string{"a", "b", "c", "1", "2", "3"}, r5)
|
||||||
|
|
||||||
r5 := []string{"a", "1", "2", "3", "b", "c"}
|
_, err := InsertByIndex(t1, 4, "1")
|
||||||
insertByIndex(t, t1, 1, []string{"1", "2", "3"}, r5)
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
r6 := []string{"a", "b", "1", "2", "3", "c"}
|
_, err = InsertByIndex(t1, 0, 1)
|
||||||
insertByIndex(t, t1, 2, []string{"1", "2", "3"}, r6)
|
assert.IsNotNil(err)
|
||||||
|
|
||||||
r7 := []string{"a", "b", "c", "1", "2", "3"}
|
|
||||||
insertByIndex(t, t1, 3, []string{"1", "2", "3"}, r7)
|
|
||||||
}
|
|
||||||
|
|
||||||
func insertByIndex(t *testing.T, test interface{}, index int, value, expected interface{}) {
|
|
||||||
res, err := InsertByIndex(test, index, value)
|
|
||||||
if err != nil {
|
|
||||||
t.Error("InsertByIndex Error: " + err.Error())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "InsertByIndex", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestUpdateByIndex(t *testing.T) {
|
func TestUpdateByIndex(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestUpdateByIndex")
|
||||||
|
|
||||||
t1 := []string{"a", "b", "c"}
|
t1 := []string{"a", "b", "c"}
|
||||||
r1 := []string{"1", "b", "c"}
|
r1, _ := UpdateByIndex(t1, 0, "1")
|
||||||
updateByIndex(t, t1, 0, "1", r1)
|
assert.Equal([]string{"1", "b", "c"}, r1)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c"}
|
t2 := []string{"a", "b", "c"}
|
||||||
r2 := []string{"a", "1", "c"}
|
r2, _ := UpdateByIndex(t2, 1, "1")
|
||||||
updateByIndex(t, t1, 1, "1", r2)
|
assert.Equal([]string{"a", "1", "c"}, r2)
|
||||||
|
|
||||||
t1 = []string{"a", "b", "c"}
|
_, err := UpdateByIndex([]string{"a", "b", "c"}, 4, "1")
|
||||||
r3 := []string{"a", "b", "1"}
|
assert.IsNotNil(err)
|
||||||
updateByIndex(t, t1, 2, "1", r3)
|
|
||||||
|
|
||||||
}
|
_, err = UpdateByIndex([]string{"a", "b", "c"}, 0, 1)
|
||||||
|
assert.IsNotNil(err)
|
||||||
func updateByIndex(t *testing.T, test interface{}, index int, value, expected interface{}) {
|
|
||||||
res, err := UpdateByIndex(test, index, value)
|
|
||||||
if err != nil {
|
|
||||||
t.Error("UpdateByIndex Error: " + err.Error())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "UpdateByIndex", test, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestUnique(t *testing.T) {
|
func TestUnique(t *testing.T) {
|
||||||
t1 := []int{1, 2, 2, 3}
|
assert := internal.NewAssert(t, "TestUnique")
|
||||||
e1 := []int{1, 2, 3}
|
|
||||||
r1 := Unique(t1)
|
|
||||||
if !reflect.DeepEqual(r1, e1) {
|
|
||||||
internal.LogFailedTestInfo(t, "Unique", t1, e1, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
t2 := []string{"a", "a", "b", "c"}
|
assert.Equal([]int{1, 2, 3}, Unique([]int{1, 2, 2, 3}))
|
||||||
e2 := []string{"a", "b", "c"}
|
assert.Equal([]string{"a", "b", "c"}, Unique([]string{"a", "a", "b", "c"}))
|
||||||
r2 := Unique(t2)
|
}
|
||||||
if !reflect.DeepEqual(r2, e2) {
|
|
||||||
internal.LogFailedTestInfo(t, "Unique", t2, e2, r2)
|
func TestUniqueBy(t *testing.T) {
|
||||||
t.FailNow()
|
assert := internal.NewAssert(t, "TestUniqueBy")
|
||||||
}
|
|
||||||
|
actual := UniqueBy([]int{1, 2, 3, 4, 5, 6}, func(val int) int {
|
||||||
|
return val % 4
|
||||||
|
})
|
||||||
|
assert.Equal([]int{1, 2, 3, 0}, actual)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestUnion(t *testing.T) {
|
func TestUnion(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestUnion")
|
||||||
|
|
||||||
s1 := []int{1, 3, 4, 6}
|
s1 := []int{1, 3, 4, 6}
|
||||||
s2 := []int{1, 2, 5, 6}
|
s2 := []int{1, 2, 5, 6}
|
||||||
s3 := []int{0, 4, 5, 7}
|
s3 := []int{0, 4, 5, 7}
|
||||||
|
|
||||||
expected1 := []int{1, 3, 4, 6, 2, 5, 0, 7}
|
assert.Equal([]int{1, 3, 4, 6, 2, 5, 0, 7}, Union(s1, s2, s3))
|
||||||
res1 := Union(s1, s2, s3)
|
assert.Equal([]int{1, 3, 4, 6, 2, 5}, Union(s1, s2))
|
||||||
if !reflect.DeepEqual(res1, expected1) {
|
assert.Equal([]int{1, 3, 4, 6}, Union(s1))
|
||||||
internal.LogFailedTestInfo(t, "Union", s1, expected1, res1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
expected2 := []int{1, 3, 4, 6}
|
|
||||||
res2 := Union(s1)
|
|
||||||
if !reflect.DeepEqual(res2, expected2) {
|
|
||||||
internal.LogFailedTestInfo(t, "Union", s1, expected2, res2)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIntersection(t *testing.T) {
|
func TestIntersection(t *testing.T) {
|
||||||
@@ -519,45 +457,49 @@ func TestIntersection(t *testing.T) {
|
|||||||
Intersection(s1),
|
Intersection(s1),
|
||||||
Intersection(s1, s4),
|
Intersection(s1, s4),
|
||||||
}
|
}
|
||||||
for i := 0; i < len(res); i++ {
|
|
||||||
if !reflect.DeepEqual(res[i], expected[i]) {
|
|
||||||
internal.LogFailedTestInfo(t, "Intersection", "Intersection", expected[i], res[i])
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
assert := internal.NewAssert(t, "TestIntersection")
|
||||||
|
|
||||||
|
for i := 0; i < len(res); i++ {
|
||||||
|
assert.Equal(res[i], expected[i])
|
||||||
|
}
|
||||||
|
assert.IsNil(Intersection())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReverseSlice(t *testing.T) {
|
func TestReverseSlice(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIntersection")
|
||||||
|
|
||||||
s1 := []int{1, 2, 3, 4, 5}
|
s1 := []int{1, 2, 3, 4, 5}
|
||||||
e1 := []int{5, 4, 3, 2, 1}
|
|
||||||
ReverseSlice(s1)
|
ReverseSlice(s1)
|
||||||
if !reflect.DeepEqual(s1, e1) {
|
assert.Equal([]int{5, 4, 3, 2, 1}, s1)
|
||||||
internal.LogFailedTestInfo(t, "ReverseSlice", s1, e1, s1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
s2 := []string{"a", "b", "c", "d", "e"}
|
s2 := []string{"a", "b", "c", "d", "e"}
|
||||||
e2 := []string{"e", "d", "c", "b", "a"}
|
|
||||||
ReverseSlice(s2)
|
ReverseSlice(s2)
|
||||||
if !reflect.DeepEqual(s2, e2) {
|
assert.Equal([]string{"e", "d", "c", "b", "a"}, s2)
|
||||||
internal.LogFailedTestInfo(t, "ReverseSlice", s2, e2, s2)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDifference(t *testing.T) {
|
func TestDifference(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestDifference")
|
||||||
|
|
||||||
s1 := []int{1, 2, 3, 4, 5}
|
s1 := []int{1, 2, 3, 4, 5}
|
||||||
s2 := []int{4, 5, 6}
|
s2 := []int{4, 5, 6}
|
||||||
e1 := []int{1, 2, 3}
|
assert.Equal([]int{1, 2, 3}, Difference(s1, s2))
|
||||||
r1 := Difference(s1, s2)
|
|
||||||
if !reflect.DeepEqual(r1, e1) {
|
|
||||||
internal.LogFailedTestInfo(t, "Difference", s1, e1, r1)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSortByField(t *testing.T) {
|
func TestDifferenceBy(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestDifferenceBy")
|
||||||
|
|
||||||
|
s1 := []int{1, 2, 3, 4, 5} //after add one: 2 3 4 5 6
|
||||||
|
s2 := []int{3, 4, 5} //after add one: 4 5 6
|
||||||
|
addOne := func(i int, v int) int {
|
||||||
|
return v + 1
|
||||||
|
}
|
||||||
|
assert.Equal([]int{1, 2}, DifferenceBy(s1, s2, addOne))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSortByFielDesc(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestSortByFielDesc")
|
||||||
|
|
||||||
type student struct {
|
type student struct {
|
||||||
name string
|
name string
|
||||||
age int
|
age int
|
||||||
@@ -568,8 +510,7 @@ func TestSortByField(t *testing.T) {
|
|||||||
{"c", 5},
|
{"c", 5},
|
||||||
{"d", 6},
|
{"d", 6},
|
||||||
}
|
}
|
||||||
|
studentsOfSortByAge := []student{
|
||||||
sortByAge := []student{
|
|
||||||
{"b", 15},
|
{"b", 15},
|
||||||
{"a", 10},
|
{"a", 10},
|
||||||
{"d", 6},
|
{"d", 6},
|
||||||
@@ -577,35 +518,109 @@ func TestSortByField(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
err := SortByField(students, "age", "desc")
|
err := SortByField(students, "age", "desc")
|
||||||
if err != nil {
|
assert.IsNil(err)
|
||||||
t.Error("IntSlice Error: " + err.Error())
|
|
||||||
|
assert.Equal(students, studentsOfSortByAge)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSortByFieldAsc(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestSortByFieldAsc")
|
||||||
|
|
||||||
|
type student struct {
|
||||||
|
name string
|
||||||
|
age int
|
||||||
|
}
|
||||||
|
students := []student{
|
||||||
|
{"a", 10},
|
||||||
|
{"b", 15},
|
||||||
|
{"c", 5},
|
||||||
|
{"d", 6},
|
||||||
|
}
|
||||||
|
studentsOfSortByAge := []student{
|
||||||
|
{"c", 5},
|
||||||
|
{"d", 6},
|
||||||
|
{"a", 10},
|
||||||
|
{"b", 15},
|
||||||
}
|
}
|
||||||
|
|
||||||
if !reflect.DeepEqual(students, sortByAge) {
|
err := SortByField(students, "age")
|
||||||
internal.LogFailedTestInfo(t, "SortByField", students, sortByAge, students)
|
assert.IsNil(err)
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
|
assert.Equal(students, studentsOfSortByAge)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithout(t *testing.T) {
|
func TestWithout(t *testing.T) {
|
||||||
s := []int{1, 2, 3, 4, 5}
|
assert := internal.NewAssert(t, "TestWithout")
|
||||||
expected := []int{3, 4, 5}
|
assert.Equal([]int{3, 4, 5}, Without([]int{1, 2, 3, 4, 5}, 1, 2))
|
||||||
res := Without(s, 1, 2)
|
assert.Equal([]int{1, 2, 3, 4, 5}, Without([]int{1, 2, 3, 4, 5}))
|
||||||
|
|
||||||
if !reflect.DeepEqual(res, expected) {
|
|
||||||
internal.LogFailedTestInfo(t, "Without", s, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestShuffle(t *testing.T) {
|
func TestShuffle(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestShuffle")
|
||||||
|
|
||||||
s := []int{1, 2, 3, 4, 5}
|
s := []int{1, 2, 3, 4, 5}
|
||||||
res := Shuffle(s)
|
res := Shuffle(s)
|
||||||
t.Log("Shuffle result: ", res)
|
t.Log("Shuffle result: ", res)
|
||||||
|
|
||||||
if reflect.TypeOf(s) != reflect.TypeOf(res) {
|
assert.Equal(reflect.TypeOf(s), reflect.TypeOf(res))
|
||||||
internal.LogFailedTestInfo(t, "Shuffle", s, res, res)
|
|
||||||
t.FailNow()
|
rv := reflect.ValueOf(res)
|
||||||
}
|
assert.Equal(5, rv.Len())
|
||||||
|
|
||||||
|
assert.Equal(true, rv.Kind() == reflect.Slice)
|
||||||
|
assert.Equal(true, rv.Type().Elem().Kind() == reflect.Int)
|
||||||
|
|
||||||
|
assert.Equal(true, Contain(res, 1))
|
||||||
|
assert.Equal(true, Contain(res, 2))
|
||||||
|
assert.Equal(true, Contain(res, 3))
|
||||||
|
assert.Equal(true, Contain(res, 4))
|
||||||
|
assert.Equal(true, Contain(res, 5))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIndexOf(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIndexOf")
|
||||||
|
|
||||||
|
arr := []string{"a", "a", "b", "c"}
|
||||||
|
assert.Equal(0, IndexOf(arr, "a"))
|
||||||
|
assert.Equal(-1, IndexOf(arr, "d"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLastIndexOf(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestLastIndexOf")
|
||||||
|
|
||||||
|
arr := []string{"a", "a", "b", "c"}
|
||||||
|
assert.Equal(1, LastIndexOf(arr, "a"))
|
||||||
|
assert.Equal(-1, LastIndexOf(arr, "d"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToSlice(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToSlice")
|
||||||
|
|
||||||
|
str1 := "a"
|
||||||
|
str2 := "b"
|
||||||
|
out1 := ToSlice(str1)
|
||||||
|
out2 := ToSlice(str1, str2)
|
||||||
|
|
||||||
|
assert.Equal([]string{"a"}, StringSlice(out1))
|
||||||
|
assert.Equal([]string{"a", "b"}, StringSlice(out2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToSlicePointer(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToSlicePointer")
|
||||||
|
|
||||||
|
var str1 interface{}
|
||||||
|
str1 = "a"
|
||||||
|
var str2 interface{}
|
||||||
|
str2 = "b"
|
||||||
|
|
||||||
|
assert.Equal([]*interface{}{&str1}, ToSlicePointer(str1))
|
||||||
|
assert.Equal([]*interface{}{&str1, &str2}, ToSlicePointer(str1, str2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAppendIfAbsent(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestToAppendIfAbsent")
|
||||||
|
|
||||||
|
str1 := []string{"a", "b"}
|
||||||
|
assert.Equal([]string{"a", "b"}, AppendIfAbsent(str1, "a"))
|
||||||
|
assert.Equal([]string{"a", "b", "c"}, AppendIfAbsent(str1, "c"))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -54,6 +54,18 @@ func Capitalize(s string) string {
|
|||||||
return string(out)
|
return string(out)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UpperFirst converts the first character of string to upper case.
|
||||||
|
func UpperFirst(s string) string {
|
||||||
|
if len(s) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
r, size := utf8.DecodeRuneInString(s)
|
||||||
|
r = unicode.ToUpper(r)
|
||||||
|
|
||||||
|
return string(r) + s[size:]
|
||||||
|
}
|
||||||
|
|
||||||
// LowerFirst converts the first character of string to lower case.
|
// LowerFirst converts the first character of string to lower case.
|
||||||
func LowerFirst(s string) string {
|
func LowerFirst(s string) string {
|
||||||
if len(s) == 0 {
|
if len(s) == 0 {
|
||||||
@@ -205,3 +217,83 @@ func ReverseStr(s string) string {
|
|||||||
}
|
}
|
||||||
return string(r)
|
return string(r)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Wrap a string with another string.
|
||||||
|
func Wrap(str string, wrapWith string) string {
|
||||||
|
if str == "" || wrapWith == "" {
|
||||||
|
return str
|
||||||
|
}
|
||||||
|
var sb strings.Builder
|
||||||
|
sb.WriteString(wrapWith)
|
||||||
|
sb.WriteString(str)
|
||||||
|
sb.WriteString(wrapWith)
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unwrap a given string from anther string. will change str value
|
||||||
|
func Unwrap(str string, wrapToken string) string {
|
||||||
|
if str == "" || wrapToken == "" {
|
||||||
|
return str
|
||||||
|
}
|
||||||
|
|
||||||
|
firstIndex := strings.Index(str, wrapToken)
|
||||||
|
lastIndex := strings.LastIndex(str, wrapToken)
|
||||||
|
|
||||||
|
if firstIndex == 0 && lastIndex > 0 && lastIndex <= len(str)-1 {
|
||||||
|
if len(wrapToken) <= lastIndex {
|
||||||
|
str = str[len(wrapToken):lastIndex]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return str
|
||||||
|
}
|
||||||
|
|
||||||
|
// SplitEx split a given string whether the result contains empty string
|
||||||
|
func SplitEx(s, sep string, removeEmptyString bool) []string {
|
||||||
|
if sep == "" {
|
||||||
|
return []string{}
|
||||||
|
}
|
||||||
|
|
||||||
|
n := strings.Count(s, sep) + 1
|
||||||
|
a := make([]string, n)
|
||||||
|
n--
|
||||||
|
i := 0
|
||||||
|
sepSave := 0
|
||||||
|
ignore := false
|
||||||
|
|
||||||
|
for i < n {
|
||||||
|
m := strings.Index(s, sep)
|
||||||
|
if m < 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
ignore = false
|
||||||
|
if removeEmptyString {
|
||||||
|
if s[:m+sepSave] == "" {
|
||||||
|
ignore = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !ignore {
|
||||||
|
a[i] = s[:m+sepSave]
|
||||||
|
s = s[m+len(sep):]
|
||||||
|
i++
|
||||||
|
} else {
|
||||||
|
s = s[m+len(sep):]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var ret []string
|
||||||
|
if removeEmptyString {
|
||||||
|
if s != "" {
|
||||||
|
a[i] = s
|
||||||
|
ret = a[:i+1]
|
||||||
|
} else {
|
||||||
|
ret = a[:i]
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
a[i] = s
|
||||||
|
ret = a[:i+1]
|
||||||
|
}
|
||||||
|
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,195 +7,185 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestCamelCase(t *testing.T) {
|
func TestCamelCase(t *testing.T) {
|
||||||
camelCase(t, "foo_bar", "fooBar")
|
assert := internal.NewAssert(t, "TestCamelCase")
|
||||||
camelCase(t, "Foo-Bar", "fooBar")
|
|
||||||
camelCase(t, "Foo&bar", "fooBar")
|
|
||||||
camelCase(t, "foo bar", "fooBar")
|
|
||||||
}
|
|
||||||
|
|
||||||
func camelCase(t *testing.T, test string, expected string) {
|
assert.Equal("fooBar", CamelCase("foo_bar"))
|
||||||
res := CamelCase(test)
|
assert.Equal("fooBar", CamelCase("Foo-Bar"))
|
||||||
if res != expected {
|
assert.Equal("fooBar", CamelCase("Foo&bar"))
|
||||||
internal.LogFailedTestInfo(t, "CamelCase", test, expected, res)
|
assert.Equal("fooBar", CamelCase("foo bar"))
|
||||||
t.FailNow()
|
|
||||||
}
|
assert.NotEqual("FooBar", CamelCase("foo_bar"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCapitalize(t *testing.T) {
|
func TestCapitalize(t *testing.T) {
|
||||||
capitalize(t, "foo", "Foo")
|
assert := internal.NewAssert(t, "TestCapitalize")
|
||||||
capitalize(t, "fOO", "Foo")
|
|
||||||
capitalize(t, "FOo", "Foo")
|
|
||||||
}
|
|
||||||
|
|
||||||
func capitalize(t *testing.T, test string, expected string) {
|
assert.Equal("Foo", Capitalize("foo"))
|
||||||
res := Capitalize(test)
|
assert.Equal("Foo", Capitalize("Foo"))
|
||||||
if res != expected {
|
assert.Equal("Foo", Capitalize("Foo"))
|
||||||
internal.LogFailedTestInfo(t, "Capitalize", test, expected, res)
|
|
||||||
t.FailNow()
|
assert.NotEqual("foo", Capitalize("Foo"))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestKebabCase(t *testing.T) {
|
func TestKebabCase(t *testing.T) {
|
||||||
kebabCase(t, "Foo Bar-", "foo-bar")
|
assert := internal.NewAssert(t, "TestKebabCase")
|
||||||
kebabCase(t, "foo_Bar", "foo-bar")
|
|
||||||
kebabCase(t, "fooBar", "foo-bar")
|
|
||||||
kebabCase(t, "__FOO_BAR__", "f-o-o-b-a-r")
|
|
||||||
}
|
|
||||||
|
|
||||||
func kebabCase(t *testing.T, test string, expected string) {
|
assert.Equal("foo-bar", KebabCase("Foo Bar-"))
|
||||||
res := KebabCase(test)
|
assert.Equal("foo-bar", KebabCase("foo_Bar"))
|
||||||
if res != expected {
|
assert.Equal("foo-bar", KebabCase("fooBar"))
|
||||||
internal.LogFailedTestInfo(t, "KebabCase", test, expected, res)
|
assert.Equal("f-o-o-b-a-r", KebabCase("__FOO_BAR__"))
|
||||||
t.FailNow()
|
|
||||||
}
|
assert.NotEqual("foo_bar", KebabCase("fooBar"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSnakeCase(t *testing.T) {
|
func TestSnakeCase(t *testing.T) {
|
||||||
snakeCase(t, "Foo Bar-", "foo_bar")
|
assert := internal.NewAssert(t, "TestSnakeCase")
|
||||||
snakeCase(t, "foo_Bar", "foo_bar")
|
|
||||||
snakeCase(t, "fooBar", "foo_bar")
|
assert.Equal("foo_bar", SnakeCase("Foo Bar-"))
|
||||||
snakeCase(t, "__FOO_BAR__", "f_o_o_b_a_r")
|
assert.Equal("foo_bar", SnakeCase("foo_Bar"))
|
||||||
snakeCase(t, "aBbc-s$@a&%_B.B^C", "a_bbc_s_a_b_b_c")
|
assert.Equal("foo_bar", SnakeCase("fooBar"))
|
||||||
|
assert.Equal("f_o_o_b_a_r", SnakeCase("__FOO_BAR__"))
|
||||||
|
assert.Equal("a_bbc_s_a_b_b_c", SnakeCase("aBbc-s$@a&%_B.B^C"))
|
||||||
|
|
||||||
|
assert.NotEqual("foo-bar", SnakeCase("foo_Bar"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func snakeCase(t *testing.T, test string, expected string) {
|
func TestUpperFirst(t *testing.T) {
|
||||||
res := SnakeCase(test)
|
assert := internal.NewAssert(t, "TestLowerFirst")
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "SnakeCase", test, expected, res)
|
assert.Equal("Foo", UpperFirst("foo"))
|
||||||
t.FailNow()
|
assert.Equal("BAR", UpperFirst("bAR"))
|
||||||
}
|
assert.Equal("FOo", UpperFirst("FOo"))
|
||||||
|
assert.Equal("FOo大", UpperFirst("fOo大"))
|
||||||
|
|
||||||
|
assert.NotEqual("Bar", UpperFirst("BAR"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLowerFirst(t *testing.T) {
|
func TestLowerFirst(t *testing.T) {
|
||||||
lowerFirst(t, "foo", "foo")
|
assert := internal.NewAssert(t, "TestLowerFirst")
|
||||||
lowerFirst(t, "BAR", "bAR")
|
|
||||||
lowerFirst(t, "FOo", "fOo")
|
|
||||||
lowerFirst(t, "FOo大", "fOo大")
|
|
||||||
}
|
|
||||||
|
|
||||||
func lowerFirst(t *testing.T, test string, expected string) {
|
assert.Equal("foo", LowerFirst("foo"))
|
||||||
res := LowerFirst(test)
|
assert.Equal("bAR", LowerFirst("BAR"))
|
||||||
if res != expected {
|
assert.Equal("fOo", LowerFirst("FOo"))
|
||||||
internal.LogFailedTestInfo(t, "LowerFirst", test, expected, res)
|
assert.Equal("fOo大", LowerFirst("FOo大"))
|
||||||
t.FailNow()
|
|
||||||
}
|
assert.NotEqual("Bar", LowerFirst("BAR"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPadEnd(t *testing.T) {
|
func TestPadEnd(t *testing.T) {
|
||||||
padEnd(t, "a", 1, "b", "a")
|
assert := internal.NewAssert(t, "TestPadEnd")
|
||||||
padEnd(t, "a", 2, "b", "ab")
|
|
||||||
padEnd(t, "abcd", 6, "mno", "abcdmn")
|
|
||||||
padEnd(t, "abcd", 6, "m", "abcdmm")
|
|
||||||
padEnd(t, "abc", 6, "ab", "abcaba")
|
|
||||||
}
|
|
||||||
|
|
||||||
func padEnd(t *testing.T, source string, size int, fillString string, expected string) {
|
assert.Equal("a", PadEnd("a", 1, "b"))
|
||||||
res := PadEnd(source, size, fillString)
|
assert.Equal("ab", PadEnd("a", 2, "b"))
|
||||||
if res != expected {
|
assert.Equal("abcdmn", PadEnd("abcd", 6, "mno"))
|
||||||
internal.LogFailedTestInfo(t, "PadEnd", source, expected, res)
|
assert.Equal("abcdmm", PadEnd("abcd", 6, "m"))
|
||||||
t.FailNow()
|
assert.Equal("abcaba", PadEnd("abc", 6, "ab"))
|
||||||
}
|
|
||||||
|
assert.NotEqual("ba", PadEnd("a", 2, "b"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPadStart(t *testing.T) {
|
func TestPadStart(t *testing.T) {
|
||||||
padStart(t, "a", 1, "b", "a")
|
assert := internal.NewAssert(t, "TestPadStart")
|
||||||
padStart(t, "a", 2, "b", "ba")
|
|
||||||
padStart(t, "abcd", 6, "mno", "mnabcd")
|
|
||||||
padStart(t, "abcd", 6, "m", "mmabcd")
|
|
||||||
padStart(t, "abc", 6, "ab", "abaabc")
|
|
||||||
}
|
|
||||||
|
|
||||||
func padStart(t *testing.T, source string, size int, fillString string, expected string) {
|
assert.Equal("a", PadStart("a", 1, "b"))
|
||||||
res := PadStart(source, size, fillString)
|
assert.Equal("ba", PadStart("a", 2, "b"))
|
||||||
if res != expected {
|
assert.Equal("mnabcd", PadStart("abcd", 6, "mno"))
|
||||||
internal.LogFailedTestInfo(t, "PadEnd", source, expected, res)
|
assert.Equal("mmabcd", PadStart("abcd", 6, "m"))
|
||||||
t.FailNow()
|
assert.Equal("abaabc", PadStart("abc", 6, "ab"))
|
||||||
}
|
|
||||||
|
assert.NotEqual("ab", PadStart("a", 2, "b"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBefore(t *testing.T) {
|
func TestBefore(t *testing.T) {
|
||||||
before(t, "lancet", "", "lancet")
|
assert := internal.NewAssert(t, "TestBefore")
|
||||||
before(t, "github.com/test/lancet", "/", "github.com")
|
|
||||||
before(t, "github.com/test/lancet", "test", "github.com/")
|
|
||||||
}
|
|
||||||
|
|
||||||
func before(t *testing.T, source, char, expected string) {
|
assert.Equal("lancet", Before("lancet", ""))
|
||||||
res := Before(source, char)
|
assert.Equal("github.com", Before("github.com/test/lancet", "/"))
|
||||||
if res != expected {
|
assert.Equal("github.com/", Before("github.com/test/lancet", "test"))
|
||||||
internal.LogFailedTestInfo(t, "Before", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBeforeLast(t *testing.T) {
|
func TestBeforeLast(t *testing.T) {
|
||||||
beforeLast(t, "lancet", "", "lancet")
|
assert := internal.NewAssert(t, "TestBeforeLast")
|
||||||
beforeLast(t, "github.com/test/lancet", "/", "github.com/test")
|
|
||||||
beforeLast(t, "github.com/test/test/lancet", "test", "github.com/test/")
|
|
||||||
}
|
|
||||||
|
|
||||||
func beforeLast(t *testing.T, source, char, expected string) {
|
assert.Equal("lancet", BeforeLast("lancet", ""))
|
||||||
res := BeforeLast(source, char)
|
assert.Equal("github.com/test", BeforeLast("github.com/test/lancet", "/"))
|
||||||
if res != expected {
|
assert.Equal("github.com/test/", BeforeLast("github.com/test/test/lancet", "test"))
|
||||||
internal.LogFailedTestInfo(t, "BeforeLast", source, expected, res)
|
|
||||||
t.FailNow()
|
assert.NotEqual("github.com/", BeforeLast("github.com/test/test/lancet", "test"))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAfter(t *testing.T) {
|
func TestAfter(t *testing.T) {
|
||||||
after(t, "lancet", "", "lancet")
|
assert := internal.NewAssert(t, "TestAfter")
|
||||||
after(t, "github.com/test/lancet", "/", "test/lancet")
|
|
||||||
after(t, "github.com/test/lancet", "test", "/lancet")
|
|
||||||
}
|
|
||||||
|
|
||||||
func after(t *testing.T, source, char, expected string) {
|
assert.Equal("lancet", After("lancet", ""))
|
||||||
res := After(source, char)
|
assert.Equal("test/lancet", After("github.com/test/lancet", "/"))
|
||||||
if res != expected {
|
assert.Equal("/lancet", After("github.com/test/lancet", "test"))
|
||||||
internal.LogFailedTestInfo(t, "After", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAfterLast(t *testing.T) {
|
func TestAfterLast(t *testing.T) {
|
||||||
afterLast(t, "lancet", "", "lancet")
|
assert := internal.NewAssert(t, "TestAfterLast")
|
||||||
afterLast(t, "github.com/test/lancet", "/", "lancet")
|
|
||||||
afterLast(t, "github.com/test/test/lancet", "test", "/lancet")
|
|
||||||
}
|
|
||||||
|
|
||||||
func afterLast(t *testing.T, source, char, expected string) {
|
assert.Equal("lancet", AfterLast("lancet", ""))
|
||||||
res := AfterLast(source, char)
|
assert.Equal("lancet", AfterLast("github.com/test/lancet", "/"))
|
||||||
if res != expected {
|
assert.Equal("/lancet", AfterLast("github.com/test/lancet", "test"))
|
||||||
internal.LogFailedTestInfo(t, "AfterLast", source, expected, res)
|
assert.Equal("/lancet", AfterLast("github.com/test/test/lancet", "test"))
|
||||||
t.FailNow()
|
|
||||||
}
|
assert.NotEqual("/test/lancet", AfterLast("github.com/test/test/lancet", "test"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsString(t *testing.T) {
|
func TestIsString(t *testing.T) {
|
||||||
isString(t, "lancet", true)
|
assert := internal.NewAssert(t, "TestIsString")
|
||||||
isString(t, 1, false)
|
|
||||||
isString(t, true, false)
|
|
||||||
isString(t, []string{}, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isString(t *testing.T, test interface{}, expected bool) {
|
assert.Equal(true, IsString("lancet"))
|
||||||
res := IsString(test)
|
assert.Equal(true, IsString(""))
|
||||||
if res != expected {
|
assert.Equal(false, IsString(1))
|
||||||
internal.LogFailedTestInfo(t, "IsString", test, expected, res)
|
assert.Equal(false, IsString(true))
|
||||||
t.FailNow()
|
assert.Equal(false, IsString([]string{}))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReverseStr(t *testing.T) {
|
func TestReverseStr(t *testing.T) {
|
||||||
reverseStr(t, "abc", "cba")
|
assert := internal.NewAssert(t, "TestReverseStr")
|
||||||
reverseStr(t, "12345", "54321")
|
|
||||||
|
|
||||||
//failed
|
assert.Equal("cba", ReverseStr("abc"))
|
||||||
//reverseStr(t, "abc", "abc")
|
assert.Equal("54321", ReverseStr("12345"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func reverseStr(t *testing.T, test string, expected string) {
|
func TestWrap(t *testing.T) {
|
||||||
res := ReverseStr(test)
|
assert := internal.NewAssert(t, "TestWrap")
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "ReverseStr", test, expected, res)
|
assert.Equal("ab", Wrap("ab", ""))
|
||||||
t.FailNow()
|
assert.Equal("", Wrap("", "*"))
|
||||||
}
|
assert.Equal("*ab*", Wrap("ab", "*"))
|
||||||
|
assert.Equal("\"ab\"", Wrap("ab", "\""))
|
||||||
|
assert.Equal("'ab'", Wrap("ab", "'"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnwrap(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestUnwrap")
|
||||||
|
|
||||||
|
assert.Equal("", Unwrap("", "*"))
|
||||||
|
assert.Equal("ab", Unwrap("ab", ""))
|
||||||
|
assert.Equal("ab", Unwrap("ab", "*"))
|
||||||
|
assert.Equal("*ab*", Unwrap("**ab**", "*"))
|
||||||
|
assert.Equal("ab", Unwrap("**ab**", "**"))
|
||||||
|
assert.Equal("ab", Unwrap("\"ab\"", "\""))
|
||||||
|
assert.Equal("*ab", Unwrap("*ab", "*"))
|
||||||
|
assert.Equal("ab*", Unwrap("ab*", "*"))
|
||||||
|
assert.Equal("*", Unwrap("***", "*"))
|
||||||
|
|
||||||
|
assert.Equal("", Unwrap("**", "*"))
|
||||||
|
assert.Equal("***", Unwrap("***", "**"))
|
||||||
|
assert.Equal("**", Unwrap("**", "**"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSplitEx(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestSplitEx")
|
||||||
|
|
||||||
|
assert.Equal([]string{}, SplitEx(" a b c ", "", true))
|
||||||
|
|
||||||
|
assert.Equal([]string{"", "a", "b", "c", ""}, SplitEx(" a b c ", " ", false))
|
||||||
|
assert.Equal([]string{"a", "b", "c"}, SplitEx(" a b c ", " ", true))
|
||||||
|
|
||||||
|
assert.Equal([]string{" a", "b", "c", ""}, SplitEx(" a = b = c = ", " = ", false))
|
||||||
|
assert.Equal([]string{" a", "b", "c"}, SplitEx(" a = b = c = ", " = ", true))
|
||||||
}
|
}
|
||||||
|
|||||||
78
system/os.go
Normal file
78
system/os.go
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
// Copyright 2021 dudaodong@gmail.com. All rights reserved.
|
||||||
|
// Use of this source code is governed by MIT license
|
||||||
|
|
||||||
|
// Package system contain some functions about os, runtime, shell command.
|
||||||
|
package system
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"runtime"
|
||||||
|
)
|
||||||
|
|
||||||
|
// IsWindows check if current os is windows
|
||||||
|
func IsWindows() bool {
|
||||||
|
return runtime.GOOS == "windows"
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsLinux check if current os is linux
|
||||||
|
func IsLinux() bool {
|
||||||
|
return runtime.GOOS == "linux"
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsMac check if current os is macos
|
||||||
|
func IsMac() bool {
|
||||||
|
return runtime.GOOS == "darwin"
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetOsEnv gets the value of the environment variable named by the key.
|
||||||
|
func GetOsEnv(key string) string {
|
||||||
|
return os.Getenv(key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetOsEnv sets the value of the environment variable named by the key.
|
||||||
|
func SetOsEnv(key, value string) error {
|
||||||
|
return os.Setenv(key, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOsEnv remove a single environment variable.
|
||||||
|
func RemoveOsEnv(key string) error {
|
||||||
|
return os.Unsetenv(key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareOsEnv gets env named by the key and compare it with comparedEnv
|
||||||
|
func CompareOsEnv(key, comparedEnv string) bool {
|
||||||
|
env := GetOsEnv(key)
|
||||||
|
if env == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return env == comparedEnv
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExecCommand use shell /bin/bash -c to execute command
|
||||||
|
func ExecCommand(command string) (stdout, stderr string, err error) {
|
||||||
|
var out bytes.Buffer
|
||||||
|
var errout bytes.Buffer
|
||||||
|
|
||||||
|
cmd := exec.Command("/bin/bash", "-c", command)
|
||||||
|
if IsWindows() {
|
||||||
|
cmd = exec.Command("cmd")
|
||||||
|
}
|
||||||
|
cmd.Stdout = &out
|
||||||
|
cmd.Stderr = &errout
|
||||||
|
err = cmd.Run()
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
stderr = string(errout.Bytes())
|
||||||
|
}
|
||||||
|
stdout = string(out.Bytes())
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetOsBits get this system bits 32bit or 64bit
|
||||||
|
// return bit int (32/64)
|
||||||
|
func GetOsBits() int {
|
||||||
|
return 32 << (^uint(0) >> 63)
|
||||||
|
}
|
||||||
72
system/os_test.go
Normal file
72
system/os_test.go
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
package system
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/duke-git/lancet/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestOsDetection(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestOsJudgment")
|
||||||
|
|
||||||
|
osType, _, _ := ExecCommand("echo $OSTYPE")
|
||||||
|
if strings.Index(osType, "linux") != -1 {
|
||||||
|
assert.Equal(true, IsLinux())
|
||||||
|
}
|
||||||
|
if strings.Index(osType, "darwin") != -1 {
|
||||||
|
assert.Equal(true, IsMac())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOsEnvOperation(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestOsEnvOperation")
|
||||||
|
|
||||||
|
envNotExist := GetOsEnv("foo")
|
||||||
|
assert.Equal("", envNotExist)
|
||||||
|
|
||||||
|
SetOsEnv("foo", "foo_value")
|
||||||
|
envExist := GetOsEnv("foo")
|
||||||
|
assert.Equal("foo_value", envExist)
|
||||||
|
|
||||||
|
assert.Equal(true, CompareOsEnv("foo", "foo_value"))
|
||||||
|
assert.Equal(false, CompareOsEnv("foo", "abc"))
|
||||||
|
assert.Equal(false, CompareOsEnv("abc", "abc"))
|
||||||
|
assert.Equal(false, CompareOsEnv("abc", "abc"))
|
||||||
|
|
||||||
|
err := RemoveOsEnv("foo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fail()
|
||||||
|
}
|
||||||
|
assert.Equal(false, CompareOsEnv("foo", "foo_value"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecCommand(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestExecCommand")
|
||||||
|
|
||||||
|
out, errout, err := ExecCommand("ls")
|
||||||
|
t.Log("std out: ", out)
|
||||||
|
t.Log("std err: ", errout)
|
||||||
|
assert.IsNil(err)
|
||||||
|
|
||||||
|
out, errout, err = ExecCommand("abc")
|
||||||
|
t.Log("std out: ", out)
|
||||||
|
t.Log("std err: ", errout)
|
||||||
|
if err != nil {
|
||||||
|
t.Logf("error: %v\n", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !IsWindows() {
|
||||||
|
assert.IsNotNil(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetOsBits(t *testing.T) {
|
||||||
|
osBits := GetOsBits()
|
||||||
|
switch osBits {
|
||||||
|
case 32, 64:
|
||||||
|
t.Logf("os is %d", osBits)
|
||||||
|
default:
|
||||||
|
t.Error("os is not 32 or 64 bits")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,17 +5,73 @@
|
|||||||
package validator
|
package validator
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
"net"
|
"net"
|
||||||
|
"net/url"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
"strings"
|
||||||
"unicode"
|
"unicode"
|
||||||
)
|
)
|
||||||
|
|
||||||
var isAlphaRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[a-zA-Z]+$`)
|
var isAlphaRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[a-zA-Z]+$`)
|
||||||
|
|
||||||
// IsAlpha checks if the string contains only letters (a-zA-Z)
|
// IsAlpha checks if the string contains only letters (a-zA-Z)
|
||||||
func IsAlpha(s string) bool {
|
func IsAlpha(str string) bool {
|
||||||
return isAlphaRegexMatcher.MatchString(s)
|
return isAlphaRegexMatcher.MatchString(str)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAllUpper check if the string is all upper case letters A-Z
|
||||||
|
func IsAllUpper(str string) bool {
|
||||||
|
for _, r := range str {
|
||||||
|
if !unicode.IsUpper(r) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return str != ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAllLower check if the string is all lower case letters a-z
|
||||||
|
func IsAllLower(str string) bool {
|
||||||
|
for _, r := range str {
|
||||||
|
if !unicode.IsLower(r) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return str != ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// ContainUpper check if the string contain at least one upper case letter A-Z
|
||||||
|
func ContainUpper(str string) bool {
|
||||||
|
for _, r := range str {
|
||||||
|
if unicode.IsUpper(r) && unicode.IsLetter(r) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// ContainLower check if the string contain at least one lower case letter A-Z
|
||||||
|
func ContainLower(str string) bool {
|
||||||
|
for _, r := range str {
|
||||||
|
if unicode.IsLower(r) && unicode.IsLetter(r) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
var containLetterRegexMatcher *regexp.Regexp = regexp.MustCompile(`[a-zA-Z]`)
|
||||||
|
|
||||||
|
// ContainLetter check if the string contain at least one letter
|
||||||
|
func ContainLetter(str string) bool {
|
||||||
|
return containLetterRegexMatcher.MatchString(str)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsJSON checks if the string is valid JSON
|
||||||
|
func IsJSON(str string) bool {
|
||||||
|
var js json.RawMessage
|
||||||
|
return json.Unmarshal([]byte(str), &js) == nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsNumberStr check if the string can convert to a number.
|
// IsNumberStr check if the string can convert to a number.
|
||||||
@@ -24,16 +80,16 @@ func IsNumberStr(s string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// IsFloatStr check if the string can convert to a float.
|
// IsFloatStr check if the string can convert to a float.
|
||||||
func IsFloatStr(s string) bool {
|
func IsFloatStr(str string) bool {
|
||||||
_, e := strconv.ParseFloat(s, 64)
|
_, e := strconv.ParseFloat(str, 64)
|
||||||
return e == nil
|
return e == nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var isIntStrRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[\+-]?\d+$`)
|
var isIntStrRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[\+-]?\d+$`)
|
||||||
|
|
||||||
// IsIntStr check if the string can convert to a integer.
|
// IsIntStr check if the string can convert to a integer.
|
||||||
func IsIntStr(s string) bool {
|
func IsIntStr(str string) bool {
|
||||||
return isIntStrRegexMatcher.MatchString(s)
|
return isIntStrRegexMatcher.MatchString(str)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsIp check if the string is a ip address.
|
// IsIp check if the string is a ip address.
|
||||||
@@ -48,13 +104,7 @@ func IsIpV4(ipstr string) bool {
|
|||||||
if ip == nil {
|
if ip == nil {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
for i := 0; i < len(ipstr); i++ {
|
return strings.Contains(ipstr, ".")
|
||||||
switch ipstr[i] {
|
|
||||||
case '.':
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsIpV6 check if the string is a ipv6 address.
|
// IsIpV6 check if the string is a ipv6 address.
|
||||||
@@ -63,15 +113,38 @@ func IsIpV6(ipstr string) bool {
|
|||||||
if ip == nil {
|
if ip == nil {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
for i := 0; i < len(ipstr); i++ {
|
return strings.Contains(ipstr, ":")
|
||||||
switch ipstr[i] {
|
}
|
||||||
case ':':
|
|
||||||
return true
|
// IsPort check if the string is a valid net port.
|
||||||
}
|
func IsPort(str string) bool {
|
||||||
|
if i, err := strconv.ParseInt(str, 10, 64); err == nil && i > 0 && i < 65536 {
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var isUrlRegexMatcher *regexp.Regexp = regexp.MustCompile(`^((ftp|http|https?):\/\/)?(\S+(:\S*)?@)?((([1-9]\d?|1\d\d|2[01]\d|22[0-3])(\.(1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.([0-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(([a-zA-Z0-9]+([-\.][a-zA-Z0-9]+)*)|((www\.)?))?(([a-z\x{00a1}-\x{ffff}0-9]+-?-?)*[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.([a-z\x{00a1}-\x{ffff}]{2,}))?))(:(\d{1,5}))?((\/|\?|#)[^\s]*)?$`)
|
||||||
|
|
||||||
|
// IsUrl check if the string is url.
|
||||||
|
func IsUrl(str string) bool {
|
||||||
|
if str == "" || len(str) >= 2083 || len(str) <= 3 || strings.HasPrefix(str, ".") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
u, err := url.Parse(str)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(u.Host, ".") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if u.Host == "" && (u.Path != "" && !strings.Contains(u.Path, ".")) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return isUrlRegexMatcher.MatchString(str)
|
||||||
|
}
|
||||||
|
|
||||||
var isDnsRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[a-zA-Z]([a-zA-Z0-9\-]+[\.]?)*[a-zA-Z0-9]$`)
|
var isDnsRegexMatcher *regexp.Regexp = regexp.MustCompile(`^[a-zA-Z]([a-zA-Z0-9\-]+[\.]?)*[a-zA-Z0-9]$`)
|
||||||
|
|
||||||
// IsDns check if the string is dns.
|
// IsDns check if the string is dns.
|
||||||
@@ -130,14 +203,14 @@ func IsBase64(base64 string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// IsEmptyString check if the string is empty.
|
// IsEmptyString check if the string is empty.
|
||||||
func IsEmptyString(s string) bool {
|
func IsEmptyString(str string) bool {
|
||||||
return len(s) == 0
|
return len(str) == 0
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsRegexMatch check if the string match the regexp
|
// IsRegexMatch check if the string match the regexp
|
||||||
func IsRegexMatch(s, regex string) bool {
|
func IsRegexMatch(str, regex string) bool {
|
||||||
reg := regexp.MustCompile(regex)
|
reg := regexp.MustCompile(regex)
|
||||||
return reg.MatchString(s)
|
return reg.MatchString(str)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsStrongPassword check if the string is strong password, if len(password) is less than the length param, return false
|
// IsStrongPassword check if the string is strong password, if len(password) is less than the length param, return false
|
||||||
|
|||||||
@@ -6,278 +6,276 @@ import (
|
|||||||
"github.com/duke-git/lancet/internal"
|
"github.com/duke-git/lancet/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestIsNumberStr(t *testing.T) {
|
func TestIsAllUpper(t *testing.T) {
|
||||||
isNumberStr(t, "3.", true)
|
assert := internal.NewAssert(t, "TestIsAllUpper")
|
||||||
isNumberStr(t, "+3.", true)
|
|
||||||
isNumberStr(t, "-3.", true)
|
assert.Equal(true, IsAllUpper("ABC"))
|
||||||
isNumberStr(t, "+3e2", true)
|
assert.Equal(false, IsAllUpper(""))
|
||||||
isNumberStr(t, "abc", false)
|
assert.Equal(false, IsAllUpper("abc"))
|
||||||
|
assert.Equal(false, IsAllUpper("aBC"))
|
||||||
|
assert.Equal(false, IsAllUpper("1BC"))
|
||||||
|
assert.Equal(false, IsAllUpper("1bc"))
|
||||||
|
assert.Equal(false, IsAllUpper("123"))
|
||||||
|
assert.Equal(false, IsAllUpper("你好"))
|
||||||
|
assert.Equal(false, IsAllUpper("A&"))
|
||||||
|
assert.Equal(false, IsAllUpper("&@#$%^&*"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func isNumberStr(t *testing.T, source string, expected bool) {
|
func TestIsAllLower(t *testing.T) {
|
||||||
res := IsNumberStr(source)
|
assert := internal.NewAssert(t, "TestIsAllLower")
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsNumberStr", source, expected, res)
|
assert.Equal(true, IsAllLower("abc"))
|
||||||
t.FailNow()
|
assert.Equal(false, IsAllLower("ABC"))
|
||||||
}
|
assert.Equal(false, IsAllLower(""))
|
||||||
|
assert.Equal(false, IsAllLower("aBC"))
|
||||||
|
assert.Equal(false, IsAllLower("1BC"))
|
||||||
|
assert.Equal(false, IsAllLower("1bc"))
|
||||||
|
assert.Equal(false, IsAllLower("123"))
|
||||||
|
assert.Equal(false, IsAllLower("你好"))
|
||||||
|
assert.Equal(false, IsAllLower("A&"))
|
||||||
|
assert.Equal(false, IsAllLower("&@#$%^&*"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestContainLower(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestContainLower")
|
||||||
|
|
||||||
|
assert.Equal(true, ContainLower("abc"))
|
||||||
|
assert.Equal(true, ContainLower("aBC"))
|
||||||
|
assert.Equal(true, ContainLower("1bc"))
|
||||||
|
assert.Equal(true, ContainLower("a&"))
|
||||||
|
|
||||||
|
assert.Equal(false, ContainLower("ABC"))
|
||||||
|
assert.Equal(false, ContainLower(""))
|
||||||
|
assert.Equal(false, ContainLower("1BC"))
|
||||||
|
assert.Equal(false, ContainLower("123"))
|
||||||
|
assert.Equal(false, ContainLower("你好"))
|
||||||
|
assert.Equal(false, ContainLower("&@#$%^&*"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestContainUpper(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestContainUpper")
|
||||||
|
|
||||||
|
assert.Equal(true, ContainUpper("ABC"))
|
||||||
|
assert.Equal(true, ContainUpper("aBC"))
|
||||||
|
assert.Equal(true, ContainUpper("1BC"))
|
||||||
|
assert.Equal(true, ContainUpper("A&"))
|
||||||
|
|
||||||
|
assert.Equal(false, ContainUpper("abc"))
|
||||||
|
assert.Equal(false, ContainUpper(""))
|
||||||
|
assert.Equal(false, ContainUpper("1bc"))
|
||||||
|
assert.Equal(false, ContainUpper("123"))
|
||||||
|
assert.Equal(false, ContainUpper("你好"))
|
||||||
|
assert.Equal(false, ContainUpper("&@#$%^&*"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestContainLetter(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestContainLetter")
|
||||||
|
|
||||||
|
assert.Equal(true, ContainLetter("ABC"))
|
||||||
|
assert.Equal(true, ContainLetter("1Bc"))
|
||||||
|
assert.Equal(true, ContainLetter("1ab"))
|
||||||
|
assert.Equal(true, ContainLetter("A&"))
|
||||||
|
|
||||||
|
assert.Equal(false, ContainLetter(""))
|
||||||
|
assert.Equal(false, ContainLetter("123"))
|
||||||
|
assert.Equal(false, ContainLetter("你好"))
|
||||||
|
assert.Equal(false, ContainLetter("&@#$%^&*"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsJSON(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsJSON")
|
||||||
|
|
||||||
|
assert.Equal(true, IsJSON("{}"))
|
||||||
|
assert.Equal(true, IsJSON("{\"name\": \"test\"}"))
|
||||||
|
assert.Equal(true, IsJSON("[]"))
|
||||||
|
assert.Equal(true, IsJSON("123"))
|
||||||
|
|
||||||
|
assert.Equal(false, IsJSON(""))
|
||||||
|
assert.Equal(false, IsJSON("abc"))
|
||||||
|
assert.Equal(false, IsJSON("你好"))
|
||||||
|
assert.Equal(false, IsJSON("&@#$%^&*"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsNumberStr(t *testing.T) {
|
||||||
|
assert := internal.NewAssert(t, "TestIsNumberStr")
|
||||||
|
|
||||||
|
assert.Equal(true, IsNumberStr("3."))
|
||||||
|
assert.Equal(true, IsNumberStr("+3."))
|
||||||
|
assert.Equal(true, IsNumberStr("-3."))
|
||||||
|
assert.Equal(true, IsNumberStr("+3e2"))
|
||||||
|
assert.Equal(false, IsNumberStr("abc"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsFloatStr(t *testing.T) {
|
func TestIsFloatStr(t *testing.T) {
|
||||||
isFloatStr(t, "3.", true)
|
assert := internal.NewAssert(t, "TestIsFloatStr")
|
||||||
isFloatStr(t, "+3.", true)
|
|
||||||
isFloatStr(t, "-3.", true)
|
|
||||||
isFloatStr(t, "12", true)
|
|
||||||
isFloatStr(t, "abc", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isFloatStr(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsFloatStr("3."))
|
||||||
res := IsFloatStr(source)
|
assert.Equal(true, IsFloatStr("+3."))
|
||||||
if res != expected {
|
assert.Equal(true, IsFloatStr("-3."))
|
||||||
internal.LogFailedTestInfo(t, "IsFloatStr", source, expected, res)
|
assert.Equal(true, IsFloatStr("12"))
|
||||||
t.FailNow()
|
assert.Equal(false, IsFloatStr("abc"))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsIntStr(t *testing.T) {
|
func TestIsIntStr(t *testing.T) {
|
||||||
isIntStr(t, "+3", true)
|
assert := internal.NewAssert(t, "TestIsIntStr")
|
||||||
isIntStr(t, "-3", true)
|
|
||||||
isIntStr(t, "3.", false)
|
assert.Equal(true, IsIntStr("+3"))
|
||||||
isIntStr(t, "abc", false)
|
assert.Equal(true, IsIntStr("-3"))
|
||||||
|
assert.Equal(false, IsIntStr("3."))
|
||||||
|
assert.Equal(false, IsIntStr("abc"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func isIntStr(t *testing.T, source string, expected bool) {
|
func TestIsPort(t *testing.T) {
|
||||||
res := IsIntStr(source)
|
assert := internal.NewAssert(t, "TestIsPort")
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsIntStr", source, expected, res)
|
assert.Equal(true, IsPort("1"))
|
||||||
t.FailNow()
|
assert.Equal(true, IsPort("65535"))
|
||||||
}
|
assert.Equal(false, IsPort("abc"))
|
||||||
|
assert.Equal(false, IsPort("123abc"))
|
||||||
|
assert.Equal(false, IsPort(""))
|
||||||
|
assert.Equal(false, IsPort("-1"))
|
||||||
|
assert.Equal(false, IsPort("65536"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsIp(t *testing.T) {
|
func TestIsIp(t *testing.T) {
|
||||||
isIp(t, "127.0.0.1", true)
|
assert := internal.NewAssert(t, "TestIsIntStr")
|
||||||
isIp(t, "::0:0:0:0:0:0:1", true)
|
|
||||||
isIp(t, "120.0.0", false)
|
|
||||||
isIp(t, "abc", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isIp(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsIp("127.0.0.1"))
|
||||||
res := IsIp(source)
|
assert.Equal(true, IsIp("::0:0:0:0:0:0:1"))
|
||||||
if res != expected {
|
assert.Equal(false, IsIp("127.0.0"))
|
||||||
internal.LogFailedTestInfo(t, "IsIp", source, expected, res)
|
assert.Equal(false, IsIp("127"))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsIpV4(t *testing.T) {
|
func TestIsIpV4(t *testing.T) {
|
||||||
isIpV4(t, "127.0.0.1", true)
|
assert := internal.NewAssert(t, "TestIsIpV4")
|
||||||
isIpV4(t, "::0:0:0:0:0:0:1", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isIpV4(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsIpV4("127.0.0.1"))
|
||||||
res := IsIpV4(source)
|
assert.Equal(false, IsIpV4("::0:0:0:0:0:0:1"))
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsIpV4", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsIpV6(t *testing.T) {
|
func TestIsIpV6(t *testing.T) {
|
||||||
isIpV6(t, "127.0.0.1", false)
|
assert := internal.NewAssert(t, "TestIsIpV6")
|
||||||
isIpV6(t, "::0:0:0:0:0:0:1", true)
|
|
||||||
|
assert.Equal(false, IsIpV6("127.0.0.1"))
|
||||||
|
assert.Equal(true, IsIpV6("::0:0:0:0:0:0:1"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func isIpV6(t *testing.T, source string, expected bool) {
|
func TestIsUrl(t *testing.T) {
|
||||||
res := IsIpV6(source)
|
assert := internal.NewAssert(t, "TestIsUrl")
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsIpV6", source, expected, res)
|
assert.Equal(true, IsUrl("http://abc.com"))
|
||||||
t.FailNow()
|
assert.Equal(true, IsUrl("abc.com"))
|
||||||
}
|
assert.Equal(true, IsUrl("a.b.com"))
|
||||||
|
assert.Equal(false, IsUrl("abc"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsDns(t *testing.T) {
|
func TestIsDns(t *testing.T) {
|
||||||
isDns(t, "abc.com", true)
|
assert := internal.NewAssert(t, "TestIsDns")
|
||||||
isDns(t, "a.b.com", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isDns(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsDns("abc.com"))
|
||||||
res := IsDns(source)
|
assert.Equal(false, IsDns("a.b.com"))
|
||||||
if res != expected {
|
assert.Equal(false, IsDns("http://abc.com"))
|
||||||
internal.LogFailedTestInfo(t, "IsDns", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsEmail(t *testing.T) {
|
func TestIsEmail(t *testing.T) {
|
||||||
isEmail(t, "abc@xyz.com", true)
|
assert := internal.NewAssert(t, "TestIsEmail")
|
||||||
isEmail(t, "a.b@@com", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isEmail(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsEmail("abc@xyz.com"))
|
||||||
res := IsEmail(source)
|
assert.Equal(false, IsEmail("a.b@@com"))
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsEmail", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestContainChinese(t *testing.T) {
|
func TestContainChinese(t *testing.T) {
|
||||||
containChinese(t, "你好", true)
|
assert := internal.NewAssert(t, "TestContainChinese")
|
||||||
containChinese(t, "hello", false)
|
|
||||||
containChinese(t, "hello你好", true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func containChinese(t *testing.T, source string, expected bool) {
|
assert.Equal(true, ContainChinese("你好"))
|
||||||
res := ContainChinese(source)
|
assert.Equal(true, ContainChinese("你好hello"))
|
||||||
if res != expected {
|
assert.Equal(false, ContainChinese("hello"))
|
||||||
internal.LogFailedTestInfo(t, "IsContainChineseChar", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsChineseMobile(t *testing.T) {
|
func TestIsChineseMobile(t *testing.T) {
|
||||||
isChineseMobile(t, "13263527980", true)
|
assert := internal.NewAssert(t, "TestIsChineseMobile")
|
||||||
isChineseMobile(t, "434324324", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isChineseMobile(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsChineseMobile("13263527980"))
|
||||||
res := IsChineseMobile(source)
|
assert.Equal(false, IsChineseMobile("434324324"))
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsChineseMobile", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsChinesePhone(t *testing.T) {
|
func TestIsChinesePhone(t *testing.T) {
|
||||||
isChinesePhone(t, "010-32116675", true)
|
assert := internal.NewAssert(t, "TestIsChinesePhone")
|
||||||
isChinesePhone(t, "0464-8756213", true)
|
|
||||||
isChinesePhone(t, "123-87562", false)
|
assert.Equal(true, IsChinesePhone("010-32116675"))
|
||||||
}
|
assert.Equal(true, IsChinesePhone("0464-8756213"))
|
||||||
|
assert.Equal(false, IsChinesePhone("123-87562"))
|
||||||
|
|
||||||
func isChinesePhone(t *testing.T, source string, expected bool) {
|
|
||||||
res := IsChinesePhone(source)
|
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsChinesePhone", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsChineseIdNum(t *testing.T) {
|
func TestIsChineseIdNum(t *testing.T) {
|
||||||
isChineseIdNum(t, "210911192105130715", true)
|
assert := internal.NewAssert(t, "TestIsChineseIdNum")
|
||||||
isChineseIdNum(t, "21091119210513071X", true)
|
|
||||||
isChineseIdNum(t, "21091119210513071x", true)
|
|
||||||
isChineseIdNum(t, "123456", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isChineseIdNum(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsChineseIdNum("210911192105130715"))
|
||||||
res := IsChineseIdNum(source)
|
assert.Equal(true, IsChineseIdNum("21091119210513071X"))
|
||||||
if res != expected {
|
assert.Equal(true, IsChineseIdNum("21091119210513071x"))
|
||||||
internal.LogFailedTestInfo(t, "IsChineseIdNum", source, expected, res)
|
assert.Equal(false, IsChineseIdNum("123456"))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsCreditCard(t *testing.T) {
|
func TestIsCreditCard(t *testing.T) {
|
||||||
isCreditCard(t, "4111111111111111", true)
|
assert := internal.NewAssert(t, "TestIsCreditCard")
|
||||||
isCreditCard(t, "123456", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isCreditCard(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsCreditCard("4111111111111111"))
|
||||||
res := IsCreditCard(source)
|
assert.Equal(false, IsCreditCard("123456"))
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsCreditCard", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsBase64(t *testing.T) {
|
func TestIsBase64(t *testing.T) {
|
||||||
isBase64(t, "aGVsbG8=", true)
|
assert := internal.NewAssert(t, "TestIsBase64")
|
||||||
isBase64(t, "123456", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isBase64(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsBase64("aGVsbG8="))
|
||||||
res := IsBase64(source)
|
assert.Equal(false, IsBase64("123456"))
|
||||||
if res != expected {
|
|
||||||
internal.LogFailedTestInfo(t, "IsBase64", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsEmptyString(t *testing.T) {
|
func TestIsEmptyString(t *testing.T) {
|
||||||
isEmptyString(t, "111", false)
|
assert := internal.NewAssert(t, "TestIsEmptyString")
|
||||||
isEmptyString(t, " ", false)
|
|
||||||
isEmptyString(t, "\t", false)
|
|
||||||
isEmptyString(t, "", true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isEmptyString(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsEmptyString(""))
|
||||||
res := IsEmptyString(source)
|
assert.Equal(false, IsEmptyString("111"))
|
||||||
if res != expected {
|
assert.Equal(false, IsEmptyString(" "))
|
||||||
internal.LogFailedTestInfo(t, "IsEmptyString", source, expected, res)
|
assert.Equal(false, IsEmptyString("\t"))
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsAlpha(t *testing.T) {
|
func TestIsAlpha(t *testing.T) {
|
||||||
isAlpha(t, "abc", true)
|
assert := internal.NewAssert(t, "TestIsAlpha")
|
||||||
isAlpha(t, "111", false)
|
|
||||||
isAlpha(t, " ", false)
|
|
||||||
isAlpha(t, "\t", false)
|
|
||||||
isAlpha(t, "", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isAlpha(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsAlpha("abc"))
|
||||||
res := IsAlpha(source)
|
assert.Equal(false, IsAlpha("111"))
|
||||||
if res != expected {
|
assert.Equal(false, IsAlpha(" "))
|
||||||
internal.LogFailedTestInfo(t, "IsAlpha", source, expected, res)
|
assert.Equal(false, IsAlpha("\t"))
|
||||||
t.FailNow()
|
assert.Equal(false, IsAlpha(""))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsRegexMatch(t *testing.T) {
|
func TestIsRegexMatch(t *testing.T) {
|
||||||
isRegexMatch(t, "abc", `^[a-zA-Z]+$`, true)
|
assert := internal.NewAssert(t, "TestIsRegexMatch")
|
||||||
isRegexMatch(t, "1ab", `^[a-zA-Z]+$`, false)
|
|
||||||
isRegexMatch(t, "111", `^[a-zA-Z]+$`, false)
|
|
||||||
isRegexMatch(t, "", `^[a-zA-Z]+$`, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isRegexMatch(t *testing.T, source, regex string, expected bool) {
|
assert.Equal(true, IsRegexMatch("abc", `^[a-zA-Z]+$`))
|
||||||
res := IsRegexMatch(source, regex)
|
assert.Equal(false, IsRegexMatch("1ab", `^[a-zA-Z]+$`))
|
||||||
if res != expected {
|
assert.Equal(false, IsRegexMatch("", `^[a-zA-Z]+$`))
|
||||||
internal.LogFailedTestInfo(t, "IsRegexMatch", source, expected, res)
|
|
||||||
t.FailNow()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsStrongPassword(t *testing.T) {
|
func TestIsStrongPassword(t *testing.T) {
|
||||||
isStrongPassword(t, "abc", 3, false)
|
assert := internal.NewAssert(t, "TestIsStrongPassword")
|
||||||
isStrongPassword(t, "abc123", 6, false)
|
|
||||||
isStrongPassword(t, "abcABC", 6, false)
|
|
||||||
isStrongPassword(t, "abc123@#$", 9, false)
|
|
||||||
isStrongPassword(t, "abcABC123@#$", 16, false)
|
|
||||||
isStrongPassword(t, "abcABC123@#$", 12, true)
|
|
||||||
isStrongPassword(t, "abcABC123@#$", 10, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isStrongPassword(t *testing.T, source string, length int, expected bool) {
|
assert.Equal(false, IsStrongPassword("abc", 3))
|
||||||
res := IsStrongPassword(source, length)
|
assert.Equal(false, IsStrongPassword("abc123", 6))
|
||||||
if res != expected {
|
assert.Equal(false, IsStrongPassword("abcABC", 6))
|
||||||
internal.LogFailedTestInfo(t, "IsStrongPassword", source, expected, res)
|
assert.Equal(false, IsStrongPassword("abc123@#$", 9))
|
||||||
t.FailNow()
|
assert.Equal(false, IsStrongPassword("abcABC123@#$", 16))
|
||||||
}
|
assert.Equal(true, IsStrongPassword("abcABC123@#$", 12))
|
||||||
|
assert.Equal(true, IsStrongPassword("abcABC123@#$", 10))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIsWeakPassword(t *testing.T) {
|
func TestIsWeakPassword(t *testing.T) {
|
||||||
isWeakPassword(t, "abc", true)
|
assert := internal.NewAssert(t, "TestIsWeakPassword")
|
||||||
isWeakPassword(t, "123", true)
|
|
||||||
isWeakPassword(t, "abc123", true)
|
|
||||||
isWeakPassword(t, "abcABC123", true)
|
|
||||||
isWeakPassword(t, "abc123@#$", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func isWeakPassword(t *testing.T, source string, expected bool) {
|
assert.Equal(true, IsWeakPassword("abc"))
|
||||||
res := IsWeakPassword(source)
|
assert.Equal(true, IsWeakPassword("123"))
|
||||||
if res != expected {
|
assert.Equal(true, IsWeakPassword("abc123"))
|
||||||
internal.LogFailedTestInfo(t, "IsWeakPassword", source, expected, res)
|
assert.Equal(true, IsWeakPassword("abcABC123"))
|
||||||
t.FailNow()
|
assert.Equal(false, IsWeakPassword("abc123@#$"))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user