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}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容