Update readme

Author: willzhen

README.md

@@ -1,35 +1,39 @@
-# GO library
-- client：调用第三方服务的客户端。
-  - ti: ti 平台客户端。
-    - ti3.4
-    - ti3.7
-- httpcall：http 调用的封装。
-  - json_post.go: JsonPost。
-  - json_get.go: JsonGet。
-  - json_put.go: JsonPut。
-  - json_delete.go: JsonDelete。
-- misc：常用的公共函数库
-  - time_related：时间相关的函数
-    - time_tick.go: TimeTick -- 计时器。
-    - timed.go: Timed -- 函数计时调用。
-  - goroutine_help.go：
-    - GoroutineHelp.Recoverd：协程 recover。
-    - GoroutineHelp.SafeGo：安全的 go。
-  - retry.go： Retry -- 带重试调用。
-  - id.go：
-    - GenerateRandomString：生成随机字符串。
-    - GenerateUUID：生成UUID。
-    - BighumpToUnderscore：大驼峰参数转换成下划线。
-    - UnderscoreToBighump：下划线参数转换成大驼峰。
-  - log.og
-    - FoldLog: 折叠日志中数据过长的字段，仅支持 json。
-- stl_extension：stl 的扩展
-  - limit_waitgroup.go：LimitWaitGroup -- 对于系统 WaitGroup 的扩展，支持 limit 并发限制并且阻塞。
-  - ordered_map.go：OrderedMap -- 实现了 c++ 中的排序 map，可以按照顺序遍历所有元素。
-- text: 文本处理相关方法
-  - aho_automaton.go：ac 自动机，多模式串快速匹配。在一个文本中找出来，出现过哪些字符串子串以及其定位。可以理解对同一文本 s 多次调用 strings.Contains(s, xxx) 的加速。
-    - BuildAcTrie: 构建自动机。
-    - AcTrie.Search: 匹配。
-  - edit_distance.go：
-    - Levenshtein：文本编辑距离。
-    - TextSim：计算两个文本的相似度。
+- [go common library](#go-common-library)
+  - [httpcall 模块](#httpcall-模块)
+  - [misc 模块](#misc-模块)
+  - [stl\_extension 模块](#stl_extension-模块)
+  - [text 模块](#text-模块)
+  - [任务调度模块](#任务调度模块)
+
+# go common library
+本仓库整理了 golang 中最常用的代码、函数、和模块。
+
+## httpcall 模块
+常用的简单 http 调用的封装。
+详见 [httpcall 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/httpcall/readme.md)。
+
+## misc 模块
+常用的公共函数库，主要包含时间、协程安全、重试、id生成，log 相关的常用的处理函数。
+详见[misc 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/misc/readme.md)。
+
+## stl_extension 模块
+针对 golang 现有的 stl 的不足的扩展。主要是对 WaitGroup 和 map 的扩展。
+- LimitWaitGroup -- 对于系统 WaitGroup 的扩展，支持 limit 并发限制并且阻塞。
+- OrderedMap -- 实现了 c++ 中的排序 map，可以按照顺序遍历所有元素。
+
+
+详见[stl_extension 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/stl_extension/readme.md)。
+
+## text 模块
+常用文本处理相关方法。
+- AcTrie：ac 自动机，多模式串快速匹配。在一个文本中快速找出来出现过哪些字符串子串以及其定位。可以理解对同一文本 s 多次调用 strings.Contains(s, xxx) 的加速。
+- Levenshtein：计算文本编辑距离。
+- TextSim：计算两个文本的相似度。
+
+
+详见[text 模块说明](https://github.com/memory-overflow/go-common-library/blob/main/text/readme.md)。
+
+
+## 任务调度模块
+任务调度模块在 go 语言中，提供了一个轻量级的任务调度框架，方便对各种同步、异步任务做统一的任务调度。致力于提高构建一套任务管理调度系统的效率。
+详见[任务调度框架设计原理和使用说明](https://github.com/memory-overflow/go-common-library/blob/main/task_scheduler/readme.md) 。

httpcall/readme.md

@@ -1,11 +1,7 @@
 # http 最常用的 json 协议调用封装
-- json_post.go: JsonPost。
-- json_get.go: JsonGet。
-- json_put.go: JsonPut。
-- json_delete.go: JsonDelete。
+4个方法, JsonPost、JsonGet、JsonPut、JsonDelete。
 
-
-example: https://github.com/memory-overflow/go-common-library/httpcall/httpcall_test.go
+example: [httpcall_test.go](https://github.com/memory-overflow/go-common-library/blob/main/httpcall/httpcall_test.go)
 ```go
 import (
 	"context"

misc/readme.md

@@ -1,4 +1,10 @@
-[TOC]
+- [misc 模块说明](#misc-模块说明)
+  - [time\_related 模块](#time_related-模块)
+  - [download 模块](#download-模块)
+  - [goroutine\_help 模块](#goroutine_help-模块)
+  - [retry](#retry)
+  - [id 生成器](#id-生成器)
+  - [log](#log)
 
 # misc 模块说明
 

stl_extension/readme.md

@@ -0,0 +1,120 @@
+- [stl\_extension 模块](#stl_extension-模块)
+  - [LimitWaitGroup](#limitwaitgroup)
+  - [OrderedMap](#orderedmap)
+
+# stl_extension 模块
+
+stl_extension 模块主要是对系统的 stl 的不足做补充。
+
+## LimitWaitGroup
+对原生 stl 的 WaitGroup 做补充，原生的 WaitGroup 没有办法限制协程的数量，比如如下处理，
+```go
+group := sync.WaitGroup{}
+for i := 0; i < 10000; i++ {
+  v := i
+  group.Add(1)
+  go func() {
+    defer group.Done()
+    fmt.Print(v)
+  }()
+}
+group.Wait()
+```
+会在一瞬间创建大量的协程。而用 LimitWaitGroup，可以实现限制并发的协程数量。
+
+```go
+// 10 协程并发
+group := stlextension.NewLimitWaitGroup(10)
+for i := 0; i < 10000; i++ {
+  v := i
+  // 如果协程并发满了，会阻塞等待
+  group.Add(1)
+  go func() {
+    defer group.Done()
+    fmt.Print(v)
+  }()
+}
+group.Wait()
+```
+
+## OrderedMap
+golang stl 原生的 map 是基于 hash 的无需 map，OrderedMap 是对 hash map 的补充。支持按照 key 顺序遍历。
+OrderedMap 使用 avl 树实现，是线程安全的。
+和 c++ map 对比测试，1000 万的随机的增删查操作：
+OrderedMap: 21806 ms, c++ map: 11592ms，效率比 c++ map 慢两倍。
+next 遍历整个 map, OrderedMap: 676ms, c++ map: 171ms；
+prev 遍历整个 map, OrderedMap: 663ms, c++ map: 198ms；
+遍历的效率大概比 c++ map 的慢三倍。
+
+用法：
+- 构建
+```go
+m := stlextension.OrderedMap{}
+```
+
+- 判断 map 是否为空
+```go
+m.Empty()
+```
+
+- 插入: 插入的 key 必须实现 stlextension.Key Less interface，也就是必须要实现比较方法，value 可以是任意 interface{}。如果插入的 key 和其他之前插入的旧的 key 比较的时候失败，插入也会失败。
+
+```go
+err := m.Insert(stlextension.IntKey(5), "BBB");
+```
+
+- 删除：插入的 key 必须实现 stlextension.Key Less interface，也就是必须要实现比较方法。
+```go
+err := m.Erase(stlextension.IntKey(5));
+```
+
+- 计数：计算 map 中的 key 的数量。
+```go
+num, err := m.Count(stlextension.IntKey(4))
+```
+
+- Find: 寻找 key 的 value。
+```go
+value, exixt, err := m.Find(stlextension.IntKey(5))
+```
+
+- Begin: Begin 获取 key 最小的元素的 key 和 value，配合 Next 进行迭代。
+- Next: 按照 key 的顺序获取当前 key 的下一个 key 和 value。
+```go
+// test begin and next
+for key, value := m.Begin(); key != nil; key, value, err = m.Next(key) {
+  if err != nil {
+    log.Fatalf("test next error: %v", err)
+  }
+  log.Printf("key: %v, value: %v", key, value)
+}
+```
+
+- RBegin: RBegin 获取 key 最大的元素的 key 和 value，配合 Prev 进行方向迭代。
+- Prev: 按照 key 的顺序获取当前 key 的前一个 key 和 value。
+```go
+// test rbegin and prev
+for key, value := m.RBegin(); key != nil; key, value, err = m.Prev(key) {
+  if err != nil {
+    log.Fatalf("test prev error: %v", err)
+  }
+  log.Printf("key: %v, value: %v", key, value)
+}
+```
+
+- Clear: 清空 map。
+```go
+m.Clear()
+```
+
+- Size: map 元素个数。
+```go
+s := m.Size()
+```
+
+- String: map 转换成 string 输出。
+```go
+log.Print(m.String())
+```
+
+example 参考：[TestOrderMap](https://github.com/memory-overflow/go-common-library/blob/main/stl_extension/stl_test.go#L13)。

task_scheduler/readme.md

@@ -0,0 +1 @@
+# 轻量级任务调度框架

text/readme.md

@@ -0,0 +1,2 @@
+# text 模块
+