Golang使用http協(xié)議實(shí)現(xiàn)心跳檢測(cè)程序過(guò)程詳解

更新時(shí)間：2023年03月15日 10:30:23 作者：夢(mèng)想畫(huà)家

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

需求說(shuō)明

實(shí)現(xiàn)心跳程序，其他應(yīng)用可以簡(jiǎn)單集成。客戶(hù)端程序通過(guò)HTTP協(xié)議進(jìn)行檢測(cè)，返回當(dāng)前程序狀態(tài)、版本ID以及已運(yùn)行時(shí)間。

程序?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))
}

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

接著在init方法中給StartTime變量賦初始值。下面時(shí)處理請(qǐng)求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())
	}
}

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

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

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

該函數(shù)定義http服務(wù)，同時(shí)暴露一個(gè)請(qǐng)求地址：/heartbeat。

Postman測(cè)試

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

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

現(xiàn)在可以通過(guò)postman定時(shí)請(qǐng)求心跳地址，驗(yàn)證程序是否一直正常運(yùn)行。

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

Go客戶(hù)端測(cè)試

下面我們寫(xiě)Get方法，使用Go語(yǔ)言實(shí)現(xiàn)http客戶(hù)端進(jìn)行測(cè)試：

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
	}
	// 解析響應(yīng)并返回結(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單元測(cè)試

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)
}

測(cè)試結(jié)果：