gf/README.MD
2018-04-19 11:13:11 +08:00

12 KiB
Raw Blame History

介绍

gf(Go Frame)是一款为Web服务及网络服务开发设计的模块化、低耦合、轻量级、高性能的Go语言开发框架。 实现了通用的HTTP/TCP/UDP Server并提供了Web服务开发的系列核心组件 包括MVC、Cookie、Session、服务注册、路由控制、配置管理、模板引擎、数据校验、数据库操作(ORM)等等, 并且提供了数十个实用开发模块包括缓存模块、日志模块、JSON模块、命令行模块、二进制模块、环境变量模块、并发安全容器、Goroutine池等等。

gf是开源的免费的基于MIT协议进行分发开源项目地址(gitee与github仓库保持实时同步) Gitee( https://gitee.com/johng/gf )Github( https://github.com/johng-cn/gf )

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

特点

  1. 纯Go语言实现开源、免费、跨平台、高性能
  2. 充分利用Go语言特点采用模块化、低耦合设计
  3. 为Web服务及网络服务开发设计轻量级简便易用
  4. 精心设计的核心组件及数十个丰富实用的开发模块库;
  5. 功能强大的HttpServer及服务注册功能提高Web开发效率
  6. 丰富详尽的框架文档及专业的技术支持/讨论群,易于使用及维护;
  7. 更多特点请查阅框架手册( 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("127.0.0.1").BindHandler("/", func(r *ghttp.Request) {
        r.Response.Write("127.0.0.1")   
    })
    s.Domain("localhost").BindHandler("/", func(r *ghttp.Request) {
        r.Response.Write("localhost")
    })
    s.Run()
}

多域名绑定支持:

package main

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

func main() {
    s := ghttp.GetServer()
    s.Domain("localhost").BindHandler("/", func(r *ghttp.Request) {
        r.Response.Write("localhost")
    })
    s.Domain("localhost1localhost2localhost3").BindHandler("/", func(r *ghttp.Request) {
        r.Response.Write("localhostx")
    })
    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 (c *ControllerUser) Age() {
    c.Response.Write("18")
}

func main() {
    // 绑定控制器到指定URI所有控制器的公开方法将会映射到指定URI末尾
    // 例如该方法执行后,查看效果可访问:
    // http://127.0.0.1:8199/user/name
    // http://127.0.0.1:8199/user/age
    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", func(r *ghttp.Request){
        r.Response.Write(r.Get("name"))
    })
    s.BindHandler("/:name/:action", func(r *ghttp.Request){
        r.Response.Write(r.Get("name"))
        r.Response.Write(r.Get("action"))
    })
    s.BindHandler("/:name/*any", func(r *ghttp.Request){
        r.Response.Write(r.Get("name"))
        r.Response.Write(r.Get("any"))
    })
    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.Instance()
// 获取配置分组名称为"user-center"的数据库对象
db, err := gdb.Instance("user-center")

数据写入

r, err := db.Insert("user", gdb.Map {
    "name": "john",
})

数据查询(列表)

list, err := db.GetAll("select * from user limit 2")

数据查询(单条)

one, err := db.GetOne("select * from user limit 2")
// 或者
one, err := db.GetOne("select * from user where uid=1000")

数据保存

r, err := db.Save("user", gdb.Map {
    "uid"  :  1,
    "name" : "john",
})

数据更新/删除

// db.Update/db.Delete 同理
r, err := db.Update("user", gdb.Map {"name": "john"}, "uid=?", 10000)
r, err := db.Update("user", "name='john'", "uid=10000")
r, err := db.Update("user", "name=?", "uid=?", "john", 10000)

链式操作

链式查询

// 查询多条记录并使用Limit分页
r, err := db.Table("user u").LeftJoin("user_detail ud", "u.uid=ud.uid").Fields("u.*, ud.site").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").LeftJoin("user_detail ud", "u.uid=ud.uid").Fields("ud.site").Where("u.uid=?", 1).Value()
// 分组及排序
r, err := db.Table("user u").LeftJoin("user_detail ud", "u.uid=ud.uid").Fields("u.*,ud.city").GroupBy("city").OrderBy("register_time asc").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()

链式写入/保存

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

事务操作

开启事务操作

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_1"}).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