nssession

Installation

go get -u github.com/no-src/nssession

Quick Start

package mainimport ("net/http""time""github.com/no-src/log""github.com/no-src/nssession""github.com/no-src/nssession/store""github.com/no-src/nssession/store/memory")func main() {// initial default session configc := &nssession.Config{Connection: "memory:",Expiration: time.Hour,Store:      store.NewStore(memory.Driver),}err := nssession.InitDefaultConfig(c)if err != nil {log.Error(err, "init the default config error")return}http.HandleFunc("/", func(writer http.ResponseWriter, request *http.Request) {// get session componentsession, err := nssession.Default(request, writer)if err != nil {log.Error(err, "get session component error")return}// set session datak := "hello"var v stringerr = session.Set(k, "world")if err != nil {log.Error(err, "set session data error")return}// get session dataerr = session.Get(k, &v)if err != nil {log.Error(err, "get session data error")return}log.Info("get the session data success, k=%s v=%s", k, v)// remove session dataerr = session.Remove(k)if err != nil {log.Error(err, "remove session data error")return}// clear all session data for the current sessionerr = session.Clear()if err != nil {log.Error(err, "clear session data error")return}})http.ListenAndServe(":8080", nil)}

Constants¶

Variables¶

var (// DefaultCookieName the default cookie name for sessionDefaultCookieName = "ns-session-id"// DefaultSessionPrefix the default session prefix for session storeDefaultSessionPrefix = "session")

var ErrNil =errors.New("nssession: nil")

Functions¶

func InitDefaultConfig(c *Config)error

Types¶

type Config struct {// Connection the connection string of the sessionConnectionstring// Expiration the expiration time of the sessionExpirationtime.Duration// SessionPrefix the session prefix for session storeSessionPrefixstring// Store the session store componentStorestore.Store// Cookie the settings of the cookieCookieCookie}

type Cookie struct {// Name the cookie name for sessionNamestring// Path set the Path property of the cookiePathstring// Domain set the Domain property of the cookieDomainstring// Expires set the Expires property of the cookieExpirestime.Time// MaxAge set the Max-Age property of the cookieMaxAgeint// Secure set the Secure property of the cookieSecurebool// SameSite set the SameSite property of the cookieSameSitehttp.SameSite}

type NSSession interface {// ID returns the session idID()string// Get get cache data by keyGet(kstring, vany)error// Set set new cache dataSet(kstring, vany)error// Remove remove the specified keyRemove(kstring)error// Clear remove all the key of current sessionClear()error}

func Default(req *http.Request, writerhttp.ResponseWriter) (NSSession,error)

func New(c *Config, req *http.Request, writerhttp.ResponseWriter) (NSSession,error)