Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 添加copy on write list实现 #260

Merged
merged 2 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 127 additions & 0 deletions list/copy_on_write_array_list.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
package list

import (
"sync"

"github.com/ecodeclub/ekit/internal/errs"
"github.com/ecodeclub/ekit/internal/slice"
)

var (
_ List[any] = &CopyOnWriteArrayList[any]{}
)

// CopyOnWriteArrayList 基于切片的简单封装 写时加锁,读不加锁,适合于读多写少场景
type CopyOnWriteArrayList[T any] struct {
vals []T
mutex *sync.Mutex
}

// NewCopyOnWriteArrayList
func NewCopyOnWriteArrayList[T any]() *CopyOnWriteArrayList[T] {
m := &sync.Mutex{}
return &CopyOnWriteArrayList[T]{
vals: make([]T, 0),
mutex: m,
}
}

// NewCopyOnWriteArrayListOf 直接使用 ts,会执行复制
func NewCopyOnWriteArrayListOf[T any](ts []T) *CopyOnWriteArrayList[T] {
items := make([]T, len(ts))
copy(items, ts)
m := &sync.Mutex{}
return &CopyOnWriteArrayList[T]{
vals: items,
mutex: m,
}
}

func (a *CopyOnWriteArrayList[T]) Get(index int) (t T, e error) {
l := a.Len()
if index < 0 || index >= l {
return t, errs.NewErrIndexOutOfRange(l, index)
}
return a.vals[index], e
}

// Append 往CopyOnWriteArrayList里追加数据
func (a *CopyOnWriteArrayList[T]) Append(ts ...T) error {
a.mutex.Lock()
defer a.mutex.Unlock()
n := len(a.vals)
newItems := make([]T, n, n+len(ts))
copy(newItems, a.vals)
newItems = append(newItems, ts...)
a.vals = newItems
return nil
}

// Add 在CopyOnWriteArrayList下标为index的位置插入一个元素
// 当index等于CopyOnWriteArrayList长度等同于append
func (a *CopyOnWriteArrayList[T]) Add(index int, t T) (err error) {
a.mutex.Lock()
defer a.mutex.Unlock()
n := len(a.vals)
newItems := make([]T, n, n+1)
copy(newItems, a.vals)
newItems, err = slice.Add(newItems, t, index)
a.vals = newItems
return
}

// Set 设置CopyOnWriteArrayList里index位置的值为t
func (a *CopyOnWriteArrayList[T]) Set(index int, t T) error {
a.mutex.Lock()
defer a.mutex.Unlock()
n := len(a.vals)
if index >= n || index < 0 {
return errs.NewErrIndexOutOfRange(n, index)
}
newItems := make([]T, n)
copy(newItems, a.vals)
newItems[index] = t
a.vals = newItems
return nil
}

// 这里不涉及缩容,每次都是当前内容长度申请的数组容量
func (a *CopyOnWriteArrayList[T]) Delete(index int) (T, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不要使用 slice DELETE 方法了,你直接循环复制

a.mutex.Lock()
defer a.mutex.Unlock()
newItems := make([]T, len(a.vals))
copy(newItems, a.vals)
res, t, err := slice.Delete(newItems, index)
if err != nil {
return t, err
}
newItems = res
a.vals = newItems
return t, nil
}

func (a *CopyOnWriteArrayList[T]) Len() int {
return len(a.vals)
}

func (a *CopyOnWriteArrayList[T]) Cap() int {
return cap(a.vals)
}

func (a *CopyOnWriteArrayList[T]) Range(fn func(index int, t T) error) error {
for key, value := range a.vals {
e := fn(key, value)
if e != nil {
return e
}
}
return nil
}

func (a *CopyOnWriteArrayList[T]) AsSlice() []T {
a.mutex.Lock()
defer a.mutex.Unlock()
res := make([]T, len(a.vals))
copy(res, a.vals)
return res
}
Loading
Loading