Service Group

Overview

go-zero uses gRPC to communicate between services. We define the interface of the service with proto files, but we may have multiple services in physical development. If the service is not clustered, the goctl generated code will be a large folder, leading to poor maintenance variability, so that the service group can improve the readability and maintenance of the code.

Service Group

In go-zero, by clustering files using service as a dimension in the proto file. We can define multiple services in the proto file and create a separate folder for each service so that different services can be grouped in order to improve readability and maintenance.

In addition to service defined in proto file, groups need to be controlled in goctl, creating code with or without groups depends on developers. We show it by example.

No group

Assume we have a proto file, below：

  1. syntax = "proto3";
  3. package user;
  5. option go_package = "github.com/example/user";
  7. message LoginReq{}
  8. message LoginResp{}
  9. message UserInfoReq{}
  10. message UserInfoResp{}
  11. message UserInfoUpdateReq{}
  12. message UserInfoUpdateResp{}
  13. message UserListReq{}
  14. message UserListResp{}
  16. message UserRoleListReq{}
  17. message UserRoleListResp{}
  18. message UserRoleUpdateReq{}
  19. message UserRoleUpdateResp{}
  20. message UserRoleInfoReq{}
  21. message UserRoleInfoResp{}
  22. message UserRoleAddReq{}
  23. message UserRoleAddResp{}
  24. message UserRoleDeleteReq{}
  25. message UserRoleDeleteResp{}
  28. message UserClassListReq{}
  29. message UserClassListResp{}
  30. message UserClassUpdateReq{}
  31. message UserClassUpdateResp{}
  32. message UserClassInfoReq{}
  33. message UserClassInfoResp{}
  34. message UserClassAddReq{}
  35. message UserClassAddResp{}
  36. message UserClassDeleteReq{}
  37. message UserClassDeleteResp{}
  39. service UserService{
  40.   rpc Login (LoginReq) returns (LoginResp);
  41.   rpc UserInfo (UserInfoReq) returns (UserInfoResp);
  42.   rpc UserInfoUpdate (UserInfoUpdateReq) returns (UserInfoUpdateResp);
  43.   rpc UserList (UserListReq) returns (UserListResp);
  45.   rpc UserRoleList (UserRoleListReq) returns (UserRoleListResp);
  46.   rpc UserRoleUpdate (UserRoleUpdateReq) returns (UserRoleUpdateResp);
  47.   rpc UserRoleInfo (UserRoleInfoReq) returns (UserRoleInfoResp);
  48.   rpc UserRoleAdd (UserRoleAddReq) returns (UserRoleAddResp);
  49.   rpc UserRoleDelete (UserRoleDeleteReq) returns (UserRoleDeleteResp);
  51.   rpc UserClassList (UserClassListReq) returns (UserClassListResp);
  52.   rpc UserClassUpdate (UserClassUpdateReq) returns (UserClassUpdateResp);
  53.   rpc UserClassInfo (UserClassInfoReq) returns (UserClassInfoResp);
  54.   rpc UserClassAdd (UserClassAddReq) returns (UserClassAddResp);
  55.   rpc UserClassDelete (UserClassDeleteReq) returns (UserClassDeleteResp);
  56. }

Let’s look at the structure of the code generated by goctl without grouping：

  1. $ goctl rpc protoc user.proto --go_out=. --go-grpc_out=. --zrpc_out=.
  2. $ tree
  3. .
  4. ├── etc
  5. │   └── user.yaml
  6. ├── github.com
  7. │   └── example
  8. │       └── user
  9. │           ├── user.pb.go
  10. │           └── user_grpc.pb.go
  11. ├── go.mod
  12. ├── internal
  13. │   ├── config
  14. │   │   └── config.go
  15. │   ├── logic
  16. │   │   ├── loginlogic.go
  17. │   │   ├── userclassaddlogic.go
  18. │   │   ├── userclassdeletelogic.go
  19. │   │   ├── userclassinfologic.go
  20. │   │   ├── userclasslistlogic.go
  21. │   │   ├── userclassupdatelogic.go
  22. │   │   ├── userinfologic.go
  23. │   │   ├── userinfoupdatelogic.go
  24. │   │   ├── userlistlogic.go
  25. │   │   ├── userroleaddlogic.go
  26. │   │   ├── userroledeletelogic.go
  27. │   │   ├── userroleinfologic.go
  28. │   │   ├── userrolelistlogic.go
  29. │   │   └── userroleupdatelogic.go
  30. │   ├── server
  31. │   │   └── userserviceserver.go
  32. │   └── svc
  33. │       └── servicecontext.go
  34. ├── user.go
  35. ├── user.proto
  36. └── userservice
  37.     └── userservice.go
  39. 10 directories, 24 files
Service Group - 图1reminding

does not support the definition of multiple services in proto file without being grouped or reporting errors.

Group

First, we need to define multiple services in proto file, as follows:：

  1. syntax = "proto3";
  3. package user;
  5. option go_package = "github.com/example/user";
  7. message LoginReq{}
  8. message LoginResp{}
  9. message UserInfoReq{}
  10. message UserInfoResp{}
  11. message UserInfoUpdateReq{}
  12. message UserInfoUpdateResp{}
  13. message UserListReq{}
  14. message UserListResp{}
  15. service UserService{
  16.   rpc Login (LoginReq) returns (LoginResp);
  17.   rpc UserInfo (UserInfoReq) returns (UserInfoResp);
  18.   rpc UserInfoUpdate (UserInfoUpdateReq) returns (UserInfoUpdateResp);
  19.   rpc UserList (UserListReq) returns (UserListResp);
  20. }
  22. message UserRoleListReq{}
  23. message UserRoleListResp{}
  24. message UserRoleUpdateReq{}
  25. message UserRoleUpdateResp{}
  26. message UserRoleInfoReq{}
  27. message UserRoleInfoResp{}
  28. message UserRoleAddReq{}
  29. message UserRoleAddResp{}
  30. message UserRoleDeleteReq{}
  31. message UserRoleDeleteResp{}
  32. service UserRoleService{
  33.   rpc UserRoleList (UserRoleListReq) returns (UserRoleListResp);
  34.   rpc UserRoleUpdate (UserRoleUpdateReq) returns (UserRoleUpdateResp);
  35.   rpc UserRoleInfo (UserRoleInfoReq) returns (UserRoleInfoResp);
  36.   rpc UserRoleAdd (UserRoleAddReq) returns (UserRoleAddResp);
  37.   rpc UserRoleDelete (UserRoleDeleteReq) returns (UserRoleDeleteResp);
  38. }
  40. message UserClassListReq{}
  41. message UserClassListResp{}
  42. message UserClassUpdateReq{}
  43. message UserClassUpdateResp{}
  44. message UserClassInfoReq{}
  45. message UserClassInfoResp{}
  46. message UserClassAddReq{}
  47. message UserClassAddResp{}
  48. message UserClassDeleteReq{}
  49. message UserClassDeleteResp{}
  50. service UserClassService{
  51.   rpc UserClassList (UserClassListReq) returns (UserClassListResp);
  52.   rpc UserClassUpdate (UserClassUpdateReq) returns (UserClassUpdateResp);
  53.   rpc UserClassInfo (UserClassInfoReq) returns (UserClassInfoResp);
  54.   rpc UserClassAdd (UserClassAddReq) returns (UserClassAddResp);
  55.   rpc UserClassDelete (UserClassDeleteReq) returns (UserClassDeleteResp);
  56. }

Let’s look at the structure of the code generated by goctl with grouping：

  1. # 通过 -m 指定 goctl 生成分组的代码
  2. $ goctl rpc protoc user.proto --go_out=. --go-grpc_out=. --zrpc_out=. -m
  3. $ tree
  4. .
  5. ├── client
  6. │   ├── userclassservice
  7. │   │   └── userclassservice.go
  8. │   ├── userroleservice
  9. │   │   └── userroleservice.go
  10. │   └── userservice
  11. │       └── userservice.go
  12. ├── etc
  13. │   └── user.yaml
  14. ├── github.com
  15. │   └── example
  16. │       └── user
  17. │           ├── user.pb.go
  18. │           └── user_grpc.pb.go
  19. ├── go.mod
  20. ├── internal
  21. │   ├── config
  22. │   │   └── config.go
  23. │   ├── logic
  24. │   │   ├── userclassservice
  25. │   │   │   ├── userclassaddlogic.go
  26. │   │   │   ├── userclassdeletelogic.go
  27. │   │   │   ├── userclassinfologic.go
  28. │   │   │   ├── userclasslistlogic.go
  29. │   │   │   └── userclassupdatelogic.go
  30. │   │   ├── userroleservice
  31. │   │   │   ├── userroleaddlogic.go
  32. │   │   │   ├── userroledeletelogic.go
  33. │   │   │   ├── userroleinfologic.go
  34. │   │   │   ├── userrolelistlogic.go
  35. │   │   │   └── userroleupdatelogic.go
  36. │   │   └── userservice
  37. │   │       ├── loginlogic.go
  38. │   │       ├── userinfologic.go
  39. │   │       ├── userinfoupdatelogic.go
  40. │   │       └── userlistlogic.go
  41. │   ├── server
  42. │   │   ├── userclassservice
  43. │   │   │   └── userclassserviceserver.go
  44. │   │   ├── userroleservice
  45. │   │   │   └── userroleserviceserver.go
  46. │   │   └── userservice
  47. │   │       └── userserviceserver.go
  48. │   └── svc
  49. │       └── servicecontext.go
  50. ├── user.go
  51. └── user.proto
  53. 19 directories, 28 files

We can see through the directory structure that logic, server, and customer directories are grouped according to service.