Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phachon/fasthttpsession
A fast and powerful session package for fasthttp servers
https://github.com/phachon/fasthttpsession
fasthttp fasthttpclient fasthttprouter fasthttpsession go go-session go-sessions golang httprouter php-sessions session session-cookie session-management session-manager session-store sessionstorage sessionstore
Last synced: about 1 month ago
JSON representation
A fast and powerful session package for fasthttp servers
- Host: GitHub
- URL: https://github.com/phachon/fasthttpsession
- Owner: phachon
- License: mit
- Created: 2018-04-10T10:24:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-17T06:11:16.000Z (about 4 years ago)
- Last Synced: 2024-06-18T23:05:32.551Z (6 months ago)
- Topics: fasthttp, fasthttpclient, fasthttprouter, fasthttpsession, go, go-session, go-sessions, golang, httprouter, php-sessions, session, session-cookie, session-management, session-manager, session-store, sessionstorage, sessionstore
- Language: Go
- Homepage:
- Size: 2.41 MB
- Stars: 25
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/phachon/fasthttpsession)
[](https://sourcegraph.com/github.com/phachon/fasthttpsession?badge)
[](https://travis-ci.org/phachon/fasthttpsession)
[](https://godoc.org/github.com/phachon/fasthttpsession)
[](https://raw.githubusercontent.com/phachon/fasthttpsession/master/LICENSE)
[](https://goreportcard.com/report/github.com/phachon/fasthttpsession)
[](https://github.com/phachon/fasthttpsession/releases)
[]()
[]()
fasthttpsession is a fast and powerful session package for [fasthttp](https://github.com/valyala/fasthttp) servers
[中文文档](./README_CN.md)
# Description
fasthttpsession is a session manager for Go. It only supports [fasthttp](https://github.com/valyala/fasthttp), currently support providers:
- file
- memcache
- memory
- mysql
- postgres
- redis
- sqlite3
# Features
- Focus on the design of the code architecture and expansion.
- Provide full session storage.
- Convenient switching of session storage.
- Customizable data serialization.
- Implement concurrent map(ccmap.go) to improve performance.
# Install
The only requirement is the Go Programming Language, at least v1.7
```shell
$ go get -u github.com/phachon/fasthttpsession
$ go get ./...
```
# Used
## Quick Start
```Golang
// fasthttpsession use memory provider
import (
"github.com/phachon/fasthttpsession"
"github.com/phachon/fasthttpsession/memory"
"github.com/valyala/fasthttp"
"log"
"os"
)
// default config
var session = fasthttpsession.NewSession(fasthttpsession.NewDefaultConfig())
func main() {
// you must set up provider before use
err := session.SetProvider("memory", &memory.Config{})
if err != nil {
log.Println(err.Error())
os.Exit(1)
}
addr := ":8086"
log.Println("fasthttpsession example server listen: "+addr)
// fasthttp start listen serve
err = fasthttp.ListenAndServe(addr, requestHandle)
if err != nil {
log.Println("listen server error :"+err.Error())
}
}
// request handler
func requestHandle(ctx *fasthttp.RequestCtx) {
// start session
sessionStore, err := session.Start(ctx)
if err != nil {
ctx.SetBodyString(err.Error())
return
}
// must defer sessionStore.save(ctx)
defer sessionStore.Save(ctx)
sessionStore.Set("name", "fasthttpsession")
ctx.SetBodyString(fmt.Sprintf("fasthttpsession setted key name= %s ok", sessionStore.Get("name").(string)))
}
```
## Custom configuration
If you don't want to use the default configuration, please use the following struct custom.
```Golang
type Config struct {
// cookie name
CookieName string
// cookie domain
Domain string
// If you want to delete the cookie when the browser closes, set it to -1.
//
// 0 means no expire, (24 years)
// -1 means when browser closes
// >0 is the time.Duration which the session cookies should expire.
Expires time.Duration
// gc life time(s)
GCLifetime int64
// session life time(s)
SessionLifetime int64
// set whether to pass this bar cookie only through HTTPS
Secure bool
// sessionId is in url query
SessionIdInURLQuery bool
// sessionName in url query
SessionNameInUrlQuery string
// sessionId is in http header
SessionIdInHttpHeader bool
// sessionName in http header
SessionNameInHttpHeader string
// SessionIdGeneratorFunc should returns a random session id.
SessionIdGeneratorFunc func() string
// Encode the cookie value if not nil.
EncodeFunc func(cookieValue string) (string, error)
// Decode the cookie value if not nil.
DecodeFunc func(cookieValue string) (string, error)
}
```
Different session provider config, please look at the Config.go the provider name directory.
# Documents
Document address: [http://godoc.org/github.com/phachon/fasthttpsession](http://godoc.org/github.com/phachon/fasthttpsession)
# Example
[Some Example](_examples)
## Feedback
- If you like the project, please [Start](https://github.com/phachon/fasthttpsession/stargazers).
- If you have any problems in the process of use, welcome submit [Issue](https://github.com/phachon/fasthttpsession/issues).
- If you find and solve bug, welcome submit [Pull Request](https://github.com/phachon/fasthttpsession/pulls).
- If you want to expand session provider, welcome [Fork](https://github.com/phachon/fasthttpsession/network/members) and merge this rep.
- If you want to make a friend, welcome send email to [[email protected]](mailto:[email protected]).
## License
MIT
Thanks
---------
Create By [email protected]