如何使用Java及其库将.proto文件转换为JSON Schema？

1. 编译.proto文件，拿到可用的FileDescriptor #

你得先把.proto编译成Java类，才能获取到有效的FileDescriptor：

• Maven/Gradle自动编译：用org.xolstice.maven.plugins:protobuf-maven-plugin（Maven）或com.google.protobuf:protobuf-gradle-plugin（Gradle），配置好proto文件所在目录和编译输出路径。执行编译命令后，生成的Java类（比如YourProto.java）里会有getDescriptor()静态方法，调用它就能拿到该.proto对应的FileDescriptor。
• 手动编译：用protoc命令，指定--java_out=输出目录参数生成Java类，同样能得到带FileDescriptor的类。
• 注意：如果.proto依赖其他proto文件，要确保这些依赖也被正确编译并引入到项目中，不然会出现FileDescriptor加载失败的问题。

2. 引入转换用的Java依赖 #

选一个能解析FileDescriptor并生成JSON Schema的库，下面是两个常用选项：

选项1：Confluent Protobuf JSON Schema库 #

依赖配置（版本要和你的protobuf-java版本匹配，比如protobuf-java用3.21.x的话，选7.x系列的Confluent库）：

<dependency>
    <groupId>io.confluent</groupId>
    <artifactId>protobuf-json-schema</artifactId>
    <version>7.4.0</version>
</dependency>

选项2：Protostuff JSON Schema库 #

<dependency>
    <groupId>io.protostuff</groupId>
    <artifactId>protostuff-json-schema</artifactId>
    <version>1.8.1</version>
</dependency>

3. 编写转换代码 #

用Confluent库的示例 #

import io.confluent.protobuf.json.SchemaGenerator;
import com.google.protobuf.Descriptors.FileDescriptor;
import your.package.YourProto; // 替换成你编译后的Proto类路径

public class ProtoToJsonSchema {
    public static void main(String[] args) {
        // 获取当前.proto的FileDescriptor
        FileDescriptor fileDescriptor = YourProto.getDescriptor();
        
        // 生成JSON Schema
        SchemaGenerator generator = new SchemaGenerator();
        String jsonSchema = generator.generateSchema(fileDescriptor);
        
        // 输出或保存Schema
        System.out.println(jsonSchema);
    }
}

用Protostuff库的示例（针对单个消息类型） #

import io.protostuff.json.schema.JsonSchemaGenerator;
import com.google.protobuf.Descriptors.FileDescriptor;
import com.google.protobuf.Descriptors.Descriptor;
import your.package.YourProto;

public class ProtoToJsonSchema {
    public static void main(String[] args) {
        FileDescriptor fileDescriptor = YourProto.getDescriptor();
        // 找到你要生成Schema的消息类型（替换成你.proto里的消息名）
        Descriptor messageDescriptor = fileDescriptor.findMessageTypeByName("UserInfo");
        
        JsonSchemaGenerator generator = new JsonSchemaGenerator();
        String jsonSchema = generator.generate(messageDescriptor);
        
        System.out.println(jsonSchema);
    }
}

4. 处理复杂场景（按需调整） #

如果你的.proto里有嵌套消息、枚举、oneof、自定义选项等：

• 优先选对这些特性支持完善的库，比如Confluent库对oneof、枚举的转换逻辑比较贴合JSON Schema规范。
• 自定义选项可能需要你手动补充Schema约束，或者查看库的文档是否提供了扩展配置。

常见坑点排查 #

• FileDescriptor获取失败：检查.proto语法是否正确，编译后的Java类是否在项目类路径中，依赖的其他.proto是否已编译并引入。
• Schema生成不符合预期：查看库的官方文档，调整生成器的配置（比如是否包含字段注释、是否忽略默认值等）。

内容的提问来源于stack exchange，提问作者Kamesh