go rpc 入門
rpc(Romote Procedure Call,遠程過程調(diào)用)。相對應(yīng)的就是本地過程調(diào)用,在以前最開始接觸編程的時候最簡單的就是調(diào)用一個自己編寫的一個函數(shù)。這種就叫做本地過程調(diào)用。
本地過程調(diào)用
比如以下代碼就是本地過程調(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))
}
在本地過程調(diào)用中,函數(shù)調(diào)用的本質(zhì)是直接拿到函數(shù)指針,然后去調(diào)用對應(yīng)的代碼段。
遠程過程調(diào)用
遠程過程調(diào)用跨越了物理服務(wù)器的限制,是在網(wǎng)絡(luò)中完成的,在調(diào)用遠程服務(wù)器的過程中,本地程序等待返回結(jié)果,知道遠端程序執(zhí)行完畢,講結(jié)果進行返回到本地,最終完成一次完整的調(diào)用。
遠程過程調(diào)用指的是調(diào)用遠端服務(wù)器上的程序的方法的整個過程
rpc的技術(shù)架構(gòu)
- 客戶端(client):服務(wù)調(diào)用發(fā)起方,又稱為服務(wù)消費者。
- 服務(wù)器(server):遠程計算機上運行的程序,其中包含客戶端要調(diào)用和訪問的方法。
- 客戶端存根(client stub):存放服務(wù)端的地址,端口消息。將客戶端的請求參數(shù)打包成網(wǎng)絡(luò)消息,發(fā)送到服務(wù)方。接受服務(wù)方返回的消息。該段程序運行在客戶端。
- 服務(wù)端存根(server stub):接受客戶端發(fā)送的數(shù)據(jù)包,解析數(shù)據(jù)包,調(diào)用具體的服務(wù)方法,將調(diào)用結(jié)果打包成數(shù)據(jù)包發(fā)送給客戶端。
- 服務(wù)消費者(client客戶端)通過本地調(diào)用的方式調(diào)用服務(wù)
- 客戶端存根(client stub)接收到調(diào)用請求后負責(zé)將方法、入?yún)⒌刃畔⑿蛄谢ńM裝)成能夠進行網(wǎng)絡(luò)傳輸?shù)南Ⅲw
- 客戶端存根(client stub)找到遠程的服務(wù)地址,并且將消息通過網(wǎng)絡(luò)發(fā)送給服務(wù)端
- 服務(wù)端存根(server stub)收到消息后進行解碼(反序列化操作)
- 服務(wù)端存根(server stub)根據(jù)解碼結(jié)果調(diào)用本地的服務(wù)進行相關(guān)處理
- 本地服務(wù)執(zhí)行具體業(yè)務(wù)邏輯并將處理結(jié)果返回給服務(wù)端存根(server stub)
- 服務(wù)端存根(server stub)將返回結(jié)果重新打包成消息(序列化)并通過網(wǎng)絡(luò)發(fā)送至消費方
- 客戶端存根(client stub)接收到消息,并進行解碼(反序列化)
- 服務(wù)消費方得到最終結(jié)果
go rpc 實踐
golang是原生支持RPC的,因為官方給我們提供了支持rpc的庫:net/rpc
.
具體鏈接如下:https://golang.org/pkg/net/rpc/。根據(jù)官方的解釋,rpc包主要是提供通過網(wǎng)絡(luò)訪問一個對象方法的功能。
服務(wù)端
服務(wù)定義及暴露
前文我們已經(jīng)講過rpc調(diào)用有兩個參與者,分別是:客戶端(client)和服務(wù)器(server)。
首先是提供方法暴露的一方--服務(wù)器。
在編程實現(xiàn)過程中,服務(wù)器端需要注冊結(jié)構(gòu)體對象,然后通過對象所屬的方法暴露給調(diào)用者,從而提供服務(wù),該方法稱之為輸出方法,此輸出方法可以被遠程調(diào)用。當(dāng)然,在定義輸出方法時,能夠被遠程調(diào)用的方法需要遵循一定的規(guī)則。我們通過代碼進行講解:
func (t *T) MethodName(request T1,response *T2) error
上述代碼是go語言官方給出的對外暴露的服務(wù)方法的定義標準,其中包含了主要的幾條規(guī)則,分別是:
- 1、對外暴露的方法有且只能有兩個參數(shù),這個兩個參數(shù)只能是輸出類型或內(nèi)建類型,兩種類型中的一種。
- 2、方法的第二個參數(shù)必須是指針類型。
- 3、方法的返回類型為error。
- 4、方法的類型是可輸出的。
- 5、方法本身也是可輸出的。
我們舉例說明:假設(shè)目前我們有一個需求,給出一個float類型變量,作為圓形的半徑,要求通過RPC調(diào)用,返回對應(yīng)的圓形面積。具體的編程實現(xiàn)思路如下:
// MathUtil 用于數(shù)學(xué)計算
type MathUtil struct {
}
// CaculateCircleArea 計算圓的面積
func (m *MathUtil) CaculateCircleArea(req float64, resp *float64) error {
*resp = math.Pi * req * req
return nil
}
在上述的案例中,我們可以看到:
- 1、CaculateCircleArea方法是服務(wù)對象MathUtil向外提供的服務(wù)方法,該方法用于接收傳入的圓形半徑數(shù)據(jù),計算圓形面積并返回。
- 2、第一個參數(shù)req代表的是調(diào)用者(client)傳遞提供的參數(shù)。
- 3、第二個參數(shù)resp代表要返回給調(diào)用者的計算結(jié)果,必須是指針類型。
- 4、正常情況下,方法的返回值為是error,為nil。如果遇到異常或特殊情況,則error將作為一個字符串返回給調(diào)用者,此時,resp參數(shù)就不會再返回給調(diào)用者。
至此為止,已經(jīng)實現(xiàn)了服務(wù)端的功能定義,接下來就是讓服務(wù)代碼生效,需要將服務(wù)進行注冊,并啟動請求處理。
注冊服務(wù)及監(jiān)聽請求
net/rpc包為我們提供了注冊服務(wù)和處理請求的一系列方法,如下所示:
func main() {
// 創(chuàng)建計算實例
mathUtil := new(MathUtil)
// 將對象注冊到rpc服務(wù)中
err := rpc.Register(mathUtil)
if err != nil {
log.Panic(err)
return
}
//3、通過該函數(shù)把mathUtil中提供的服務(wù)注冊到HTTP協(xié)議上,方便調(diào)用者可以利用http的方式進行數(shù)據(jù)傳遞
rpc.HandleHTTP()
//4、在特定的端口進行監(jiān)聽
listen, err := net.Listen("tcp", ":8081")
if err != nil {
panic(err.Error())
}
go http.Serve(listen, nil)
}
經(jīng)過服務(wù)注冊和監(jiān)聽處理,RPC調(diào)用過程中的服務(wù)端實現(xiàn)就已經(jīng)完成了。接下來需要實現(xiàn)的是客戶端請求代碼的實現(xiàn)。
代碼:
package main
import (
"log"
"math"
"net"
"net/http"
"net/rpc"
)
// MathUtil 用于數(shù)學(xué)計算
type MathUtil struct {
}
// CaculateCircleArea 計算圓的面積
func (m *MathUtil) CaculateCircleArea(req float64, resp *float64) error {
*resp = math.Pi * req * req
return nil
}
func main() {
// 創(chuàng)建計算實例
mathUtil := new(MathUtil)
// 將對象注冊到rpc服務(wù)中
err := rpc.Register(mathUtil)
if err != nil {
log.Panic(err)
return
}
//3、通過該函數(shù)把mathUtil中提供的服務(wù)注冊到HTTP協(xié)議上,方便調(diào)用者可以利用http的方式進行數(shù)據(jù)傳遞
rpc.HandleHTTP()
//4、在特定的端口進行監(jiān)聽
listen, err := net.Listen("tcp", ":8081")
if err != nil {
panic(err.Error())
}
http.Serve(listen, nil)
}
客戶端
在服務(wù)端是通過Http的端口監(jiān)聽方式等待連接的,因此在客戶端就需要通過http連接,首先與服務(wù)端實現(xiàn)連接。
- 客戶端連接服務(wù)端
client, err := rpc.DialHTTP("tcp", "localhost:8081")
if err != nil {
panic(err.Error())
}
- 遠端方法調(diào)用 客戶端成功連接服務(wù)端以后,就可以通過方法調(diào)用調(diào)用服務(wù)端的方法,具體調(diào)用方法如下:
var req float64 //請求值
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)用,該方法有三個參數(shù),第一個參數(shù)表示要調(diào)用的遠端服務(wù)的方法名,第二個參數(shù)是調(diào)用時要傳入的參數(shù),第三個參數(shù)是調(diào)用要接收的返回值。 上述的Call方法調(diào)用實現(xiàn)的方式是同步的調(diào)用,除此之外,還有一種異步的方式可以實現(xiàn)調(diào)用。異步調(diào)用代碼實現(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
第三個傳入的channel
,但是如果傳入的是空則會新建一個。
多參數(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 計算和
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)
}