http.ResponseWriter

HTTP报文响应结构和请求报文结构类似，也分为三部分分别是状态行、响应头（首部字段）、响应体

例如：

HTTP/1.1 200 OK
Date: Wed, 29 Dec 2021 10:31:40 GMT
Content-Length: 0

响应报文	描述
状态行	包含HTTP版本和响应状态码
响应头	包含HTTP响应的首部字段，如内容类型、编码方式、缓存控制、Cookie等。
响应体	返回的XML/JSON格式数据/HTML文档等

Go中HTTP通信时，客户端请求信息封装在http.Request对象中，服务端返回的响应报文会被保存在http.Response结构体中。需要注意的是，发送给客户端响应的并不是http.Response，而是通过http.ResponseWriter接口来实现的。

例如：HTTP服务端接收客户端请求后返回响应给客户端

func main() {
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte(r.RemoteAddr))
    })
    http.ListenAndServe(":3000", nil)
}

http.ResponseWriter

http.ResponseWriter接口是处理器用来构造HTTP响应的接口，包含三个方法签名。

type ResponseWriter interface {
    Header() Header
    Write([]byte) (int, error)
    WriteHeader(statusCode int)
}

方法签名	描述
Header()	用户设置或获取响应头信息
Write()	用于写入数据到响应体
WriteHeader()	用于设置响应状态码，若不调用则默认状态码为200 OK。

实际上在底层支撑http.ResponseWriter接口的是http.response结构，因为http.response结构实现了http.ResponseWriter所有的方法签名。

type response struct {
    conn             *conn
    req              *Request // request for this response
     // ...
}

当执行readRequest()调用处理器处理HTTP请求时会返回*http.response指针。

func (c *conn) readRequest(ctx context.Context) (w *response, err error)

WriteHeader

例如：设置响应状态码，比如在API接口中返回401未认证的响应状态码

func main() {
    http.HandleFunc("/error", func(w http.ResponseWriter, r *http.Request) {
        w.WriteHeader(401)
        fmt.Fprintf(w, "未认证状态")
    })
    //监听端口接收连接
    if err := http.ListenAndServe(":8900", nil); err != nil {
        panic(err)
    }
}

发起请求后查看响应报文

$ curl -i http://127.0.0.1:8900/error
HTTP/1.1 401 Unauthorized
Date: Wed, 29 Dec 2021 11:33:55 GMT
Content-Length: 15
Content-Type: text/plain; charset=utf-8

未认证状态

Header

• 当Header()和WriteHeader()都存在时，WriteHeader()之后所有的Header()操作都会失效。
• Header中的Key进行规范化处理，若Key的长度大于127或不包含在isTokenTable中则不会被处理。此外还会对Key的首字母进行大写处理，连字符-后的单词首字母也会做大写处理。

例如：设置响应头，比如设置一个301重定向响应。

func main() {
    //注册路由
    http.HandleFunc("/redirect", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Location", "http://baidu.com")
        w.WriteHeader(301)
    })
    //监听端口接收连接
    if err := http.ListenAndServe(":8900", nil); err != nil {
        panic(err)
    }
}

$ curl -i http://127.0.0.1:8900/redirect
HTTP/1.1 301 Moved Permanently
Location: http://baidu.com
Date: Wed, 29 Dec 2021 11:37:47 GMT
Content-Length: 0

注意w.Header().Set()必须在w.WriteHeader()之前否则不会发生跳转行为，因为一旦调用w.WriteHeader()就不能再对响应头进行设置。

Write

例如：写入数据到响应体

func main() {
    //注册路由
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte(r.Method))
    })
    //监听端口接收连接
    if err := http.ListenAndServe(":8900", nil); err != nil {
        panic(err)
    }
}

$ curl -i http://127.0.0.1:8900/
HTTP/1.1 200 OK
Date: Wed, 29 Dec 2021 11:42:43 GMT
Content-Length: 3
Content-Type: text/plain; charset=utf-8

GET

注意：若调用w.Write()时不知道Content-Type则会通过数据前512个字节自行判断

type HttpResponse struct {
    Code int         `json:"code"`
    Msg  string      `json:"msg"`
    Data interface{} `json:"data"`
}

func main() {
    //注册路由
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        res := HttpResponse{Code: 200, Msg: "SUCCESS", Data: nil}
        bts, err := json.Marshal(res)
        if err != nil {
            fmt.Fprintln(w, err.Error())
            return
        }
        w.Write(bts)
    })
    //监听端口接收连接
    if err := http.ListenAndServe(":8900", nil); err != nil {
        panic(err)
    }
}

$ curl -i http://127.0.0.1:8900/
HTTP/1.1 200 OK
Date: Wed, 29 Dec 2021 11:48:45 GMT
Content-Length: 40
Content-Type: text/plain; charset=utf-8

{"code":200,"msg":"SUCCESS","data":null}

注意虽然使用json.Marshal()对数据进行JSON序列化，但发现响应报文中的Content-Type: text/plain; charset=utf-8依然是文本类型，而期望是直接获得JSON格式，这正式因为返回前并未手动指定Content-Type。

func main() {
    //注册路由
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        res := HttpResponse{Code: 200, Msg: "SUCCESS", Data: nil}
        bts, err := json.Marshal(res)
        if err != nil {
            fmt.Fprintln(w, err.Error())
            return
        }
        w.Header().Set("Content-Type", "application/json")
        w.Write(bts)
    })
    //监听端口接收连接
    if err := http.ListenAndServe(":8900", nil); err != nil {
        panic(err)
    }
}

$ curl -i http://127.0.0.1:8900/
HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 29 Dec 2021 11:52:34 GMT
Content-Length: 40

{"code":200,"msg":"SUCCESS","data":null}