imicola net.http入门
net.http入门

net.http入门

733 字 · 约 2 分钟

当我们从客户端向服务器发送http请求的时候,go语言有一套专门负责解析,构造的函数,本文主要描述一个简单的实例来引入http server

HTTP服务链路

假设我们的客户端构造一个8080端口的GET /healthz 的请求,而服务端需要返回 HTTP 200 ok ,这其中基本的链路如下:

客户端连接 8080 端口
→ Go HTTP Server 读取并解析 HTTP 请求
→ 路由器根据请求路径寻找 Handler
→ /healthz 匹配到 healthz 函数
→ healthz 读取请求 r
→ 通过 w 写回响应

想要完成上面的链路,需要涉及如下的方法:

  • net/http.ListenAndServe
  • net/http.HandleFunc
  • net/http.HandlerFunc
  • net/http.ResponseWriter
  • net/http.Request

我们接下来逐一讲解这些基本方法

HandleFunc

func http.HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
go

HandleFunc 是注册函数,负责在默认路由器中把 pattern 表示的路径与 handler 函数关联起来。

例如:

http.HandleFunc("/healthz", healthz)
go

表示将 /healthz 与函数 healthz 绑定并且注册到默认路由器中,对于这个函数我们后面会提到,这个操作并不会直接进入 healthz 函数中

ListenAndServe

func http.ListenAndServe(addr string, handler http.Handler) error
go

这个函数接受一个 TCP 地址,例如 IPv4:Port。本地测试时可以写成 :Port,其中省略的是具体主机地址,通常表示监听本机所有可用网络接口,并不等同于只监听 localhost;客户端仍可使用 localhost:Port 访问。

这个函数的作用是启动一个 HTTP Server,在第一个参数指定的地址上监听,并把收到的请求交给第二个参数代表的 Handler 处理。

  • 这里有一点需要注意的是,当我们没有手写mux的时候这里可以填入nil,这代表请求会被DefaultServeMux 处理

HandlerFunc

HandlerFunc 是标准库定义的命名函数类型。

type HandlerFunc func(ResponseWriter, *Request)
go

HandlerFunc 实现了 Handler 接口,可以把签名匹配的普通函数适配为 HTTP Handler。原始 HTTP 数据到 Request 对象的解析由 HTTP Server 完成,在进入 Handler 前已经完成。

Request

在函数内部 ,Request 不负责执行底层解析,而是让我们读取解析后的请求信息

其常见的内容如下:

r.Method      // GET、POST 等请求方法
r.URL         // 路径和查询参数
r.Header      // 请求头
r.Body        // 请求体
r.Context()   // 请求上下文和取消信号
go

ResponseWriter

ResponseWriter 可以理解为你向客户端写回 HTTP 响应的出口

对于一个HTTP响应,主要分为三部分

HTTP/1.1 200 OK                   → 状态行
Content-Type: application/json    → 响应头

{"status":"ok"}                   → 响应体
http

因此,代码中的函数应该围绕构建这三个部分进行

w.Header().Set(...) // 设置响应头
w.WriteHeader(...)  // 设置响应状态码
w.Write(...)        // 写入响应体
go

对于这三个函数,顺序是非常重要的,因为一旦调用 WriteHeader 或 Write后响应头通常就已经被发送(go会自动发送 200 ok)

[!响应头] HTTP 响应头是一组键值形式的元数据,用于描述响应,而不是响应的实际内容

例如:

Content-Type: application/json
Content-Length: 15
Cache-Control: no-cache
Allow: GET
http

其中Content-Type 的含义是告诉客户端响应体应该按什么格式解析

总结

所以对于实现一个简单的 GET /healthz 监听响应程序,我们可以这样书写代码

package main

import (
	"log"
	"net/http"
)

func healthz(w http.ResponseWriter, r *http.Request) {
	if r.Method != http.MethodGet {
		w.WriteHeader(http.StatusMethodNotAllowed)
		return
	}
	w.Header().Set("Content-Type", "application/json")
	w.WriteHeader(http.StatusOK)
	w.Write([]byte(`{"status":"ok"}`))
}

func main() {
	http.HandleFunc("/healthz", healthz)
	log.Println("Server start ok")
	err := http.ListenAndServe(":8080", nil)
	if err != nil {
		log.Fatal(err)
		return
	}
}
go

知识关联

1 反向链接 · 0 提及笔记
局部关系图谱 悬停高亮 · 点击跳转