tong - 桐 是一个以 学习 为目的的 Go Web 框架，遵循 GPL V3 协议。
与 桐 框架配套的，是一本开源书籍《深入浅出 Go Web 编程》，在这本开源书籍中，我们尽可能全面，详细的介绍了与 Go Web 开发相关的知识。在这本书中我们也完整的介绍了 桐 框架的源码。
正如我们所说的， 桐 是一个以 学习 为主要目的的 Web 框架，我们并不自负，也不盲目的想去创造一个全新的轮子。我们只是希望更多的人，不只是使用，而是去思考；我们只是希望的更多的人，不只是使用，而是去创造；我们希望通过对 桐 框架的使用，通过对《深入浅出 Go Web 编程》的阅读，能让更多的人发现，创造一个开源的框架，并不像想象中那么困难。
当然，我们也希望，通过这个过程，你可以完善，细化自己 Web 开发的知识体系。
我们也更希望，如果可能，你可以一起来完善 桐 ，使它成为一个可以在生产环境中应用的完整框架。
为了安装 tong package，首先你需要安装 Go 环境（version 1.11+ ），并设置好你的 Go workspace。
随后，你可以使用下面的 Go 命令来安装 tong：
go get github.com/ming3000/tong
在你的代码中，通过下面的 import 语句来引入 tong：
import "github.com/ming3000/tong"
假定你的测试代码位于 demo.go 文件中。
$ cat ./demo.go
package main
import (
"github.com/ming3000/tong"
"log"
"net/http"
)
func index(ctx *tong.Context) error {
return ctx.String(http.StatusOK, "hello world!")
}
func fun(ctx *tong.Context) error {
return ctx.String(http.StatusOK, "have fun!")
}
func main() {
t := tong.New()
t.GET("/", index)
t.GET("/fun", fun)
log.Fatalln(t.Start(":3000"))
} 运行 demo.go 文件：
$ go run demo.go
在浏览器中通过 localhost:3000/ 进行访问。
func main() {
// create a tong instance
t := tong.New()
// register handler
t.GET("/someGet", somGetHandle)
t.POST("/somePost", somePostHandle)
// start the server on localhost:3000
log.Fatalln(t.Start(":3000"))
} func main() {
// create a tong instance
t := tong.New()
// the handler math the url /user?name=python&age=30
t.GET("/user", func(c *tong.Context) error {
name := c.QueryString("name", "default name")
age := c.QueryInt("age", 3)
return c.String(http.StatusOK,
fmt.Sprintf("hello, %s, %d", name, age))
})
log.Fatalln(t.Start(":3000"))
}
func main() {
// create a tong instance
t := tong.New()
t.POST("/user", func(c *tong.Context) error {
name := c.PostString("name", "default name")
age := c.PostInt("age", 3)
return c.String(http.StatusOK,
fmt.Sprintf("hello,name:%s,age:%d", name, age))
})
log.Fatalln(t.Start(":3000"))
}
返回 string 给客户端：
String(code int, value string) error
返回 json 结构体给客户端：
Json(code int, value interface{}, indent string) error
[todo]
query string
form
json
protobuf
[todo]
客户端ip解析
访问日志 logger
异常恢复 recover
令牌桶限流 rating
bitmap黑名单
cors
jwt
访问超时
tong 框架原生支持定时任务，每一个定时任务都会在独立的 goroutine 中执行。每一个定时任务，都是实现了如下接口的对象实例：
// Job is an interface for job to do.
type Job interface {
// true to decline the step period, false to stay
Run() bool
} tong 的定时任务采用了一种 “自适应” 的执行方式。即如果定时任务的 Run 方法返回了 true 值，则下一次定时任务的执行时间间隔为 基础时间间隔 + 步长时间间隔，直到达到了最大定时时间间隔。相反，如果定时任务的 Run 方法返回了 false值，则下一次定时任务依旧按照预设的定时时间间隔周期执行。
type helloJob struct {}
func (h helloJob) Run() bool {
log.Println("hello, ", time.Now().Format(time.RFC3339))
return false
}
t := tong.New()
t.AddCronJob(time.Second*3, time.Second*10, time.Minute, helloJob{})
tong 的上下文 context 中，提供了 common.Logger 类型的日志工具类对象 。在处理程序中，可以直接使用 日志工具类对象 提供的方法，打印输出日志信息。
tong 的日志工具类有以下几个特点：
- 可以指定日志输出文件，调试信息会同时打印到标准 Stdout 和文件。
- 日志输出文件可以配置为 按照 日志文件的大小 或 日志文件的生成时间 进行 拆分。
- tong 并没有提供类似 info，debug，error 等复杂的日志分类级别，只提供了一个全局的 debug 开关配置项。如果 debug 配置项设置为 false，则 debug 类的信息均不会输出。
- 在打印错误信息时，同时会输出函数调用栈信息。
日志工具类 common.Logger 提供了 5 个日志打印相关的接口：
// 打印格式化调试信息
DebugFormat(format string, message ...interface{})
// 打印调试信息并输出换行符
Debug(message ...interface{})
// 设置打印输出错误信息时，函数调用栈的最大深度
SetCallerDepth(depth uint8)
// 打印格式化错误信息
ErrorFormat(format string, message ...interface{})
// 打印错误信息并输出换行符
Error(format string, message ...interface{})
tong 提供了 common.Logger 的构造函数，以便按需求对日志进行定制化配置：
func NewLogger(fileName string, // 日志文件名
fileMaxSize int, // 日志文件进行切分的最大长度
fileMaxExpire int,// 日志文件进行切分的最长时间
prefix string, // 日志前缀
debug bool // 是否输出 debug 信息
) *Logger
tong 的上下文 context 中，提供了 2 种缓存对象。它们都是并发安全的。
RequestCache - 该缓存的作用域为当前的 HTTP Request 的生命周期。 在处理请求时，用作临时存储的对象，每次请求都会重设这个变量。实现策略为 LRU 链表。
GlobalCache - 该缓存的作用域为整个 tong 应用程序的生命周期。该缓存的内容会被持久化到磁盘。下一次应用重启时，可以重复使用。实现策略为 LSM 文件。
这两种缓存对象，都提供了下面的三种方法，供处理器程序使用：
Set(key string, value interface{})
Get(key string) interface{}
Del(key string)
[todo]