动手实现一个localcache - 实现篇

发表于 3年以前  | 总阅读数:277 次

前言

哈喽,大家好, 经过了前面两篇的介绍,我们已经基本了解该如何设计一个本地缓存了,本文就是这个系列的终结篇,自己动手实现一个本地缓存,接下来且听我细细道来!!!

本文代码已经上传到github:https://github.com/asong2020/go-localcache

现在这一版本算是一个1.0,后续会继续进行优化和迭代。

第一步:抽象接口

第一步很重要,以面向接口编程为原则,我们先抽象出来要暴露给用户的方法,给用户提供简单易懂的方法,因此我抽象出来的结果如下:

// ICache abstract interface
type ICache interface {
 // Set value use default expire time. default does not expire.
 Set(key string, value []byte) error
 // Get value if find it. if value already expire will delete.
 Get(key string) ([]byte, error)
 // SetWithTime set value with expire time
 SetWithTime(key string, value []byte, expired time.Duration) error
 // Delete manual removes the key
 Delete(key string) error
 // Len computes number of entries in cache
 Len() int
 // Capacity returns amount of bytes store in the cache.
 Capacity() int
 // Close is used to signal a shutdown of the cache when you are done with it.
 // This allows the cleaning goroutines to exit and ensures references are not
 // kept to the cache preventing GC of the entire cache.
 Close() error
 // Stats returns cache's statistics
 Stats() Stats
 // GetKeyHit returns key hit
 GetKeyHit(key string) int64
}
  • Set(key string, value []byte):使用该方法存储的数据使用默认的过期时间,如果清除过期的异步任务没有enable,那么就永不过期,否则默认过期时间为10min。
  • Get(key string) ([]byte, error):根据key获取对象内容,如果数据过期了会在这一步删除。
  • SetWithTime(key string, value []byte, expired time.Duration):存储对象是使用自定义过期时间
  • Delete(key string) error:根据key删除对应的缓存数据
  • Len() int:获取缓存的对象数量
  • Capacity() int:获取当前缓存的容量
  • Close() error:关闭缓存
  • Stats() Stats:缓存监控数据
  • GetKeyHit(key string) int64:获取key的命中率数据

第二步:定义缓存对象

第一步我们抽象好了接口,下面就要定义一个缓存对象实例实现接口,先看定义结构:

type cache struct {
 // hashFunc represents used hash func
 hashFunc HashFunc
 // bucketCount represents the number of segments within a cache instance. value must be a power of two.
 bucketCount uint64
 // bucketMask is bitwise AND applied to the hashVal to find the segment id.
 bucketMask uint64
 // segment is shard
 segments []*segment
 // segment lock
 locks    []sync.RWMutex
 // close cache
 close chan struct{}
}
  • hashFunc:分片要用的哈希函数,用户可以自行定义,实现HashFunc接口即可,默认使用fnv算法。
  • bucketCount:分片的数量,一定要是偶数,默认分片数为256
  • bucketMask:因为分片数是偶数,所以可以分片时可以使用位运算代替取余提升性能效率,hashValue % bucketCount == hashValue & bucketCount - 1
  • segments:分片对象,每个分片的对象结构我们在后面介绍。
  • locks:每个分片的读写锁
  • close:关闭缓存对象时通知其他goroutine暂停

接下来我们来写cache对象的构造函数:

// NewCache constructor cache instance
func NewCache(opts ...Opt) (ICache, error) {
 options := &options{
  hashFunc: NewDefaultHashFunc(),
  bucketCount: defaultBucketCount,
  maxBytes: defaultMaxBytes,
  cleanTime: defaultCleanTIme,
  statsEnabled: defaultStatsEnabled,
  cleanupEnabled: defaultCleanupEnabled,
 }
 for _, each := range opts{
  each(options)
 }

 if !isPowerOfTwo(options.bucketCount){
  return nil, errShardCount
 }

  if options.maxBytes <= 0 {
  return nil, ErrBytes
 }

 segments := make([]*segment, options.bucketCount)
 locks := make([]sync.RWMutex, options.bucketCount)

 maxSegmentBytes := (options.maxBytes + options.bucketCount - 1) / options.bucketCount
 for index := range segments{
  segments[index] = newSegment(maxSegmentBytes, options.statsEnabled)
 }

 c := &cache{
  hashFunc: options.hashFunc,
  bucketCount: options.bucketCount,
  bucketMask: options.bucketCount - 1,
  segments: segments,
  locks: locks,
  close: make(chan struct{}),
 }
    if options.cleanupEnabled {
  go c.cleanup(options.cleanTime)
 }

 return c, nil
}

这里为了更好的扩展,我们使用Options编程模式,我们的构造函数主要做三件事:

  • 前置参数检查,对于外部传入的参数,我们还是要做基本的校验
  • 分片对象初始化
  • 构造缓存对象

这里构造缓存对象时我们要先计算每个分片的容量,默认整个本地缓存256M的数据,然后在平均分到每一片区内,用户可以自行选择要缓存的数据大小。

第三步:定义分片结构

每个分片结构如下:

type segment struct {
 hashmap map[uint64]uint32
 entries buffer.IBuffer
 clock   clock
 evictList  *list.List
 stats IStats
}
  • hashmp:存储key所对应的存储索引
  • entries:存储key/value的底层结构,我们在第四步的时候介绍,也是代码的核心部分。
  • clock:定义时间方法
  • evicList:这里我们使用一个队列来记录old索引,当容量不足时进行删除(临时解决方案,当前存储结构不适合使用LRU淘汰算法)
  • stats:缓存的监控数据。

接下来我们再来看一下每个分片的构造函数:

func newSegment(bytes uint64, statsEnabled bool) *segment {
 if bytes == 0 {
  panic(fmt.Errorf("bytes cannot be zero"))
 }
 if bytes >= maxSegmentSize{
  panic(fmt.Errorf("too big bytes=%d; should be smaller than %d", bytes, maxSegmentSize))
 }
 capacity := (bytes + segmentSize - 1) / segmentSize
 entries := buffer.NewBuffer(int(capacity))
 entries.Reset()
 return &segment{
  entries: entries,
  hashmap: make(map[uint64]uint32),
  clock:   &systemClock{},
  evictList: list.New(),
  stats: newStats(statsEnabled),
 }
}

这里主要注意一点:

我们要根据每个片区的缓存数据大小来计算出容量,与上文的缓存对象初始化步骤对应上了。

第四步:定义缓存结构

缓存对象现在也构造好了,接下来就是本地缓存的核心:定义缓存结构。

bigcachefastcachefreecache都使用字节数组代替map存储缓存数据,从而减少GC压力,所以我们也可以借鉴其思想继续保持使用字节数组,这里我们使用二维字节切片存储缓存数据key/value;画个图表示一下:

使用二维数组存储数据的相比于bigcache的优势在于可以直接根据索引删除对应的数据,虽然也会有虫洞的问题,但是我们可以记录下来虫洞的索引,不断填充。

每个缓存的封装结构如下:

基本思想已经明确,接下来看一下我们对存储层的封装:

type Buffer struct {
 array [][]byte
 capacity int
 index int
 // maxCount = capacity - 1
 count int
 // availableSpace If any objects are removed after the buffer is full, the idle index is logged.
 // Avoid array "wormhole"
 availableSpace map[int]struct{}
 // placeholder record the index that buffer has stored.
 placeholder map[int]struct{}
}
  • array [][]byte:存储缓存对象的二维切片
  • capacity:缓存结构的最大容量
  • index:索引,记录缓存所在的位置的索引
  • count:记录缓存数量
  • availableSpace:记录"虫洞",当缓存对象被删除时记录下空闲位置的索引,方便后面容量满了后使用"虫洞"
  • placeholder:记录缓存对象的索引,迭代清除过期缓存可以用上。

buffer写入数据的流程(不贴代码了):

第五步:完善向缓存写入数据方法

上面我们定义好了所有需要的结构,接下来就是填充我们的写入缓存方法就可以了:

func (c *cache) Set(key string, value []byte) error  {
 hashKey := c.hashFunc.Sum64(key)
 bucketIndex := hashKey&c.bucketMask
 c.locks[bucketIndex].Lock()
 defer c.locks[bucketIndex].Unlock()
 err := c.segments[bucketIndex].set(key, hashKey, value, defaultExpireTime)
 return err
}

func (s *segment) set(key string, hashKey uint64, value []byte, expireTime time.Duration) error {
 if expireTime <= 0{
  return ErrExpireTimeInvalid
 }
 expireAt := uint64(s.clock.Epoch(expireTime))

 if previousIndex, ok := s.hashmap[hashKey]; ok {
  if err := s.entries.Remove(int(previousIndex)); err != nil{
   return err
  }
  delete(s.hashmap, hashKey)
 }

 entry := wrapEntry(expireAt, key, hashKey, value)
 for {
  index, err := s.entries.Push(entry)
  if err == nil {
   s.hashmap[hashKey] = uint32(index)
   s.evictList.PushFront(index)
   return nil
  }
  ele := s.evictList.Back()
  if err := s.entries.Remove(ele.Value.(int)); err != nil{
   return err
  }
  s.evictList.Remove(ele)
 }
}

流程分析如下:

  • 根据key计算哈希值,然后根据分片数获取对应分片位置
  • 如果当前缓存中存在相同的key,则先删除,在重新插入,会刷新过期时间
  • 封装存储结构,根据过期时间戳、key长度、哈希大小、缓存对象进行封装
  • 将数据存入缓存,如果缓存失败,移除最老的数据后再次重试

第六步:完善从缓存读取数据方法

第一步根据key计算哈希值,再根据分片数获取对应的分片位置:

func (c *cache) Get(key string) ([]byte, error)  {
 hashKey := c.hashFunc.Sum64(key)
 bucketIndex := hashKey&c.bucketMask
 c.locks[bucketIndex].RLock()
 defer c.locks[hashKey&c.bucketMask].RUnlock()
 entry, err := c.segments[bucketIndex].get(key, hashKey)
 if err != nil{
  return nil, err
 }
 return entry,nil
}

第二步执行分片方法获取缓存数据:

  • 先根据哈希值判断key是否存在于缓存中,不存返回key没有找到
  • 从缓存中读取数据得到缓存中的key判断是否发生哈希冲突
  • 判断缓存对象是否过期,过期删除缓存数据(可以根据业务优化需要是否返回当前过期数据)
  • 在每个记录缓存监控数据
func (s *segment) getWarpEntry(key string, hashKey uint64) ([]byte,error) {
 index, ok := s.hashmap[hashKey]
 if !ok {
  s.stats.miss()
  return nil, ErrEntryNotFound
 }
 entry, err := s.entries.Get(int(index))
 if err != nil{
  s.stats.miss()
  return nil, err
 }
 if entry == nil{
  s.stats.miss()
  return nil, ErrEntryNotFound
 }

 if entryKey := readKeyFromEntry(entry); key != entryKey {
  s.stats.collision()
  return nil, ErrEntryNotFound
 }
 return entry, nil
}

func (s *segment) get(key string, hashKey uint64) ([]byte, error) {
 currentTimestamp := s.clock.TimeStamp()
 entry, err := s.getWarpEntry(key, hashKey)
 if err != nil{
  return nil, err
 }
 res := readEntry(entry)

 expireAt := int64(readExpireAtFromEntry(entry))
 if currentTimestamp - expireAt >= 0{
  _ = s.entries.Remove(int(s.hashmap[hashKey]))
  delete(s.hashmap, hashKey)
  return nil, ErrEntryNotFound
 }
 s.stats.hit(key)

 return res, nil
}

第七步:来个测试用例体验一下

先来个简单的测试用例测试一下:

func (h *cacheTestSuite) TestSetAndGet() {
 cache, err := NewCache()
 assert.Equal(h.T(), nil, err)
 key := "asong"
 value := []byte("公众号:Golang梦工厂")

 err = cache.Set(key, value)
 assert.Equal(h.T(), nil, err)

 res, err := cache.Get(key)
 assert.Equal(h.T(), nil, err)
 assert.Equal(h.T(), value, res)
 h.T().Logf("get value is %s", string(res))
}

运行结果:

=== RUN   TestCacheTestSuite
=== RUN   TestCacheTestSuite/TestSetAndGet
    cache_test.go:33: get value is 公众号:Golang梦工厂
--- PASS: TestCacheTestSuite (0.00s)
    --- PASS: TestCacheTestSuite/TestSetAndGet (0.00s)
PASS

大功告成,基本功能通了,剩下就是跑基准测试、优化、迭代了(不在文章赘述了,可以关注github仓库最新动态)。

参考文章

  • https://github.com/allegro/bigcache
  • https://github.com/VictoriaMetrics/fastcache
  • https://github.com/coocood/freecache
  • https://github.com/patrickmn/go-cache

总结

实现篇到这里就结束了,但是这个项目的编码仍未结束,我会继续以此版本为基础不断迭代优化,该本地缓存的优点:

  • 实现简单、提供给用户的方法简单易懂
  • 使用二维切片作为存储结构,避免了不能删除底层数据的缺点,也在一定程度上避免了"虫洞"问题。
  • 测试用例齐全,适合作为小白的入门项目

待优化点:

  • 没有使用高效的缓存淘汰算法,可能会导致热点数据被频繁删除
  • 定时删除过期数据会导致锁持有时间过长,需要优化
  • 关闭缓存实例需要优化处理方式
  • 根据业务场景进行优化(特定业务场景)

迭代点:

  • 添加异步加载缓存功能
  • ...... (思考中)

本文代码已经上传到github:https://github.com/asong2020/go-localcache

好啦,本文到这里就结束了, 我们下期见。

本文由哈喽比特于3年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/11m4m0YA0wPut5alVUu-Ew

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237273次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8108次阅读
 目录