Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/num30/go-cache

An in-memory key:value store/cache (similar to Memcached) library that takes advantage of Go Generics
https://github.com/num30/go-cache

cache generic go golang

Last synced: about 1 month ago
JSON representation

An in-memory key:value store/cache (similar to Memcached) library that takes advantage of Go Generics

Host: GitHub
URL: https://github.com/num30/go-cache
Owner: num30
License: mit
Created: 2022-05-02T08:07:31.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-09-05T07:28:59.000Z (over 1 year ago)
Last Synced: 2024-06-19T17:50:58.383Z (6 months ago)
Topics: cache, generic, go, golang
Language: Go
Homepage:
Size: 209 KB
Stars: 15
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # go-cache

[![test-and-lint](https://github.com/num30/go-cache/actions/workflows/test.yaml/badge.svg)](https://github.com/num30/go-cache/actions/workflows/test.yaml)

[![codecov](https://codecov.io/gh/num30/go-cache/branch/main/graph/badge.svg?token=FMvJ4TbC2r)](https://codecov.io/gh/num30/go-cache)

[![Go Report Card](https://goreportcard.com/badge/github.com/num30/go-cache)](https://goreportcard.com/report/github.com/num30/go-cache)

[![Go Reference](https://pkg.go.dev/badge/github.com/num30/go-cache.svg)](https://pkg.go.dev/github.com/num30/go-cache)

ℹ️ go-cache is a port of great [go-cache](https://github.com/patrickmn/go-cache) library that was written by @patrickmn. The main defference is that it relies on generics instead of reflection.

go-cache is a  in-memory key:value store/cache similar to memcached that is

suitable for applications running on a single machine. Its major advantage is

that, being essentially a thread-safe `map[string][T]` with expiration

times, it doesn't need to serialize or transmit its contents over the network.

Any object can be stored, for a given duration or forever, and the cache can be

safely used by multiple goroutines.

Although go-cache isn't meant to be used as a persistent datastore, the entire

cache can be saved to and loaded from a file (using `c.Items()` to retrieve the

items map to serialize, and `NewFrom()` to create a cache from a deserialized

one) to recover from downtime quickly. (See the docs for `NewFrom()` for caveats.)

### Installation

`go get github.com/num30/go-cache`

### Usage

```go

import (

	"fmt"

	"github.com/num30/go-cache"

	"time"

)

func main() {

	// Create a cache with a default expiration time of 5 minutes, and which

	// purges expired items every 10 minutes

	c := cache.New[string](5*time.Minute, 10*time.Minute)

	// Set the value of the key "foo" to "bar", with the default expiration time

	c.Set("foo", "bar", cache.DefaultExpiration)

	// Set the value of the key "baz" to "lightning", with no expiration time

	// (the item won't be removed until it is re-set, or removed using

	// c.Delete("baz")

	c.Set("baz", "lightning", cache.NoExpiration)

	// Get the string associated with the key "foo" from the cache

	foo, found := c.Get("foo")

	if found {

		fmt.Println(foo)

	}

	// Want performance? Store pointers!

	structCache := cache.New[MyStruct](5*time.Minute, 10*time.Minute)

	structCache.Set("foo", &MyStruct, cache.DefaultExpiration)

	if x, found := c.Get("foo"); found {

		fmt.Println(")

	}

}

```

Run this example with `go run examples/main.go`.

## Performance Comparison

Comparison of performance with original [go-cache](https://github.com/patrickmn/go-cache) implementation.

Spoiler alert! The difference is insignificant.

| _Test                                        |    _{[Non generic](https://github.com/patrickmn/go-cache)} |       |         _{This version} |           |  

|----------------------------------------------|-----------|-------------|-----------|---------------|

| _{BenchmarkCacheGetStringExpiring-8}|  _29884011 | _{41.45 ns/op} | _28318041 | _{43.31 ns/op} |

| _{BenchmarkCacheGetStringNotExpiring-8}|  _91891774 | _{14.20 ns/op} | _72259294 | _{14.02 ns/op} |

| _{BenchmarkCacheGetConcurrentExpiring-8}|  _26299849 | _{42.58 ns/op} | _30129078 | _{39.53 ns/op} |

| _{BenchmarkCacheGetConcurrentNotExpiring-8}|  _28991383 | _{41.25 ns/op} | _30760544 | _{38.09 ns/op} |

| _{BenchmarkCacheGetManyConcurrentExpiring-8}|  _55589712 | _{44.90 ns/op} | _56991110 | _{38.86 ns/op} |

| _{BenchmarkCacheGetManyConcurrentNotExpiring-8}|  _30105078 | _{43.98 ns/op} | _46270045 | _{41.54 ns/op} |

| _{BenchmarkCacheSetStringExpiring-8}|  _18392893 | _{63.41 ns/op} | _17788724 | _{61.42 ns/op} |

| _{BenchmarkCacheSetStringNotExpiring-8}|  _46400654 | _{28.45 ns/op} | _40226074 | _{27.41 ns/op} |

| _{BenchmarkCacheSetDelete-8}|  _18703620 | _{60.75 ns/op} | _18270448 | _{59.90 ns/op} |

| _{BenchmarkCacheSetDeleteSingleLock-8}|  _32633755 | _{39.34 ns/op} | _32415156 | _{36.96 ns/op} |

| _{BenchmarkCacheGetStructExpiring-8}|  _30487856 | _{41.60 ns/op} | _26925226 | _{40.55 ns/op} |

| _{BenchmarkCacheGetStructNotExpiring-8}|  _91921044 | _{13.94 ns/op} | _96379750 | _{13.08 ns/op} |

| _{BenchmarkCacheSetStructExpiring-8}|  _13977464 | _{86.44 ns/op} | _13364509 | _{87.69 ns/op} |

| _{BenchmarkCacheSetStructNotExpiring-8}|  _22749384 | _{54.14 ns/op} | _23207397 | _{52.58 ns/op} |

| _{BenchmarkCacheSetFatStructExpiring-8}|  _11718718 | _{103.3 ns/op} | _12051895 | _{102.3 ns/op} |

| _{BenchmarkCacheGetFatStructNotExpiring-8}|  _88695709 | _{13.92 ns/op} | _83220014 | _{13.76 ns/op} |