Skip to content

Make JSON serialization opt-in via generateJson flag #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merlimat merged 1 commit into from
May 9, 2026
Merged

Make JSON serialization opt-in via generateJson flag #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions code-generator/src/main/java/io/streamnative/lightproto/generator/LightProto.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,19 @@ public class LightProto {

public LightProto(ProtoFileDescriptor proto, String protoFileName,
String outerClassName, boolean useOuterClass) {
this(proto, protoFileName, outerClassName, useOuterClass, false);
this(proto, protoFileName, outerClassName, useOuterClass, false, false);
}

public LightProto(ProtoFileDescriptor proto, String protoFileName,
String outerClassName, boolean useOuterClass,
boolean generateTextFormat) {
this(proto, protoFileName, outerClassName, useOuterClass, generateTextFormat, false);
}

public LightProto(ProtoFileDescriptor proto, String protoFileName,
String outerClassName, boolean useOuterClass,
boolean generateTextFormat,
boolean generateJson) {
this.proto = proto;
this.protoFileName = protoFileName;
this.outerClassName = outerClassName;
Expand All @@ -59,7 +66,7 @@ public LightProto(ProtoFileDescriptor proto, String protoFileName,
" */%n",
LightProtoGenerator.getVersion(), protoFileName);
this.enums = proto.getEnumGroups().stream().map(LightProtoEnum::new).collect(Collectors.toList());
this.messages = proto.getMessages().stream().map(m -> new LightProtoMessage(m, useOuterClass, generateTextFormat)).collect(Collectors.toList());
this.messages = proto.getMessages().stream().map(m -> new LightProtoMessage(m, useOuterClass, generateTextFormat, generateJson)).collect(Collectors.toList());
this.services = proto.getServices().stream().map(LightProtoService::new).collect(Collectors.toList());
}

Expand Down
12 changes: 10 additions & 2 deletions code-generator/src/main/java/io/streamnative/lightproto/generator/LightProtoGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,21 @@ static String getVersion() {
public static List<File> generate(List<ProtoFileDescriptor> descriptors, File outputDirectory,
String classPrefix, boolean useOuterClass,
List<String> fileNames) throws Exception {
return generate(descriptors, outputDirectory, classPrefix, useOuterClass, fileNames, false);
return generate(descriptors, outputDirectory, classPrefix, useOuterClass, fileNames, false, false);
}

public static List<File> generate(List<ProtoFileDescriptor> descriptors, File outputDirectory,
String classPrefix, boolean useOuterClass,
List<String> fileNames,
boolean generateTextFormat) throws Exception {
return generate(descriptors, outputDirectory, classPrefix, useOuterClass, fileNames, generateTextFormat, false);
}

public static List<File> generate(List<ProtoFileDescriptor> descriptors, File outputDirectory,
String classPrefix, boolean useOuterClass,
List<String> fileNames,
boolean generateTextFormat,
boolean generateJson) throws Exception {
List<File> generatedFiles = new ArrayList<>();
Set<String> javaPackages = new HashSet<>();

Expand All @@ -74,7 +82,7 @@ public static List<File> generate(List<ProtoFileDescriptor> descriptors, File ou
String javaDir = Joiner.on('/').join(javaPackageName.split("\\."));
Path targetDir = Paths.get(String.format("%s/%s", outputDirectory, javaDir));

LightProto lightProto = new LightProto(proto, fileName, outerClassName, useOuterClass, generateTextFormat);
LightProto lightProto = new LightProto(proto, fileName, outerClassName, useOuterClass, generateTextFormat, generateJson);
generatedFiles.addAll(lightProto.generate(targetDir.toFile()));

javaPackages.add(javaPackageName);
Expand Down
33 changes: 25 additions & 8 deletions code-generator/src/main/java/io/streamnative/lightproto/generator/LightProtoMessage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,29 @@ public class LightProtoMessage {
private final ProtoMessageDescriptor message;
private final boolean isNested;
private final boolean generateTextFormat;
private final boolean generateJson;
private final List<LightProtoEnum> enums;
private final List<LightProtoField> fields;
private final List<LightProtoMessage> nestedMessages;
private final List<ProtoOneofDescriptor> oneofs;
private final Map<Integer, List<LightProtoField>> oneofFields;

public LightProtoMessage(ProtoMessageDescriptor message, boolean isNested) {
this(message, isNested, false);
this(message, isNested, false, false);
}

public LightProtoMessage(ProtoMessageDescriptor message, boolean isNested, boolean generateTextFormat) {
this(message, isNested, generateTextFormat, false);
}

public LightProtoMessage(ProtoMessageDescriptor message, boolean isNested,
boolean generateTextFormat, boolean generateJson) {
this.message = message;
this.isNested = isNested;
this.generateTextFormat = generateTextFormat;
this.generateJson = generateJson;
this.enums = message.getNestedEnumGroups().stream().map(LightProtoEnum::new).collect(Collectors.toList());
this.nestedMessages = message.getNestedMessages().stream().map(m -> new LightProtoMessage(m, true, generateTextFormat)).collect(Collectors.toList());
this.nestedMessages = message.getNestedMessages().stream().map(m -> new LightProtoMessage(m, true, generateTextFormat, generateJson)).collect(Collectors.toList());
this.oneofs = message.getOneofs();

this.fields = new ArrayList<>();
Expand Down Expand Up @@ -83,13 +90,17 @@ public void generate(PrintWriter w) {
generateOneofFields(w);
generateSerialize(w);
generateGetSerializedSize(w);
generateWriteJsonTo(w);
if (generateJson) {
generateWriteJsonTo(w);
}
generateParseFrom(w);
generateCheckRequiredFields(w);
generateClear(w);
generateCopyFrom(w);

generateParseFromJson(w);
if (generateJson) {
generateParseFromJson(w);
}
if (generateTextFormat) {
generateWriteTextFormatTo(w);
generateParseFromTextFormat(w);
Expand Down Expand Up @@ -281,7 +292,7 @@ private void generateWriteJsonTo(PrintWriter w) {
w.println(" * the protobuf JSON encoding (lowerCamelCase field names).");
w.println(" * @return the number of bytes written");
w.println(" */");
w.format(" @Override public int writeJsonTo(io.netty.buffer.ByteBuf _b) {\n");
w.format(" public int writeJsonTo(io.netty.buffer.ByteBuf _b) {\n");
w.format(" int _wIdx = _b.writerIndex();\n");
w.format(" _b.writeByte('{');\n");
w.format(" boolean _first = true;\n");
Expand Down Expand Up @@ -317,20 +328,26 @@ private void generateWriteJsonTo(PrintWriter w) {
// Convenience method: toJson()
w.println(" /** Serialize this message to a JSON string. */");
w.println(" public String toJson() {");
w.println(" return LightProtoCodec.toJson(this);");
w.println(" io.netty.buffer.ByteBuf _b = io.netty.buffer.Unpooled.buffer(256);");
w.println(" try {");
w.println(" writeJsonTo(_b);");
w.println(" return _b.toString(java.nio.charset.StandardCharsets.UTF_8);");
w.println(" } finally {");
w.println(" _b.release();");
w.println(" }");
w.println(" }");
}

private void generateParseFromJson(PrintWriter w) {
// Public API: parseFromJson(byte[])
w.println(" /** Deserialize this message from a JSON byte array. */");
w.println(" @Override public void parseFromJson(byte[] _a) {");
w.println(" public void parseFromJson(byte[] _a) {");
w.println(" parseFromJson(io.netty.buffer.Unpooled.wrappedBuffer(_a));");
w.println(" }");

// Public API: parseFromJson(ByteBuf)
w.println(" /** Deserialize this message from a JSON-encoded ByteBuf. */");
w.println(" @Override public void parseFromJson(io.netty.buffer.ByteBuf _b) {");
w.println(" public void parseFromJson(io.netty.buffer.ByteBuf _b) {");
w.println(" clear();");
w.println(" _parseJsonObject(new LightProtoCodec.JsonReader(_b));");
w.println(" }");
Expand Down
17 changes: 0 additions & 17 deletions code-generator/src/main/resources/io/streamnative/lightproto/generator/LightProtoCodec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,28 +576,11 @@ static void skipUnknownField(int tag, ByteBuf buffer) {
interface LightProtoMessage {
int getSerializedSize();
int writeTo(ByteBuf b);
int writeJsonTo(ByteBuf b);
void parseFrom(ByteBuf buffer, int size);
void parseFrom(byte[] a);
void parseFromJson(byte[] a);
void parseFromJson(ByteBuf b);
void materialize();
}

static void parseFromJson(LightProtoMessage msg, String json) {
msg.parseFromJson(json.getBytes(java.nio.charset.StandardCharsets.UTF_8));
}

static String toJson(LightProtoMessage msg) {
ByteBuf buf = io.netty.buffer.Unpooled.buffer(256);
try {
msg.writeJsonTo(buf);
return buf.toString(java.nio.charset.StandardCharsets.UTF_8);
} finally {
buf.release();
}
}

static final class StringHolder {
String s;
int idx;
Expand Down
6 changes: 5 additions & 1 deletion gradle-plugin/src/main/java/io/streamnative/lightproto/gradle/GenerateLightProtoTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ public abstract class GenerateLightProtoTask extends DefaultTask {
@Input
public abstract Property<Boolean> getGenerateTextFormat();

@Input
public abstract Property<Boolean> getGenerateJson();

@Input
public abstract Property<String> getProtocVersion();

Expand Down Expand Up @@ -147,7 +150,8 @@ public void generate() {
}

LightProtoGenerator.generate(descriptors, outputDir, getClassPrefix().get(),
getSingleOuterClass().get(), fileNames, getGenerateTextFormat().get());
getSingleOuterClass().get(), fileNames, getGenerateTextFormat().get(),
getGenerateJson().get());
} catch (GradleException e) {
throw e;
} catch (Exception e) {
Expand Down
2 changes: 2 additions & 0 deletions gradle-plugin/src/main/java/io/streamnative/lightproto/gradle/LightProtoExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ public abstract class LightProtoExtension {

public abstract Property<Boolean> getGenerateTextFormat();

public abstract Property<Boolean> getGenerateJson();

public abstract Property<String> getProtocVersion();

public abstract Property<String> getProtocPath();
Expand Down
2 changes: 2 additions & 0 deletions gradle-plugin/src/main/java/io/streamnative/lightproto/gradle/LightProtoPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public void apply(Project project) {
extension.getClassPrefix().convention("");
extension.getSingleOuterClass().convention(false);
extension.getGenerateTextFormat().convention(false);
extension.getGenerateJson().convention(false);
extension.getProtocVersion().convention("4.34.0");

registerTaskForSourceSet(project, extension, "main");
Expand All @@ -53,6 +54,7 @@ private void registerTaskForSourceSet(Project project, LightProtoExtension exten
task.getClassPrefix().set(extension.getClassPrefix());
task.getSingleOuterClass().set(extension.getSingleOuterClass());
task.getGenerateTextFormat().set(extension.getGenerateTextFormat());
task.getGenerateJson().set(extension.getGenerateJson());
task.getProtocVersion().set(extension.getProtocVersion());
task.getProtocPath().set(extension.getProtocPath());
task.getExtraProtoPaths().from(extension.getExtraProtoPaths());
Expand Down
5 changes: 4 additions & 1 deletion maven-plugin/src/main/java/io/streamnative/lightproto/maven/plugin/LightProtoMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ public class LightProtoMojo extends AbstractMojo {
@Parameter(property = "generateTextFormat", defaultValue = "false", required = false)
private boolean generateTextFormat;

@Parameter(property = "generateJson", defaultValue = "false", required = false)
private boolean generateJson;

@Parameter(property = "sources", required = false)
private List<File> sources;

Expand Down Expand Up @@ -162,7 +165,7 @@ private void generate(File protoDir, List<File> protoFiles, File outputDirectory
}
}

LightProtoGenerator.generate(descriptors, outputDirectory, classPrefix, singleOuterClass, fileNames, generateTextFormat);
LightProtoGenerator.generate(descriptors, outputDirectory, classPrefix, singleOuterClass, fileNames, generateTextFormat, generateJson);
} catch (MojoExecutionException e) {
throw e;
} catch (Exception e) {
Expand Down
1 change: 1 addition & 0 deletions tests/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
<version>${project.version}</version>
<configuration>
<generateTextFormat>true</generateTextFormat>
<generateJson>true</generateJson>
</configuration>
<executions>
<execution>
Expand Down
Loading