go rpc 入門(mén)

go rpc 入門(mén)

rpc（Romote Procedure Call，遠(yuǎn)程過(guò)程調(diào)用）。相對(duì)應(yīng)的就是本地過(guò)程調(diào)用，在以前最開(kāi)始接觸編程的時(shí)候最簡(jiǎn)單的就是調(diào)用一個(gè)自己編寫(xiě)的一個(gè)函數(shù)。這種就叫做本地過(guò)程調(diào)用。

本地過(guò)程調(diào)用

比如以下代碼就是本地過(guò)程調(diào)用。

package main

import "fmt"

func Sum(a, b int) int {
    return a+b
}

func main() {
    fmt.Printf("sum = %d\n", Sum(1, 2))
}

在本地過(guò)程調(diào)用中，函數(shù)調(diào)用的本質(zhì)是直接拿到函數(shù)指針，然后去調(diào)用對(duì)應(yīng)的代碼段。

遠(yuǎn)程過(guò)程調(diào)用

遠(yuǎn)程過(guò)程調(diào)用跨越了物理服務(wù)器的限制，是在網(wǎng)絡(luò)中完成的，在調(diào)用遠(yuǎn)程服務(wù)器的過(guò)程中，本地程序等待返回結(jié)果，知道遠(yuǎn)端程序執(zhí)行完畢，講結(jié)果進(jìn)行返回到本地，最終完成一次完整的調(diào)用。

遠(yuǎn)程過(guò)程調(diào)用指的是調(diào)用遠(yuǎn)端服務(wù)器上的程序的方法的整個(gè)過(guò)程

rpc的技術(shù)架構(gòu)

image
  1. 客戶端（client）：服務(wù)調(diào)用發(fā)起方，又稱為服務(wù)消費(fèi)者。
  2. 服務(wù)器（server）：遠(yuǎn)程計(jì)算機(jī)上運(yùn)行的程序，其中包含客戶端要調(diào)用和訪問(wèn)的方法。
  3. 客戶端存根（client stub）：存放服務(wù)端的地址，端口消息。將客戶端的請(qǐng)求參數(shù)打包成網(wǎng)絡(luò)消息，發(fā)送到服務(wù)方。接受服務(wù)方返回的消息。該段程序運(yùn)行在客戶端。
  4. 服務(wù)端存根（server stub）：接受客戶端發(fā)送的數(shù)據(jù)包，解析數(shù)據(jù)包，調(diào)用具體的服務(wù)方法，將調(diào)用結(jié)果打包成數(shù)據(jù)包發(fā)送給客戶端。
image
  1. 服務(wù)消費(fèi)者（client客戶端）通過(guò)本地調(diào)用的方式調(diào)用服務(wù)
  2. 客戶端存根（client stub）接收到調(diào)用請(qǐng)求后負(fù)責(zé)將方法、入?yún)⒌刃畔⑿蛄谢ńM裝）成能夠進(jìn)行網(wǎng)絡(luò)傳輸?shù)南Ⅲw
  3. 客戶端存根（client stub）找到遠(yuǎn)程的服務(wù)地址，并且將消息通過(guò)網(wǎng)絡(luò)發(fā)送給服務(wù)端
  4. 服務(wù)端存根（server stub）收到消息后進(jìn)行解碼（反序列化操作）
  5. 服務(wù)端存根（server stub）根據(jù)解碼結(jié)果調(diào)用本地的服務(wù)進(jìn)行相關(guān)處理
  6. 本地服務(wù)執(zhí)行具體業(yè)務(wù)邏輯并將處理結(jié)果返回給服務(wù)端存根（server stub）
  7. 服務(wù)端存根（server stub）將返回結(jié)果重新打包成消息（序列化）并通過(guò)網(wǎng)絡(luò)發(fā)送至消費(fèi)方
  8. 客戶端存根（client stub）接收到消息，并進(jìn)行解碼（反序列化）
  9. 服務(wù)消費(fèi)方得到最終結(jié)果

go rpc 實(shí)踐

golang是原生支持RPC的，因?yàn)楣俜浇o我們提供了支持rpc的庫(kù)：net/rpc.
具體鏈接如下：https://golang.org/pkg/net/rpc/。根據(jù)官方的解釋，rpc包主要是提供通過(guò)網(wǎng)絡(luò)訪問(wèn)一個(gè)對(duì)象方法的功能。

服務(wù)端

服務(wù)定義及暴露

前文我們已經(jīng)講過(guò)rpc調(diào)用有兩個(gè)參與者，分別是：客戶端（client）和服務(wù)器（server）。

首先是提供方法暴露的一方--服務(wù)器。

在編程實(shí)現(xiàn)過(guò)程中，服務(wù)器端需要注冊(cè)結(jié)構(gòu)體對(duì)象，然后通過(guò)對(duì)象所屬的方法暴露給調(diào)用者，從而提供服務(wù)，該方法稱之為輸出方法，此輸出方法可以被遠(yuǎn)程調(diào)用。當(dāng)然，在定義輸出方法時(shí)，能夠被遠(yuǎn)程調(diào)用的方法需要遵循一定的規(guī)則。我們通過(guò)代碼進(jìn)行講解：

func (t *T) MethodName(request T1,response *T2) error

上述代碼是go語(yǔ)言官方給出的對(duì)外暴露的服務(wù)方法的定義標(biāo)準(zhǔn)，其中包含了主要的幾條規(guī)則，分別是：

  • 1、對(duì)外暴露的方法有且只能有兩個(gè)參數(shù)，這個(gè)兩個(gè)參數(shù)只能是輸出類(lèi)型或內(nèi)建類(lèi)型，兩種類(lèi)型中的一種。
  • 2、方法的第二個(gè)參數(shù)必須是指針類(lèi)型。
  • 3、方法的返回類(lèi)型為error。
  • 4、方法的類(lèi)型是可輸出的。
  • 5、方法本身也是可輸出的。
    我們舉例說(shuō)明：假設(shè)目前我們有一個(gè)需求，給出一個(gè)float類(lèi)型變量，作為圓形的半徑，要求通過(guò)RPC調(diào)用，返回對(duì)應(yīng)的圓形面積。具體的編程實(shí)現(xiàn)思路如下：
// MathUtil 用于數(shù)學(xué)計(jì)算
type MathUtil struct {
}

// CaculateCircleArea 計(jì)算圓的面積
func (m *MathUtil) CaculateCircleArea(req float64, resp *float64) error {
    *resp = math.Pi * req * req
    return nil
}

在上述的案例中，我們可以看到：

  • 1、CaculateCircleArea方法是服務(wù)對(duì)象MathUtil向外提供的服務(wù)方法，該方法用于接收傳入的圓形半徑數(shù)據(jù)，計(jì)算圓形面積并返回。
  • 2、第一個(gè)參數(shù)req代表的是調(diào)用者（client）傳遞提供的參數(shù)。
  • 3、第二個(gè)參數(shù)resp代表要返回給調(diào)用者的計(jì)算結(jié)果，必須是指針類(lèi)型。
  • 4、正常情況下，方法的返回值為是error，為nil。如果遇到異?；蛱厥馇闆r，則error將作為一個(gè)字符串返回給調(diào)用者，此時(shí)，resp參數(shù)就不會(huì)再返回給調(diào)用者。

至此為止，已經(jīng)實(shí)現(xiàn)了服務(wù)端的功能定義，接下來(lái)就是讓服務(wù)代碼生效，需要將服務(wù)進(jìn)行注冊(cè)，并啟動(dòng)請(qǐng)求處理。

注冊(cè)服務(wù)及監(jiān)聽(tīng)請(qǐng)求

net/rpc包為我們提供了注冊(cè)服務(wù)和處理請(qǐng)求的一系列方法，如下所示：

func main() {
    // 創(chuàng)建計(jì)算實(shí)例
    mathUtil := new(MathUtil)

    // 將對(duì)象注冊(cè)到rpc服務(wù)中
    err := rpc.Register(mathUtil)
    if err != nil {
        log.Panic(err)
        return
    }

    //3、通過(guò)該函數(shù)把mathUtil中提供的服務(wù)注冊(cè)到HTTP協(xié)議上，方便調(diào)用者可以利用http的方式進(jìn)行數(shù)據(jù)傳遞
    rpc.HandleHTTP()

    //4、在特定的端口進(jìn)行監(jiān)聽(tīng)
    listen, err := net.Listen("tcp", ":8081")
    if err != nil {
        panic(err.Error())
    }
    go http.Serve(listen, nil)
}

經(jīng)過(guò)服務(wù)注冊(cè)和監(jiān)聽(tīng)處理，RPC調(diào)用過(guò)程中的服務(wù)端實(shí)現(xiàn)就已經(jīng)完成了。接下來(lái)需要實(shí)現(xiàn)的是客戶端請(qǐng)求代碼的實(shí)現(xiàn)。

代碼：

package main

import (
    "log"
    "math"
    "net"
    "net/http"
    "net/rpc"
)

// MathUtil 用于數(shù)學(xué)計(jì)算
type MathUtil struct {
}

// CaculateCircleArea 計(jì)算圓的面積
func (m *MathUtil) CaculateCircleArea(req float64, resp *float64) error {
    *resp = math.Pi * req * req
    return nil
}

func main() {
    // 創(chuàng)建計(jì)算實(shí)例
    mathUtil := new(MathUtil)

    // 將對(duì)象注冊(cè)到rpc服務(wù)中
    err := rpc.Register(mathUtil)
    if err != nil {
        log.Panic(err)
        return
    }

    //3、通過(guò)該函數(shù)把mathUtil中提供的服務(wù)注冊(cè)到HTTP協(xié)議上，方便調(diào)用者可以利用http的方式進(jìn)行數(shù)據(jù)傳遞
    rpc.HandleHTTP()

    //4、在特定的端口進(jìn)行監(jiān)聽(tīng)
    listen, err := net.Listen("tcp", ":8081")
    if err != nil {
        panic(err.Error())
    }
    http.Serve(listen, nil)
}

客戶端

在服務(wù)端是通過(guò)Http的端口監(jiān)聽(tīng)方式等待連接的，因此在客戶端就需要通過(guò)http連接，首先與服務(wù)端實(shí)現(xiàn)連接。

  1. 客戶端連接服務(wù)端
client, err := rpc.DialHTTP("tcp", "localhost:8081")
    if err != nil {
        panic(err.Error())
    }
  1. 遠(yuǎn)端方法調(diào)用 客戶端成功連接服務(wù)端以后，就可以通過(guò)方法調(diào)用調(diào)用服務(wù)端的方法，具體調(diào)用方法如下：
var req float64 //請(qǐng)求值
req = 3

var resp *float64 //返回值
err = client.Call("MathUtil.CalculateCircleArea", req, &resp)
if err != nil {
    panic(err.Error())
}
fmt.Println(*resp)

上述的調(diào)用方法核心在于client.Call方法的調(diào)用，該方法有三個(gè)參數(shù)，第一個(gè)參數(shù)表示要調(diào)用的遠(yuǎn)端服務(wù)的方法名，第二個(gè)參數(shù)是調(diào)用時(shí)要傳入的參數(shù)，第三個(gè)參數(shù)是調(diào)用要接收的返回值。 上述的Call方法調(diào)用實(shí)現(xiàn)的方式是同步的調(diào)用，除此之外，還有一種異步的方式可以實(shí)現(xiàn)調(diào)用。異步調(diào)用代碼實(shí)現(xiàn)如下：

var req float64 = 3.0
var respSync *float64
//異步的調(diào)用方式
syncCall := client.Go("MathUtil.CalculateCircleArea", req, &respSync, nil)
replayDone := <-syncCall.Done
fmt.Println(replayDone)
fmt.Println(*respSync)

replayDone打印的結(jié)果是：&{MathUtil.CalculateCircleArea 3 0xc0000fe030 <nil> 0xc0000f6420}

其本質(zhì)就是call結(jié)構(gòu)體：

type Call struct {
    ServiceMethod string      // The name of the service and method to call.
    Args          interface{} // The argument to the function (*struct).
    Reply         interface{} // The reply from the function (*struct).
    Error         error       // After completion, the error status.
    Done          chan *Call  // Strobes when call is complete.
}

syncCall.Done就是client.Go第三個(gè)傳入的channel，但是如果傳入的是空則會(huì)新建一個(gè)。

多參數(shù)的調(diào)用

文件結(jié)構(gòu)如下：

.
├── client.go
├── param
│   └── param.go
└── server.go

// param/param.go
package param

type Param struct {
    Num1 float64
    Num2 float64
}

在server.go中添加如下函數(shù)

// CalculateSum 計(jì)算和
func (m *MathUtil) CalculateSum(req param.Param, resp *float64) error {
    *resp = req.Num1 + req.Num2
    return nil
}

修改client.go:

package main

import (
    "fmt"
    "RpcCode_mul/param"
    "net/rpc"
)

func main() {
    client, err := rpc.DialHTTP("tcp", "localhost:8081")
    if err != nil {
        panic(err.Error())
    }


    req := param.Param{
        Num1: 1,
        Num2: 3,
    }
    var respSync *float64
    //異步的調(diào)用方式
    syncCall := client.Go("MathUtil.CalculateSum", req, &respSync, nil)
    replayDone := <-syncCall.Done
    fmt.Println(replayDone)
    fmt.Println(*respSync)
}

參考
https://github.com/rubyhan1314/Golang-100-Days/blob/master/Day80(RPC%E8%BF%9C%E7%A8%8B%E8%B0%83%E7%94%A8%E6%9C%BA%E5%88%B6)/day80_RPC%E8%BF%9C%E7%A8%8B%E8%BF%87%E7%A8%8B%E8%B0%83%E7%94%A8.md

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容