Skip to content

Latest commit

 

History

History
235 lines (163 loc) · 7.08 KB

quick_start.md

File metadata and controls

235 lines (163 loc) · 7.08 KB
Raw

English

前言

本文通过一个简单的代码示例帮助您开始了解和使用tRPC-Cpp。

开发环境搭建

在 C++ 世界中，没有普遍接受的标准来管理项目依赖项。 因此在构建和运行本文中的 Hello World 示例之前，您需要进行开发环境的安装，具体可以参考 环境搭建 这篇文章。刚开始体验tRPC-Cpp时建议使用bazel, 本节中接下来的步骤主要介绍如何使用bazel编译和运行 Hello World 示例。

编译和运行demo示例

编译框架

从github下载tRPC-Cpp框架源代码

git clone https://github.com/trpc-group/trpc-cpp

编译tRPC-Cpp框架代码

cd trpc-cpp
./build.sh

使用bazel编译第一次编译框架时会比较慢，可能需要等几分钟。bazel编译的过程信息会输出到终端，若编译成功，可以看到类似如下的信息:

INFO: Elapsed time: 279.100s, Critical Path: 48.83s
INFO: 2629 processes: 2629 processwrapper-sandbox.
INFO: Build completed successfully, 5459 total actions

若出现失败，可能是网络原因（无法拉取远程代码）、环境安装（gcc、框架依赖的库版本过低）等导致，可以参见 环境搭建faq。

编译示例代码

tRPC-Cpp框架代码编译成功后，接下来开始编译和运行 Hello World 示例。

执行如下的命令编译 Hello World 示例代码。

bazel build //examples/helloworld/...

运行示例代码

编译成功后，运行服务端程序。

./bazel-bin/examples/helloworld/helloworld_svr --config=./examples/helloworld/conf/trpc_cpp_fiber.yaml

打开另外一个终端，运行客户端测试程序。

./bazel-bin/examples/helloworld/test/fiber_client --client_config=./examples/helloworld/test/conf/trpc_cpp_fiber.yaml

客户端测试程序成功运行后，可以看到如下的输出。

FLAGS_service_name:trpc.test.helloworld.Greeter
FLAGS_client_config:./examples/helloworld/test/conf/trpc_cpp_fiber.yaml
get rsp msg: Hello, fiber

同时也可以在执行启动服务端命令的目录下（trpc-cpp目录），找到并查阅服务端的日志文件 helloworld_fiber.log。

cat helloworld_fiber.log

可以看到如下输出。

[2023-08-25 15:30:56.587] [default] [info] [greeter_service.cc:37] remote address: 127.0.0.1:46074
[2023-08-25 15:30:56.587] [default] [info] [greeter_service.cc:38] request message: fiber

到这里，恭喜您已经成功使用 tRPC-Cpp 运行了一个客户端-服务器应用程序。

更新服务实现

现在让我们看看如何为服务端添加一个新的RPC方法，并让客户端调用此方法。

当前我们tRPC-Cpp提供的服务是使用protocol buffers IDL定义来实现的，服务器和客户端存根都有一个 SayHello() RPC 方法，该方法从客户端获取 HelloRequest 并从服务端返回 HelloReply，它的定义如下：

syntax = "proto3";

package trpc.test.helloworld;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
   string msg = 1;
}

message HelloReply {
   string msg = 1;
}

打开 examples/helloworld/helloworld.proto 文件，并添加一个新的 SayHelloAgain() 方法，它和 SayHello 具有相同的请求和响应类型。

syntax = "proto3";
 
package trpc.test.helloworld;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}

  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string msg = 1;
}

message HelloReply {
  string msg = 1;
}

然后更新服务端程序

打开 examples/helloworld/greeter_service.h 文件，为 GreeterServiceImpl 添加 SayHelloAgain 方法。

class GreeterServiceImpl : public ::trpc::test::helloworld::Greeter {
 public:
  ::trpc::Status SayHello(::trpc::ServerContextPtr context,
                          const ::trpc::test::helloworld::HelloRequest* request,
                          ::trpc::test::helloworld::HelloReply* reply) override;

  ::trpc::Status SayHelloAgain(::trpc::ServerContextPtr context,
                               const ::trpc::test::helloworld::HelloRequest* request,
                               ::trpc::test::helloworld::HelloReply* reply) override;
};

打开 examples/helloworld/greeter_service.cc 文件，给 GreeterServiceImpl 添加 SayHelloAgain 方法的代码实现。

::trpc::Status GreeterServiceImpl::SayHelloAgain(::trpc::ServerContextPtr context,
                                                 const ::trpc::test::helloworld::HelloRequest* request,
                                                 ::trpc::test::helloworld::HelloReply* reply) {
  // Your can access more information from rpc context, eg: remote ip and port
  TRPC_FMT_INFO("remote address: {}:{}", context->GetIp(), context->GetPort());
  TRPC_FMT_INFO("request message: {}", request->msg());

  std::string response = "Hello, ";
  response += request->msg();
  response += " Again";

  reply->set_msg(response);

  return ::trpc::kSuccStatus;
}

更新客户端调用代码

现在存根中提供了一个新的 SayHelloAgain() 方法。 我们将参考调用 SayHello() 的代码，实现调用 SayHelloAgain() 的函数，打开 examples/helloworld/test/fiber_client.cc 文件，在 DoRpcCall 函数后面添加如下代码。

int DoRpcCallAgain(const std::shared_ptr<::trpc::test::helloworld::GreeterServiceProxy>& proxy) {
  ::trpc::ClientContextPtr client_ctx = ::trpc::MakeClientContext(proxy);
  ::trpc::test::helloworld::HelloRequest req;
  req.set_msg("fiber");
  ::trpc::test::helloworld::HelloReply rsp;
  ::trpc::Status status = proxy->SayHelloAgain(client_ctx, req, &rsp);
  if (!status.OK()) {
    std::cerr << "get again rpc error: " << status.ErrorMessage() << std::endl;
    return -1;
  }
  std::cout << "get again rsp msg: " << rsp.msg() << std::endl;
  return 0;
}

然后, 我们在 Run 函数中调用上面的 DoRpcCallAgain 函数，如下：

int Run() {
  auto proxy = ::trpc::GetTrpcClient()->GetProxy<::trpc::test::helloworld::GreeterServiceProxy>(FLAGS_service_name);

  int ret = DoRpcCall(proxy);

  ret = DoRpcCallAgain(proxy);

  return ret;
}

运行验证

编译整个示例代码

bazel build //examples/helloworld/...

再次运行服务端程序

./bazel-bin/examples/helloworld/helloworld_svr --config=./examples/helloworld/conf/trpc_cpp_fiber.yaml

打开另外一个终端，再次运行客户端测试程序。

./bazel-bin/examples/helloworld/test/fiber_client --client_config=./examples/helloworld/test/conf/trpc_cpp_fiber.yaml

将看到如下的输出

FLAGS_service_name:trpc.test.helloworld.Greeter
FLAGS_client_config:./examples/helloworld/test/conf/trpc_cpp_fiber.yaml
get rsp msg: Hello, fiber
get again rsp msg: Hello, fiber Again

下一步