Lile简单介绍

继续挖坑，希望将来能静下心来，安静的补坑。

Lile是Go中的gRPC服务和一组工具/库的应用程序生成器（类似于create-react-app，rails new或django startproject）。

Lile的主要焦点是在创建新服务时通过创建基本结构，测试示例，Dockerfile，Makefile等。

Lile带有基本的预设置，带有可插拔选项，适用于……

• Metrics (例如Prometheus)
• Tracing (例如Zipkin)
• PubSub (例如Google PubSub)
• Service Discovery

安装Lile非常简单，使用go get就可以安装lile的命令行工具，用于生成新的服务和所需的库。

首先，您需要安装Google的Protocol Buffers。

1. $ brew install protobuf
2. $ go get -u github.com/lileio/lile/...

使用lile new生成新服务。

1. $ lile new lileio/users

Lile附带一个“代码生成器”，可以快速生成新的Lile服务。

Lile遵循Go关于$GOPATH的约定（参见如何写Go），并且自动解析您的新服务的名称，以在正确的位置创建服务。

如果您的Github用户名是lileio，并且您想创建一个新的服务为了发布消息到Slack，您可以使用如下命令：

1. lile new lileio/slack

这将创建一个项目到$GOPATH/src/github.com/lileio/slack

Lile服务主要使用gRPC，因此使用protocol buffers作为接口定义语言（IDL），用于描述有效负载消息的服务接口和结构。 如果需要，可以使用其他替代品。

我强烈建议您先阅读Google API设计文档，以获得有关RPC方法和消息的一般命名的好建议，以及如果需要，可以通过gRPC Gateway将其转换为REST/JSON。

下面是一个简单的例子account_service：

1. service AccountService {
2. rpc List (ListAccountsRequest) returns (ListAccountsResponse) {}
3. rpc GetById (GetByIdRequest) returns (Account) {}
4. rpc GetByEmail (GetByEmailRequest) returns (Account) {}
5. rpc AuthenticateByEmail (AuthenticateByEmailRequest) returns (Account) {}
6. rpc GeneratePasswordToken (GeneratePasswordTokenRequest) returns (GeneratePasswordTokenResponse) {}
7. rpc ResetPassword (ResetPasswordRequest) returns (Account) {}
8. rpc ConfirmAccount (ConfirmAccountRequest) returns (Account) {}
9. rpc Create (CreateAccountRequest) returns (Account) {}
10. rpc Update (UpdateAccountRequest) returns (Account) {}
11. rpc Delete (DeleteAccountRequest) returns (google.protobuf.Empty) {}
12. }

生成RPC方法

默认情况下，Lile将创建一个RPC方法和一个简单的请求和响应消息。

1. syntax = "proto3";
2. option go_package = "github.com/lileio/slack";
3. package slack;
4. message Request {
5. string id = 1;
6. }
7. message Response {
8. string id = 1;
9. }
10. service Slack {
11. rpc Read (Request) returns (Response) {}
12. }

我们来修改一下使它能够提供真正的服务，并添加自己的方法。

我们来创建一个Announce方法向Slack发布消息。

我们假设Slack团队和身份验证已经由服务配置来处理，所以我们服务的用户只需要提供一个房间和他们的消息。 该服务将发送特殊的空响应，因为我们只需要知道是否发生错误，也不需要知道其他任何内容。

现在我们的proto文件看起来像这样：

1. syntax = "proto3";
2. option go_package = "github.com/lileio/slack";
3. import "google/protobuf/empty.proto";
4. package slack;
5. message AnnounceRequest {
6. string channel = 1;
7. string msg = 2;
8. }
9. service Slack {
10. rpc Announce (AnnounceRequest) returns (google.protobuf.Empty) {}
11. }

现在我们运行protoc工具我们的文件，以及Lile生成器插件。

1. protoc -I . slack.proto --lile-server_out=. --go_out=plugins=grpc:$GOPATH/src

Lile提供了一个Makefile，每个项目都有一个已经配置的proto构建步骤。 所以我们可以运行它。

1. make proto

我们可以看到，Lile将在server目录中为我们创建两个文件。

1. $ make proto
2. protoc -I . slack.proto --lile-server_out=. --go_out=plugins=grpc:$GOPATH/src
3. 2017/07/12 15:44:01 [Creating] server/announce.go
4. 2017/07/12 15:44:01 [Creating test] server/announce_test.go

我们来看看Lile为我们创建的announce.go文件。

1. package server
2. import (
3. "errors"
4. "github.com/golang/protobuf/ptypes/empty"
5. "github.com/lileio/slack"
6. context "golang.org/x/net/context"
7. )
8. func (s SlackServer) Announce(ctx context.Context, r *slack.AnnounceRequest) (*empty.Empty, error) {
9. return nil, errors.New("not yet implemented")
10. }

接下来我们实现这个生成的方法，让我们从测试开始吧！

编写并运行测试用例

当您使用Lile生成RPC方法时，也会创建一个对应的测试文件。例如，给定我们的announce.go文件，Lile将在同一目录中创建announce_test.go

看起来如下:

1. package server
2. import (
3. "testing"
4. "github.com/lileio/slack"
5. "github.com/stretchr/testify/assert"
6. context "golang.org/x/net/context"
7. )
8. func TestAnnounce(t *testing.T) {
9. ctx := context.Background()
10. req := &slack.AnnounceRequest{}
11. res, err := cli.Announce(ctx, req)
12. assert.Nil(t, err)
13. assert.NotNil(t, res)
14. }

您现在可以使用Makefile运行测试，并运行make test命令:

1. $ make test
2. === RUN TestAnnounce
3. --- FAIL: TestAnnounce (0.00s)
4. Error Trace: announce_test.go:16
5. Error: Expected nil, but got: &status.statusError{Code:2, Message:"not yet implemented", Details:[]*any.Any(nil)}
6. Error Trace: announce_test.go:17
7. Error: Expected value not to be nil.
8. FAIL
9. coverage: 100.0% of statements
10. FAIL github.com/lileio/slack/server 0.011s
11. make: *** [test] Error 2

我们的测试失败了，因为我们还没有实现我们的方法，在我们的方法中返回一个“未实现”的错误。

让我们在announce.go中实现Announce方法，这里是一个使用nlopes的slack library的例子。

1. package server
2. import (
3. "os"
4. "google.golang.org/grpc/codes"
5. "google.golang.org/grpc/status"
6. "github.com/golang/protobuf/ptypes/empty"
7. "github.com/lileio/slack"
8. sl "github.com/nlopes/slack"
9. context "golang.org/x/net/context"
10. )
11. var api = sl.New(os.Getenv("SLACK_TOKEN"))
12. func (s SlackServer) Announce(ctx context.Context, r *slack.AnnounceRequest) (*empty.Empty, error) {
13. _, _, err := api.PostMessage(r.Channel, r.Msg, sl.PostMessageParameters{})
14. if err != nil {
15. return nil, status.Errorf(codes.Internal, err.Error())
16. }
17. return &empty.Empty{}, nil
18. }

我们再次修改我们的测试用力，然后再次运行我们的测试:

1. package server
2. import (
3. "testing"
4. "github.com/lileio/slack"
5. "github.com/stretchr/testify/assert"
6. context "golang.org/x/net/context"
7. )
8. func TestAnnounce(t *testing.T) {
9. ctx := context.Background()
10. req := &slack.AnnounceRequest{
11. Channel: "@alex",
12. Msg: "hellooo",
13. }
14. res, err := cli.Announce(ctx, req)
15. assert.Nil(t, err)
16. assert.NotNil(t, res)
17. }

现在如果我使用我的Slack令牌作为环境变量运行测试，我应该看到通过测试！

1. $ alex@slack: SLACK_TOKEN=zbxkkausdkasugdk make test
2. go test -v ./... -cover
3. ? github.com/lileio/slack [no test files]
4. === RUN TestAnnounce
5. --- PASS: TestAnnounce (0.32s)
6. PASS
7. coverage: 75.0% of statements
8. ok github.com/lileio/slack/server 0.331s coverage: 75.0% of statements
9. ? github.com/lileio/slack/slack [no test files]
10. ? github.com/lileio/slack/slack/cmd [no test files]
11. ? github.com/lileio/slack/subscribers [no test files]

使用生成的命令行

生成服务时，Lile会基于cobra生成命令行程序。您可以使用自己的cmd扩展应用程序，也可以使用内置cmds来运行服务。

运行不带任何参数的cmd行应用程序将打印生成的帮助。

例如go run orders/main.go

运行up将同时运行RPC服务器和发布订阅的订阅者。

添加你自己的命令行

要添加自己的cmd，您可以使用Cobra内置的生成器来生成更多的命令。

1. $ cd orders
2. $ cobra add import

您现在可以编辑生成的文件，以创建您的命令行，cobra会自动将命令行的名称添加到帮助中。