header.md

[TOC]

自定义Header

HTTP客户端发起请求时可以自定义发送给服务端的Header内容，该特性使用SetHeader*相关方法实现。

方法列表：

func (c *Client) SetHeader(key, value string) *Client
func (c *Client) SetHeaderMap(m map[string]string) *Client
func (c *Client) SetHeaderRaw(headers string) *Client

我们来看一个客户端通过Header来自定义发送自定义链路跟踪信息Span-Id及Trace-Id消息头的示例。

服务端

package main

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

func main() {
	s := g.Server()
	s.BindHandler("/", func(r *ghttp.Request) {
		r.Response.Writef(
			"Span-Id:%s,Trace-Id:%s",
			r.Header.Get("Span-Id"),
			r.Header.Get("Trace-Id"),
		)
	})
	s.SetPort(8199)
	s.Run()
}

由于是作为示例，服务端的逻辑很简单，直接将接收到的Span-Id及Trace-Id参数返回给客户端。

客户端

1. 使用SetHeader方法

   package main
   
   import (
       "fmt"
       "github.com/gogf/gf/frame/g"
   )
   
   func main() {
       c := g.Client()
       c.SetHeader("Span-Id", "0.0.1")
       c.SetHeader("Trace-Id", "NBC56410N97LJ016FQA")
       if r, e := c.Get("http://127.0.0.1:8199/"); e != nil {
           panic(e)
       } else {
           fmt.Println(r.ReadAllString())
       }
   }

   通过g.Client()创建一个自定义的HTTP请求客户端对象，并通过c.SetHeader设置自定义的Header信息。

2. 使用SetHeaderRaw方法

   这个方法更加简单，可以通过原始的Header字符串来设置客户端请求Header。

   package main
   
   import (
       "fmt"
       "github.com/gogf/gf/frame/g"
   )
   
   func main() {
       c := g.Client()
       c.SetHeaderRaw(`
           Referer: https://localhost
           Span-Id: 0.0.1
           Trace-Id: NBC56410N97LJ016FQA
           User-Agent: MyTestClient
       `)
       if r, e := c.Get("http://127.0.0.1:8199/"); e != nil {
           panic(e)
       } else {
           fmt.Println(r.ReadAllString())
       }
   }

3. 执行结果

   客户端代码执行后，终端将会打印出服务端的返回结果，如下：

   Span-Id:0.0.1,Trace-Id:NBC56410N97LJ016FQA