使用Go內置庫實現簡易httpbin功能

簡介

經過學習「Go語言聖經」的入門部分，瞭解到 go 內置庫裏提供了一個簡單的 http 功能。因而想模擬下httpbin^[1]的 get 方法顯示 header 頭信息的功能來練手。

本人 Go 初學小白，爲了練習只是簡單的實現了請求 header 的 JSON 格式展現，跟 httpbin 功能相差甚遠，還請見諒。

知識點

• go http
• go json 序列化

代碼

1. 包導入

• net/http: 簡易 http 功能
• log: 簡易 logging 功能
• encoding/json: json 序列化功能
• fmt: 格式化輸出
• strings: 字符串操做

2. 聲明結構體類型(保存請求頭數據) 2.1 先看下 httpbin 的 get 方法返回的 JSON 結構

// Request URL：httpbin.org/get?user=test&pwd=xxx

{
  "args": {
    "pwd": "xxx", 
    "user": "test"
  }, 
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3", 
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "zh-CN,zh;q=0.9", 
    "Cache-Control": "max-age=0", 
    "Host": "httpbin.org", 
    "Upgrade-Insecure-Requests": "1", 
    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
  }, 
  "origin": "10x.x.xxx.xxx", 
  "url": "https://httpbin.org/get?user=test&pwd=xxx"
}
複製代碼

2.1 肯定 Struct 的成員字段

返回的 JSON 外層結構裏有四個 Key ，分別爲：

• args
• headers
• origin
• url

因此聲明的 struct 類型要包含這四個字段，以便後續將 struct 序列化爲 json 結構。

2.2 肯定 Struct 的字段類型

type JsonBody struct {
    Args    map[string]string
    Headers map[string]string
    Origin  string
    Url     string
}
複製代碼

1.爲何字段要大寫開頭？這是由於只有 struct 中支持導出的 field 才能被 JSON package 序列化，即首字母大寫的 field。

2.又由於 args 和 headers 兩個字段下還有 key-value 結構，因此不能用 string 類型。這個時候 args 和 headers 的首選類型應該仍是 struct，可是因爲 args 和 headers 內參數的不肯定性，因此這裏是由 map 類型來組合。

2.3 指定Struct Tag

type HeaderBody struct {
	Args 	map[string]string 	`json:"args"`
	Headers map[string]string 	`json:"headers"`
	Origin 	string 			`json:"origin"`
	Url 	string 			`json:"url"`
}
複製代碼

JSON 對象通常都是小寫表示，Marshal 以後 JSON 對象的首字母依然是大寫，若是序列化以後的名稱想要改變，可使用 struct tags。 (注意冒號":"後面不能有空格)

3. 完成http服務部分

3.1 main函數

func main() {
	http.HandleFunc("/", handler)
	log.Fatal(http.ListenAndServe("localhost:4000", nil))
}
複製代碼

1.經過http的HandlerFunc來指定web的根路徑，並將訪問的請求交由handler函數處理。 2.經過http的ListenAndServe監聽端口，並啓動http服務。 3.Fatal功能上等價於Print(), 只不過在輸出後會調用os.Exit(1)。

3.2 handler函數

func handler(w http.ResponseWriter, r *http.Request) {
    // 聲明並初始化兩個map
	headers := make(map[string]string)
	args := make(map[string]string)

	// JsonBody初始化
	origin := strings.Split(r.RemoteAddr, ":")[0]
	jsonBody := JsonBody{Origin: origin, Url: "http://" + r.Host + r.URL.String()}

	// headers
	// Host := strings.Split(r.Host, ":")[0]        // 換一種方式實現
	Host := strings.TrimSuffix(r.Host, ":4000")     
	headers["Host"] = Host

	for k, v := range r.Header {
		headers[k] = v[0]
	}

    // args
	if err := r.ParseForm(); err != nil {
		log.Print(err)
	}

	for k, v := range r.Form {
		args[k] = v[0]
	}

	headersBody.Args = args
	headersBody.Headers = headers
	
	// 序列化
	b, err := json.Marshal(headersBody)
	if err != nil {
		log.Print(err)
		return
	}
	
    // response
	fmt.Fprint(w, string(b))
}
複製代碼

在handler中將所需的字符串信息進行處理，填充到map和struct中，最後進行序列化，並由http服務返回。

相關信息介紹

• http.Request:

  • r.RemoteAddr: client端的IP:Port信息
  • r.Host: client請求的domain
  • r.Header: 請求頭信息。遍歷出的value是slice類型，且只有一個元素，因此用下標 0 來輸出。
  • r.Form: URL請求參數

• json

  • Marshal: 由go數據結構序列化爲json數據結構

4. 完整代碼

package main

import (
	"net/http"
	"log"
	"encoding/json"
	"fmt"
	"strings"
)

type HeaderBody struct {
	Args 	map[string]string 	`json:"args"`
	Headers map[string]string 	`json:"headers"`
	Origin 	string 			`json:"origin"`
	Url 	string 			`json:"url"`
}


func handler(w http.ResponseWriter, r *http.Request) {
	headers := make(map[string]string)
	args := make(map[string]string)

	// headersBody
	origin := strings.Split(r.RemoteAddr, ":")[0]
	headersBody := HeaderBody{Origin: origin, Url: "http://" + r.Host + r.URL.String()}

	// headers
	Host := strings.Split(r.Host, ":")[0]
	headers["Host"] = Host

	for k, v := range r.Header {
	    headers[k] = v[0]
	}

	if err := r.ParseForm(); err != nil {
	    log.Print(err)
	}

	for k, v := range r.Form {
	    args[k] = v[0]
	}

	headersBody.Args = args
	headersBody.Headers = headers
	b, err := json.Marshal(headersBody)
	if err != nil {
	    log.Print(err)
	    return
	}
	fmt.Fprint(w, string(b))
}

func main() {
	http.HandleFunc("/", handler)
	log.Fatal(http.ListenAndServe("localhost:4000" , nil))
}
複製代碼

效果展現

請求URL：http://localhost:4000/?user=test&pwd=xxx

Response返回

{
  "args": {
    "age": "10",
    "user": "a"
  },
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3",
    "Accept-Encoding": "gzip, deflate, br",
    "Accept-Language": "zh-CN,zh;q=0.9",
    "Cache-Control": "max-age=0",
    "Connection": "keep-alive",
    "Host": "localhost",
    "Upgrade-Insecure-Requests": "1",
    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
  },
  "origin": "127.0.0.1",
  "url": "http://localhost:4000/?user=a&age=10"
}
複製代碼

參考

• GO語言聖經: docs.hacknode.org/gopl-zh/ch1…
• 參考博客: sanyuesha.com/2018/05/07/…
• httpbin: httpbin.org

---

1. httpbin是一個HTTP Request & Response Service，你能夠向他發送請求，而後他會按照指定的規則將你的請求返回。這個相似於echo服務器，可是功能又比它要更強大一些。 httpbin支持HTTP/HTTPS，支持全部的HTTP動詞，能模擬302跳轉乃至302跳轉的次數，還能夠返回一個HTML文件或一個XML文件或一個圖片文件（還支持指定返回圖片的格式）。實在是請求調試中居家必備的良器！(ps: 此網站由 kennethreitz K神出品) ↩︎