Go HTTP程式設計
目錄
- net/http介紹
- HTTP服務端
- 預設的Server
- 自定義Server
- HTTP客戶端
- 基本的HTTP/HTTPS請求
- GET請求示例
- 帶引數的GET請求示例
- Post請求示例
- 自定義Client
- 自定義Transport
net/http介紹
Go語言標準庫內建提供了net/http包,涵蓋了HTTP客戶端和服務端的具體實現。使用net/http包,我們可以很方便地編寫HTTP客戶端或服務端的程式。
HTTP服務端
預設的Server
首先,我們編寫一個最簡單的Web伺服器。編寫這個Web服務只需要兩步:
註冊一個處理器函式(註冊到DefaultServeMux);
設定監聽的TCP地址並啟動服務;
對應到我們的程式碼裡就是這樣的:
package main import ( "fmt" "net/http" ) //say hello to the world func sayHello(w http.ResponseWriter, r *http.Request) { //n, err := fmt.Fprintln(w, "hello world") _, _ = w.Write([]byte("hello world")) } func main() { //1.註冊一個處理器函式 http.HandleFunc("/", sayHello) //2.設定監聽的TCP地址並啟動服務 //引數1:TCP地址(IP+Port) //引數2:handler handler引數一般會設為nil,此時會使用DefaultServeMux。 err := http.ListenAndServe("127.0.0.1:9000", nil) if err != nil { fmt.Printf("http.ListenAndServe()函式執行錯誤,錯誤為:%v\n", err) return } }
執行該程式,通過瀏覽器訪問,可以看到hello world
顯示在了瀏覽器頁面上
ListenAndServe使用指定的監聽地址和處理器啟動一個HTTP服務端。處理器引數通常是nil,這表示採用包變數DefaultServeMux作為處理器。
Handle和HandleFunc函式可以向DefaultServeMux新增處理器。
http.HandleFunc
使用Go語言中的net/http
包來編寫一個簡單的接收HTTP請求的Server端示例,net/http
包是對net包的進一步封裝,專門用來處理HTTP協議的資料。具體的程式碼如下:
處理器函式的實現原理:
通過原始碼可知,這個函式實際上是呼叫了預設的serveMux的handleFunc方法, 這也解釋了我們第一步裡所說的預設的實際註冊到DefaultServeMux
既然說了http.ListenAndServe
的第二個引數為nil
時採用預設的DefaultServeMux,那麼如果我們不想採用預設的,而是想自己建立一個ServerMux該怎麼辦呢,http給我們提供了方法
func NewServeMux() *ServeMux
NewServeMux建立並返回一個新的*ServeMux
如果是我們自己建立的ServeMux,我們只需要簡單的更新一下程式碼:
package main
import (
"fmt"
"net/http"
)
//my goal is to become a gopher
func myGoal(w http.ResponseWriter, r *http.Request) {
_, _ = w.Write([]byte("I wan`t to become a gopher."))
}
func main() {
//1.註冊一個處理器函式
serveMux := http.NewServeMux()
serveMux.HandleFunc("/", myGoal)
//2.設定監聽的TCP地址並啟動服務
//引數1:TCP地址(IP+Port)
//引數2:handler 建立新的*serveMux,不使用預設的
err := http.ListenAndServe("127.0.0.1:9000", serveMux)
if err != nil {
fmt.Printf("http.ListenAndServe()函式執行錯誤,錯誤為:%v\n", err)
return
}
}
執行修改後的程式碼,和採用預設ServeMux一樣正常執行
http.Handle
如果是使用http的handle方法,則handle的第二個引數需要實現handler介面,要想實現這個介面,就得實現這個介面的serveHTTP
方法
package main
import (
"fmt"
"net/http"
)
type MyHandler struct {}
//實現Handler介面
func (h *MyHandler) ServeHTTP (w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "goodbye")
}
func main() {
var handler MyHandler
http.Handle("/sayGoodbye", &handler)
var err = http.ListenAndServe(":8080", nil)
if err != nil {
fmt.Printf("http server failed, err: %v\n", err)
return
}
}
http.Request
一個Web伺服器最基本的工作就是接收請求,做出響應。http包幫助我們封裝了一個Request結構體,我們通過這個結構體拿到很多使用者的一次HTTP請求的所有資訊。這個Request結構體定義如下:
type Request struct {
//Method指定HTTP方法(GET、POST、PUT等)。對客戶端,""代表GET。
Method string
// 在客戶端,URL的Host欄位指定了要連線的伺服器,
// 而Request的Host欄位(可選地)指定要傳送的HTTP請求的Host頭的值。
URL *url.URL
//接收到的請求的協議版本。本包生產的Request使用HTTP/1.1或者HTTP/2
Proto string // "HTTP/1.0"
ProtoMajor int // 1
ProtoMinor int // 0
//Header欄位用來表示HTTP請求的頭域。
Header Header
//請求主題
Body io.ReadCloser
.....
}
我這裡列舉的並不是完整的Request結構體定義,只是大致的說明一下。完整的定義以及這些欄位的中文含義可以檢視Go語言標準庫中文文件,不過需要注意的是由於中文文件更新不及時(畢竟非官方),會導致一些描述不準確,比如上面的Request結構體中的Proto請求協議版本欄位在最新的Go版本中已經支援了HTTP/2,但是在其中的翻譯還是停留在老版本的只支援HTTP/1.1。所以英語好的同學還是更推薦看原始碼裡的官方文件描述。
我們通過通過瀏覽器可以發現,我們一次HTTP請求會攜帶很多資訊
這些資訊,我們可以用http.Request來獲取到
示例程式碼:
package main
import (
"fmt"
"net/http"
)
func myHandler(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
fmt.Println("Method: ", r.Method)
fmt.Println("URL: ", r.URL)
fmt.Println("header: ", r.Header)
fmt.Println("body: ", r.Body)
fmt.Println("RemoteAddr: ", r.RemoteAddr)
w.Write([]byte("請求成功!!!"))
}
func main() {
http.HandleFunc("/", myHandler)
err := http.ListenAndServe("127.0.0.1:9000", nil)
if err != nil {
fmt.Printf("http.ListenAndServe()函式執行錯誤,錯誤為:%v\n", err)
return
}
}
自定義Server
要管理服務端的行為,可以建立一個自定義的Server:
import (
"fmt"
"net/http"
"time"
)
type MyHandler struct {}
func (h *MyHandler) ServeHTTP (w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "hello world!")
}
func main() {
var handler MyHandler
var server = http.Server{
Addr: ":8080",
Handler: &handler,
ReadTimeout: 2 * time.Second,
MaxHeaderBytes: 1 << 20,
}
var err = server.ListenAndServe()
if err != nil {
fmt.Printf("http server failed, err: %v\n", err)
return
}
}
HTTP客戶端
http包提供了很多訪問Web伺服器的函式,比如http.Get()
、http.Post()
、http.Head()
等,讀到的響應報文資料被儲存在 Response 結構體中。
我們可以看一下Response結構體的定義
type Response struct {
Status string // e.g. "200 OK"
StatusCode int // e.g. 200
Proto string // e.g. "HTTP/1.0"
ProtoMajor int // e.g. 1
ProtoMinor int // e.g. 0
Header Header
Body io.ReadCloser
//...
}
上面只是Response的部分定義,完整的建議去檢視原始碼。
伺服器傳送的響應包體被儲存在Body中。可以使用它提供的Read方法來獲取資料內容。儲存至切片緩衝區中,拼接成一個完整的字串來檢視。
結束的時候,需要呼叫Body中的Close()方法關閉io。
基本的HTTP/HTTPS請求
Get、Head、Post和PostForm函式發出HTTP/HTTPS請求。
resp, err := http.Get("http://example.com/")
...
resp, err := http.Post("http://example.com/upload", "image/jpeg", &buf)
...
resp, err := http.PostForm("http://example.com/form",
url.Values{"key": {"Value"}, "id": {"123"}})
程式在使用完response後必須關閉回覆的主體。
resp, err := http.Get("http://example.com/")
if err != nil {
// handle error
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
// ...
GET請求示例
使用net/http
包編寫一個簡單的傳送HTTP請求的Client端,程式碼如下:
package main
import (
"fmt"
"io/ioutil"
"net/http"
)
func main() {
resp, err := http.Get("http://127.0.0.1:9000")
if err != nil {
fmt.Printf("http.Get()函式執行錯誤,錯誤為:%v\n", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Printf("ioutil.ReadAll()函式執行出錯,錯誤為:%v\n", err)
return
}
fmt.Println(string(body))
}
將上面的程式碼儲存之後編譯成可執行檔案,執行之後就能在終端列印請求成功!!!
網站首頁的內容了,我們的瀏覽器其實就是一個傳送和接收HTTP協議資料的客戶端,我們平時通過瀏覽器訪問網頁其實就是從網站的伺服器接收HTTP資料,然後瀏覽器會按照HTML、CSS等規則將網頁渲染展示出來。
帶引數的GET請求示例
關於GET請求的引數需要使用Go語言內建的net/url
這個標準庫來處理。
package main
import (
"fmt"
"io/ioutil"
"net/http"
"net/url"
)
func main() {
//1.處理請求引數
params := url.Values{}
params.Set("name", "itbsl")
params.Set("hobby", "fishing")
//2.設定請求URL
rawUrl := "http://127.0.0.1:9000"
reqURL, err := url.ParseRequestURI(rawUrl)
if err != nil {
fmt.Printf("url.ParseRequestURI()函式執行錯誤,錯誤為:%v\n", err)
return
}
//3.整合請求URL和引數
//Encode方法將請求引數編碼為url編碼格式("bar=baz&foo=quux"),編碼時會以鍵進行排序。
reqURL.RawQuery = params.Encode()
//4.傳送HTTP請求
//說明: reqURL.String() String將URL重構為一個合法URL字串。
resp, err := http.Get(reqURL.String())
if err != nil {
fmt.Printf("http.Get()函式執行錯誤,錯誤為:%v\n", err)
return
}
defer resp.Body.Close()
//5.一次性讀取響應的所有內容
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Printf("ioutil.ReadAll()函式執行出錯,錯誤為:%v\n", err)
return
}
fmt.Println(string(body))
}
對應的Server端程式碼如下:
package main
import (
"fmt"
"net/http"
)
func myHandler(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
params := r.URL.Query()
fmt.Fprintln(w, "name:", params.Get("name"), "hobby:", params.Get("hobby"))
}
func main() {
http.HandleFunc("/", myHandler)
err := http.ListenAndServe("127.0.0.1:9000", nil)
if err != nil {
fmt.Printf("http.ListenAndServe()函式執行錯誤,錯誤為:%v\n", err)
return
}
}
Post請求示例
上面演示了使用net/http
包傳送GET
請求的示例,傳送POST
請求的示例程式碼如下:
package main
import (
"fmt"
"io/ioutil"
"net/http"
"strings"
)
// net/http post demo
func main() {
url := "http://127.0.0.1:9090/post"
// 表單資料
//contentType := "application/x-www-form-urlencoded"
//data := "name=小王子&age=18"
// json
contentType := "application/json"
data := `{"name":"小王子","age":18}`
resp, err := http.Post(url, contentType, strings.NewReader(data))
if err != nil {
fmt.Println("post failed, err:%v\n", err)
return
}
defer resp.Body.Close()
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("get resp failed,err:%v\n", err)
return
}
fmt.Println(string(b))
}
對應的Server端HandlerFunc如下:
func postHandler(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
// 1. 請求型別是application/x-www-form-urlencoded時解析form資料
r.ParseForm()
fmt.Println(r.PostForm) // 列印form資料
fmt.Println(r.PostForm.Get("name"), r.PostForm.Get("age"))
// 2. 請求型別是application/json時從r.Body讀取資料
b, err := ioutil.ReadAll(r.Body)
if err != nil {
fmt.Println("read request.Body failed, err:%v\n", err)
return
}
fmt.Println(string(b))
answer := `{"status": "ok"}`
w.Write([]byte(answer))
}
自定義Client
要管理HTTP客戶端的頭域、重定向策略和其他設定,建立一個Client:
client := &http.Client{
CheckRedirect: redirectPolicyFunc,
}
resp, err := client.Get("http://example.com")
// ...
req, err := http.NewRequest("GET", "http://example.com", nil)
// ...
req.Header.Add("If-None-Match", `W/"wyzzy"`)
resp, err := client.Do(req)
// ...
自定義Transport
要管理代理、TLS配置、keep-alive、壓縮和其他設定,建立一個Transport:
tr := &http.Transport{
TLSClientConfig: &tls.Config{RootCAs: pool},
DisableCompression: true,
}
client := &http.Client{Transport: tr}
resp, err := client.Get("https://example.com")
Client和Transport型別都可以安全的被多個goroutine同時使用。出於效率考慮,應該一次建立、儘量重