gf/README.MD
2018-05-04 21:13:51 +08:00

12 KiB
Raw Blame History

介绍

gf是一款模块化、松耦合、轻量级、高性能的Web开发框架。开源项目地址(仓库保持实时同步) GiteeGithub

使用中有任何问题/建议欢迎加入技术QQ群交流116707870。如有优秀的框架使用案例欢迎联系作者将地址展示到项目库中您的牛逼将被世人所瞻仰。

特点

  1. 轻量级、高性能,模块化、松耦合设计,丰富的开发模块;
  2. 专业的技术交流群,完善的开发文档,良好的中文化支持;
  3. 支持多种形式的服务注册特性,灵活高效的路由控制管理;
  4. 支持服务事件回调注册功能可供选择的pprof性能分析模块
  5. 支持配置文件及模板文件的自动检测更新机制,即修改即生效;
  6. 强大的数据/表单校验模块支持常用的40种及自定义校验规则
  7. 提供了对基本数据类型的并发安全封装,提供了常用的并发安全容器;
  8. 支持Go变量/Json/Xml/Yml/Toml任意数据格式之间的相互转换及创建
  9. 强大的数据库管理模块支持应用层级的集群管理、读写分离、负载均衡方法及链式ORM操作
  10. 更多特点请查阅框架手册( http://gf.johng.cn )

文档

贡献

gf是开源的、免费的软件这意味着任何人都可以为其开发和进步贡献力量。 gf的项目源代码目前同时托管在 Gitee 和 Github 平台上,您可以选择您喜欢的平台来 fork 项目和合并你的贡献, 两个平台的仓库将会保持即时的同步。我们非常欢迎有更多的朋友加入到gf框架的开发中来 您为gf所做出的任何贡献都将会被记录到gf的史册中。

安装

go get -u gitee.com/johng/gf

使用

哈喽世界!

package main

import "gitee.com/johng/gf/g/net/ghttp"

func main() {
    s := ghttp.GetServer()
    s.BindHandler("/", func(r *ghttp.Request){
        r.Response.Write("哈喽世界!")
    })
    s.Run()
}

多域名支持

package main

import "gitee.com/johng/gf/g/net/ghttp"

func main() {
    s := ghttp.GetServer()
    s.Domain("localhost1localhost2localhost3").BindHandler("/", func(r *ghttp.Request) {
        r.Response.Write("localhostx")
    })
    s.Run()
}

多端口支持

package main

import (
    "gitee.com/johng/gf/g/net/ghttp"
)

func main() {
    s := ghttp.GetServer()
    s.BindHandler("/", func(r *ghttp.Request){
        r.Response.Writeln("go frame!")
    })
    s.SetPort(8080, 8081, 8082)
    s.Run()
}

服务注册

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() {
    // 绑定控制器到指定URI所有控制器的公开方法将会映射到指定URI末尾
    // 例如该方法执行后,查看效果可访问:
    // http://127.0.0.1:8199/user/name
    s := ghttp.GetServer()
    s.BindController("/user", &ControllerUser{})
    s.Run()
}

路由控制

package main

import "gitee.com/johng/gf/g/net/ghttp"

func main() {
    s := ghttp.GetServer()
    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()
}

模板引擎

package main

import (
    "gitee.com/johng/gf/g/net/ghttp"
    "gitee.com/johng/gf/g/frame/gmvc"
)

type ControllerTemplate struct {
    gmvc.Controller
}

func (c *ControllerTemplate) Info() {
    c.View.Assign("name", "john")
    c.View.Assigns(map[string]interface{}{
        "age"   : 18,
        "score" : 100,
    })
    c.View.DisplayContent(`
        <html>
            <head>
                <title>gf template engine</title>
            </head>
            <body>
                <p>Name: {{.name}}</p>
                <p>Age:  {{.age}}</p>
                <p>Score:{{.score}}</p>
            </body>
        </html>
    `)
}

func main() {
    s := ghttp.GetServer()
    s.BindController("/template", &ControllerTemplate{})
    s.SetPort(8199)
    s.Run()
}

数据校验

rule := "url|min-length:11"
msgs := map[string]string{
    "url"       : "请输入正确的URL地址",
    "minlength" : "地址长度至少为:min位"
}
fmt.Println(gvalid.Check("http://gfjohngcn", rule, msgs))

数据库ORM

链式操作

ORM单例对象

// 获取默认配置的数据库对象(配置名称为"default")
db, err := gdb.New()
// 获取配置分组名称为"user-center"的数据库对象
db, err := gdb.New("user-center")

单表/联表查询

// 查询多条记录并使用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查询

r, err := db.Table("user").Where("name like ?", "%john%").Select()

链式更新/删除

// 更新
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()

链式写入/保存

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()

链式批量写入

r, err := db.Table("user").Data(gdb.List{
    {"name": "john_1"},
    {"name": "john_2"},
    {"name": "john_3"},
    {"name": "john_4"},
}).Insert()

链式批量保存

r, err := db.Table("user").Data(gdb.List{
    {"uid":10000, "name": "john_1"},
    {"uid":10001, "name": "john_2"},
    {"uid":10002, "name": "john_3"},
    {"uid":10003, "name": "john_4"},
}).Save()

事务操作

开启事务操作

if tx, err := db.Begin(); err == nil {
    fmt.Println("开启事务操作")
}

事务回滚操作

if tx, err := db.Begin(); err == nil {
    r, err := tx.Save("user", gdb.Map{
        "uid"  :  1,
        "name" : "john",
    })
    tx.Rollback()
    fmt.Println(r, err)
}

事务提交操作

if tx, err := db.Begin(); err == nil {
    r, err := tx.Save("user", gdb.Map{
        "uid"  :  1,
        "name" : "john",
    })
    tx.Commit()
    fmt.Println(r, err)
}

事务链式操作

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)
}

数据编码解析

// JSON
data :=
    `{
        "users" : {
            "count" : 100,
            "list"  : [
                {"name" : "Ming", "score" : 60},
                {"name" : "John", "score" : 99.5}
            ]
        }
    }`

if p, e := gparser.LoadContent([]byte(data), "json"); e != nil {
    glog.Error(e)
} else {
    fmt.Println("John Score:", p.GetFloat32("users.list.1.score"))
}
// XML
data :=
    `<?xml version="1.0" encoding="UTF-8"?>
     <note>
         <to>Tove</to>
         <from>Jani</from>
         <heading>Reminder</heading>
         <body>Don't forget me this weekend!</body>
     </note>`

if p, e := gparser.LoadContent([]byte(data), "xml"); e != nil {
    glog.Error(e)
} else {
    fmt.Println("Heading:", p.GetString("note.heading"))
}

...

更多特性及示例请查看官方开发文档:gf.johng.cn