mirror of
https://gitee.com/johng/gf
synced 2026-06-07 02:12:11 +08:00
238 lines
6.2 KiB
Markdown
238 lines
6.2 KiB
Markdown
<div align=center>
|
||
<img src="http://cover.kancloud.cn/johng/gf" width="150"/>
|
||
</div>
|
||
|
||
# 安装
|
||
```html
|
||
go get -u gitee.com/johng/gf
|
||
```
|
||
|
||
# 介绍
|
||
gf是一款模块化、松耦合、轻量级、高性能的Web开发框架。开源项目地址(仓库保持实时同步)：
|
||
[Gitee](https://gitee.com/johng/gf)，[Github](https://github.com/johng-cn/gf)。
|
||
使用中有任何问题/建议，欢迎加入技术QQ群交流：116707870。
|
||
如有优秀的框架使用案例，欢迎联系作者将地址展示到项目库中，您的牛逼将被世人所瞻仰。
|
||
|
||
# 特点
|
||
1. 轻量级、高性能，模块化、松耦合设计，丰富的开发模块；
|
||
1. 热重启、热更新特性，并支持Web界面及命令行管理接口；
|
||
1. 专业的技术交流群，完善的开发文档及示例代码，良好的中文化支持；
|
||
1. 支持多种形式的服务注册特性，灵活高效的路由控制管理；
|
||
1. 支持服务事件回调注册功能，可供选择的pprof性能分析模块；
|
||
1. 支持配置文件及模板文件的自动检测更新机制，即修改即生效；
|
||
1. 支持自定义日期时间格式的时间模块，类似PHP日期时间格式化；
|
||
1. 强大的数据/表单校验模块，支持常用的40种及自定义校验规则；
|
||
1. 强大的网络通信TCP/UDP组件，并提供TCP连接池特性，简便高效；
|
||
1. 提供了对基本数据类型的并发安全封装，提供了常用的数据结构容器；
|
||
1. 支持Go变量/Json/Xml/Yml/Toml任意数据格式之间的相互转换及创建；
|
||
1. 强大的数据库ORM，支持应用层级的集群管理、读写分离、负载均衡，查询缓存、方法及链式ORM操作；
|
||
1. 更多特点请查阅框架手册和源码；
|
||
|
||
# 文档
|
||
GoFrame开发文档：[http://gf.johng.cn](http://gf.johng.cn)
|
||
|
||
|
||
# 使用
|
||
## 哈喽世界！
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"gitee.com/johng/gf/g"
|
||
"gitee.com/johng/gf/g/net/ghttp"
|
||
)
|
||
|
||
func main() {
|
||
s := g.Server()
|
||
s.BindHandler("/", func(r *ghttp.Request) {
|
||
r.Response.Write("哈喽世界！")
|
||
})
|
||
s.Run()
|
||
}
|
||
```
|
||
## 多域名支持
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"gitee.com/johng/gf/g"
|
||
"gitee.com/johng/gf/g/net/ghttp"
|
||
)
|
||
|
||
func main() {
|
||
s := g.Server()
|
||
s.Domain("localhost1，localhost2，localhost3").BindHandler("/", func(r *ghttp.Request) {
|
||
r.Response.Write("localhostx")
|
||
})
|
||
s.Run()
|
||
}
|
||
```
|
||
## 多端口支持
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"gitee.com/johng/gf/g"
|
||
"gitee.com/johng/gf/g/net/ghttp"
|
||
)
|
||
|
||
func main() {
|
||
s := g.Server()
|
||
s.BindHandler("/", func(r *ghttp.Request){
|
||
r.Response.Writeln("go frame!")
|
||
})
|
||
s.SetPort(8080, 8081, 8082)
|
||
s.Run()
|
||
}
|
||
```
|
||
|
||
## 服务注册
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"gitee.com/johng/gf/g/net/ghttp"
|
||
"gitee.com/johng/gf/g/frame/gmvc"
|
||
)
|
||
|
||
type ControllerUser struct {
|
||
gmvc.Controller
|
||
}
|
||
|
||
func (c *ControllerUser) Name() {
|
||
c.Response.Write("John")
|
||
}
|
||
|
||
func main() {
|
||
s := g.Server()
|
||
s.BindController("/user", &ControllerUser{})
|
||
s.Run()
|
||
}
|
||
```
|
||
|
||
## 路由控制
|
||
```go
|
||
package main
|
||
|
||
import "gitee.com/johng/gf/g/net/ghttp"
|
||
|
||
func main() {
|
||
s := g.Server()
|
||
s.BindHandler("/:name/:action", func(r *ghttp.Request){
|
||
r.Response.Write(r.Get("name"))
|
||
r.Response.Write(r.Get("action"))
|
||
})
|
||
s.SetPort(8199)
|
||
s.Run()
|
||
}
|
||
```
|
||
|
||
## 数据校验
|
||
```go
|
||
rule := "url|min-length:11"
|
||
msgs := map[string]string{
|
||
"url" : "请输入正确的URL地址",
|
||
"minlength" : "地址长度至少为:min位"
|
||
}
|
||
fmt.Println(gvalid.Check("http://gfjohngcn", rule, msgs))
|
||
```
|
||
|
||
## 数据库ORM
|
||
|
||
### 链式操作
|
||
|
||
#### ORM单例对象
|
||
```go
|
||
// 获取默认配置的数据库对象(配置名称为"default")
|
||
db, err := gdb.New()
|
||
// 获取配置分组名称为"user-center"的数据库对象
|
||
db, err := gdb.New("user-center")
|
||
```
|
||
#### 单表/联表查询
|
||
```go
|
||
// 查询多条记录并使用Limit分页
|
||
r, err := db.Table("user").Where("u.uid > ?", 1).Limit(0, 10).Select()
|
||
// 查询符合条件的单条记录(第一条)
|
||
r, err := db.Table("user u").LeftJoin("user_detail ud", "u.uid=ud.uid").Fields("u.*,ud.site").Where("u.uid=?", 1).One()
|
||
// 查询指定字段值
|
||
r, err := db.Table("user u").RightJoin("user_detail ud", "u.uid=ud.uid").Fields("ud.site").Where("u.uid=?", 1).Value()
|
||
// 分组及排序
|
||
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()
|
||
// 不使用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()
|
||
```
|
||
|
||
#### like查询
|
||
```go
|
||
r, err := db.Table("user").Where("name like ?", "%john%").Select()
|
||
```
|
||
|
||
#### 链式更新/删除
|
||
```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()
|
||
// 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()
|
||
```
|
||
#### 链式写入/保存
|
||
```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 {
|
||
fmt.Println("开启事务操作")
|
||
}
|
||
```
|
||
|
||
#### 事务回滚操作
|
||
```go
|
||
if tx, err := db.Begin(); err == nil {
|
||
r, err := tx.Save("user", gdb.Map{
|
||
"uid" : 1,
|
||
"name" : "john",
|
||
})
|
||
tx.Rollback()
|
||
fmt.Println(r, err)
|
||
}
|
||
```
|
||
|
||
#### 事务提交操作
|
||
```go
|
||
if tx, err := db.Begin(); err == nil {
|
||
r, err := tx.Save("user", gdb.Map{
|
||
"uid" : 1,
|
||
"name" : "john",
|
||
})
|
||
tx.Commit()
|
||
fmt.Println(r, err)
|
||
}
|
||
```
|
||
|
||
#### 事务链式操作
|
||
```go
|
||
if tx, err := db.Begin(); err == nil {
|
||
r, err := tx.Table("user").Data(gdb.Map{"uid":1, "name": "john"}).Save()
|
||
tx.Commit()
|
||
fmt.Println(r, err)
|
||
}
|
||
```
|
||
|
||
|
||
...
|
||
|
||
|
||
更多特性及示例请查看官方开发文档：[gf.johng.cn](http://gf.johng.cn)
|