[proto] Support generate toString method for the proto messages

LiebingYu · LiebingYu · commit 941579c441d8 · 2025-09-08T14:54:27.000+08:00
diff --git a/fluss-common/src/main/java/org/apache/fluss/utils/ProtoCodecUtils.java b/fluss-common/src/main/java/org/apache/fluss/utils/ProtoCodecUtils.java
@@ -284,11 +284,21 @@ public static void skipUnknownField(int tag, ByteBuf buffer) {
     public static final class StringHolder {
         public String s;
         public int len;
+
+        @Override
+        public String toString() {
+            return s;
+        }
     }
 
     /** Holder for a byte array and byte length. */
     public static final class BytesHolder {
         public byte[] b;
         public int len;
+
+        @Override
+        public String toString() {
+            return "<byte[" + len + "]>";
+        }
     }
 }
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtoGenUtil.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtoGenUtil.java
@@ -30,6 +30,7 @@
 import org.apache.fluss.utils.ProtoCodecUtils;
 
 import java.io.PrintWriter;
+import java.util.Arrays;
 
 import static org.apache.fluss.shaded.guava32.com.google.common.base.CaseFormat.LOWER_CAMEL;
 import static org.apache.fluss.shaded.guava32.com.google.common.base.CaseFormat.LOWER_UNDERSCORE;
@@ -72,7 +73,9 @@ public class ProtoGenUtil {
                 WritableOutput.class,
                 // netty dependencies
                 ByteBuf.class,
-                Unpooled.class
+                Unpooled.class,
+                // util dependencies
+                Arrays.class
             };
 
     public static void printHeader(PrintWriter pw) {
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufAbstractRepeated.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufAbstractRepeated.java
@@ -44,4 +44,10 @@ public void fieldClear(PrintWriter w, String enclosingType) {
         w.format("            return this;\n");
         w.format("        }\n");
     }
+
+    @Override
+    public void stringify(PrintWriter w, String sep) {
+        w.format("                + \"%s%s=\"\n", sep, pluralName);
+        w.format("                + %s\n", pluralName);
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufBytesField.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufBytesField.java
@@ -103,4 +103,10 @@ public void serialize(PrintWriter w) {
     protected String typeTag() {
         return "ProtoCodecUtils.WIRETYPE_LENGTH_DELIMITED";
     }
+
+    @Override
+    public void stringify(PrintWriter w, String sep) {
+        w.format("                + \"%s%s=\"\n", sep, ccName);
+        w.format("                + \"<byte[\" + %s.length + \"]>\"\n", ccName);
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufField.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufField.java
@@ -171,4 +171,9 @@ protected String fieldMask() {
     protected int bitFieldIndex() {
         return index / 32;
     }
+
+    public void stringify(PrintWriter w, String sep) {
+        w.format("                + \"%s%s=\"\n", sep, ccName);
+        w.format("                + %s\n", ccName);
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufMessage.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufMessage.java
@@ -103,6 +103,7 @@ public void generate(PrintWriter w) {
         generateCheckRequiredFields(w);
         generateClear(w);
         generateCopyFrom(w);
+        generateToString(w);
 
         w.println();
         w.println("        @Override");
@@ -331,6 +332,23 @@ private void generateCheckRequiredFields(PrintWriter w) {
         w.format("}\n");
     }
 
+    private void generateToString(PrintWriter w) {
+        w.println();
+        w.format("    @Override\n");
+        w.format("    public String toString() {\n");
+        w.format("        return \"%s{\"\n", message.getName());
+
+        boolean first = true;
+        for (ProtobufField field : fields) {
+            String sep = first ? "" : ", ";
+            first = false;
+
+            field.stringify(w, sep);
+        }
+        w.format("                + '}';\n");
+        w.format("    }\n");
+    }
+
     private int bitFieldsCount() {
         if (message.getFieldCount() == 0) {
             return 0;
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufRecordsField.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufRecordsField.java
@@ -194,4 +194,12 @@ public void serialize(PrintWriter w) {
     protected String typeTag() {
         return "ProtoCodecUtils.WIRETYPE_LENGTH_DELIMITED";
     }
+
+    @Override
+    public void stringify(PrintWriter w, String sep) {
+        w.format("                + \"%s%s=\"\n", sep, ccName);
+        w.format(
+                "                + \"<%s[\" + %s.getBytesLength() + \"]>\"\n",
+                BYTES_VIEW_CLASS, ccName);
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufRepeatedNumberField.java b/fluss-protogen/fluss-protogen-generator/src/main/java/org/apache/fluss/protogen/generator/generator/ProtobufRepeatedNumberField.java
@@ -205,4 +205,10 @@ public void clear(PrintWriter w) {
     protected String typeTag() {
         return ProtobufNumberField.typeTag(field);
     }
+
+    @Override
+    public void stringify(PrintWriter w, String sep) {
+        w.format("                + \"%s%s=\"\n", sep, pluralName);
+        w.format("                + Arrays.toString(%s)\n", pluralName);
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/AddressBookTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/AddressBookTest.java
@@ -121,4 +121,19 @@ public void testAddressBook() throws Exception {
         assertThat(parsed.getPersonAt(1).getPhoneAt(0).getNumber()).isEqualTo("xxx-zzz-2222");
         assertThat(parsed.getPersonAt(1).getPhoneAt(0).getType()).isEqualTo(Person.PhoneType.HOME);
     }
+
+    @Test
+    public void testToString() {
+        AddressBook ab = new AddressBook();
+        Person p1 = ab.addPerson().setName("name 1").setEmail("name1@example.com").setId(5);
+        p1.addPhone().setNumber("xxx-zzz-1111").setType(Person.PhoneType.HOME);
+        p1.addPhone().setNumber("xxx-zzz-2222").setType(Person.PhoneType.MOBILE);
+
+        Person p2 = ab.addPerson().setName("name 2").setEmail("name2@example.com").setId(6);
+        p2.addPhone().setNumber("xxx-zzz-2222").setType(Person.PhoneType.HOME);
+
+        assertThat(ab.toString())
+                .isEqualTo(
+                        "AddressBook{persons=[Person{name=name 1, id=5, email=name1@example.com, phones=[PhoneNumber{number=xxx-zzz-1111, type=HOME}, PhoneNumber{number=xxx-zzz-2222, type=MOBILE}]}, Person{name=name 2, id=6, email=name2@example.com, phones=[PhoneNumber{number=xxx-zzz-2222, type=HOME}]}]}");
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/BytesTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/BytesTest.java
@@ -276,4 +276,22 @@ public void testRepeatedBytes() throws Exception {
         assertThat(parsed.getExtraItemAt(0)).isEqualTo(new byte[] {1, 2, 3});
         assertThat(parsed.getExtraItemAt(1)).isEqualTo(new byte[] {4, 5, 6, 7});
     }
+
+    @Test
+    public void testBytesToString() {
+        B lpb = new B();
+        lpb.setPayload(new byte[] {1, 2, 3, 4, 5});
+        lpb.addExtraItem(new byte[] {1, 2, 3});
+        lpb.addExtraItem(new byte[] {4, 5, 6, 7});
+        System.out.println(lpb.toString());
+
+        // assertThat(lpb.toString()).isEqualTo("B{payload=<byte[5]>, extraItems=null}");
+    }
+
+    @Test
+    public void testRecordsToString() {
+        RD lpb = new RD().setRecords(new byte[] {1, 2, 3, 4, 5});
+
+        assertThat(lpb.toString()).isEqualTo("RD{records=<BytesView[5]>}");
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/EnumsTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/EnumsTest.java
@@ -160,4 +160,17 @@ public void testUnknownRepeatedPackedEnum() throws Exception {
         assertThat(parsed.getEAt(1)).isEqualTo(E1.B1);
         assertThat(parsed.getEAt(2)).isEqualTo(E1.C1);
     }
+
+    @Test
+    public void testToString() {
+        EnumTest2 lpet2 = new EnumTest2().setE(E2.D2);
+        assertThat(lpet2.toString()).isEqualTo("EnumTest2{e=D2}");
+
+        EnumTest2Repeated lpet2Repeated = new EnumTest2Repeated();
+        lpet2Repeated.addE(E2.A2);
+        lpet2Repeated.addE(E2.B2);
+        lpet2Repeated.addE(E2.C2);
+        lpet2Repeated.addE(E2.D2);
+        assertThat(lpet2Repeated.toString()).isEqualTo("EnumTest2Repeated{es=[A2, B2, C2, D2]}");
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/MessagesTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/MessagesTest.java
@@ -225,4 +225,18 @@ public void testApiMessage() {
         assertThat(parsed.getX().getA()).isEqualTo("a");
         assertThat(parsed.getX().getB()).isEqualTo("b");
     }
+
+    @Test
+    public void testToString() {
+        M lpm = new M();
+
+        lpm.setX().setA("a").setB("b");
+
+        lpm.addItem().setK("k1").setV("v1");
+        lpm.addItem().setK("k2").setV("v2").setXx().setN(5);
+
+        assertThat(lpm.toString())
+                .isEqualTo(
+                        "M{x=X{a=a, b=b}, items=[KV{k=k1, v=v1, xx=null}, KV{k=k2, v=v2, xx=XX{n=5}}]}");
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/NumbersTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/NumbersTest.java
@@ -240,4 +240,29 @@ public void testNumberFields() throws Exception {
 
         verify(lpn, pbn.build());
     }
+
+    @Test
+    public void testToString() {
+        Numbers lpn = new Numbers();
+
+        lpn.setEnum1(Enum1.X1_1);
+        lpn.setEnum2(Numbers.Enum2.X2_1);
+        lpn.setXBool(true);
+        lpn.setXDouble(1.0);
+        lpn.setXFixed32(2);
+        lpn.setXFixed64(12345L);
+        lpn.setXSfixed32(-2);
+        lpn.setXSfixed64(-12345L);
+        lpn.setXFloat(1.2f);
+        lpn.setXInt32(4);
+        lpn.setXInt64(126L);
+        lpn.setXUint32(40);
+        lpn.setXUint64(1260L);
+        lpn.setXSint32(-11);
+        lpn.setXSint64(-12L);
+
+        assertThat(lpn.toString())
+                .isEqualTo(
+                        "Numbers{xInt32=4, xInt64=126, xUint32=40, xUint64=1260, xSint32=-11, xSint64=-12, xFixed32=2, xFixed64=12345, xSfixed32=-2, xSfixed64=-12345, xFloat=1.2, xDouble=1.0, xBool=true, enum1=X1_1, enum2=X2_1}");
+    }
 }
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/RepeatedNumbersTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/RepeatedNumbersTest.java
@@ -306,6 +306,8 @@ public void testNumberFields() throws Exception {
         assertThat(parsed.getXSint32At(1)).isEqualTo(-12);
         assertThat(parsed.getXSint64At(0)).isEqualTo(-12L);
         assertThat(parsed.getXSint64At(1)).isEqualTo(-13L);
+
+        System.out.println(lpn);
     }
 
     @Test
diff --git a/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/StringsTest.java b/fluss-protogen/fluss-protogen-tests/src/test/java/org/apache/fluss/protogen/tests/StringsTest.java
@@ -115,4 +115,14 @@ public void testClearStrings() throws Exception {
         assertThat(lps.getNameAt(0)).isEqualTo("d");
         assertThat(lps.getNameAt(1)).isEqualTo("e");
     }
+
+    @Test
+    public void testToString() {
+        S lps = new S();
+        lps.addName("a");
+        lps.addName("b");
+        lps.addName("c");
+
+        System.out.println(lps.toString());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -44,4 +44,10 @@ public void fieldClear(PrintWriter w, String enclosingType) {`
`44`	`44`	`w.format(" return this;\n");`
`45`	`45`	`w.format(" }\n");`
`46`	`46`	`}`
	`47`	`+`
	`48`	`+ @Override`
	`49`	`+ public void stringify(PrintWriter w, String sep) {`
	`50`	`+ w.format(" + \"%s%s=\"\n", sep, pluralName);`
	`51`	`+ w.format(" + %s\n", pluralName);`
	`52`	`+ }`
`47`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,4 +103,10 @@ public void serialize(PrintWriter w) {`
`103`	`103`	`protected String typeTag() {`
`104`	`104`	`return "ProtoCodecUtils.WIRETYPE_LENGTH_DELIMITED";`
`105`	`105`	`}`
	`106`	`+`
	`107`	`+ @Override`
	`108`	`+ public void stringify(PrintWriter w, String sep) {`
	`109`	`+ w.format(" + \"%s%s=\"\n", sep, ccName);`
	`110`	`+ w.format(" + \"<byte[\" + %s.length + \"]>\"\n", ccName);`
	`111`	`+ }`
`106`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,4 +171,9 @@ protected String fieldMask() {`
`171`	`171`	`protected int bitFieldIndex() {`
`172`	`172`	`return index / 32;`
`173`	`173`	`}`
	`174`	`+`
	`175`	`+ public void stringify(PrintWriter w, String sep) {`
	`176`	`+ w.format(" + \"%s%s=\"\n", sep, ccName);`
	`177`	`+ w.format(" + %s\n", ccName);`
	`178`	`+ }`
`174`	`179`	`}`
Original file line number	Diff line number	Diff line change
`@@ -194,4 +194,12 @@ public void serialize(PrintWriter w) {`
`194`	`194`	`protected String typeTag() {`
`195`	`195`	`return "ProtoCodecUtils.WIRETYPE_LENGTH_DELIMITED";`
`196`	`196`	`}`
	`197`	`+`
	`198`	`+ @Override`
	`199`	`+ public void stringify(PrintWriter w, String sep) {`
	`200`	`+ w.format(" + \"%s%s=\"\n", sep, ccName);`
	`201`	`+ w.format(`
	`202`	`+ " + \"<%s[\" + %s.getBytesLength() + \"]>\"\n",`
	`203`	`+ BYTES_VIEW_CLASS, ccName);`
	`204`	`+ }`
`197`	`205`	`}`
Original file line number	Diff line number	Diff line change
`@@ -205,4 +205,10 @@ public void clear(PrintWriter w) {`
`205`	`205`	`protected String typeTag() {`
`206`	`206`	`return ProtobufNumberField.typeTag(field);`
`207`	`207`	`}`
	`208`	`+`
	`209`	`+ @Override`
	`210`	`+ public void stringify(PrintWriter w, String sep) {`
	`211`	`+ w.format(" + \"%s%s=\"\n", sep, pluralName);`
	`212`	`+ w.format(" + Arrays.toString(%s)\n", pluralName);`
	`213`	`+ }`
`208`	`214`	`}`