大部分场景下，通过 gsession 组件内置提供的常见 Storage 实现已经能够满足需求。如果有特殊的场景需要制定不易开发 Storage 当然也是支持的，因为 gsession 的功能都采用了接口化设计。

Storage定义

https://github.com/gogf/gf/v2/blob/master/os/gsession/gsession_storage.go

  1. // Storage is the interface definition for session storage.
  2. type Storage interface {
  3.     // New creates a custom session id.
  4.     // This function can be used for custom session creation.
  5.     New(ctx context.Context, ttl time.Duration) (id string, err error)
  7.     // Get retrieves and returns session value with given key.
  8.     // It returns nil if the key does not exist in the session.
  9.     Get(ctx context.Context, id string, key string) (value interface{}, err error)
  11.     // GetMap retrieves all key-value pairs as map from storage.
  12.     GetMap(ctx context.Context, id string) (data map[string]interface{}, err error)
  14.     // GetSize retrieves and returns the size of key-value pairs from storage.
  15.     GetSize(ctx context.Context, id string) (size int, err error)
  17.     // Set sets one key-value session pair to the storage.
  18.     // The parameter `ttl` specifies the TTL for the session id.
  19.     Set(ctx context.Context, id string, key string, value interface{}, ttl time.Duration) error
  21.     // SetMap batch sets key-value session pairs as map to the storage.
  22.     // The parameter `ttl` specifies the TTL for the session id.
  23.     SetMap(ctx context.Context, id string, data map[string]interface{}, ttl time.Duration) error
  25.     // Remove deletes key with its value from storage.
  26.     Remove(ctx context.Context, id string, key string) error
  28.     // RemoveAll deletes all key-value pairs from storage.
  29.     RemoveAll(ctx context.Context, id string) error
  31.     // GetSession returns the session data as `*gmap.StrAnyMap` for given session id from storage.
  32.     //
  33.     // The parameter `ttl` specifies the TTL for this session.
  34.     // The parameter `data` is the current old session data stored in memory,
  35.     // and for some storage it might be nil if memory storage is disabled.
  36.     //
  37.     // This function is called ever when session starts. It returns nil if the TTL is exceeded.
  38.     GetSession(ctx context.Context, id string, ttl time.Duration, data *gmap.StrAnyMap) (*gmap.StrAnyMap, error)
  40.     // SetSession updates the data for specified session id.
  41.     // This function is called ever after session, which is changed dirty, is closed.
  42.     // This copy all session data map from memory to storage.
  43.     SetSession(ctx context.Context, id string, data *gmap.StrAnyMap, ttl time.Duration) error
  45.     // UpdateTTL updates the TTL for specified session id.
  46.     // This function is called ever after session, which is not dirty, is closed.
  47.     UpdateTTL(ctx context.Context, id string, ttl time.Duration) error
  48. }

每一个方法的调用时机都在注释中详细介绍了，开发者在实现自定义的 Storage 时，可以充分参考内置的几种 Storage 实现。

注意事项

  • Storage 接口中，并不是所有的接口方法都需要实现，开发者仅需要根据业务需要，实现特定调用时机的一些接口即可。
  • 为了提高 Session 的执行性能，接口有 gmap.StrAnyMap 容器类型的使用，开发时可以参考一下章节： 字典类型-gmap