protobuf编译.proto文件到.java

本文详细介绍了如何使用Protobuf工具编译.proto文件,并在Java中生成RPC服务。从下载protoc工具到准备.proto文件,再到编译过程及Java使用示例,全面覆盖了从零开始构建RPC服务的步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一。下载protoc.exe工具

http://central.maven.org/maven2/com/google/protobuf/protoc/3.5.1/protoc-3.5.1-windows-x86_64.exe 

二。准备.proto文件

如:CubeVisit.proto

syntax = "proto2";
option java_package = "org.apache.kylin.storage.hbase.cube.v2.coprocessor.endpoint.generated";

option java_outer_classname = "CubeVisitProtos1";

option java_generic_services = true;

option java_generate_equals_and_hash = true;

option optimize_for = SPEED;

message CubeVisitRequest {
    required bytes gtScanRequest = 1;
    required bytes hbaseRawScan = 2;
    required int32 rowkeyPreambleSize = 3;
    repeated IntList hbaseColumnsToGT = 4;
    required string kylinProperties = 5; // kylin properties
    optional string queryId = 6;
    optional bool spillEnabled = 7 [default = true];
    optional int64 maxScanBytes = 8; // must be positive
    optional bool isExactAggregate = 9 [default = false];
    message IntList {
        repeated int32 ints = 1;
    }
}

message CubeVisitResponse {
    message Stats {
        optional int64 serviceStartTime = 1;
        optional int64 serviceEndTime = 2;
        optional int64 scannedRowCount = 3;
        optional int64 aggregatedRowCount = 4;
        optional double systemCpuLoad = 5;
        optional double freePhysicalMemorySize = 6;
        optional double freeSwapSpaceSize = 7;
        optional string hostname = 8;
        optional string etcMsg = 9;
        optional int32 normalComplete =10;
        optional int64 scannedBytes = 11;
        optional int64 filteredRowCount = 12;
    }
    enum ErrorType {
        UNKNOWN_TYPE = 0;
        TIMEOUT = 1;
        RESOURCE_LIMIT_EXCEEDED = 2;
    }
    message ErrorInfo {
        required ErrorType type = 1;
        required string message = 2;
    }
    required bytes compressedRows = 1;
    required Stats stats = 2;
    optional ErrorInfo errorInfo = 3; // should be set when stats.normalComplete == false
}

service CubeVisitService {
    rpc visitCube (CubeVisitRequest) returns (CubeVisitResponse);
}

三。编译

示例:D:>protoc-3.5.1-windows-x86_64.exe --proto_path F:\ideaproject\kylin-kylin-2.6.0\storage-hbase\src\main\java\org\apache\kylin\storage\hbase\cube\v2\coprocessor\endpoint\protobuf --java_out ./ CubeVisit1.proto

  • protoc,编译命令;
  • --proto_path,就是你的proto文件所在目录是哪。我这里是F:\ideaproject\kylin-kylin-2.6.0\storage-hbase\src\main\java\org\apache\kylin\storage\hbase\cube\v2\coprocessor\endpoint\protobuf。
  • --java_out,标识输出的java文件应该放在哪个目录。这里的 ./ 是指当前目录。
  • protoDemo.proto,就是我们要编译的文件

注意:生成的RPC service的类CubeVisitService是在CubeVisitProtos1里面的,它是一个抽象类,你要使用的话需要继承并实现它的方法。

四。java使用

<dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.6.0</version>
        </dependency>
### 配置 IntelliJ IDEA 编译 .proto 文件生成 Java 类 为了使 IntelliJ IDEA 正确编译 `.proto` 文件并生成相应的 Java 类,需按照如下指南操作: #### 安装 Protobuf 插件 确保安装了 Protocol Buffer 支持插件。对于较新的 Idea 版本(如 2024.2.3),此插件可能已预加载;而对于旧版,则需要手动通过 `File -> Settings -> Plugins` 来查找并安装 “Protocol Buffer Support” 或者其他兼容的 protobuf 插件[^3]。 #### 修改 IntelliSense 参数设置 有时由于文件大小限制,默认情况下 IDE 可能无法识别较大的自动生成文件。可以通过修改配置来提高这一上限值,在菜单栏选择 `Help->Edit Custom VM Options...`, 添加以下选项: ``` idea.max.intellisense.filesize=10000 ``` 之后保存更改并重启 IDE[^2]。 #### 使用 Maven 构建工具处理 Proto 文件 当项目依赖于 Maven 进行构建管理时,应该利用其生命周期阶段完成 protojava 的转换工作。这通常涉及到引入特定的 maven-plugin 并适当配置 pom.xml 文件中的 `<build>` 和 `<plugins>` 节点,从而实现自动化地从源码树下的 *.proto* 文件创建对应的 Java 实体类。 ```xml <plugin> <groupId>com.github.os72</groupId> <artifactId>protoc-jar-maven-plugin</artifactId> <version>${protobuf.version}</version> <executions> <execution> <phase>generate-sources</phase> <goals><goal>run</goal></goals> </execution> </executions> </plugin> ``` 上述 XML 片段展示了如何定义一个执行目标用于触发 protoc 工具运行,并将其绑定到 generate-sources 生命周期阶段上。这样每次 clean install 命令都会自动调用该过程。 #### 检查编译状态 如果仍然遇到问题,确认是否成功完成了 protoc 文件的实际编译流程。未正确编译可能是导致找不到生成 classes 的根本原因所在[^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值