2019-05-08 17:21:18 +08:00
|
|
|
// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
|
|
|
//
|
|
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
|
|
// If a copy of the MIT was not distributed with gm file,
|
|
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
//
|
|
|
|
|
|
|
|
package gmap
|
|
|
|
|
|
|
|
import (
|
2019-07-13 17:48:16 +08:00
|
|
|
"encoding/json"
|
2020-01-20 19:56:42 +08:00
|
|
|
"github.com/gogf/gf/util/gconv"
|
2019-07-13 17:48:16 +08:00
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
"github.com/gogf/gf/internal/empty"
|
|
|
|
|
2019-07-29 21:01:19 +08:00
|
|
|
"github.com/gogf/gf/internal/rwmutex"
|
2019-05-08 17:21:18 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
type StrStrMap struct {
|
|
|
|
mu *rwmutex.RWMutex
|
|
|
|
data map[string]string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewStrStrMap returns an empty StrStrMap object.
|
2019-11-30 18:33:51 +08:00
|
|
|
// The parameter <safe> is used to specify whether using map in concurrent-safety,
|
2019-07-23 23:20:27 +08:00
|
|
|
// which is false in default.
|
|
|
|
func NewStrStrMap(safe ...bool) *StrStrMap {
|
2019-05-08 17:21:18 +08:00
|
|
|
return &StrStrMap{
|
2019-06-19 09:06:52 +08:00
|
|
|
data: make(map[string]string),
|
2019-07-23 23:20:27 +08:00
|
|
|
mu: rwmutex.New(safe...),
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-30 18:33:51 +08:00
|
|
|
// NewStrStrMapFrom creates and returns a hash map from given map <data>.
|
2019-05-11 20:47:25 +08:00
|
|
|
// Note that, the param <data> map will be set as the underlying data map(no deep copy),
|
2019-05-08 17:21:18 +08:00
|
|
|
// there might be some concurrent-safe issues when changing the map outside.
|
2019-07-23 23:20:27 +08:00
|
|
|
func NewStrStrMapFrom(data map[string]string, safe ...bool) *StrStrMap {
|
2019-06-19 09:06:52 +08:00
|
|
|
return &StrStrMap{
|
2019-07-23 23:20:27 +08:00
|
|
|
mu: rwmutex.New(safe...),
|
2019-06-19 09:06:52 +08:00
|
|
|
data: data,
|
|
|
|
}
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Iterator iterates the hash map with custom callback function <f>.
|
|
|
|
// If <f> returns true, then it continues iterating; or false to stop.
|
2019-06-19 09:06:52 +08:00
|
|
|
func (m *StrStrMap) Iterator(f func(k string, v string) bool) {
|
2019-05-08 17:21:18 +08:00
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
for k, v := range m.data {
|
|
|
|
if !f(k, v) {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Clone returns a new hash map with copy of current map data.
|
|
|
|
func (m *StrStrMap) Clone() *StrStrMap {
|
2019-09-29 14:27:09 +08:00
|
|
|
return NewStrStrMapFrom(m.MapCopy(), !m.mu.IsSafe())
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
// Map returns the underlying data map.
|
|
|
|
// Note that, if it's in concurrent-safe usage, it returns a copy of underlying data,
|
|
|
|
// or else a pointer to the underlying data.
|
|
|
|
func (m *StrStrMap) Map() map[string]string {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
if !m.mu.IsSafe() {
|
|
|
|
return m.data
|
|
|
|
}
|
|
|
|
data := make(map[string]string, len(m.data))
|
|
|
|
for k, v := range m.data {
|
|
|
|
data[k] = v
|
|
|
|
}
|
|
|
|
return data
|
2019-09-26 20:01:48 +08:00
|
|
|
}
|
|
|
|
|
2019-11-30 18:33:51 +08:00
|
|
|
// MapStrAny returns a copy of the underlying data of the map as map[string]interface{}.
|
2019-09-30 17:23:23 +08:00
|
|
|
func (m *StrStrMap) MapStrAny() map[string]interface{} {
|
|
|
|
m.mu.RLock()
|
|
|
|
data := make(map[string]interface{}, len(m.data))
|
|
|
|
for k, v := range m.data {
|
|
|
|
data[k] = v
|
|
|
|
}
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return data
|
|
|
|
}
|
|
|
|
|
2019-11-30 18:33:51 +08:00
|
|
|
// MapCopy returns a copy of the underlying data of the hash map.
|
2019-09-29 14:27:09 +08:00
|
|
|
func (m *StrStrMap) MapCopy() map[string]string {
|
2019-06-19 09:06:52 +08:00
|
|
|
m.mu.RLock()
|
2019-09-29 14:27:09 +08:00
|
|
|
defer m.mu.RUnlock()
|
2019-05-12 21:11:26 +08:00
|
|
|
data := make(map[string]string, len(m.data))
|
2019-06-19 09:06:52 +08:00
|
|
|
for k, v := range m.data {
|
|
|
|
data[k] = v
|
|
|
|
}
|
|
|
|
return data
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
// FilterEmpty deletes all key-value pair of which the value is empty.
|
|
|
|
func (m *StrStrMap) FilterEmpty() {
|
|
|
|
m.mu.Lock()
|
|
|
|
for k, v := range m.data {
|
|
|
|
if empty.IsEmpty(v) {
|
|
|
|
delete(m.data, k)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// Set sets key-value to the hash map.
|
|
|
|
func (m *StrStrMap) Set(key string, val string) {
|
|
|
|
m.mu.Lock()
|
|
|
|
m.data[key] = val
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Sets batch sets key-values to the hash map.
|
|
|
|
func (m *StrStrMap) Sets(data map[string]string) {
|
2019-06-19 09:06:52 +08:00
|
|
|
m.mu.Lock()
|
|
|
|
for k, v := range data {
|
|
|
|
m.data[k] = v
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
2019-05-10 13:38:06 +08:00
|
|
|
// Search searches the map with given <key>.
|
|
|
|
// Second return parameter <found> is true if key was found, otherwise false.
|
|
|
|
func (m *StrStrMap) Search(key string) (value string, found bool) {
|
|
|
|
m.mu.RLock()
|
|
|
|
value, found = m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// Get returns the value by given <key>.
|
|
|
|
func (m *StrStrMap) Get(key string) string {
|
|
|
|
m.mu.RLock()
|
|
|
|
val, _ := m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return val
|
|
|
|
}
|
|
|
|
|
2019-10-16 23:33:06 +08:00
|
|
|
// Pop retrieves and deletes an item from the map.
|
|
|
|
func (m *StrStrMap) Pop() (key, value string) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
for key, value = range m.data {
|
|
|
|
delete(m.data, key)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Pops retrieves and deletes <size> items from the map.
|
|
|
|
// It returns all items if size == -1.
|
|
|
|
func (m *StrStrMap) Pops(size int) map[string]string {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if size > len(m.data) || size == -1 {
|
|
|
|
size = len(m.data)
|
|
|
|
}
|
|
|
|
if size == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
index := 0
|
|
|
|
newMap := make(map[string]string, size)
|
|
|
|
for k, v := range m.data {
|
|
|
|
delete(m.data, k)
|
|
|
|
newMap[k] = v
|
|
|
|
index++
|
|
|
|
if index == size {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return newMap
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// doSetWithLockCheck checks whether value of the key exists with mutex.Lock,
|
|
|
|
// if not exists, set value to the map with given <key>,
|
|
|
|
// or else just return the existing value.
|
|
|
|
//
|
|
|
|
// It returns value with given <key>.
|
|
|
|
func (m *StrStrMap) doSetWithLockCheck(key string, value string) string {
|
|
|
|
m.mu.Lock()
|
2019-10-31 23:37:33 +08:00
|
|
|
defer m.mu.Unlock()
|
2019-05-08 17:21:18 +08:00
|
|
|
if v, ok := m.data[key]; ok {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
m.data[key] = value
|
|
|
|
return value
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSet returns the value by key,
|
2019-11-06 20:22:20 +08:00
|
|
|
// or sets value with given <value> if it does not exist and then returns this value.
|
2019-05-08 17:21:18 +08:00
|
|
|
func (m *StrStrMap) GetOrSet(key string, value string) string {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return m.doSetWithLockCheck(key, value)
|
|
|
|
} else {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSetFunc returns the value by key,
|
2019-11-06 20:22:20 +08:00
|
|
|
// or sets value with returned value of callback function <f> if it does not exist
|
|
|
|
// and then returns this value.
|
2019-05-08 17:21:18 +08:00
|
|
|
func (m *StrStrMap) GetOrSetFunc(key string, f func() string) string {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return m.doSetWithLockCheck(key, f())
|
|
|
|
} else {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSetFuncLock returns the value by key,
|
2019-11-06 20:22:20 +08:00
|
|
|
// or sets value with returned value of callback function <f> if it does not exist
|
|
|
|
// and then returns this value.
|
2019-05-08 17:21:18 +08:00
|
|
|
//
|
|
|
|
// GetOrSetFuncLock differs with GetOrSetFunc function is that it executes function <f>
|
|
|
|
// with mutex.Lock of the hash map.
|
|
|
|
func (m *StrStrMap) GetOrSetFuncLock(key string, f func() string) string {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok = m.data[key]; ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return v
|
|
|
|
}
|
2019-05-10 13:38:06 +08:00
|
|
|
v = f()
|
2019-10-31 23:37:33 +08:00
|
|
|
if v != "" {
|
|
|
|
m.data[key] = v
|
|
|
|
}
|
2019-05-10 13:38:06 +08:00
|
|
|
return v
|
2019-05-08 17:21:18 +08:00
|
|
|
} else {
|
2019-05-10 13:38:06 +08:00
|
|
|
return v
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-06 20:22:20 +08:00
|
|
|
// SetIfNotExist sets <value> to the map if the <key> does not exist, and then returns true.
|
2019-05-08 17:21:18 +08:00
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
func (m *StrStrMap) SetIfNotExist(key string, value string) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.doSetWithLockCheck(key, value)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2019-11-06 20:22:20 +08:00
|
|
|
// SetIfNotExistFunc sets value with return value of callback function <f>, and then returns true.
|
2019-05-08 17:21:18 +08:00
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
func (m *StrStrMap) SetIfNotExistFunc(key string, f func() string) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.doSetWithLockCheck(key, f())
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2019-11-06 20:22:20 +08:00
|
|
|
// SetIfNotExistFuncLock sets value with return value of callback function <f>, and then returns true.
|
2019-05-08 17:21:18 +08:00
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
//
|
|
|
|
// SetIfNotExistFuncLock differs with SetIfNotExistFunc function is that
|
|
|
|
// it executes function <f> with mutex.Lock of the hash map.
|
|
|
|
func (m *StrStrMap) SetIfNotExistFuncLock(key string, f func() string) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if _, ok := m.data[key]; !ok {
|
|
|
|
m.data[key] = f()
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// Removes batch deletes values of the map by keys.
|
|
|
|
func (m *StrStrMap) Removes(keys []string) {
|
2019-06-19 09:06:52 +08:00
|
|
|
m.mu.Lock()
|
|
|
|
for _, key := range keys {
|
|
|
|
delete(m.data, key)
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Remove deletes value from map by given <key>, and return this deleted value.
|
|
|
|
func (m *StrStrMap) Remove(key string) string {
|
|
|
|
m.mu.Lock()
|
|
|
|
val, exists := m.data[key]
|
|
|
|
if exists {
|
|
|
|
delete(m.data, key)
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
return val
|
|
|
|
}
|
|
|
|
|
|
|
|
// Keys returns all keys of the map as a slice.
|
|
|
|
func (m *StrStrMap) Keys() []string {
|
|
|
|
m.mu.RLock()
|
2019-06-19 09:06:52 +08:00
|
|
|
keys := make([]string, len(m.data))
|
2019-05-12 21:11:26 +08:00
|
|
|
index := 0
|
2019-05-08 17:21:18 +08:00
|
|
|
for key := range m.data {
|
2019-05-12 21:11:26 +08:00
|
|
|
keys[index] = key
|
|
|
|
index++
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
2019-06-19 09:06:52 +08:00
|
|
|
m.mu.RUnlock()
|
2019-05-08 17:21:18 +08:00
|
|
|
return keys
|
|
|
|
}
|
|
|
|
|
|
|
|
// Values returns all values of the map as a slice.
|
|
|
|
func (m *StrStrMap) Values() []string {
|
|
|
|
m.mu.RLock()
|
2019-05-12 21:11:26 +08:00
|
|
|
values := make([]string, len(m.data))
|
2019-06-19 09:06:52 +08:00
|
|
|
index := 0
|
2019-05-08 17:21:18 +08:00
|
|
|
for _, value := range m.data {
|
2019-05-12 21:11:26 +08:00
|
|
|
values[index] = value
|
|
|
|
index++
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return values
|
|
|
|
}
|
|
|
|
|
|
|
|
// Contains checks whether a key exists.
|
|
|
|
// It returns true if the <key> exists, or else false.
|
|
|
|
func (m *StrStrMap) Contains(key string) bool {
|
|
|
|
m.mu.RLock()
|
|
|
|
_, exists := m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return exists
|
|
|
|
}
|
|
|
|
|
|
|
|
// Size returns the size of the map.
|
|
|
|
func (m *StrStrMap) Size() int {
|
|
|
|
m.mu.RLock()
|
|
|
|
length := len(m.data)
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return length
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsEmpty checks whether the map is empty.
|
|
|
|
// It returns true if map is empty, or else false.
|
|
|
|
func (m *StrStrMap) IsEmpty() bool {
|
2019-10-16 23:33:06 +08:00
|
|
|
return m.Size() == 0
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Clear deletes all data of the map, it will remake a new underlying data map.
|
|
|
|
func (m *StrStrMap) Clear() {
|
2019-06-19 09:06:52 +08:00
|
|
|
m.mu.Lock()
|
|
|
|
m.data = make(map[string]string)
|
|
|
|
m.mu.Unlock()
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
2019-11-04 21:26:16 +08:00
|
|
|
// Replace the data of the map with given <data>.
|
|
|
|
func (m *StrStrMap) Replace(data map[string]string) {
|
|
|
|
m.mu.Lock()
|
|
|
|
m.data = data
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// LockFunc locks writing with given callback function <f> within RWMutex.Lock.
|
|
|
|
func (m *StrStrMap) LockFunc(f func(m map[string]string)) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
f(m.data)
|
|
|
|
}
|
|
|
|
|
|
|
|
// RLockFunc locks reading with given callback function <f> within RWMutex.RLock.
|
|
|
|
func (m *StrStrMap) RLockFunc(f func(m map[string]string)) {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
f(m.data)
|
|
|
|
}
|
|
|
|
|
2019-05-10 13:38:06 +08:00
|
|
|
// Flip exchanges key-value of the map to value-key.
|
2019-05-08 17:21:18 +08:00
|
|
|
func (m *StrStrMap) Flip() {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
n := make(map[string]string, len(m.data))
|
|
|
|
for k, v := range m.data {
|
|
|
|
n[v] = k
|
|
|
|
}
|
|
|
|
m.data = n
|
|
|
|
}
|
|
|
|
|
|
|
|
// Merge merges two hash maps.
|
|
|
|
// The <other> map will be merged into the map <m>.
|
|
|
|
func (m *StrStrMap) Merge(other *StrStrMap) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if other != m {
|
|
|
|
other.mu.RLock()
|
|
|
|
defer other.mu.RUnlock()
|
|
|
|
}
|
|
|
|
for k, v := range other.data {
|
|
|
|
m.data[k] = v
|
|
|
|
}
|
|
|
|
}
|
2019-07-13 17:48:16 +08:00
|
|
|
|
|
|
|
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
|
|
|
|
func (m *StrStrMap) MarshalJSON() ([]byte, error) {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
return json.Marshal(m.data)
|
|
|
|
}
|
2019-09-30 14:23:15 +08:00
|
|
|
|
|
|
|
// UnmarshalJSON implements the interface UnmarshalJSON for json.Unmarshal.
|
|
|
|
func (m *StrStrMap) UnmarshalJSON(b []byte) error {
|
|
|
|
if m.mu == nil {
|
|
|
|
m.mu = rwmutex.New()
|
|
|
|
m.data = make(map[string]string)
|
|
|
|
}
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if err := json.Unmarshal(b, &m.data); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2020-01-20 19:56:42 +08:00
|
|
|
|
|
|
|
// UnmarshalValue is an interface implement which sets any type of value for map.
|
|
|
|
func (m *StrStrMap) UnmarshalValue(value interface{}) (err error) {
|
|
|
|
if m.mu == nil {
|
|
|
|
m.mu = rwmutex.New()
|
|
|
|
}
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
m.data = gconv.MapStrStr(value)
|
|
|
|
return
|
|
|
|
}
|