git/lancet
1
0
Fork 0
mirror of https://github.com/duke-git/lancet.git synced 2026-02-09 07:02:29 +08:00
Code Issues Projects Releases Wiki Activity
Files
ae92ae766658481c9b5fb08e4b5bd15d2fbef3a2
lancet/README_zh-CN.md
dudaodong 526e568d0e doc: add doc for Substring
2022-12-29 20:03:59 +08:00

38 KiB
Raw Blame History


Go version Release GoDoc Go Report Card test codecov License

lancet（柳叶刀）是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。

简体中文 | English

特性

  • 👏 全面、高效、可复用
  • 💪 300+常用 go 工具函数，支持 string、slice、datetime、net、crypt...
  • 💅 只依赖 go 标准库
  • 🌍 所有导出函数单元测试覆盖率 100%

安装

Note:

  1. 使用go1.18及以上版本的用户，建议安装v2.x.x。 因为v2.x.x应用go1.18的泛型重写了大部分函数。
go get github.com/duke-git/lancet/v2 //安装v2最新版本v2.x.x
  1. 使用go1.18以下版本的用户，必须安装v1.x.x。目前最新的v1版本是v1.3.5。
go get github.com/duke-git/lancet@v1.3.5 // 使用go1.18以下版本, 必须安装v1.x.x版本

用法

lancet 是以包的结构组织代码的，使用时需要导入相应的包名。例如：如果使用字符串相关函数，需要导入 strutil 包:

import "github.com/duke-git/lancet/v2/strutil"

例子

此处以字符串工具函数 Reverse（逆序字符串）为例，需要导入 strutil 包:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/v2/strutil"
)

func main() {
    s := "hello"
    rs := strutil.Reverse(s)
    fmt.Println(rs) //olleh
}

文档

1. algorithm包实现一些基本查找和排序算法。

import "github.com/duke-git/lancet/v2/algorithm"

Function list:

  • BubbleSort : 使用冒泡排序算法对切片进行排序。 [doc] [play]
  • CountSort : 使用计数排序算法对切片进行排序。不改变原数据。 [doc] [play]
  • HeapSort : 使用堆排序算法对切片进行排序。 [doc] [play]
  • InsertionSort : 使用插入排序算法对切片进行排序。 [doc] [play]
  • MergeSort : 使用合并排序算法对切片进行排序。 [doc] [play]
  • QuickSort : 使用快速排序算法对切片进行排序。 [doc] [play]
  • SelectionSort : 使用选择排序算法对切片进行排序。 [doc] [play]
  • ShellSort : 使用希尔排序算法对切片进行排序。 [doc] [play]
  • BinarySearch : 返回排序切片中目标值的索引，使用二分搜索（递归调用）。 [doc] [play]
  • BinaryIterativeSearch :返回排序切片中目标值的索引，使用二分搜索（非递归）。 [doc] [play]
  • LinearSearch : 基于传入的相等函数返回切片中目标值的索引。（线性查找） [doc]
  • LRUCache : 应用lru算法实现内存缓存. [doc] [play]

2. concurrency包含一些支持并发编程的功能。例如：goroutine, channel, async 等。

import "github.com/duke-git/lancet/v2/concurrency"

Function list:

3. condition包含一些用于条件判断的函数。

import "github.com/duke-git/lancet/v2/condition"

Function list:

4. convertor 转换器包支持一些常见的数据类型转换。

import "github.com/duke-git/lancet/v2/convertor"

函数列表:

5. cryptor 加密包支持数据加密和解密，获取md5，hash 值。支持base64, md5, hmac, aes, des, rsa。

import "github.com/duke-git/lancet/v2/cryptor"

函数列表:

6. datetime 日期时间处理包，格式化日期，比较日期。

import "github.com/duke-git/lancet/v2/datetime"

函数列表:

7. datastructure 包含一些普通的数据结构实现。例如：list, linklist, stack, queue, set, tree, graph.

import list "github.com/duke-git/lancet/v2/datastructure/list"
import link "github.com/duke-git/lancet/v2/datastructure/link"
import stack "github.com/duke-git/lancet/v2/datastructure/stack"
import queue "github.com/duke-git/lancet/v2/datastructure/queue"
import set "github.com/duke-git/lancet/v2/datastructure/set"
import tree "github.com/duke-git/lancet/v2/datastructure/tree"
import heap "github.com/duke-git/lancet/v2/datastructure/heap"
import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"

Function list:

8. fileutil 包含文件基本操作。

import "github.com/duke-git/lancet/v2/fileutil"

函数列表：

9. formatter 格式化器包含一些数据格式化处理方法。

import "github.com/duke-git/lancet/v2/formatter"

函数列表:

10. function 函数包控制函数执行流程，包含部分函数式编程。

import "github.com/duke-git/lancet/v2/function"

函数列表:

11. maputil包括一些操作map的函数.

import "github.com/duke-git/lancet/v2/maputil"

函数列表:

12. mathutil包实现了一些数学计算的函数。

import "github.com/duke-git/lancet/v2/mathutil"

Function list:

13. netutil网络包支持获取ip地址，发送http请求。

import "github.com/duke-git/lancet/v2/netutil"

函数列表:

14. random随机数生成器包，可以生成随机[]bytes, int, string。

import "github.com/duke-git/lancet/v2/random"

函数列表:

15. retry重试执行函数直到函数运行成功或被context cancel。

import "github.com/duke-git/lancet/v2/retry"

函数列表:

16. slice包含操作切片的方法集合。

import "github.com/duke-git/lancet/v2/slice"

函数列表:

17. strutil包含字符串处理的相关函数。

import "github.com/duke-git/lancet/v2/strutil"

函数列表:

  • After : 返回源字符串中指定字符串首次出现时的位置之后的子字符串。 [doc] [play]
  • AfterLast : 返回源字符串中指定字符串最后一次出现时的位置之后的子字符串。 [doc] [play]
  • Before : 返回源字符串中指定字符串第一次出现时的位置之前的子字符串。 [doc] [play]
  • BeforeLast : 返回源字符串中指定字符串最后一次出现时的位置之前的子字符串。 [doc] [play]
  • CamelCase : 将字符串转换为CamelCase驼峰式字符串, 非字母和数字会被忽略。 [doc] [play]
  • Capitalize : 将字符串的第一个字符转换为大写。 [doc] [play]
  • IsString : 判断传入参数的数据类型是否为字符串。 [doc] [play]
  • KebabCase : 将字符串转换为kebab-case形式字符串, 非字母和数字会被忽略。 [doc] [play]
  • UpperKebabCase : 将字符串转换为大写KEBAB-CASE形式字符串, 非字母和数字会被忽略。 [doc] [play]
  • LowerFirst : 将字符串的第一个字符转换为小写形式。 [doc] [play]
  • UpperFirst : 将字符串的第一个字符转换为大写形式。 [doc] [play]
  • PadEnd : 如果字符串短于限制大小，则在右侧用给定字符填充字符串。 如果填充字符超出大小，它们将被截断。 [doc] [play]
  • PadStart : 如果字符串短于限制大小，则在左侧用给定字符填充字符串。 如果填充字符超出大小，它们将被截断。 [doc] [play]
  • Reverse : 返回字符顺序与给定字符串相反的字符串。 [doc] [play]
  • SnakeCase : 将字符串转换为snake_case形式, 非字母和数字会被忽略。 [doc] [play]
  • UpperSnakeCase : 将字符串转换为大写SNAKE_CASE形式, 非字母和数字会被忽略。 [doc] [play]
  • SplitEx : 拆分给定的字符串可以控制结果切片是否包含空字符串。 [doc] [play]
  • Substring : 根据指定的位置和长度截取子字符串。 [doc]
  • Wrap : 用给定字符包裹传入的字符串 [doc] [play]
  • Unwrap : 从另一个字符串中解开一个给定的字符串。 将更改源字符串。 [doc] [play]

18. system包含os, runtime, shell command的相关函数。

import "github.com/duke-git/lancet/v2/system"

函数列表:

19. validator验证器包，包含常用字符串格式验证函数。

import "github.com/duke-git/lancet/v2/validator"

函数列表:

20. xerror包实现一些错误处理函数

import "github.com/duke-git/lancet/v2/xerror"

函数列表:

如何贡献代码

非常感激任何的代码提交以使 lancet 的功能越来越强大。创建 pull request 时请遵守以下规则。

  1. Fork lancet 仓库。
  2. 创建自己的特性分支。
  3. 提交变更。
  4. Push 分支。
  5. 创建新的 pull request。
Reference in New Issue View Git Blame Copy Permalink