GoFrame 基础教程 - Go 语言 Web 开发快速入门#

GoFrame 是一款 Go 语言开发的模块化、高性能 Web 开发框架，提供了丰富的功能模块和工具，帮助开发者快速构建 Web 应用。

一、GoFrame 简介#

GoFrame 提供了完整的 Web 开发解决方案，包括：

Web 服务：HTTP 服务器、路由、中间件
请求与响应：参数解析、数据验证、响应格式化
配置管理：多环境配置、热加载
日志管理：结构化日志、日志级别控制
数据库：MySQL、PostgreSQL 等关系型数据库支持
缓存：Redis 连接与操作
工具库：字符串处理、JSON 解析、类型转换等

二、环境搭建#

安装 Go#

确保已安装 Go 1.18+ 版本：

1
go version

创建项目#

1
mkdir myapp
2
cd myapp
3
go mod init myapp

安装 GoFrame#

1
go get github.com/gogf/gf/v2

三、Web 服务介绍#

基础 HTTP 服务器#

1
package main
2

3
import (
4
    "github.com/gogf/gf/v2/frame/g"
5
    "github.com/gogf/gf/v2/os/gctx"
6
)
7

8
func main() {
9
    s := g.Server()
10
    s.BindHandler("/", func(r *g.Request) {
11
        r.Response.Write("Hello World!")
12
    })
13
    s.Run()
14
}

路由注册#

GoFrame 支持多种路由注册方式：

1
// 基础路由
2
s.BindHandler("/user", GetUser)
3

4
// RESTful 风格
5
s.BindHandler("GET:/user/list", ListUsers)
6
s.BindHandler("POST:/user/create", CreateUser)
7
s.BindHandler("PUT:/user/update", UpdateUser)
8
s.BindHandler("DELETE:/user/delete", DeleteUser)
9

10
// 带参数路由
11
s.BindHandler("/user/:id", GetUserByID)
12
s.BindHandler("/article/{category}/{id}", GetArticle)

四、请求与响应#

获取请求参数#

1
func Handler(r *g.Request) {
2
    // 获取查询参数
3
    id := r.Get("id").Int()
4
    name := r.Get("name").String()
5

6
    // 获取 POST 参数
7
    data := r.Parse()
8

9
    // 获取 JSON 请求体
10
    var user User
11
    r.Parse(&user)
12
}

响应数据#

1
func Handler(r *g.Request) {
2
    // JSON 响应
3
    r.Response.WriteJson(g.Map{
4
        "code":    0,
5
        "message": "success",
6
        "data":    result,
7
    })
8

9
    // 重定向
10
    r.Response.Redirect("/new-path")
11

12
    // 设置 Header
13
    r.Response.Header().Set("Content-Type", "application/json")
14
}

五、中间件#

中间件用于处理请求前后的通用逻辑，如认证、日志、CORS 等：

1
// 注册中间件
2
s.Use(CORS, Auth, Logger)
3

4
// 中间件函数
5
func CORS(r *g.Request) {
6
    r.Response.CORSDefault()
7
    r.ExitAll()
8
}
9

10
func Auth(r *g.Request) {
11
    token := r.Get("token").String()
12
    if !validateToken(token) {
13
        r.Response.WriteJson(g.Map{
14
            "code":    401,
15
            "message": "unauthorized",
16
        })
17
        r.ExitAll()
18
    }
19
    r.ExitAll()
20
}

六、配置管理#

配置文件格式#

GoFrame 支持多种配置文件格式（YAML、TOML、JSON、INI）：

1
server:
2
  address: ":8080"
3
  serverRoot: "./public"
4

5
database:
6
  default:
7
    link: "mysql:user:pass@tcp(127.0.0.1:3306)/dbname"
8
    debug: true
9

10
redis:
11
  default:
12
    address: "127.0.0.1:6379"
13
    db: 0

读取配置#

1
import "github.com/gogf/gf/v2/frame/g"
2

3
// 读取配置
4
address := g.Cfg().Get(context.Background(), "server.address").String()
5
dbLink := g.Cfg().Get(context.Background(), "database.default.link").String()

七、日志管理#

1
import (
2
    "github.com/gogf/gf/v2/frame/g"
3
    "github.com/gogf/gf/v2/os/gctx"
4
)
5

6
func main() {
7
    ctx := gctx.New()
8

9
    // 不同级别日志
10
    g.Log().Info(ctx, "info message")
11
    g.Log().Debug(ctx, "debug message")
12
    g.Log().Warning(ctx, "warning message")
13
    g.Log().Error(ctx, "error message")
14

15
    // 带字段日志
16
    g.Log().Infof(ctx, "user %s logged in", username)
17
}

八、数据库操作#

MySQL 连接#

1
import (
2
    "github.com/gogf/gf/v2/database/gdb"
3
    "github.com/gogf/gf/v2/frame/g"
4
)
5

6
// 查询
7
func GetUser(id int) (*gdb.Record, error) {
8
    result, err := g.DB().Table("user").Where("id", id).One()
9
    if err != nil {
10
        return nil, err
11
    }
12
    return result, nil
13
}
14

15
// 插入
16
func InsertUser(data gdb.Map) (int64, error) {
17
    result, err := g.DB().Table("user").Data(data).Insert()
18
    if err != nil {
19
        return 0, err
20
    }
21
    return result.LastInsertId()
22
}
23

24
// 更新
25
func UpdateUser(id int, data gdb.Map) (int64, error) {
26
    result, err := g.DB().Table("user").Data(data).Where("id", id).Update()
27
    if err != nil {
28
        return 0, err
29
    }
30
    return result.RowsAffected()
31
}
32

33
// 删除
34
func DeleteUser(id int) (int64, error) {
35
    result, err := g.DB().Table("user").Where("id", id).Delete()
36
    if err != nil {
37
        return 0, err
38
    }
39
    return result.RowsAffected()
40
}

九、Redis 操作#

1
import (
2
    "github.com/gogf/gf/v2/frame/g"
3
    "github.com/gogf/gf/v2/os/gctx"
4
)
5

6
func main() {
7
    ctx := gctx.New()
8

9
    // 设置
10
    g.Redis().Set(ctx, "key", "value")
11

12
    // 获取
13
    value, _ := g.Redis().Get(ctx, "key")
14

15
    // 删除
16
    g.Redis().Del(ctx, "key")
17

18
    // 哈希操作
19
    g.Redis().HSet(ctx, "user:1", "name", "John")
20
    g.Redis().HGet(ctx, "user:1", "name")
21

22
    // 列表操作
23
    g.Redis().LPush(ctx, "list", "item1", "item2")
24
    g.Redis().LRange(ctx, "list", 0, -1)
25
}

十、常用工具#

GoFrame 提供了丰富的工具函数：

字符串处理 (gstr)#

1
import "github.com/gogf/gf/v2/util/gstr"
2

3
// 包含判断
4
gstr.Contains("hello world", "world")
5

6
// 分割
7
gstr.Split("a,b,c", ",")
8

9
// 替换
10
gstr.Replace("hello world", "world", "Go")
11

12
// 大小写转换
13
gstr.ToLower("HELLO")
14
gstr.ToUpper("hello")

类型转换 (gconv)#

1
import "github.com/gogf/gf/v2/util/gconv"
2

3
// 转换为字符串
4
gconv.String(123)
5

6
// 转换为整数
7
gconv.Int("456")
8

9
// 转换为浮点数
10
gconv.Float64("3.14")
11

12
// 转换为切片
13
gconv.Ints("1,2,3")
14

15
// 转换为 Map
16
gconv.Map(jsonStr)

JSON 处理 (gjson)#

1
import "github.com/gogf/gf/v2/encoding/gjson"
2

3
// 解析 JSON
4
j, _ := gjson.DecodeToJson(jsonBytes)
5

6
// 获取值
7
name := j.Get("user.name").String()
8
age := j.Get("user.age").Int()
9

10
// 转换为 Map
11
data := j.Map()

并发 Map (gmap)#

1
import "github.com/gogf/gf/v2/container/gmap"
2

3
// 创建线程安全 Map
4
m := gmap.New()
5

6
// 设置
7
m.Set("key", "value")
8

9
// 获取
10
value := m.Get("key")
11

12
// 删除
13
m.Remove("key")

MD5 加密#

1
import "github.com/gogf/gf/v2/crypto/gmd5"
2

3
// MD5 加密
4
hash := gmd5.EncryptString("password")

十一、项目资源#

代码仓库#

GitHub: https://github.com/goflyfox/gfstudy
Gitee: https://gitee.com/goflyfox/gfstudy

教程目录#

gfstudy 项目提供了完整的 GoFrame 基础教程：

GoFrame 介绍
GoFrame 环境搭建
GoFrame 的 Web 服务介绍
GoFrame 请求与响应
GoFrame 路由注册
GoFrame 中间件
GoFrame 的 HTTP 客户端
GoFrame 配置管理
GoFrame 日志管理
GoFrame 数据库
GoFrame Redis
GoFrame 常用工具

视频教程#

Bilibili 教程：GoFrame 基础教程 - 快速入门

交流方式#

QQ 交流群: 479196644

总结#

GoFrame 作为一款成熟的 Go Web 框架，提供了从基础 HTTP 服务到数据库操作、缓存管理、日志记录等全方位的支持。通过模块化的设计和丰富的工具库，开发者可以快速搭建高性能的 Web 应用。

本文介绍了 GoFrame 的核心功能和使用方法，更多详细内容可以参考 gfstudy 项目的完整教程和示例代码。