ZBLOG

go-zero框架设计api 从https到rpc

在 Go-zero 框架中,从 HTTPS API 设计到 RPC 服务的过程与从 HTTP 到 RPC 的步骤类似,主要差别在于启用 HTTPS 加密。这是一个简单的流程示例:

步骤概述

  1. 定义 HTTPS API 接口:创建 HTTPS API。
  2. 定义 RPC 接口:使用 Protocol Buffers (protobuf) 定义你的 RPC。
  3. 生成代码:使用 goctl 工具生成 HTTP 和 RPC 代码。
  4. 实现业务逻辑:实现你的业务逻辑,并将其连接到 HTTPS 和 RPC 服务中。
  5. 启动服务:运行你的服务并监听请求。

示例流程

1. 定义 HTTPS API 接口

首先,创建一个 .api 文件,例如 api/your_service.api

  1. syntax = "proto3";
  2. package your_service;
  3. service YourService {
  4. rpc GetUser(GetUserRequest) returns (GetUserResponse);
  5. }
  6. message GetUserRequest {
  7. int64 id = 1;
  8. }
  9. message GetUserResponse {
  10. int64 id = 1;
  11. string name = 2;
  12. }

接下来,在同一文件中,我们也可以定义HTTPS接口(在 go-zero 中,它通常会从同样的 .api 文件生成):

  1. http:
  2. /user:
  3. get:
  4. handler: GetUserHandler
  5. request: GetUserRequest
  6. response: GetUserResponse

2. 生成代码

确保你已经安装了 goctl 工具。如果没有,可以通过以下命令安装:

  1. go install github.com/zeromicro/go-zero/tools/goctl@latest

然后在项目根目录下执行以下命令生成代码:

  1. goctl api go -api api/your_service.api -dir .

这将会在你的项目中生成相应的目录结构和文件,包括:

  • /internal/handler/user_handler.go
  • /internal/svc/service_context.go
  • /your_service.pb.go

3. 实现业务逻辑

打开 internal/handler/user_handler.go,并实现业务逻辑:

  1. package handler
  2. import (
  3. "net/http"
  4. "your_project/internal/svc"
  5. "your_project/your_service"
  6. "github.com/zeromicro/go-zero/core/logx"
  7. "github.com/zeromicro/go-zero/rest/httpx"
  8. )
  9. type GetUserHandler struct {
  10. logx.Logger
  11. ctx context.Context
  12. svcCtx *svc.ServiceContext
  13. }
  14. func NewGetUserHandler(ctx context.Context, svcCtx *svc.ServiceContext) http.HandlerFunc {
  15. return func(w http.ResponseWriter, r *http.Request) {
  16. var req your_service.GetUserRequest
  17. if err := httpx.Parse(r, &req); err != nil {
  18. httpx.Error(w, err)
  19. return
  20. }
  21. userResp, err := svcCtx.RpcClient.GetUser(r.Context(), &req)
  22. if err != nil {
  23. httpx.Error(w, err)
  24. return
  25. }
  26. httpx.OkJson(w, userResp)
  27. }
  28. }

这里我们调用了 RPC 客户端的方法来获取用户数据。

4. 启动服务(使用 HTTPS)

为了支持 HTTPS,你需要准备 SSL/TLS 证书。假设你有一个证书和私钥,文件名分别为 server.crtserver.key

main.go 中,你需要设置服务器以支持 HTTPS:

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "your_project/internal/config"
  6. "your_project/internal/handler"
  7. "your_project/internal/svc"
  8. "github.com/zeromicro/go-zero/rest"
  9. )
  10. func main() {
  11. c := config.Config{} // 假设你已经配置好读取配置信息的方式
  12. svcCtx := svc.NewServiceContext(c)
  13. r := rest.NewServer(c.RestServerConf)
  14. r.AddRoute(rest.Route{
  15. Method: http.MethodGet,
  16. Path: "/user",
  17. Handler: handler.NewGetUserHandler(context.Background(), svcCtx),
  18. // 注册更多需要处理的路由...
  19. })
  20. go func() {
  21. if err := r.StartTLS("server.crt", "server.key"); err != nil { // 使用 StartTLS 启动HTTPS服务器
  22. fmt.Println("Failed to start REST server:", err)
  23. return
  24. }
  25. fmt.Println("REST server started at https://" + c.Host + ":" + c.Port)
  26. }()
  27. rpcServer := zrpc.MustNewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
  28. your_service.RegisterYourServiceServer(grpcServer, handler.NewYourServiceHandler(context.Background(), svcCtx))
  29. // 注册其他RPC服务...
  30. })
  31. defer rpcServer.Stop()
  32. fmt.Printf("Starting RPC server at %s:%d...\n", c.Host, c.Port)
  33. rpcServer.Start()
  34. }

总结

以上就是如何在 Go-zero 框架中设计从 HTTPS 到 RPC 的API服务。通过适当配置和实施,可以轻松地实现安全的数据交换,同时保持高效的后端逻辑。根据具体需求,你可能还需要添加更多功能,比如认证、授权、日志记录等。希望这个示例对你有所帮助!


内容由零声教学AI助手提供,问题来源于学员提问

本站部分文章来源于网络,版权归原作者所有,如有侵权请联系站长删除。
转载请注明出处:https://golang.0voice.com/?id=22325

分享:
扫描分享到社交APP
上一篇
下一篇
发表列表
游客 游客
此处应有掌声~
评论列表

还没有评论,快来说点什么吧~

联系我们

在线咨询: 点击这里给我发消息

微信号:3007537140

上班时间: 10:30-22:30

关注我们
x

注册

已经有帐号?