ProtoDumper (Protobuf Code Dumper)

A simple tool to dump all protobuf classes to .proto file from a jar file or specified classes.

Features

• Dump all protobuf classes fast and accurate
• Support oneof, map and repeated keywords
• Auto formatting for dumped .proto file
• Keep package structure

original proto file:

syntax = "proto3";
import "me/mantou/common/common.proto";
package me.mantou.client;

option java_package = "me.mantou.client";
option java_outer_classname = "ClientProto";
option java_multiple_files = true;

message UserSettings{
  common.User user = 1;
  repeated string ranks = 2;
  map<string, Setting> settings = 3;

  oneof Payload{
    string s = 4;
    int32 i = 5;
    bool b = 6;
  }

  optional string desc = 7;

  message Setting{
    string value = 1;
  }
}

message ProtoFieldTypes{
  int32 i32 = 1;
  int64 i64 = 2;
  uint32 u32 = 3;
  uint64 u64 = 4;
  sint32 si32 = 5;
  sint64 si64 = 6;
  fixed32 f32 = 7;
  fixed64 f64 = 8;
  sfixed32 sf32 = 9;
  sfixed64 sf64 = 10;
  float f = 11;
  double d = 12;
  bool b = 13;
  string s = 14;
  bytes bytes = 15;
  TypeEnum e = 16;
  TypeMessage m = 17;

  enum TypeEnum{
    V1 = 0;
  }

  message TypeMessage{
  }
}

ProtoDumper dumped proto file:

syntax = "proto3";

package me.mantou.client;

import "me/mantou/common/common.proto";

option java_package = "me.mantou.client";
option java_outer_classname = "ClientProto";
option java_multiple_files = true;

message UserSettings {
  me.mantou.common.User user = 1;
  repeated string ranks = 2;
  repeated me.mantou.client.UserSettings.SettingsEntry settings = 3;
  oneof Payload {
    string s = 4;
    int32 i = 5;
    bool b = 6;
  }
  optional string desc = 7;

  message SettingsEntry {
    string key = 1;
    me.mantou.client.UserSettings.Setting value = 2;
  }

  message Setting {
    string value = 1;
  }
}

message ProtoFieldTypes {
  int32 i32 = 1;
  int64 i64 = 2;
  uint32 u32 = 3;
  uint64 u64 = 4;
  sint32 si32 = 5;
  sint64 si64 = 6;
  fixed32 f32 = 7;
  fixed64 f64 = 8;
  sfixed32 sf32 = 9;
  sfixed64 sf64 = 10;
  float f = 11;
  double d = 12;
  bool b = 13;
  string s = 14;
  bytes bytes = 15;
  me.mantou.client.ProtoFieldTypes.TypeEnum e = 16;
  me.mantou.client.ProtoFieldTypes.TypeMessage m = 17;

  message TypeMessage {
  }
  enum TypeEnum {
    V1 = 0;
  }
}

package structure:

Usage

dump a jar file:

import java.io.File

val protoDumper = ProtoDumper(File("path/to/your/file"))
protoDumper.init()
protoDumper.dumpTo(Path.of("output"))

dump specified classes:

val protoDumper = ProtoDumper()
protoDumper.init()
protoDumper.addNeedDumpClass(YourProto::class.java)
protoDumper.addNeedDumpClass("com.example.OtherProto")
protoDumper.dumpTo(Path.of("output"))

TODO

• gRpc resolver