github.com/bingoohuang/gg@v0.0.0-20240325092523-45da7dee9335/pkg/cmap/README-zh.md (about)

     1  # concurrent map [![Build Status](https://travis-ci.com/orcaman/concurrent-map.svg?branch=master)](https://travis-ci.com/orcaman/concurrent-map)
     2  
     3  正如 [这里](http://golang.org/doc/faq#atomic_maps) 和 [这里](http://blog.golang.org/go-maps-in-action)所描述的, Go语言原生的`map`类型并不支持并发读写。`concurrent-map`提供了一种高性能的解决方案:通过对内部`map`进行分片，降低锁粒度，从而达到最少的锁等待时间(锁冲突)
     4  
     5  在Go 1.9之前，go语言标准库中并没有实现并发`map`。在Go 1.9中，引入了`sync.Map`。新的`sync.Map`与此`concurrent-map`有几个关键区别。标准库中的`sync.Map`是专为`append-only`场景设计的。因此，如果您想将`Map`用于一个类似内存数据库，那么使用我们的版本可能会受益。你可以在golang repo上读到更多，[这里](https://github.com/golang/go/issues/21035) and [这里](https://stackoverflow.com/questions/11063473/map-with-concurrent-access)
     6  ***译注:`sync.Map`在读多写少性能比较好，否则并发性能很差***
     7  
     8  ## 用法
     9  
    10  导入包:
    11  
    12  ```go
    13  import (
    14  	"github.com/orcaman/concurrent-map"
    15  )
    16  
    17  ```
    18  
    19  ```bash
    20  go get "github.com/orcaman/concurrent-map"
    21  ```
    22  
    23  现在包被导入到了`cmap`命名空间下
    24  ***译注:通常包的限定前缀(命名空间)是和目录名一致的，但是这个包有点典型😂，不一致！！！所以用的时候注意***
    25  
    26  ## 示例
    27  
    28  ```go
    29  
    30  	// 创建一个新的 map.
    31  	m := cmap.New()
    32  
    33  	// 设置变量m一个键为“foo”值为“bar”键值对
    34  	m.Set("foo", "bar")
    35  
    36  	// 从m中获取指定键值.
    37  	if tmp, ok := m.Get("foo"); ok {
    38  		bar := tmp.(string)
    39  	}
    40  
    41  	// 删除键为“foo”的项
    42  	m.Remove("foo")
    43  
    44  ```
    45  
    46  更多使用示例请查看`concurrent_map_test.go`.
    47  
    48  运行测试:
    49  
    50  ```bash
    51  go test "github.com/orcaman/concurrent-map"
    52  ```
    53  
    54  ## 贡献说明
    55  
    56  我们非常欢迎大家的贡献。如欲合并贡献，请遵循以下指引:
    57  - 新建一个issue,并且叙述为什么这么做(解决一个bug，增加一个功能，等等)
    58  - 根据核心团队对上述问题的反馈，提交一个PR，描述变更并链接到该问题。
    59  - 新代码必须具有测试覆盖率。
    60  - 如果代码是关于性能问题的，则必须在流程中包括基准测试(无论是在问题中还是在PR中)。
    61  - 一般来说，我们希望`concurrent-map`尽可能简单，且与原生的`map`有相似的操作。当你新建issue时请注意这一点。
    62  
    63  ## 许可证
    64  MIT (see [LICENSE](https://github.com/orcaman/concurrent-map/blob/master/LICENSE) file)