README
¶
gmap 包
简介
gmap 包提供了线程安全的 Map 容器，支持保持键的插入顺序，并提供丰富的操作方法。
功能特性
- 线程安全：所有操作都是线程安全的
- 有序遍历：保持键的插入顺序
- 丰富操作：存储、删除、查找、遍历等
- 内存管理：支持 GC 回收内存
安装
go get github.com/snail007/gmc/util/map
快速开始
package main
import (
"fmt"
"github.com/snail007/gmc/util/map"
)
func main() {
m := gmap.New()
// 存储键值对
m.Store("name", "John")
m.Store("age", 30)
m.Store("city", "New York")
// 获取值
if value, ok := m.Load("name"); ok {
fmt.Println("Name:", value)
}
// 检查是否存在
if m.Has("age") {
fmt.Println("Age exists")
}
// 遍历（按插入顺序）
m.Range(func(key, value interface{}) bool {
fmt.Printf("%v: %v\n", key, value)
return true
})
// 删除
m.Delete("city")
// 获取所有键
keys := m.Keys()
fmt.Println("Keys:", keys)
// 获取长度
fmt.Println("Length:", m.Len())
// 转换为普通 map
normalMap := m.ToMap()
fmt.Println(normalMap)
}
API 参考
创建和基本操作
New() *Map：创建新 MapStore(key, value)：存储键值对Load(key) (value, bool)：获取值Delete(key)：删除键Has(key) bool：检查键是否存在Len() int：获取长度
遍历
Range(func(key, value) bool)：遍历所有键值对RangeFast(func(key, value) bool)：快速遍历（无序）Keys() []interface{}：获取所有键Values() []interface{}：获取所有值
栈和队列操作
Shift() (key, value, bool)：移除并返回第一个元素Pop() (key, value, bool)：移除并返回最后一个元素
其他操作
Clear()：清空Clone() *Map：克隆ToMap() map[interface{}]interface{}：转换为普通 mapGC()：垃圾回收，释放内存
类型别名
// M 是 map[string]interface{} 的别名
type M = map[string]interface{}
// Mii 是 map[interface{}]interface{} 的别名
type Mii = map[interface{}]interface{}
// Mss 是 map[string]string 的别名
type Mss = map[string]string
使用场景
- 配置管理：存储应用配置
- 缓存：内存缓存
- 会话存储：HTTP 会话数据
- 有序字典：需要保持插入顺序的场景
- 并发访问：多 goroutine 安全访问
注意事项
- 遍历时按插入顺序
RangeFast不保证顺序但性能更好GC()可以释放已删除键占用的内存- 键可以是任意类型
相关链接
Documentation
¶
Index ¶
- func Less(v1, v2 interface{}) bool
- func Sort(s []map[string]interface{}, key string, aes bool)
- func SortStr(s []map[string]string, key string, aes bool)
- func ToAny(a map[string]string) (b map[string]interface{})
- func ToString(a map[string]interface{}) (b map[string]string)
- type M
- type Map
- func (s *Map) Clear()
- func (s *Map) Clone() *Map
- func (s *Map) CloneAndClear() *Map
- func (s *Map) Delete(key interface{})
- func (s *Map) GC()
- func (s *Map) IndexOf(k interface{}) int
- func (s *Map) IsEmpty() bool
- func (s *Map) Keys() (keys []interface{})
- func (s *Map) Len() int
- func (s *Map) Load(key interface{}) (value interface{}, ok bool)
- func (s *Map) LoadAndDelete(key interface{}) (value interface{}, loaded bool)
- func (s *Map) LoadAndStoreFunc(key interface{}, ...) (newValue interface{}, loaded bool)
- func (s *Map) LoadAndStoreFuncErr(key interface{}, ...) (newValue interface{}, loaded bool, err error)
- func (s *Map) LoadOrStore(key, value interface{}) (actual interface{}, loaded bool)
- func (s *Map) LoadOrStoreFront(key, value interface{}) (actual interface{}, loaded bool)
- func (s *Map) LoadOrStoreFunc(key interface{}, f func() interface{}) (actual interface{}, loaded bool)
- func (s *Map) LoadOrStoreFuncErr(key interface{}, f func() (x interface{}, err error)) (actual interface{}, loaded bool, err error)
- func (s *Map) Merge(m *Map) *Map
- func (s *Map) MergeMap(m Mii) *Map
- func (s *Map) MergeStrMap(m M) *Map
- func (s *Map) MergeStrStrMap(m Mss) *Map
- func (s *Map) MergeSyncMap(m *sync.Map) *Map
- func (s *Map) Pop() (k, v interface{}, ok bool)
- func (s *Map) Range(f func(key, value interface{}) bool)
- func (s *Map) RangeFast(f func(key, value interface{}) bool)
- func (s *Map) Shift() (k, v interface{}, ok bool)
- func (s *Map) Store(key, value interface{})
- func (s *Map) StoreFront(key, value interface{})
- func (s *Map) String() string
- func (s *Map) StringKeys() (keys []string)
- func (s *Map) ToMap() map[interface{}]interface{}
- func (s *Map) ToStringMap() map[string]interface{}
- type Mii
- type Mss
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Map ¶
type Map struct {
// contains filtered or unexported fields
}
Map a map can kept the sequence of keys when range the map have more useful function, Len(), Shift(), Pop(),Keys(), etc.
func (*Map) IndexOf ¶
IndexOf indicates the index of value in Map s, if not found returns -1.
idx start with 0.
func (*Map) Keys ¶
func (s *Map) Keys() (keys []interface{})
Keys returns all keys in map s and keep the sequence of store sequence.
func (*Map) Load ¶
Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.
func (*Map) LoadAndDelete ¶
LoadAndDelete deletes the value for a key, returning the previous value if any. The loaded result reports whether the key was present.
func (*Map) LoadAndStoreFunc ¶
func (s *Map) LoadAndStoreFunc(key interface{}, f func(oldValue interface{}, loaded bool) (newValue interface{})) (newValue interface{}, loaded bool)
LoadAndStoreFunc call the given func and stores it returns value. The loaded result is true if the keys was exists, false if not exists. If loaded, the given func firstly parameter is the loaded value, otherwise is nil.
func (*Map) LoadAndStoreFuncErr ¶
func (s *Map) LoadAndStoreFuncErr(key interface{}, f func(oldValue interface{}, loaded bool) (newValue interface{}, err error)) (newValue interface{}, loaded bool, err error)
LoadAndStoreFuncErr call the given func and stores it returns value, if func returns an error, the error be returned. The loaded result is true if the keys was exists, false if not exists. If loaded, the given func firstly parameter is the loaded value, otherwise is nil.
func (*Map) LoadOrStore ¶
LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.
func (*Map) LoadOrStoreFront ¶
LoadOrStoreFront returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored. The key will be stored the first in keys queue if key not exists.
func (*Map) LoadOrStoreFunc ¶
func (s *Map) LoadOrStoreFunc(key interface{}, f func() interface{}) (actual interface{}, loaded bool)
LoadOrStoreFunc returns the existing value for the key if present. Otherwise, it call the given func and stores it returns value. The loaded result is true if the value was loaded, false if stored.
func (*Map) LoadOrStoreFuncErr ¶
func (s *Map) LoadOrStoreFuncErr(key interface{}, f func() (x interface{}, err error)) (actual interface{}, loaded bool, err error)
LoadOrStoreFuncErr returns the existing value for the key if present. Otherwise, it call the given func and stores it returns value, if the func returns an error, nothing will be stored, the function's error be returned. The loaded result is true if the value was loaded, false if stored.
func (*Map) MergeStrStrMap ¶
MergeStrStrMap merges a map to Map s.
func (*Map) MergeSyncMap ¶
MergeSyncMap merges a sync.Map to Map s.
func (*Map) Range ¶
Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.
Range keep the sequence of store sequence.
func (*Map) RangeFast ¶
RangeFast calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.
RangeFast keep the sequence of store sequence.
RangeFast do not create a snapshot for range, so you can not modify map s in range loop, indicate do not call Delete(), Store(), LoadOrStore(), Merge(), etc.
func (*Map) StoreFront ¶
func (s *Map) StoreFront(key, value interface{})
StoreFront sets the value for a key. The key will be stored the first in keys queue.
func (*Map) StringKeys ¶
StringKeys returns all keys in map s and keep the sequence of store sequence.
func (*Map) ToStringMap ¶
ToStringMap duplicates the map s.
Source Files