前言
這是系列最後一篇文章了,最後我們來為我們的rpc框架實現一個http gateway。這個功能實際上受到了rpcx的啟發,基於這種方式實現一個簡單的類似service mesh中的sidecar。程式碼地址:github
原理
http gateway可以接收來自客戶端的http請求並將其轉換為rpc請求然後交給服務端處理,再將服務端處理過後的結果通過http響應返回給客戶端。
http gateway的大致原理就是將我們的RPC協議中header部分放到http header中,然後RPC協議中的body部分放到http body即可。
實現
首先我們需要定義http header中各個欄位的名稱:
const (
HEADER_SEQ = "rpc-header-seq" //序號, 用來唯一標識請求或響應
HEADER_MESSAGE_TYPE = "rpc-header-message_type" //訊息型別,用來標識一個訊息是請求還是響應
HEADER_COMPRESS_TYPE = "rpc-header-compress_type" //壓縮型別,用來標識一個訊息的壓縮方式
HEADER_SERIALIZE_TYPE = "rpc-header-serialize_type" //序列化型別,用來標識訊息體採用的編碼方式
HEADER_STATUS_CODE = "rpc-header-status_code" //狀態型別,用來標識一個請求是正常還是異常
HEADER_SERVICE_NAME = "rpc-header-service_name" //服務名
HEADER_METHOD_NAME = "rpc-header-method_name" //方法名
HEADER_ERROR = "rpc-header-error" //方法呼叫發生的異常
HEADER_META_DATA = "rpc-header-meta_data" //其他後設資料
)
複製程式碼
然後我們需要啟動一個http server,用來接收http請求。這裡我們使用go自帶的api,預設使用5080埠,如果發現埠已經被佔用了,就遞增埠。
func (s *SGServer) startGateway() {
port := 5080
ln, err := net.Listen("tcp", ":" + strconv.Itoa(port))
for err != nil && strings.Contains(err.Error(), "address already in use") {
port++
ln, err = net.Listen("tcp", ":" + strconv.Itoa(port))
}
if err != nil {
log.Printf("error listening gateway: %s", err.Error())
}
log.Printf("gateway listenning on " + strconv.Itoa(port))
//避免阻塞,使用新的goroutine來執行http server
go func() {
err := http.Serve(ln, s)
if err != nil {
log.Printf("error serving http %s", err.Error())
}
}()
}
複製程式碼
接下來我們需要實現ServeHTTP函式:
func (s *SGServer) ServeHTTP(rw http.ResponseWriter, r *http.Request) {
//如果url不對則直接返回
if r.URL.Path != "/invoke" {
rw.WriteHeader(404)
return
}
//如果method不對則直接返回
if r.Method != "POST" {
rw.WriteHeader(405)
return
}
//構造新的請求
request := protocol.NewMessage(s.Option.ProtocolType)
//根據http header填充request的header
request, err := parseHeader(request, r)
if err != nil {
rw.WriteHeader(400)
}
//根據http body填充request的data
request, err = parseBody(request, r)
if err != nil {
rw.WriteHeader(400)
}
//構造context
ctx := metadata.WithMeta(context.Background(), request.MetaData)
response := request.Clone()
response.MessageType = protocol.MessageTypeResponse
//處理請求
response = s.process(ctx, request, response)
//返回相應
s.writeHttpResponse(response, rw, r)
}
func parseBody(message *protocol.Message, request *http.Request) (*protocol.Message, error) {
data, err := ioutil.ReadAll(request.Body)
if err != nil {
return nil, err
}
message.Data = data
return message, nil
}
func parseHeader(message *protocol.Message, request *http.Request) (*protocol.Message, error) {
headerSeq := request.Header.Get(HEADER_SEQ)
seq, err := strconv.ParseUint(headerSeq, 10, 64)
if err != nil {
return nil, err
}
message.Seq = seq
headerMsgType := request.Header.Get(HEADER_MESSAGE_TYPE)
msgType, err := protocol.ParseMessageType(headerMsgType)
if err != nil {
return nil, err
}
message.MessageType = msgType
headerCompressType := request.Header.Get(HEADER_COMPRESS_TYPE)
compressType, err := protocol.ParseCompressType(headerCompressType)
if err != nil {
return nil, err
}
message.CompressType = compressType
headerSerializeType := request.Header.Get(HEADER_SERIALIZE_TYPE)
serializeType, err := codec.ParseSerializeType(headerSerializeType)
if err != nil {
return nil, err
}
message.SerializeType = serializeType
headerStatusCode := request.Header.Get(HEADER_STATUS_CODE)
statusCode, err := protocol.ParseStatusCode(headerStatusCode)
if err != nil {
return nil, err
}
message.StatusCode = statusCode
serviceName := request.Header.Get(HEADER_SERVICE_NAME)
message.ServiceName = serviceName
methodName := request.Header.Get(HEADER_METHOD_NAME)
message.MethodName = methodName
errorMsg := request.Header.Get(HEADER_ERROR)
message.Error = errorMsg
headerMeta := request.Header.Get(HEADER_META_DATA)
meta := make(map[string]interface{})
err = json.Unmarshal([]byte(headerMeta), &meta)
if err != nil {
return nil, err
}
message.MetaData = meta
return message, nil
}
func (s *SGServer) writeHttpResponse(message *protocol.Message, rw http.ResponseWriter, r *http.Request) {
header := rw.Header()
header.Set(HEADER_SEQ, string(message.Seq))
header.Set(HEADER_MESSAGE_TYPE, message.MessageType.String())
header.Set(HEADER_COMPRESS_TYPE, message.CompressType.String())
header.Set(HEADER_SERIALIZE_TYPE, message.SerializeType.String())
header.Set(HEADER_STATUS_CODE, message.StatusCode.String())
header.Set(HEADER_SERVICE_NAME, message.ServiceName)
header.Set(HEADER_METHOD_NAME, message.MethodName)
header.Set(HEADER_ERROR, message.Error)
metaDataJson, _ := json.Marshal(message.MetaData)
header.Set(HEADER_META_DATA, string(metaDataJson))
_, _ = rw.Write(message.Data)
}
複製程式碼
最後我們只需要在wrapper中啟動http server即可。
func (w *DefaultServerWrapper) WrapServe(s *SGServer, serveFunc ServeFunc) ServeFunc {
return func(network string, addr string, meta map[string]interface{}) error {
//省略前面的部分
...
//啟動gateway
s.startGateway()
return serveFunc(network, addr, meta)
}
}
複製程式碼
客戶端測試程式碼:
func MakeHttpCall() {
//宣告引數並序列化,放到http請求的body中
arg := service.Args{A: rand.Intn(200), B: rand.Intn(100)}
data, _ := msgpack.Marshal(arg)
body := bytes.NewBuffer(data)
req, err := http.NewRequest("POST", "http://localhost:5080/invoke", body)
if err != nil {
log.Println(err)
return
}
req.Header.Set(server.HEADER_SEQ, "1")
req.Header.Set(server.HEADER_MESSAGE_TYPE, protocol.MessageTypeRequest.String())
req.Header.Set(server.HEADER_COMPRESS_TYPE,protocol.CompressTypeNone.String())
req.Header.Set(server.HEADER_SERIALIZE_TYPE,codec.MessagePack.String())
req.Header.Set(server.HEADER_STATUS_CODE,protocol.StatusOK.String())
req.Header.Set(server.HEADER_SERVICE_NAME,"Arith")
req.Header.Set(server.HEADER_METHOD_NAME,"Add")
req.Header.Set(server.HEADER_ERROR,"")
meta := map[string]interface{}{"key":"value"}
metaJson, _ := json.Marshal(meta)
req.Header.Set(server.HEADER_META_DATA,string(metaJson))
response, err := http.DefaultClient.Do(req)
if err != nil {
log.Println(err)
return
}
if response.StatusCode != 200 {
log.Println(response)
} else if response.Header.Get(server.HEADER_ERROR) != "" {
log.Println(response.Header.Get(server.HEADER_ERROR))
} else {
data, err = ioutil.ReadAll(response.Body)
result := service.Reply{}
msgpack.Unmarshal(data, &result)
fmt.Println(result.C)
}
}
複製程式碼
結語
這個系列到此就告一段落了,但是還有很多需要改進和豐富的地方甚至是錯誤,後續再以單獨文章的形式更新。