微服务系列笔记之Mico Api详解

本文已被阅读过 Posted by 陌无崖 on 2019-08-10

导语

上一篇文章中有了入门案例,现在是不是有了很好的理解,不过有个前提是你需要了解grpc技术,简单的来说grpc是一个通信框架,micro是类似的一个通信框架,只不过这个框架应用于微服务中。因此如果你还未了解grpc技术,仍然建议你学习grpc基础,便于更好的理解本篇文章。

准备工作

1
2
3
4
5
6
7
8
9
10
11
12
## 安装go-micro
go get github.com/micro/go-micro
## 安装micro
go get github.com/micro/micro
## 安装grpc
go get -u google.golang.org/grpc
## 安装grpc插件
go get -u github.com/golang/protobuf/protoc-gen-go
## 安装micro插件
go get github.com/micro/protoc-gen-micro
# 设置环境变量,便于命令行操作
export PATH=$PATH:$GOPATH/bin

Micro API

如果你做过web开发,Http请求是无法避免的,服务端需要接受请求并返回相应的结果,但是这种情况下,如何才能在Go Micro中实现呢?其实在Micro中官方为我们提供了API网关micro api。对API的请求将有HTTP提供,并通过服务发现我们的路由。简单来说使用API​​网关模式为你的服务提供单个公共入口点。micro api服务于HTTP并使用服务发现动态路由。由于micro api基于go-micro开发,因此它同时具备了服务发现,负载均衡等能力。是可插拔的一个微服务。

如何使用

启动

1
micro api [command options] [arguments...]

options选项

–address:用来设置api地址,例如:0.0.0.0:8080
–handler:用来指定用于将HTTP请求映射到服务的请求处理程序,值有四个:api,event,http,rpc。
–namespace:设置api的命名空间,例如:go.micro.api,使用这个之后,http请求之后,才会解析api所在的路由
–resolver:设置api使用的主机名解析程序,值有三个:host,path,grpc。

小试牛刀

服务端

定义api.proto,这里需要注意的是我们定义了两个服务分别是Example 和 Foo,下面模拟Http请求结构体,其实Go-micro直接为我们封装了这部分如图

这里我们只是贴上源码,方便大家理解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
syntax = "proto3";

package go.micro.api.example;

service Example {
rpc Call(Request) returns(Response);
}

service Foo {
rpc Bar(Request) returns(Response);
}


message Pair {
string key = 1;
repeated string values = 2;
}
// 一个Http请求
message Request {
string method = 1;
string path = 2;
map<string, Pair> header = 3;
map<string, Pair> get = 4;
map<string, Pair> post = 5;
string body = 6;
string url = 7;
}
// 一个Http响应
message Response {
int32 statusCode = 1;
map<string, Pair> header = 2;
string body = 3;
}
// 一个Http事件
message Event {
// e.g login
string name = 1;
// uuid
string id = 2;
// unix timestamp of event
int64 timestamp = 3;
// event headers
map<string, Pair> header = 4;
// the event data
string data = 5;
}

编写我们的服务端代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
type Example struct{}

type Foo struct{}

// Example.Call 通过API向外暴露为/example/call,接收http请求
func (e *Example) Call(ctx context.Context, req *api.Request, rsp *api.Response) error {
log.Log("Example.Call接口收到请求")
//获取参数 map[string]*api.Pair数据类型
name, ok := req.Get["name"]
// 判断 values数组是否存在值
if !ok || len(name.Values) == 0 {
return errors.BadRequest("go.micro.api.example", "参数不正确")
}

// 打印请求头
for k, v := range req.Header {
log.Log("请求头信息,", k, " : ", v)
}

rsp.StatusCode = 200

b, _ := json.Marshal(map[string]string{
"message": "我们已经收到你的请求," + strings.Join(name.Values, " "),
})

// 设置返回值
rsp.Body = string(b)

return nil
}
//
func (f *Foo) Bar(ctx context.Context, req *api.Request, rsp *api.Response) error {
log.Logf("Foo.Bar接口收到请求")
//判断请求方法是否是POST
if req.Method != "POST" {
return errors.BadRequest("go.micro.api.example", "require post")
}
//获得请求头
ct, ok := req.Header["Content-Type"]
if !ok || len(ct.Values) == 0 {
return errors.BadRequest("go.micro.api.example", "need content-type")
}

fmt.Println(ct.Values[0])
if ct.Values[0] != "application/json" {
return errors.BadRequest("go.micro.api.example", "expect application/json")
}

var body map[string]interface{}
json.Unmarshal([]byte(req.Body), &body)

// 设置返回值
rsp.Body = "收到消息:" + string([]byte(req.Body))

return nil
}

注册我们的服务,这里和之前方法类似,不再强调。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
service := micro.NewService(
micro.Name("go.micro.api.example"),
micro.Version("latest"),
)

service.Init()
// 注册 example handler
api.RegisterExampleHandler(service.Server(), new(Example))

// 注册 foo handler
api.RegisterFooHandler(service.Server(), new(Foo))

if err := service.Run(); err != nil {
log.Fatal(err)
}

测试

首先启动我们的api

micro api --handler=api --namespace=go.micro.api

启动我们的服务端

go run api.go

我们这里用postman进行测试如下
测试bar


测试example

查看我们的控制台,同样产生了信息

结语

掌握本篇知识,总体来说不是很难,阅读时,请耐心思考,自己多加实践,才能更好的掌握。

本篇文章参考Go-Mico官方博客和系列案例
进行总结分享。

推荐阅读


本文欢迎转载,转载请联系作者,谢谢!


打开微信扫一扫,关注微信公众号