gf/README.MD

182 lines
5.8 KiB
Plaintext
Raw Normal View History

2018-04-19 22:20:03 +08:00
<div align=center>
2018-07-21 23:48:04 +08:00
<img src="http://cover.kancloud.cn/johng/gf" width="150"/>
2018-02-26 17:22:38 +08:00
</div>
2018-04-19 22:15:46 +08:00
2018-05-30 12:56:49 +08:00
2018-08-06 23:05:07 +08:00
GF(Go Frame)是一款模块化、松耦合、轻量级、高性能的Go语言Web开发框架。支持热重启、热更新、多域名、多端口、多服务、HTTP/HTTPS、动态路由等特性
并提供了Web服务开发的系列核心组件Router、Cookie、Session、服务注册、配置管理、模板引擎、数据校验、分页管理、数据库ORM等等等等
并且提供了数十个实用开发模块集缓存、日志、时间、命令行、二进制、文件锁、对象池、连接池、数据编码、进程管理、进程通信、TCP/UDP组件、
并发安全容器、Goroutine池等等等等等等。
2018-08-06 12:59:08 +08:00
开源项目地址(仓库保持实时同步)
2018-07-22 00:04:46 +08:00
[Gitee](https://gitee.com/johng/gf)[Github](https://github.com/johng-cn/gf)。
2018-08-06 12:57:03 +08:00
使用中有任何问题/建议欢迎加入技术QQ群交流**116707870**。
2018-07-21 23:48:04 +08:00
如有优秀的框架使用案例,欢迎联系作者将地址展示到项目库中,您的牛逼将被世人所瞻仰。
2018-01-12 13:10:37 +08:00
2018-08-06 23:05:07 +08:00
# 安装
```html
go get -u gitee.com/johng/gf
```
# 限制
```shell
golang版本 >= 1.9.2
```
2018-04-15 10:33:24 +08:00
# 特点
2018-04-22 09:48:18 +08:00
1. 轻量级、高性能,模块化、松耦合设计,丰富的开发模块;
2018-05-18 16:14:48 +08:00
1. 热重启、热更新特性并支持Web界面及命令行管理接口
2018-07-22 12:25:35 +08:00
1. 专业的技术交流群,完善的开发文档及示例代码,良好的中文化支持;
2018-04-19 22:14:22 +08:00
1. 支持多种形式的服务注册特性,灵活高效的路由控制管理;
1. 支持服务事件回调注册功能可供选择的pprof性能分析模块
1. 支持配置文件及模板文件的自动检测更新机制,即修改即生效;
2018-07-22 00:04:46 +08:00
1. 支持自定义日期时间格式的时间模块类似PHP日期时间格式化
2018-04-19 22:14:22 +08:00
1. 强大的数据/表单校验模块支持常用的40种及自定义校验规则
2018-07-22 00:04:46 +08:00
1. 强大的网络通信TCP/UDP组件并提供TCP连接池特性简便高效
1. 提供了对基本数据类型的并发安全封装,提供了常用的数据结构容器;
2018-04-19 22:14:22 +08:00
1. 支持Go变量/Json/Xml/Yml/Toml任意数据格式之间的相互转换及创建
2018-07-22 00:04:46 +08:00
1. 强大的数据库ORM支持应用层级的集群管理、读写分离、负载均衡查询缓存、方法及链式ORM操作
2018-08-06 12:57:03 +08:00
1. 更多特点请查阅框架[手册](http://gf.johng.cn)和[源码](https://godoc.org/github.com/johng-cn/gf)
2018-02-28 13:55:05 +08:00
2018-04-15 10:33:24 +08:00
# 文档
2018-07-21 23:48:04 +08:00
GoFrame开发文档[http://gf.johng.cn](http://gf.johng.cn)
2018-04-19 11:08:09 +08:00
2018-04-15 10:33:24 +08:00
# 使用
2018-08-06 12:57:03 +08:00
## Hello World
2018-04-19 11:08:09 +08:00
```go
package main
2018-05-18 15:55:27 +08:00
import (
"gitee.com/johng/gf/g"
"gitee.com/johng/gf/g/net/ghttp"
)
2018-04-19 11:08:09 +08:00
func main() {
2018-05-18 15:55:27 +08:00
s := g.Server()
s.BindHandler("/", func(r *ghttp.Request) {
2018-08-06 12:57:03 +08:00
r.Response.Write("Hello World")
2018-04-19 11:08:09 +08:00
})
s.Run()
}
```
2018-05-04 21:13:51 +08:00
## 多域名支持
2018-04-19 11:10:19 +08:00
```go
package main
2018-05-18 15:55:27 +08:00
import (
"gitee.com/johng/gf/g"
"gitee.com/johng/gf/g/net/ghttp"
)
2018-04-19 11:10:19 +08:00
func main() {
2018-05-18 15:55:27 +08:00
s := g.Server()
2018-08-06 12:57:03 +08:00
s.Domain("localhost1,localhost2").BindHandler("/", func(r *ghttp.Request) {
2018-05-04 21:13:51 +08:00
r.Response.Write("localhostx")
2018-04-19 11:10:19 +08:00
})
s.Run()
}
```
2018-05-04 21:13:51 +08:00
## 多端口支持
2018-04-19 11:10:19 +08:00
```go
package main
2018-05-04 21:13:51 +08:00
import (
2018-05-18 15:55:27 +08:00
"gitee.com/johng/gf/g"
2018-05-04 21:13:51 +08:00
"gitee.com/johng/gf/g/net/ghttp"
)
2018-04-19 11:10:19 +08:00
func main() {
2018-05-18 15:55:27 +08:00
s := g.Server()
2018-05-04 21:13:51 +08:00
s.BindHandler("/", func(r *ghttp.Request){
r.Response.Writeln("go frame!")
2018-04-19 11:10:19 +08:00
})
2018-05-04 21:13:51 +08:00
s.SetPort(8080, 8081, 8082)
2018-04-19 11:10:19 +08:00
s.Run()
}
```
2018-08-06 12:57:03 +08:00
## 路由控制
2018-04-19 11:08:09 +08:00
```go
package main
import (
2018-08-06 12:57:03 +08:00
"gitee.com/johng/gf/g"
2018-04-19 11:08:09 +08:00
"gitee.com/johng/gf/g/net/ghttp"
)
func main() {
2018-07-22 00:04:46 +08:00
s := g.Server()
2018-08-06 12:57:03 +08:00
s.BindHandler("/order/:action/{page}.html", func(r *ghttp.Request){
r.Response.Writef("action:%s, page:%s", r.Get("action"), r.Get("page"))
2018-04-19 11:08:09 +08:00
})
s.SetPort(8199)
s.Run()
}
```
## 数据库ORM
2018-04-21 15:36:09 +08:00
2018-08-06 12:57:03 +08:00
### ORM创建/关闭
2018-04-19 11:10:19 +08:00
```go
// 获取默认配置的数据库对象(配置名称为"default")
2018-05-04 21:13:51 +08:00
db, err := gdb.New()
2018-04-19 11:10:19 +08:00
// 获取配置分组名称为"user-center"的数据库对象
2018-05-04 21:13:51 +08:00
db, err := gdb.New("user-center")
2018-08-06 12:57:03 +08:00
// 关闭数据库操作对象(丢回连接池对象复用)
db.Close()
2018-04-19 11:10:19 +08:00
```
2018-08-06 12:57:03 +08:00
### 单表/联表查询
2018-04-19 11:13:11 +08:00
```go
// 查询多条记录并使用Limit分页
2018-04-21 15:36:09 +08:00
r, err := db.Table("user").Where("u.uid > ?", 1).Limit(0, 10).Select()
2018-04-19 11:13:11 +08:00
// 查询符合条件的单条记录(第一条)
r, err := db.Table("user u").LeftJoin("user_detail ud", "u.uid=ud.uid").Fields("u.*,ud.site").Where("u.uid=?", 1).One()
2018-04-21 15:36:09 +08:00
// 查询指定字段值
r, err := db.Table("user u").RightJoin("user_detail ud", "u.uid=ud.uid").Fields("ud.site").Where("u.uid=?", 1).Value()
2018-04-19 11:13:11 +08:00
// 分组及排序
2018-04-21 15:36:09 +08:00
r, err := db.Table("user u").InnerJoin("user_detail ud", "u.uid=ud.uid").Fields("u.*,ud.city").GroupBy("city").OrderBy("register_time asc").Select()
2018-05-04 21:13:51 +08:00
// 不使用john的联表查询
r, err := db.Table("user u,user_detail ud").Where("u.uid=ud.uid").Fields("u.*,ud.city").All()
// 不使用Fields方法指定查询字段时默认查询为"*"
r, err := db.Table("user").Where("u.uid=1",).One()
```
2018-08-06 12:57:03 +08:00
### 更新/删除
2018-04-19 11:13:11 +08:00
```go
// 更新
r, err := db.Table("user").Data(gdb.Map{"name" : "john2"}).Where("name=?", "john").Update()
r, err := db.Table("user").Data("name='john3'").Where("name=?", "john2").Update()
// 删除
r, err := db.Table("user").Where("uid=?", 10).Delete()
2018-05-04 21:13:51 +08:00
// Data数值方法的参数形式比较灵活
r, err := db.Table("user").Data(`name="john"`).Update()
r, err := db.Table("user").Data("name", "john").Update()
r, err := db.Table("user").Data(g.Map{"name" : "john"}).Update()
2018-04-19 11:13:11 +08:00
```
2018-08-06 12:57:03 +08:00
### 写入/保存
2018-04-19 11:13:11 +08:00
```go
r, err := db.Table("user").Data(gdb.Map{"name": "john"}).Insert()
r, err := db.Table("user").Data(gdb.Map{"uid": 10000, "name": "john"}).Replace()
r, err := db.Table("user").Data(gdb.Map{"uid": 10001, "name": "john"}).Save()
```
### 事务操作
```go
if tx, err := db.Begin(); err == nil {
2018-08-06 12:57:03 +08:00
if r, err := tx.Table("user").Data(gdb.Map{"uid":1, "name": "john"}).Save(); err == nil {
tx.Commit()
} else {
tx.Rollback()
}
2018-07-22 00:04:46 +08:00
2018-04-19 11:13:11 +08:00
fmt.Println(r, err)
}
```
2018-04-15 10:56:09 +08:00
...
更多特性及示例请查看官方开发文档:[gf.johng.cn](http://gf.johng.cn)