【橘子分布式】gRPC(编程篇-上)

原创

已于 2025-07-19 09:25:04 修改 · 460 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#分布式 #rpc

于 2025-07-18 10:50:41 首次发布

一、简介

我们之前学习了grpc的一些理论知识，现在我们开始正式进入编程环节。
我们的项目结构和之前的thrift结构还是一样的，一个common,一个client，一个server。只不过在grpc这里common它一般叫做api模块。还是放置一些公共的实体类，业务service类之类的。

二、项目结构

1. xxxx-api 模块 
   定义 protobuf的idl语言 
   并且通过命令创建对应的通用代码，包括实体类和service，其他模块统一引入即可。
2. xxxx-server模块
   1. 实现api模块中定义的服务接口
   2. 发布gRPC服务 (创建服务端程序，提供对外服务)
3. xxxx-clien模块
   1. 创建服务端stub(代理)
   2. 基于代理（stub) RPC调用。

1、代码编写

先创建一个rpc-grpc-api模块。

1.1、创建proto文件

我们在模块目录下创建一个proto目录来管理我们的.proto文件。
然后在该目录下创建一个hello.proto文件用来编写idl语言。

// 定义proto文件版本号
syntax = "proto3";

// 生成一个java类即可
option java_multiple_files = false;
// 生成的java类的包名
option java_package = "com.levi";
// 外部类，这里就是HelloProto,实际开发你可以有多个proto管理不同业务类，然后各自的外部类都可以。比如OrderService就是Order.proto 外部类就是OrderProto
option java_outer_classname = "HelloProto";

// 定义请求接口参数
message HelloRequest{
  string name = 1;
}

// 定义接口响应参数
message HelloResponse{
  string result = 1;
}

// 定义服务
service HelloService{
  /* 简单rpc,参数为HelloRequest类型，返回类型为HelloResponse */
  rpc hello(HelloRequest) returns (HelloResponse){}
}

然后我们就用protoc命令来翻译这个idl。

1.1、命令行生成IDL

如同之前thrift一样，我们在这里也是要先编写idl的部分。我们需要首先在.proto后缀的文件中编写protobuf的IDL。
然后使用protoc命令把proto文件中的IDL 转换成编程语言，我们之前已经安装过protobuf环境了，所以可以直接使用。
具体命令格式为

protoc  --java_out=生成的java代码路径   依赖的.proto文件
如果你要翻译为go语言，那就是protoc -go_out ......

举个例子就是:

protoc --java_out=/src/java  /src/proto/hello.proto

但是这种我们需要在终端操作，不太方便。还好idea的maven插件支持了这个能力。

1.2、maven插件支持

maven插件进行protobuf IDL文件的编译，并把他放置IDEA具体位置。这个能力的支持来自于一个grpc-java开源项目，我们看到它对于maven很方便的支持了能力，我们先创建一个模块来引入这个maven配置。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.levi</groupId>
        <artifactId>rpc</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>rpc-grpc-api</artifactId>

    <properties>
        <java.version>11</java.version>
        <grpc-netty-shaded.version>1.73.0</grpc-netty-shaded.version>
        <grpc-protobuf.version>1.73.0</grpc-protobuf.version>
        <grpc-stub.version>1.73.0</grpc-stub.version>
        <annotations-api.version>6.0.53</annotations-api.version>

        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8