自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

如何基于 Golang 標(biāo)準(zhǔn)庫(kù)實(shí)現(xiàn)插件功能

開(kāi)發(fā)
插件可以在解耦的基礎(chǔ)上靈活擴(kuò)展應(yīng)用功能,本文介紹了如何基于Golang標(biāo)準(zhǔn)庫(kù)實(shí)現(xiàn)插件功能,幫助我們構(gòu)建更靈活可擴(kuò)展的應(yīng)用。

什么是插件

簡(jiǎn)單來(lái)說(shuō),插件就是可以被其他軟件加載的軟件,通常用于擴(kuò)展應(yīng)用程序的功能和外觀,插件的開(kāi)發(fā)人員甚至可以不直接修改基礎(chǔ)應(yīng)用程序。

你很可能在日常生活中使用過(guò)插件,也許用的是其他名稱,如擴(kuò)展(extensions)或附加組件(add-ons)。最常見(jiàn)的例子就是 VSCode 擴(kuò)展,你應(yīng)該用過(guò) VSCode,對(duì)吧?畢竟這是最受程序員歡迎的文本編輯器。如果你用過(guò),一定會(huì)同意 VSCode 本身就是一個(gè)文本編輯器,而不是集成開(kāi)發(fā)環(huán)境。其基本功能非常簡(jiǎn)單,幾乎不支持集成開(kāi)發(fā)環(huán)境中常見(jiàn)的功能,如調(diào)試、自動(dòng)完成和測(cè)試導(dǎo)航等。不過(guò),通過(guò)編輯器的擴(kuò)展市場(chǎng),可以找到支持這些功能以及其他更多功能的各種插件。事實(shí)上,插件已成為編輯器的主要賣點(diǎn)之一,促使工具開(kāi)發(fā)人員集中精力為編輯器制作專用插件,有時(shí)甚至超越了編碼本身的范疇,就像 Figma 所做的那樣[2]。

對(duì)于 VSCode 而言,插件是用 JavaScript 編寫(xiě)的,但也有基于 Go 編寫(xiě)插件的情況。例如 Terraform(云提供商基礎(chǔ)設(shè)施即代碼服務(wù)),它允許用戶為其工具編寫(xiě)插件[3],從而與多個(gè)云供應(yīng)商(AWS、GCP、Azure......)進(jìn)行交互。

另一個(gè)例子是 API 網(wǎng)關(guān)服務(wù) Kong,它允許開(kāi)發(fā)人員使用不同語(yǔ)言(包括 Go)編寫(xiě)插件,這些插件[4]可以在將請(qǐng)求轉(zhuǎn)發(fā)給底層服務(wù)之前,對(duì)接收到的請(qǐng)求進(jìn)行處理。

免責(zé)聲明

  • 本文假設(shè)你至少對(duì) Go 語(yǔ)言有基本的了解。如果還不了解,建議先了解一下 Go[5],然后再來(lái)閱讀。
  • 本文示例代碼中的某些功能要求至少使用 Go 1.21.0 版本。
  • Windows 機(jī)器尚未支持 Go 的插件功能。如果你用的是 Windows,建議使用 WSL[6]。
  • 本文生成的代碼可在 Github 代碼庫(kù)[7]中找到。

插件的基礎(chǔ)設(shè)施

我們將插件基礎(chǔ)架構(gòu)分為三個(gè)部分:協(xié)議/API、實(shí)現(xiàn)和插件加載器。請(qǐng)注意,這種劃分不是官方標(biāo)準(zhǔn),也不是紙上談兵,而是在實(shí)際應(yīng)用中的通常做法。

協(xié)議/API

協(xié)議是我們?nèi)我庠O(shè)置的定義和默認(rèn)值,這樣就可以在各組件之間進(jìn)行簡(jiǎn)潔的通信。和任何協(xié)議一樣,需要設(shè)定插件和基礎(chǔ)應(yīng)用程序之間的通信方式。為此,我們可以使用不同的方法,既可以通過(guò)簡(jiǎn)單的文檔解釋期望的方法,也可以定義接口庫(kù)(編程接口,如 class foo implements bar)。只要插件的實(shí)現(xiàn)遵循這些準(zhǔn)則,應(yīng)用就能調(diào)用插件代碼。

實(shí)現(xiàn)

我們需要編碼來(lái)實(shí)現(xiàn)協(xié)議設(shè)定的功能。也就是說(shuō),需要在插件代碼中實(shí)現(xiàn)預(yù)期的函數(shù)和變量,以便主應(yīng)用程序可以調(diào)用。

提醒一下,插件代碼并不局限于這些實(shí)現(xiàn)方式。

插件加載器

這是需要由主應(yīng)用程序執(zhí)行的部分,有兩個(gè)職責(zé):查找插件并在代碼中加載其功能。

插件是主程序項(xiàng)目的外部組件,因此需要一種方法來(lái)查找該程序的所有插件。我們可以簡(jiǎn)單的在文件系統(tǒng)中定義一個(gè)固定的文件夾來(lái)存放所有插件,但最好是允許應(yīng)用程序用戶通過(guò)配置文件來(lái)指向他們的插件,或者兩種方式同時(shí)支持。

安裝所有插件后,需要在應(yīng)用程序中訪問(wèn)它們的應(yīng)用程序接口。這通常是通過(guò)鉤子實(shí)現(xiàn)的:運(yùn)行時(shí)調(diào)用插件(或插件的一部分)的部分。以 VSCode 為例,"文件加載時(shí)"就是這樣一個(gè)鉤子,因此插件可以使用這個(gè)鉤子捕捉加載的文件并據(jù)此運(yùn)行。實(shí)現(xiàn)哪些鉤子以及何時(shí)實(shí)現(xiàn)鉤子與應(yīng)用程序的邏輯有內(nèi)在聯(lián)系,只能具體問(wèn)題具體分析。

我們?cè)跇?gòu)建什么

學(xué)習(xí)編程的最佳方式莫過(guò)于動(dòng)手實(shí)踐。因此我們來(lái)創(chuàng)建一個(gè)使用插件的簡(jiǎn)單應(yīng)用程序。

我們要構(gòu)建的是一個(gè)基于插件的 HTTP 重定向服務(wù)。這是一個(gè)簡(jiǎn)單的 HTTP 服務(wù),監(jiān)聽(tīng)端口中的請(qǐng)求并將其重定向到另一個(gè)服務(wù)器,同時(shí)將響應(yīng)傳遞給原始客戶端。有了這項(xiàng)服務(wù),我們就可以接入請(qǐng)求并對(duì)其進(jìn)行修改。在本例中,我們將通過(guò)插件獲取請(qǐng)求并打印。

至于插件加載部分,我們使用Go庫(kù)作為協(xié)議,并通過(guò)配置文件來(lái)定位插件。

1.開(kāi)發(fā)插件協(xié)議

我們首先定義插件協(xié)議。為此,我們定義一個(gè) go 庫(kù)組件。

在定義該模塊之前,我們先定義應(yīng)用程序組件:

# From a folder you want to keep the project:
mkdir http-redirect
cd http-redirect
go work init
go mod init github.com/<your_github_username>/http-redirect
go work use .

當(dāng)然,你可以自行決定應(yīng)用名稱。因?yàn)樾枰鄠€(gè)模塊進(jìn)行交互,因此我們決定使用 go 工作區(qū)。要了解更多相關(guān)信息,請(qǐng)查看文檔[8]。

接下來(lái)可以創(chuàng)建庫(kù)組件了:

# From http-redirect
mkdir protocol
cd protocol
go mod init github.com/<your_github_username>/http-redirect/protocol
go work use . # Add new module to workspace

接下來(lái)創(chuàng)建一些文件,整個(gè)文件樹(shù)應(yīng)該是這樣的:

我們將在 protocol.go 中開(kāi)展工作。我們希望在協(xié)議中為每個(gè)請(qǐng)求調(diào)用函數(shù)。因此,我們要為插件實(shí)現(xiàn)一個(gè)名為 PreRequestHook 的函數(shù),看起來(lái)是這樣的:

// protocol.go
package protocol

import "net/http"

// Plugins should export a variable called "Plugin" which implements this interface
type HttpRedirectPlugin interface {
  PreRequestHook(*http.Request)
}

代碼很簡(jiǎn)單,我們只需獲取指向 http.Request 類型的指針(因?yàn)榭赡芨恼?qǐng)求),然后將每個(gè) HTTP 請(qǐng)求傳遞給我們的服務(wù)器。我們使用的是標(biāo)準(zhǔn)庫(kù)定義的類型,但請(qǐng)注意,也可以根據(jù)應(yīng)用需求使用不同的類型。

就是這樣!但不要被例子的簡(jiǎn)單性所迷惑。對(duì)于大型應(yīng)用來(lái)說(shuō),這可能是一個(gè)相當(dāng)大的文件,其中包含不同的接口、默認(rèn)實(shí)現(xiàn)、配置和其他亂七八糟的東西。

2.實(shí)現(xiàn)插件

現(xiàn)在有了一個(gè)可遵循的協(xié)議,就可以創(chuàng)建并實(shí)現(xiàn)插件了。

同樣,我們?yōu)椴寮?chuàng)建一個(gè)新組件,并為其創(chuàng)建一個(gè)文件。

# From http-redirect
mkdir log-plugin
cd log-plugin
go mod init github.com/<your_github_username>/http-redirect/log-plugin
go work use . # Add new module to workspace
touch plugin.go

現(xiàn)在的文件樹(shù)應(yīng)該是這樣的:

我們來(lái)編寫(xiě)插件!首先,創(chuàng)建一個(gè)函數(shù)來(lái)打印請(qǐng)求。

// log-plugin/plugin.go
package main

import (
  "log/slog"
  "net/http"
  "net/http/httputil"
)

func logRequest(req *http.Request) {
  result, err := httputil.DumpRequest(req, true)
  if err != nil {
    slog.Error("Failed to print request", "err", err)
  }
  slog.Info("Request sent:", "req", result)
}

func logRequestLikeCUrl(req *http.Request) {
  panic("Unimplemented!")
}

func main() { /*empty because it does nothing*/ }

這里的未實(shí)現(xiàn)函數(shù)只是為了顯示我們可以為更復(fù)雜的協(xié)議添加更多功能,只是目前還無(wú)法正確配置,因此不會(huì)使用。

我們要用到的是 logRequest 函數(shù),它通過(guò) go 標(biāo)準(zhǔn)庫(kù)的結(jié)構(gòu)化日志組件打印請(qǐng)求。這就完成了我們的功能,但現(xiàn)在需要導(dǎo)出插件,使其滿足協(xié)議要求。

你可能注意到了,有一個(gè)什么也不做的 main 函數(shù)。這是 go 編譯器的要求,因?yàn)槟承┕δ苄枰粋€(gè)入口點(diǎn)。雖然這個(gè)編譯包中存在 main 函數(shù),但不會(huì)作為可執(zhí)行文件被調(diào)用。

我們需要導(dǎo)入庫(kù)。一般情況下,可以使用 go get 來(lái)恢復(fù)這個(gè)庫(kù),但由于我們是在本地機(jī)器上開(kāi)發(fā),因此只需在 go.mod 文件中添加庫(kù)路徑即可:

replace github.com/profusion/http-redirect/protocol => ../protocol

接下來(lái)我們創(chuàng)建一個(gè)實(shí)現(xiàn) HttpRedirectPlugin 接口的結(jié)構(gòu)體,并調(diào)用日志函數(shù)。

// log-plugin/plugin.go
package main

import (
  //…
  "github.com/<your_github_username>/http-redirect/protocol"
)

// … previous code …

type PluginStr struct{}

// Compile time check for
// PreRequestHook implements protocol.HttpRedirectPlugin.
var _ protocol.HttpRedirectPlugin = PluginStr{}

// PreRequestHook implements protocol.HttpRedirectPlugin.
func (p PluginStr) PreRequestHook(req *http.Request) {
  logRequest(req)
}

var Plugin = PluginStr{}

這就是需要的所有代碼。我們只需將其作為插件構(gòu)建即可。為此,我們只需向 go 編譯器傳遞 buildmode 標(biāo)志:

# From http-redirect/log-plugin
go build -buildmode=plugin -o plugin.so plugin.go

瞧!我們有了一個(gè)插件!現(xiàn)在只需將其加載到應(yīng)用程序就行了。

3.加載插件

我們需要一個(gè)應(yīng)用程序來(lái)加載插件。這不是本文的重點(diǎn),但以下是 Go 中 HTTP 重定向服務(wù)器代碼,我們可以對(duì)其進(jìn)行修改。

// cmd/main.go
package main

import (
  "flag"
  "fmt"
  "io"
  "log/slog"
  "net/http"
  "strings"
)

var from int
var to string

func init() {
  flag.IntVar(&from, "from", 5555, "Local port to get requests")
  flag.StringVar(&to, "to", "", "Target server to redirect request to")
}

func main() {
  flag.Parse()
  Listen()
}

type proxy struct{}

func Listen() {
  p := &proxy{}
  srvr := http.Server{
    Addr: fmt.Sprintf(":%d", from),
    Handler: p,
  }
  if err := srvr.ListenAndServe(); err != nil {
    slog.Error("Server is down", "Error", err)
  }
}

// ServeHTTP implements http.Handler.
func (p *proxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
  // Remove original URL for redirect
  req.RequestURI = ""

  // Set URL accordingly
  req.URL.Host = to
  if req.TLS == nil {
    req.URL.Scheme = "http"
  } else {
    req.URL.Scheme = "https"
  }

  // Remove connection headers
  // (will be replaced by redirect client)
  DropHopHeaders(&req.Header)

  // Register Proxy Request
  SetProxyHeader(req)

  // Resend request
  client := &http.Client{}

  resp, err := client.Do(req)

  if err != nil {
    http.Error(rw, "Server Error: Redirect failed", http.StatusInternalServerError)
  }
  defer resp.Body.Close()

  // Once again, remove connection headers
  DropHopHeaders(&resp.Header)
  
  // Prepare and send response
  CopyHeaders(rw.Header(), &resp.Header)
  rw.WriteHeader(resp.StatusCode)
  if _, err = io.Copy(rw, resp.Body); err != nil {
    slog.Error("Error writing response", "error", err)
  }
}

func CopyHeaders(src http.Header, dst *http.Header) {
  for headingName, headingValues := range src {
    for _, value := range headingValues {
      dst.Add(headingName, value)
    }
  }
}

// Hop-by-hop headers. These are removed when sent to the backend.
// http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html
var hopHeaders = []string{
  "Connection",
  "Keep-Alive",
  "Proxy-Authenticate",
  "Proxy-Authorization",
  "Te", // canonicalized version of "TE"
  "Trailers",
  "Transfer-Encoding",
  "Upgrade",
}

func DropHopHeaders(head *http.Header) {
  for _, header := range hopHeaders {
    head.Del(header)
  }
}

func SetProxyHeader(req *http.Request) {
  headerName := "X-Forwarded-for"
  target := to
  if prior, ok := req.Header[headerName]; ok {
    // Not first proxy, append
    target = strings.Join(prior, ", ") + ", " + target
  }
  req.Header.Set(headerName, target)
}

首先需要找到插件的位置。為此,我們將用 JSON 定義配置文件,在里面定義路徑列表,在本文中列表里只有一項(xiàng),但請(qǐng)注意,這是一個(gè)為插件定義配置的機(jī)會(huì)。


// config.json
[
  "log-plugin/plugin.so"
]

這就足夠了。然后我們編寫(xiě)讀取該文件內(nèi)容的代碼,為了保持整潔,將在另一個(gè)文件中進(jìn)行插件加載。

// cmd/plugin.go
package main

import (
  "encoding/json"
  "os"
)

// global but private, safe usage here in this file
var pluginPathList []string

func LoadConfig() {
  f, err := os.ReadFile("config.json")
  if err != nil {
    // NOTE: in real cases, deal with this error
    panic(err)
  }
  json.Unmarshal(f, &pluginPathList)
}

然后加載插件本身,為此我們將使用標(biāo)準(zhǔn)庫(kù)中的 golang 插件組件[9]。

// cmd/plugin.go
package main

import (
  //…
  "plugin"
)

// ...previous code...

var pluginList []*plugin.Plugin

func LoadPlugins() {
  // Allocate a list for storing all our plugins
  pluginList = make([]*plugin.Plugin, 0, len(pluginPathList))
  for _, p := range pluginPathList {
    // We use plugin.Open to load the plugin by path
    plg, err := plugin.Open(p)
    if err != nil {
      // NOTE: in real cases, deal with this error
      panic(err)
    }
    pluginList = append(pluginList, plg)
  }
}

// Let's throw this here so it loads the plugins as soon as we import this module
func init() {
  LoadConfig()
  LoadPlugins()
}

插件加載后,就可以訪問(wèn)其符號(hào)了,包括我們?cè)趨f(xié)議中定義的變量 Plugin。我們修改之前的代碼,保存這個(gè)變量,而不是整個(gè)插件?,F(xiàn)在,我們的文件看起來(lái)是這樣的:

// cmd/plugin.go

import (
  //…
  "protocol"
  "net/http"
)

//…

// Substitute previous code
var pluginList []*protocol.HttpRedirectPlugin

func LoadPlugins() {
  // Allocate a list for storing all our plugins
  pluginList = make([]*protocol.HttpRedirectPlugin, 0, len(pluginPathList))
  for _, p := range pluginPathList {
    // We use plugin.Open to load plugins by path
    plg, err := plugin.Open(p)
    if err != nil {
      // NOTE: in real cases, deal with this error
      panic(err)
    }
  
    // Search for variable named "Plugin"
    v, err := plg.Lookup("Plugin")
    if err != nil {
      // NOTE: in real cases, deal with this error
      panic(err)
    }
    
    // Cast symbol to protocol type
    castV, ok := v.(protocol.HttpRedirectPlugin)
    if !ok {
      // NOTE: in real cases, deal with this error
      panic("Could not cast plugin")
    }
    
    pluginList = append(pluginList, &castV)
  }
}

// …

很好,現(xiàn)在 pluginList 中的所有變量都是正常的 golang 變量,可以直接訪問(wèn),就好像從一開(kāi)始就是代碼的一部分。然后,我們構(gòu)建鉤子函數(shù),在發(fā)送請(qǐng)求前調(diào)用所有插件鉤子。

// cmd/plugin.go

//…

func PreRequestHook(req *http.Request) {
  for _, plg := range pluginList {
    // Plugin is a list of pointers, we need to dereference them
    // to use the proper function
    (*plg).PreRequestHook(req)
  }
}

最后,在主代碼中調(diào)用鉤子:

// cmd/main.go

//…

// ServeHTTP implements http.Handler.
func (p *proxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
  PreRequestHook(req)
// …

就是這樣!我們創(chuàng)建了一個(gè)應(yīng)用程序和一個(gè)插件,將插件加載到應(yīng)用中,然后針對(duì)收到的每個(gè)請(qǐng)求運(yùn)行插件代碼,并記錄這些請(qǐng)求。

想要測(cè)試?直接運(yùn)行就行:

# From http-redirect
go run cmd/*.go -from <port> -to <url>

結(jié)論

我們?cè)诒疚闹杏懻摿耸裁词遣寮?、插件的用途,以及如何基?Go 標(biāo)準(zhǔn)庫(kù)創(chuàng)建支持插件的應(yīng)用程序的能力。在未來(lái)的工作中,請(qǐng)考慮通過(guò)這種基礎(chǔ)架構(gòu)為解決方案提供更好的可擴(kuò)展性,從而幫助其他開(kāi)發(fā)人員可以更廣泛的使用我們的工具和應(yīng)用。

責(zé)任編輯:趙寧寧 來(lái)源: DeepNoMind
相關(guān)推薦

2023-11-14 08:38:43

Golang人臉識(shí)別

2024-01-29 08:04:48

Golang標(biāo)準(zhǔn)庫(kù)服務(wù)端

2024-02-05 08:50:57

Golang標(biāo)準(zhǔn)庫(kù)客戶端

2020-10-22 06:59:09

GolangRust語(yǔ)言

2021-01-29 08:56:13

Golang標(biāo)準(zhǔn)庫(kù)函數(shù)

2024-10-09 17:19:04

GoGolangKubernetes

2019-12-09 10:03:40

MySQLSQL數(shù)據(jù)庫(kù)

2010-01-22 13:31:58

C++標(biāo)準(zhǔn)庫(kù)

2024-11-12 08:00:00

LSM樹(shù)GolangMemTable

2020-11-23 14:16:42

Golang

2010-03-26 13:39:28

Python標(biāo)準(zhǔn)庫(kù)

2011-03-22 10:48:28

Nagios監(jiān)控

2021-07-28 13:03:42

Golang熔斷語(yǔ)言

2022-09-19 13:49:55

操作系統(tǒng)鴻蒙

2024-04-03 09:00:10

2024-09-04 08:46:38

2023-07-28 09:26:43

GolangZap

2022-11-24 16:11:27

2022-12-28 08:08:57

點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)