Go-Kit实现莫斯电码转换

go-kit

本文通过一个简单的服务器案例，说明go-kit微服务工具集的基本使用方式。

我们的需求是实现一个可以将英文和莫斯电码相互转换的api服务，举例，我们希望通过建立一个api服务，将 ”Hello World“ 翻译为 ”… . .-… .-… — .-- — .-. .-… -…“。

项目地址：https://github.com/xuezhaojun/gomorse_gui

Overview

Go-kit架构具有三个抽象分层，分别是：

传输层
服务层
EndPoint层

然后概览一下项目结构：

--gomorse_gui--pkg-- object_model-- interfaces.go-- morse-- morse_translater.go--svc-- morse_service-- endpoint.go-- transport.go-- main.go

主要go文件有四个：

interfaces.go
morse_translater.go
main.go
transport.go

接下来，我们将分别介绍三个层以及其对应的代码。

服务层

业务逻辑实现在服务层里，而在服务层的代码只需要关心业务逻辑即可。

pkg/object_model目录下的interfaces.go，主要作用以接口的形式，定义业务目标：

type Morse interface {TranslateEnglishToMorseCode(request Request) (Response, error)TranslateMorseCodeToEnglish(request Request) (Response, error)
}

简明来说，我们的这个需要实现两个目标：

将English翻译为MorseCode
将MorseCode翻译为English

pkg/morse目录下的morse_translater.go, 则是该接口的具体实现：

type MorseTranslater struct{}func NewMorseTranlater() *MorseTranslater {return &MorseTranslater{}
}func (m *MorseTranslater) TranslateEnglishToMorseCode(request object_model.Request) (response object_model.Response, err error) {if err := gomorse.Valid(request.Text); err != nil {return object_model.Response{}, err}return object_model.Response{Text: gomorse.ToMorse(request.Text),}, nil
}func (m *MorseTranslater) TranslateMorseCodeToEnglish(request object_model.Request) (response object_model.Response, err error) {return object_model.Response{Text: gomorse.FromMorse(request.Text),}, nil
}

将具体实现和业务目标解耦，外部依赖只引用object_model包下的接口定义，而对接口具体是如何实现的并不关心。

EndPoint层

EndPoint是server和client的基础结构，我们来看下EndPoint在Go-kit中的定义：

type Endpoint func(ctx context.Context, request interface{}) (response interface{}, err error)

Endpoint是一个function，输入request（泛型），输出response（泛型）

我们的目的是将之前的业务逻辑，打包到EndPoint里，代码在svc/morse_service/endpoint.go 文件下, 比如 makeTranslateEToMEndpoint 这个方法，将转换英文到morseCode这个业务，打包为了一个EndPoint, 这个EndPoint中：

先将req指定为request类型
然后调用业务代码
然后在将结果转化为response类型

func makeTranslateEToMEndpoint(s *morse.MorseTranslater) endpoint.Endpoint {return func(ctx context.Context, req interface{}) (interface{}, error) {// 此处request是transport层来的r := req.(request)// 此处需要打包为transport层可以明白结构体resp, err := s.TranslateEnglishToMorseCode(object_model.Request{r.Text,})if err != nil {return response{Err: err.Error(),}, nil}return response{Text: resp.Text,}, nil}
}

其中request 和 response，是传输层定义的http数据包结构，由此可见Endpoint起到业务层（或者服务层）和传输层之间的粘合作用

传输层

传输层负责微服务和外部的通信，go-kit支持多种传输层方法，包括但不限于：

http
gRPC
amqp消息队列
nats消息队列

本项目中，我们使用http的作为传输层。

首先，我们需要定义EndPoint中所使用到的request和response：

type request struct {Text string `json:"text"`
}type response struct {Text string `json:"text"`Err  string `json:"err"`
}

既然基于http，我们就需要定义如何解析http的data到我们的request和response：

func decodeRequest(_ context.Context, r *http.Request) (interface{}, error) {var request requesterr := json.NewDecoder(r.Body).Decode(&request)if err != nil {return nil, err}return request, err
}func encodeResponse(_ context.Context, w http.ResponseWriter, response interface{}) error {return json.NewEncoder(w).Encode(response)
}

然后我们定义个Run方法，并执行以下步骤：

创建服务层业务逻辑实现的实例 — translateSvc
通过makeEndpoint将translateSvc包装为EndPoint
我们借助了 go-kit/translate/http 包下NewServer方法，将EndPoint打包为一个http.Handler
- 当然我们也可以利用go-kit/translate/grpc包下的NewServer方法，将EndPoint打包为 grpc.Handler, 对应grpc方式的传输层
最后利用handler创建http服务，完成传输层的构建

func Run(addr string) error {translateSvc := morse.NewMorseTranlater()endPointEtoM := makeTranslateEToMEndpoint(translateSvc)endPointMtoE := makeTranslateMToEEndPoint(translateSvc)// NewServer以三个方法作为输入translateEToMHandler := httphandler.NewServer(endPointEToM, decodeRequest, encodeResponse,)translateMToEHandler := httphandler.NewServer(endPointMToE, decodeRequest, encodeResponse,)r := mux.NewRouter()r.Methods("POST").Path("/english_to_morse").Handler(translateEToMHandler)r.Methods("POST").Path("/morse_to_english").Handler(translateMToEHandler)r.Methods("GET").PathPrefix("/").Handler(&hello{})return http.ListenAndServe(addr, r)
}

总结

至此，我们完成了一个基于Go-kit的http微服务的编写，其实Go-kit官方推荐了不少代码生成的工具，可以自动基于proto文件生成除了业务逻辑以外的代码，但是从scratch来编写代码，会更有助于理解go-kit的结构。

Thanks for reading!

参考

Go Microservices with Go kit: Introduction