使用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神出品) ↩︎

转载于:https://juejin.im/post/5ceccac66fb9a07edc0b35f7