Go微服务实战 - 用户服务开发(gRPC+Protocol Buffer)

概要

用户服务基本是每个互联网产品里必备的一个服务了，因为没有用户基本是什么也干不了。所以他的重要性不言而喻。本文主要介绍下如何开发一个用户微服务，以及他的详细开发流程。
目录

• Go微服务实战 - 从0到1搭建一个类Instagram应用(持续更新)
  
• Go微服务实战 - 用户服务(gRPC+Protocol Buffer)
  
• Go微服务实战 - 关系服务服务(gRPC+Protocol Buffer)
  
• Go微服务实战 - 动态服务(gRPC+Protocol Buffer)
  
• Go微服务实战 - 聚合服务(http)
  

调用流程图


技术栈

• Go
  
• Eagle 开发框架
  
• Redis
  
• MySQL
  
• Gorm
  
• docker
  
• kubernetes
  

接口开发

使用proto方式定义，主要包含以下接口

开发步骤

这里详细的记录了开发的步骤，方便参看本项目的同学知道其实现过程。
1、生成proto模板文件

1. eagle proto add api/user/v1/user.proto

复制代码

内容如下

1. syntax = "proto3";
3. package api.user.v1;
5. option go_package = "github.com/go-microservice/user-service/api/user/v1;v1";
6. option java_multiple_files = true;
7. option java_package = "api.user.v1";
9. service UserService {
10.         rpc CreateUser (CreateUserRequest) returns (CreateUserReply);
11.         rpc UpdateUser (UpdateUserRequest) returns (UpdateUserReply);
12.         rpc DeleteUser (DeleteUserRequest) returns (DeleteUserReply);
13.         rpc GetUser (GetUserRequest) returns (GetUserReply);
14.         rpc ListUser (ListUser1Request) returns (ListUserReply);
15. }
17. message CreateUser1Request {}
18. message CreateUser1Reply {}
20. message UpdateUserRequest {}
21. message UpdateUserReply {}
23. message DeleteUserRequest {}
24. message DeleteUserReply {}
26. message GetUserRequest {}
27. message GetUserReply {}
29. message ListUserRequest {}
30. message ListUserReply {}

复制代码

2、为proto填充业务方法及字段定义

1. vim api/user/v1/user.proto

复制代码

3、生成pb文件

1. # 生成所有proto
2. make grpc
4. # 或者
5. # 生成指定proto的pb文件
6. eagle proto client api/user/v1/user.proto
8. # Output
9. ll api/user/v1/
10. user.pb.go #新增
11. user.proto
12. user_grpc.pb.go #新增

复制代码

会生成两个文件 api/user/v1/user.pb.go 和 api/user/v1/user.pb.go
4、生成server骨架代码

1. # 生成骨架代码
2. eagle proto server api/user/v1/user.proto
4. # 默认会输出到 internal/service
5. # 如果需要指定到对应的目录，可以使用 -t 参数, eg:
6. # eagle proto server -t internal/logic
8. # 查看
9. internal/service/user_svc.go

复制代码

5、注册服务到gRPC Server

1. // internal/server/grpc.go
3. import (
4.                 ...
5.                 v1 "github.com/go-microservice/user-service/api/user/v1"
6.                 ...
7. )
9. ...
11. // NewGRPCServer creates a gRPC server
12. func NewGRPCServer(
13.         cfg *app.ServerConfig,
14.         // 新增
15.         svc *service.UserServiceServer,
16. ) *grpc.Server {
18.         grpcServer := grpc.NewServer(
19.                 grpc.Network("tcp"),
20.                 grpc.Address(cfg.WriteTimeout),
21.                 grpc.Timeout(cfg.WriteTimeout),
22.         )
24.         // register biz service
25.         // 新增
26.         v1.RegisterUserServiceServer(grpcServer, svc)
28.         return grpcServer
29. }

复制代码

6、在生成的server中编写业务逻辑

1. // vim internal/service/user_svc.go
3. package service
5. import (
6.         "context"
8.         pb "github.com/go-microservice/moment-service/api/user/v1"
9. )
11. var (
12.         _ pb.UserServiceServer = (*UserServiceServer)(nil)
13. )
15. type UserServiceServer struct {
16.         pb.UnimplementedUserServiceServer
17. }
19. func NewUserServiceServer() *UserServiceServer {
20.         return &UserServiceServer{
21. }
22. }
24. func (s *UserServiceServer) CreateUser(ctx context.Context, req *pb.CreateUserRequest) (*pb.CreateUserReply, error) {
26.         return &pb.CreateUserReply{}, nil
27. }
28. func (s *UserServiceServer) UpdateUser(ctx context.Context, req *pb.UpdateUserRequest) (*pb.UpdateUserReply, error) {
29.         return &pb.UpdateUserReply{}, nil
30. }
31. func (s *UserServiceServer) DeleteUser(ctx context.Context, req *pb.DeleteUserRequest) (*pb.DeleteUserReply, error) {
32.         return &pb.DeleteUserReply{}, nil
33. }
34. func (s *UserServiceServer) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.GetUserReply, error) {
35.         return &pb.GetUserReply{}, nil
36. }
37. func (s *UserServiceServer) ListUser(ctx context.Context, req *pb.ListUserRequest) (*pb.ListUserReply, error) {
38.         return &pb.ListUserReply{}, nil
39. }

复制代码

后面就可以在这里补充具体的业务逻辑处理了。
7、启动服务

1. # 在根目录下运行
2. go run main.go

复制代码

确保运行gRPC server

1. // main.go
3. ...
4. eagle.WithServer(
5.         // init gRPC server
6.         gs,
7. ),
8. ...

复制代码

8、接口调试
调试工具，这里使用 [grpcurl](https://github.com/fullstorydev/grpcurl)

1. # 查看服务列表
2. grpcurl -plaintext localhost:9090 list
4. # Output
5. api.user.v1.UserService
6. grpc.health.v1.Health
7. grpc.reflection.v1alpha.ServerReflection
9. # 访问列表
10. grpcurl -plaintext -d '{"user_id":2}' localhost:9090 api.user.v1.UserService/ListUser

复制代码

参数说明

• -d 提交的参数， json格式
  
• -plaintext 使用纯文本连接，跳过TLS
  

也可以使用以下工具进行本地测试

• postman: 新版本的postman 也支持gRPC(beta版)调试
  
• grpucui: https://github.com/fullstorydev/grpcui
  1. # 开启UI界面调试窗口
  2. grpcui -plaintext localhost:9090

  复制代码

部署

两种部署方式

• docker
  
• k8s (本地部署可以使用minikube)
  

部署步骤

• 构建docker镜像
  1. docker build -t user-service:v1.0.0 -f deploy/docker/Dockerfile .

  复制代码
• 打docker tag
  1. docker tag user-service:v1.0.0 qloog/user-service:v1.0.0

  复制代码
• push tag 到 docker hub
  1. docker push qloog/user-service:v1.0.0

  复制代码
• 部署到k8s
  1. kubectl apply -f deploy/k8s/go-deployment.yaml
  2. kubectl apply -f deploy/k8s/go-service.yaml

  复制代码

以上命令都是一步一步执行的，为了方便期间，这里也提供了一件部署脚本，执行如下

1. sh deploy/deploy.sh

复制代码

项目源码

最终源码在这里：https://github.com/go-microservice/user-service
完结

到此，开发、测试、部署已经操作完了，后面会继续完善链路追踪和监控相关的部分。
感谢阅读， 祝大家 Happy coding~