GoFrame是一款基础设施建设比较完善的模块化框架，WebServer模块是其中比较核心的模块，我们这里将Web服务开发作为框架入门的选择，便于大家更容易学习和理解。

GoFrame框架提供了非常强大的WebServer，由ghttp模块实现。实现了丰富完善的相关组件，例如：Router、Cookie、Session、路由注册、配置管理、模板引擎、缓存控制等等，支持热重启、热更新、多域名、多端口、多实例、HTTPS、Rewrite、PProf等等特性。

接口文档地址：

https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp

哈喽世界

老规矩，我们先来一个Hello World：

package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
)

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

这便是一个最简单的服务，默认情况下它不支持静态文件处理，只有一个功能，访问 http://127.0.0.1/ 的时候，它会返回哈喽世界！。

任何时候，您都可以通过g.Server()方法获得一个默认的Server对象，该方法采用单例模式设计，也就是说，多次调用该方法，返回的是同一个Server对象。通过Run()方法执行Server的监听运行，在没有任何额外设置的情况下，它默认监听80端口。

关于其中的路由注册，我们将会在后续的章节中介绍，我们继续来看看如何创建一个支持静态文件的Server。

静态服务

创建并运行一个支持静态文件的WebServer：

package main

import (
    "github.com/gogf/gf/v2/frame/g"
)

func main() {
    s := g.Server()
    s.SetIndexFolder(true)
    s.SetServerRoot("/home/www/")
    s.Run()
}

创建了Server对象之后，我们可以使用Set*方法来设置Server的属性，我们这里的示例中涉及到了两个属性设置方法：

  1. SetIndexFolder用来设置是否允许列出Server主目录的文件列表（默认为false）。
  2. SetServerRoot用来设置Server的主目录（类似nginx中的root配置，默认为空）。

Server默认情况下是没有任何主目录的设置，只有设置了主目录，才支持对应主目录下的静态文件的访问。

多端口监听

Server同时支持多端口监听，只需要往SetPort参数设置多个端口号即可（当然，针对于HTTPS服务，我们也同样可以通过SetHTTPSPort来设置绑定并支持多个端口号的监听，HTTPS服务的介绍请参看后续对应章节）。

我们来看一个例子：

package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
)

func main() {
    s := g.Server()
    s.BindHandler("/", func(r *ghttp.Request){
        r.Response.Writeln("go frame!")
    })
    s.SetPort(8100, 8200, 8300)
    s.Run()
}

执行以上示例后，我们访问以下URL将会得到期望的相同结果：

http://127.0.0.1:8100/
http://127.0.0.1:8200/
http://127.0.0.1:8300/

多实例支持

Server支持同一进程多实例运行，下面我们来看一个例子：

package main

import (
    "github.com/gogf/gf/v2/frame/g"
)

func main() {
    s1 := g.Server("s1")
    s1.SetPort(8080)
    s1.SetIndexFolder(true)
    s1.SetServerRoot("/home/www/static1")
    s1.Start()

    s2 := g.Server("s2")
    s2.SetPort(8088)
    s2.SetIndexFolder(true)
    s2.SetServerRoot("/home/www/static2")
    s2.Start()

    g.Wait()
}

可以看到我们在支持多个Server的语句中，给g.Server方法传递了不同的单例名称参数，该参数用于标识不同的Server实例，因此需要保证唯一性。如果需要获取同一个Server实例，那么传入同一个名称即可。例如在多个goroutine中，或者不同的模块中，都可以通过g.Server获取到同一个Server实例。

域名绑定

Server支持多域名绑定，并且不同的域名可以绑定不同的服务。

我们来看一个简单的例子：

package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
)

func Hello1(r *ghttp.Request) {
    r.Response.Write("127.0.0.1: Hello1!")
}

func Hello2(r *ghttp.Request) {
    r.Response.Write("localhost: Hello2!")
}

func main() {
    s := g.Server()
    s.Domain("127.0.0.1").BindHandler("/", Hello1)
    s.Domain("localhost").BindHandler("/", Hello2)
    s.Run()
}

我们访问 http://127.0.0.1/ 和 http://localhost/ 可以看输出不同的内容。

此外，Domain方法支持多个域名参数，使用英文“,”号分隔，例如：

s.Domain("localhost1,localhost2,localhost3").BindHandler("/", Hello2)

这条语句的表示将Hello2方法注册到指定的3个域名中(localhost1~3)，对其他域名不可见。

需要注意的是：Domain方法的参数必须是准确的域名，不支持泛域名形式，例如：*.goframe.org或者.goframe.org是不支持的，api.goframe.org或者goframe.org才被认为是正确的域名参数。

路由特性

Server提供了非常出色的路由特性，我们先来看一个简单的示例：

package main

import (
    "github.com/gogf/gf/v2/net/ghttp"
    "github.com/gogf/gf/v2/frame/g"
)

func main() {
    s := g.Server()
    s.BindHandler("/{class}-{course}/:name/*act", func(r *ghttp.Request) {
        r.Response.Writef(
            "%v %v %v %v",
            r.Get("class"),
            r.Get("course"),
            r.Get("name"),
            r.Get("act"),
        )
    })
    s.SetPort(8199)
    s.Run()
}

这是一个混合的路由规则示例，用于展示某个班级、某个学科、某个学生、对应的操作，运行后，我们可以通过例如该地址： http://127.0.0.1:8199/class3-math/john/score 看到测试结果。在页面上你可以看得到对应的路由规则都被一一解析，业务层可以根据解析的参数进行对应的业务逻辑处理。 具体的路由注册管理介绍请查看后续 路由管理-路由规则 章节。

配置管理

GoFrame的核心组件均实现了便捷的配置管理特性，仅需通过配置文件的修改即可实现组件的功能配置。大多数的场景中我们推荐使用配置文件来管理组件的配置，Server的配置请查看 服务配置 章节。

平滑重启

Server内置支持平滑重启特性，详细介绍请参考 平滑重启特性 章节。

HTTPS支持

Server支持HTTPS服务，并且也同时支持单进程提供HTTP&HTTPS服务，HTTPS的详细介绍请参考 HTTPS&TLS 章节。

更多功能特性

更多功能及特性请继续阅读后续章节。


Content Menu

  • No labels

24 Comments

  1. udtech

    http服务 如何监听IPV6呢？

    1. 海亮

      地址只填端口

  2. kkstun

    有没有max_execution_time 最大执行时间？

  3. qingtian009

    当 

    g.Server().Start() 并且
    g.Server().Shutdown()后

    无法再次  g.Server().Start() 

    程序会退出，请查看一下

    [FATA] duplicated route registry "/api.json" at  这个是出错信息

    如果去掉api.json 则会出现端口已经被占用

  4. johnny

    建议把每个代码修改的文件路径也加上，不然都不知道图上的代码指哪一块

  5. gcf

    s.run()会阻塞住，要在后面执行一些逻辑，如何实现比较好？

    1. 糖水不加糖

      goroutine执行s.run,后续逻辑执行完成之后执行ghttp.Wait()或者selece{}阻塞住主线程.

      1. gcf

        方法总比困难多，就怕大神随便一说，感谢指导，走通逻辑：

                    //启动协程
			pool := grpool.New()
			pool.Add(ctx, func(ctx context.Context) {
				// 启动http服务，协程内阻塞
				s.Run()
			})

			gtimer.SetTimeout(ctx, time.Second*3, func(ctx context.Context) {
				glog.Info(ctx, "延时执行其他动作")
				DoSomeThings(ctx)
			})

            //阻塞主进程防止协程挂掉
			select {}

        1. 张金富

          可以参考 多实例支持

  6. 小李飞刀

    没有控制台打印 请求信息么？  状态码，方法和地址，有时候调试挺麻烦

    1. 郭强

      可以看下日志那块文档 服务日志管理

      1. 小陈

        强哥, 关注一下win平台呗, win下跑单元测试就有些通不过, 有些是偶尔跑不通过. 虽然这些功能我根本不会用到.  还是希望可以加强win平台.  目前跑不通过的有 gclient, gcron, grpool, gfile..

        ...., 我改不来. 业余, 还菜.....

        1. 小陈

          我做柜子的, 玩这个是业余且新手, 连提pr都不懂...  

          比较菜, 还请见谅..

  7. 小陈

    感觉大佬平常用的都是Linux,  但是在win下跑单元测试就有些通不过, 有些是偶尔跑不通过. 虽然这些功能我根本不会用到.  还是希望可以加强win平台.  目前跑不通过的有 gclient, gcron, grpool, gfile..

    可能有人会说你改啊...., 改不了. 业余, 还菜.....

    1. 小陈

      后面看到这条评论的, 麻烦看清日期, 估计你现在看到的时候早修好了, 早已经版本今非昔比了. 

    2. 小陈

      简单的比如不同平台换行符不一样, 我还能改改, 其他复杂的就看不懂了. .. 表示想改也改不来...

  8. 大辉哥

    gf能否增加一个类似jin框架打包静态资源到二进制同时实现路径映射的功能

    //go:embed templates/* public/*
var f embed.FS

fp, _ := fs.Sub(f, "public")
r.StaticFS("/public", http.FS(fp))


s := g.Server()

s.AddStaticFSPath("/public",  ghttp.FS(fp))



    1. 海亮

      资源管理-使用示例 - GoFrame (ZH)-Latest - GoFrame官网 - 类似PHP-Laravel, Java-SpringBoot的Go企业级开发框架

      有类似的功能

  9. 小陈

    忍不住想说, gf牛掰....

  10. tobin

    从1.15转到v2, 我表示这v2和v2文档很难用。这个文档系统也没有区分哪块是v1的文档，哪块是v2的文档，我发现是混着的。

    搞了半天，service也不能自动生成，是要先手动码上logic，再生成service吗？

    路由也是，把path写到了request包里？

    从快速上手的角度来说，v2没有做到v1那么流畅 

    建议换掉这个文档系统。

    1. 郭强

  11. Kuijun Cui

    案例讲解，脱离工程目录结构，好难照猫画虎啊！

    1. 小陈

      可以去哔哩哔哩找找视频教程. 工程目录结构, 可以看看工程开发设计(🔥重点🔥) - GoFrame (ZH)-Latest - GoFrame官网 - 类似PHP-Laravel, Java-SpringBoot的Go企业级开发框架, 

      gf自带了一个工具, 可以生成目录结构

  12. 杨佳佳

    版本2.4

    type mController struct{}



    func New() *mController {
    return &mController{}
    }
    func (c *mController) UserKll(ctx context.Context, req *v1.CreateShopTypeReq) (res *v1.CreateShopTypeRes, err error) {
    logo, err := utils.UploadFileToBase64(ctx, req.Logo)
    err = service.Shop().CreateShopType(ctx, model.ShopTypeInput{
    Name: req.Name,
    Logo: logo,
    })
    return
    }

    为什么启动后method是ALL而不是POST， route是user-kll而不是/shop/type