g4cache

g4cache

Add cache on your GORM V2 queries' results is now a breeze

Introduction

• 中文版说明请参考 README.zh_cn.md
• Cache Layer for GORM GORM
• only support Redis cache
• Golang 1.16 +

Install

go get -u github.com/vodka0629/g4cache

Usage

Init

// define a redisClient
redisClient := redis.NewClient(&redis.Options{
    Addr:         "redis:6379",
    Password:     "",
})
// use redisAdapter to init the cache 
redisAdapter, _ := cache.RedisAdapter.New(redisClient)
plugin, err = G4Cache.New(&CacheOptions{
    Cache:     redisAdapter,
    Ttl:       time.Hour,
    AutoFlush: true,
})
// plugin to gorm
err = db.Use(plugin)

CURD

just follow the old path

Features

• follow the GORM Plugin interface
• support simple query / scan / plunk methods, and has-one / belongs-to / has-many / many-to-many relations
• support cache all 1+n query results
• depend on GORM db.Statement.Context
  • DONT use db.WithContext to change the context or input/output params to/from the plugin
• all featured expire strategies
  • support custom TTL
  • support auto flush cache by GORM's create delete update methods
    • need to open AutoFlush option
  • support flush cache manually
    • use FlushTags to expire cache keys by Database's table_name
    • use FlushStruct to expire cache keys by GORM's struct
    • use FlushDB to flush the whole cache database danger!
• provide all logs info for debug propose
  • depend on GORM's logger ( so you need to plugin to GORM first, and config the logger correctly )
  • set CacheOptions debug : true to enable the debug mode
  • set CacheOptions verbose : true to enable the verbose mode
  • colorful logs
• adaptability
  • custom serializer/deserializer interface
    • need to implement serializer.Adapter interface
  • custom cache adapter interface
    • need to implement cache.Adapter interface
• automatic test

TODO

• full sized sample code ( at present, you can find the samples in g4cache_test.go )
• setup github CI actions
  • provide code coverage report
• provide more detailed documents
• support GORM raw query