Golang使用http協(xié)議實現(xiàn)心跳檢測程序過程詳解

更新時間：2023年03月15日 10:30:23 作者：夢想畫家

這篇文章主要介紹了Golang使用http協(xié)議實現(xiàn)心跳檢測程序過程，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習吧

需求說明

實現(xiàn)心跳程序，其他應用可以簡單集成。客戶端程序通過HTTP協(xié)議進行檢測，返回當前程序狀態(tài)、版本ID以及已運行時間。

程序?qū)崿F(xiàn)

package main
import (
	"encoding/json"
	"github.com/hako/durafmt"
	"log"
	"net/http"
	"time"
)
const NotAvailableMessage = "Not available"
var CommitHash string
var StartTime time.Time
type HeartbeatMessage struct {
	Status string `json:"status"`
	Build  string `json:"build"`
	Uptime string `json:"uptime"`
}
func init() {
	StartTime = time.Now()
}
func handler(rw http.ResponseWriter, r *http.Request) {
	hash := CommitHash
	if hash == "" {
		hash = NotAvailableMessage
	}
	df, _ := durafmt.ParseString(time.Since(StartTime).String())
	uptime := df.String()
	err := json.NewEncoder(rw).Encode(HeartbeatMessage{"running", hash, uptime})
	if err != nil {
		log.Fatalf("Failed to write heartbeat message. Reason: %s", err.Error())
	}
}
func RunHeartbeatService(address string) {
	http.HandleFunc("/heartbeat", handler)
	log.Println(http.ListenAndServe(address, nil))
}

首先定義了兩個變量，CommitHash、StartTime，然后定義結(jié)構(gòu)體HeartbeatMessage封裝返回值。

接著在init方法中給StartTime變量賦初始值。下面時處理請求handler方法：

func handler(rw http.ResponseWriter, r *http.Request) {
	hash := CommitHash
	if hash == "" {
		hash = NotAvailableMessage
	}
	df, _ := durafmt.ParseString(time.Since(StartTime).String())
	uptime := df.String()
	err := json.NewEncoder(rw).Encode(HeartbeatMessage{"running", hash, uptime})
	if err != nil {
		log.Fatalf("Failed to write heartbeat message. Reason: %s", err.Error())
	}
}

這個把CommitHash給hash，CommitHash可以通過上文的知識，在編譯時賦值。然后計算應用已運行的時間并返回HeartbeatMessage結(jié)構(gòu)體的值。durafmt是時間周期格式化工具，比內(nèi)置的更直觀易用。

當然最重要的是HTTP服務，Golang只需要一句代碼http.ListenAndServe(address, nil)就搞定：

func RunHeartbeatService(address string) {
	http.HandleFunc("/heartbeat", handler)
	log.Println(http.ListenAndServe(address, nil))
}

該函數(shù)定義http服務，同時暴露一個請求地址：/heartbeat。

Postman測試

定義一個最簡單的應用，在main方法中調(diào)用心跳功能，為了避免影響業(yè)務，讓其在獨立的協(xié)程中運行。

func main() {
	go RunHeartbeatService(":9090")
	// 阻塞主程序，模擬應用一直在運行
	select {}
}

現(xiàn)在可以通過postman定時請求心跳地址，驗證程序是否一直正常運行。

localhost:9090/heartbeat
{"status":"running","build":"Not available","uptime":"3 minutes 47 seconds 148 milliseconds 967 microseconds"}

Go客戶端測試

下面我們寫Get方法，使用Go語言實現(xiàn)http客戶端進行測試：

func Get(address string) (HeartbeatMessage, error) {
	// 定義http client
	client := &http.Client{}
	req, err := http.NewRequest("GET", address, nil)
	resp, err := client.Do(req)
	if err != nil {
		return HeartbeatMessage{}, err
	}
	// 解析響應并返回結(jié)果
	b, err := io.ReadAll(resp.Body)
	defer resp.Body.Close()
	if resp.StatusCode != http.StatusOK {
		return HeartbeatMessage{}, errors.New(fmt.Sprintf("Wrong status code: %d", resp.StatusCode))
	}
	message := HeartbeatMessage{}
	err = json.Unmarshal(b, &message)
	if err != nil {
		log.Println("Error occured unmarshalling the response")
	}
	return message, nil
}

Go單元測試

package main
import (
	"fmt"
	"testing"
)
func TestGet(t *testing.T) {
	hs, err := Get("http://localhost:9090/heartbeat")
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(hs)
}

測試結(jié)果：