brisk

README

高性能go语言web框架

Brisk 高性能HTTP-web框架

Brisk，使用go标准库net/http构建的HTTP-web框架，采用前缀树路由系统，支持动态路由匹配。

Brisk可以用来构建一些简单的api，目前已支持动态路由、自定义中间件、分组路由；后续将会推出一系列内置中间件，支持项目级别的配置管理、集成go模板渲染库、信号与接收器、热更新等更加丰富的功能便于开发者使用。

Getting Started

---

在项目中引入

// main.go

package main

import "github.com/DomineCore/brisk"

在项目中引入后，请手动执行 go mod tidy

创建brisk实例 && 运行brisk应用

// main.go

package main

import "github.com/DomineCore/brisk"

func main() {
  b := brisk.New()
  b.Run(":8000")
}

添加你的第一个API：Hello Brisk!

// main.go

func main() {
  b :=brisk.New()
  b.Get("/", func (c *brisk.Context) {
    c.WriteString(http.StatusOk, "Hello Brisk!")
  })
  b.Run(":8000")
}

brisk提供了快捷的创建Get、Post请求的两个方法，这两个方法直接绑定在Brisk结构体上，便于开发者创建简单api。

func (b *Brisk) Get(pattern string, handler HandleFunc){}
func (b *Brisk) Post(pattern string, handler HandleFunc){}

使用路由

Brisk提供了一个基于动态前缀树的路由结构体。使用该结构体可以实现添加API、分组路由、动态路径路由等功能。

使用路由添加API

在Brisk结构体中包含一个Router，它将作为整个项目的总路由，下面我们演示用Brisk.Router来添加路由的方法

func main() {
  ···
  b.Router.Add("/api/", http.MethodPost, func(c *brisk.Context){
    c.WriteString(http.StatusOk, "Hello Brisk!")
  })
  ···
}

分组路由

Brisk.Router结构体提供了一个Include方法，用于连接子路由，借助Include方法可以方便地对我们的项目结构按照不同的路有前缀进行切分。借助分组路由，我们将获得更好的项目组织能力。

func main() {
  ···
  // 创建一个子路由
  api_v1 := brisk.NewRouter()
  api_v1.Add("/hello/", http.MethodGet, func(c *brisk.Context){
    c.WriteString(http.StatusOk, "Hello Brisk!")
  })
  // 连接到主路由
  b.Router.Include("/api/v1/", api_v1)
  ···
}

动态路径参数

Brisk.Router也支持开发者使用形如api/v1/:id的动态路径，例如：

/api/v1/123/ 被解析后将会在上下文Context中新增一个PathParams参数id=123

使用中间件

中间件是用于处理api的公共逻辑，如跨域、日志、登录认证和鉴权等功能，通过中间件来实现是更好的选择。

Brisk内置一个Middleware接口，接口包含两个方法process_request和process_response，两个方法都将Context请求上下文作为参数，借助Context的能力来实现对请求和响应的公共处理逻辑。

使用内置中间件

Brisk内置了两个中间件：LoggingMiddleware和CrosMiddleware分别用于打印访问日志、处理跨域。

b.Router.Use(&brisk.LoggingMiddleware{}) // 使用Router.Use方法来应用中间件
b.Router.Use(&brisk.CrosMiddleware{})

自定义中间件

Brisk实现的Middleware接口，是实现自定义中间件的标准。

实现自定义中间件我们需要创建一个自己的中间件结构体，并且在结构体上实现process_request和process_response两个方法用来实现具体逻辑，以访问日志中间件为例:

type LoggingMiddleware struct{}

func (l *LoggingMiddleware) process_request(c *Context) {
	method := c.Method
	path := c.Path
	time := time.Now()
	timestr := time.Format("2006-01-02 15:04")
	useragent := c.Request.UserAgent()
	loggingstr := fmt.Sprintf("*Request:\t【method:%s; path:%s】\t %s\t from：%s\t", method, path, timestr, useragent)
	println(loggingstr)
}

func (l *LoggingMiddleware) process_response(c *Context) {
	status := c.StatusCode
	path := c.Path
	time := time.Now()
	timestr := time.Format("2006-01-02 15:04")
	loggingstr := fmt.Sprintf("*Response:\t【status:%d; path:%s】\t %s\t", status, path, timestr)
	println(loggingstr)
}

管理配置

brisk 使用go知名开源库viper来管理配置，viper被注入在Birsk结构体中，这样我们可以通过app对象来访问配置。

声明配置文件路径

b.Conf.SetConfigFile('./config') // 配置文件所在路径
b.Conf.SetConfigName('settings') // 配置文件名
b.Conf.SetConfigType('json') // 配置文件类型

获取配置项

b.Conf.Get("key")
b.Conf.GetString("key") //返回key对应value的string
b.Conf.GetBool("key") //返回对应bool值

更多能力请访问viper

---

Brisk仍在快速迭代中，敬请期待后续版本的优化👾。

Documentation

Overview

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Copyright 2022 DomineCore. All rights reserved. Use of this source code is governed by a MIT style license that can be found in the LICENSE file.

Index

• Variables
• func SetConf(path string, name string, filetype string)
• type Brisk
  • func New(configpath string) *Brisk
  • func (b *Brisk) Get(pattern string, handler HandleFunc)
  • func (b *Brisk) LoadConfig(configpath string)
  • func (b *Brisk) LoadDataBase()
  • func (b *Brisk) Post(pattern string, handler HandleFunc)
  • func (b *Brisk) Run(addr string) (err error)
  • func (b *Brisk) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type Conf
  • func NewConf() *Conf
• type Context
  • func NewContext(w http.ResponseWriter, r *http.Request) *Context
  • func (c *Context) AddHeader(key string, value string)
  • func (c *Context) Data(code int, data []byte)
  • func (c *Context) Form(key string) string
  • func (c *Context) HTML(code int, html string)
  • func (c *Context) JsonBind(obj interface{}) error
  • func (c *Context) QueryParams(key string) string
  • func (c *Context) SetHeader(key string, value string)
  • func (c *Context) SetStatusCode(code int)
  • func (c *Context) WriteJSON(code int, obj interface{})
  • func (c *Context) WriteString(code int, format string, values ...interface{})
• type CrosMiddleware
• type DBConnector
  • func NewDBConnector() *DBConnector
  • func (db *DBConnector) Connect()
• type DBEngine
• type HandleFunc
• type LoggingMiddleware
• type MiddleWare
• type MySQL
  • func (engine *MySQL) Connect() (*gorm.DB, error)
  • func (engine *MySQL) Init()
• type Node
• type Router
  • func NewRouter() *Router
  • func (r *Router) Add(pattern string, method string, handler HandleFunc)
  • func (r *Router) Dispatch(method string, pattern string, c *Context) (HandleFunc, error)
  • func (r *Router) Include(pattern string, child *Router)
  • func (r *Router) Use(middleware MiddleWare)
• type Trie
  • func NewTrie() *Trie
  • func (t *Trie) Insert(pattern string, method string, handler HandleFunc)
  • func (t *Trie) InsertChild(pattern string, child *Router)
  • func (t *Trie) Search(pattern string, method string) (HandleFunc, map[string]string, error)

Variables

var DB *gorm.DB

Functions

func SetConf

func SetConf(path string, name string, filetype string)

Types

type Brisk

type Brisk struct {
	Router *Router
}

func New

func New(configpath string) *Brisk

func (*Brisk) Get

func (b *Brisk) Get(pattern string, handler HandleFunc)

func (*Brisk) LoadConfig

func (b *Brisk) LoadConfig(configpath string)

func (*Brisk) LoadDataBase

func (b *Brisk) LoadDataBase()

func (*Brisk) Post

func (b *Brisk) Post(pattern string, handler HandleFunc)

func (*Brisk) Run

func (b *Brisk) Run(addr string) (err error)

func (*Brisk) ServeHTTP

func (b *Brisk) ServeHTTP(w http.ResponseWriter, req *http.Request)

type Conf

type Conf struct {
	viper.Viper
}

var Config Conf

func NewConf

func NewConf() *Conf

type Context

type Context struct {
	// 原始结构封装
	Request        *http.Request
	ResponseWriter http.ResponseWriter
	// 请求信息
	Path       string
	Method     string
	PathParams map[string]string // 用于存储动态路径查询参数 example: "/goods/:id/" -- > {"id":123}
	// 响应信息
	StatusCode int
}

func NewContext

func NewContext(w http.ResponseWriter, r *http.Request) *Context

func (*Context) AddHeader

func (c *Context) AddHeader(key string, value string)

func (*Context) Data

func (c *Context) Data(code int, data []byte)

func (*Context) Form

func (c *Context) Form(key string) string

func (*Context) HTML

func (c *Context) HTML(code int, html string)

func (*Context) JsonBind

func (c *Context) JsonBind(obj interface{}) error

func (*Context) QueryParams

func (c *Context) QueryParams(key string) string

func (*Context) SetHeader

func (c *Context) SetHeader(key string, value string)

func (*Context) SetStatusCode

func (c *Context) SetStatusCode(code int)

func (*Context) WriteJSON

func (c *Context) WriteJSON(code int, obj interface{})

func (*Context) WriteString

func (c *Context) WriteString(code int, format string, values ...interface{})

type CrosMiddleware

type CrosMiddleware struct{}

type DBConnector

type DBConnector struct {
	DriverName string // driver_name: mysql/ sqlite/ postgresql/ sqlserver
}

func NewDBConnector

func NewDBConnector() *DBConnector

func (*DBConnector) Connect

func (db *DBConnector) Connect()

type DBEngine

type DBEngine interface {
	Init()                      // init config
	Connect() (*gorm.DB, error) // connect
}

type HandleFunc

type HandleFunc func(c *Context)

type LoggingMiddleware

type LoggingMiddleware struct{}

type MiddleWare

type MiddleWare interface {
	// contains filtered or unexported methods
}

type MySQL

type MySQL struct {
	Username  string
	Password  string
	Host      string
	Port      string
	DBNAME    string
	Charset   string
	Parsetime string
}

func (*MySQL) Connect

func (engine *MySQL) Connect() (*gorm.DB, error)

func (*MySQL) Init

func (engine *MySQL) Init()

type Node

type Node struct {
	// contains filtered or unexported fields
}

type Router

type Router struct {
	Middlewares []MiddleWare
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter() *Router

func (*Router) Add

func (r *Router) Add(pattern string, method string, handler HandleFunc)

func (*Router) Dispatch

func (r *Router) Dispatch(method string, pattern string, c *Context) (HandleFunc, error)

func (*Router) Include

func (r *Router) Include(pattern string, child *Router)

func (*Router) Use

func (r *Router) Use(middleware MiddleWare)

type Trie

type Trie struct {
	// contains filtered or unexported fields
}

func NewTrie

func NewTrie() *Trie

func (*Trie) Insert

func (t *Trie) Insert(pattern string, method string, handler HandleFunc)

func (*Trie) InsertChild

func (t *Trie) InsertChild(pattern string, child *Router)

func (*Trie) Search

func (t *Trie) Search(pattern string, method string) (HandleFunc, map[string]string, error)