ProtobufHttpMessageConverter: Make JSON format configurable [SPR-15550]

[spring-projects-issues]

Andreas Ahlenstorf opened SPR-15550 and commented

I would like to be able to configure/customize the JsonFormat.Printer used by ProtobufJavaUtilSupport in the ProtobufHttpMessageConverter in order to influence the format of the generated JSON. This is currently not possible and requires the reimplementation of the entire MessageConverter.

One possible solution would be to offer another constructor of ProtobufHttpMessageConverter that takes a ProtobufFormatSupport instance as single argument. ProtobufJavaUtilSupport and ProtobufJavaFormatSupport would have to be made public and ProtobufJavaUtilSupport would get an additional constructor with JsonFormat.Parser and JsonFormat.Printer as arguments. The default behaviour could remain the same.

---

Affects: 5.0 RC1

Issue Links:

• ProtobufHttpMessageConverter support for protobuf 3.0.0-beta4 [SPR-13589] #18166 ProtobufHttpMessageConverter support for protobuf 3.0.0-beta4
• ProtobufHttpMessageConverter: JSON not written to response [SPR-15988] #20538 ProtobufHttpMessageConverter: JSON not written to response

Referenced from: commits ce5e2b9

[spring-projects-issues]

Juergen Hoeller commented

I've introduced a dedicated ProtobufJsonFormatHttpMessageConverter as a subclass of ProtobufHttpMessageConverter, exposing an overloaded constructor with JsonFormat.Parser and JsonFormat.Printer arguments. This requires Protobuf 3.x and protobuf-java-util 3.x since it exposes the specific JsonFormat type from the latter.

The common ProtobufHttpMessageConverter keeps doing the best possible default job on Protobuf 2.6 or 3.x, using protobuf-java-format or protobuf-java-util if present on the classpath but also working without any format library if the standard Protobuf format is sufficient.