![\"\"](\"https:\/\/www.codemotion.com\/magazine\/wp-content\/uploads\/2023\/02\/Banner_NL_WF_23_Lite-1.png\")
<\/a><\/figure>\n\n\n\nThe ABC of message modeling<\/strong><\/h2>\n\n\n\nMessaging works at a number of levels in software and network systems. Message modeling is a series of techniques used to ensure consistency and effectiveness in these communications.<\/p>\n\n\n\n
Server\/Application Communication<\/strong><\/h3>\n\n\n\nIn the era of the public Internet, we’re all very familiar with the effects of digital messaging. But it is most effective when its end-users have no awareness of how it takes place, nor of any latency or failures. Message protocols like HTTP and SMTP have long formed the bedrock of Internet communications<\/strong>. However, they are now joined by many more (and more secure) protocols for network operations as well as a much more intricate and subtle range of messaging systems that work across as well as within application architectures.<\/p>\n\n\n\nStandards<\/strong><\/h3>\n\n\n\nStandards are key to any messaging system. Communication cannot take place unless there is an understood message format that both sender and receiver can interpret in order to produce or process messages. Commonly used message formats include:<\/p>\n\n\n\n
\n- CSV<\/li>\n\n\n\n
- XML<\/li>\n\n\n\n
- JSON<\/li>\n\n\n\n
- Other custom or binary data<\/li>\n<\/ul>\n\n\n\n
Some message formats are self-defining, meaning the message can be parsed without reference to a predefined model. This generally means that the message includes its own metadata along with the data<\/strong>. XML messages typically work in this way, by encoding properties in an intrinsically readable (and often human-readable) structure. JSON similarly can encode its attribute labels, meaning that such formats are extremely flexible for serialising all manner of digital objects.<\/p>\n\n\n\n![\"Java](\"https:\/\/www.codemotion.com\/magazine\/wp-content\/uploads\/2023\/01\/iStock-1335247101-1024x550.jpg\")
With object-oriented languages such as Java<\/a>, message modeling is key for communication within applications as well as across networks and distributed systems<\/figcaption><\/figure>\n\n\n\nJSON libraries to communicate with Java<\/strong><\/h3>\n\n\n\nJSON (JavaScript Object Notation) is used to store and transmit data as a series of attribute-value arrays. It is a lightweight, open standard format, based on plain text rather than binary data, meaning it is typically human as well as machine-readable. JSON was originally derived from JavaScript (hence the name), but it is now language-independent<\/strong>. The JSON standard<\/a> is now well-established and widely used to serialise objects in object-oriented languages like Java.<\/p>\n\n\n\nThe Java language was originally devised with platform independence and networking in mind. That means effective messaging is key to its success. It’s no surprise then that Java supports a number of different JSON libraries. A typical setup could use:<\/p>\n\n\n\n
\n- Spring<\/strong>: Spring<\/a> is a Java application framework leveraging the Inversion of Control (IoC) pattern. IoC is used extensively and depends on the effective dispatch of events and messages, where RabbitMQ makes an ideal partner.<\/li>\n\n\n\n
- RabbitMQ<\/strong>: RabbitMQ<\/a> is a fast, open-source message-broker, widely used for JSON transmission. RabbitMQ originally implemented the AMQP (Advanced Message Queuing Protocol), but its plugin architecture now means it can serve a number of other protocols including HTTP and STOMP.<\/li>\n\n\n\n
- AMQP<\/strong>: Advanced Message Queuing Protocol is an application layer protocol that defines message orientation, routing, queuing, resilience and security. It is commonly used for Java applications. However, a key benefit is that, unlike some earlier protocols like JMS (Java Message Service), it is ‘wire-level’<\/a>, meaning it is not tied to any particular API or implementation.<\/li>\n<\/ul>\n\n\n\n
Implementing message modeling the easy way<\/strong><\/h2>\n\n\n\nTo gain a better understanding of message modeling, it’s worthwhile taking a look at some practical implementations.<\/p>\n\n\n\n
JSON Simple<\/strong><\/h3>\n\n\n\nJSON Simple<\/a> is a utility for serialising and deserialising JSON for Java applications. The library is very lightweight, with the declared aims being simplicity and ease of use. With the latter in mind, it’s worth pointing out some features: lenient deserialisation means that it won’t break with missing commas or colons. Plus deserialisation interruptions are reported with line numbers, making error tracing easier. Serialising data can be as simple as:<\/p>\n\n\nJSONObject myObject = new<\/span> JSONObject();\n\nmyObject.put(\"textField\"<\/span>, \"Some text\"<\/span>);\n\nmyObject.put(\"numericalField\"<\/span>, new<\/span> Integer(100<\/span>));\n\n\/\/ etc<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\nThe data can then be written to a file or stream as required for your transmission or storage systems. The JSONObject class used here is an extension of java.util.HashMap, which makes it an easy drop-in for any interfaces using that existing Java class. Similarly, JSON Simple’s JsonArray extends java.util.ArrayList facilitating similar integrations.<\/p>\n\n\n\n
JSON Simple features strong typing, meaning data integrity is better guarded. It is not dependent on any other third-party libraries and is suitable for processing any serialisable data into JSON.<\/p>\n\n\n\n
The JSON simple library provides an interface to facilitate modelling development.<\/strong><\/p>\n\n\n\nTo create a model you need to create a Java class that implements the “Jsonable” interface. This interface requires the “toJson” method to be implemented in order to serialize everything into a string in json format.<\/p>\n\n\n\n
It is advisable to create an “enum” to better define the characteristics of the keys.<\/p>\n\n\n\n
It is also possible to create getter and setter methods for fields, constructors and utility methods to facilitate use by the programmer.<\/p>\n\n\n\n
Finally, it is possible to further customize the classes by adding metadata useful for carrying out compatibility checks.<\/p>\n\n\n\n
Protobuf<\/strong><\/h3>\n\n\n\nProtobuf (or Protocol Buffers<\/a>) is a platform-neutral mechanism for serialising data. It was originally developed by Google to improve messaging within their own suite of apps and services but is now available as a free, open-source format for general use. It can be used in any situations where XML or JSON may previously have been leveraged – its major claim is that it is smaller and faster than XML<\/a>. It integrates easily with Java and many other modern languages such as Python<\/a>, C++, Kotlin, Dart and Ruby.<\/p>\n\n\n\nProtobuf achieves its efficiencies by the use of a definition language, created in .proto files. This allows structuring to be declared only once (unlike the self-defining structure of XML). From there, automatic compilation processes data structures into highly compact units for storage and transmission, which can be quickly parsed by receiving systems.<\/p>\n\n\n\n
It is worth mentioning a specific benefit of Protobuf from an implementation point of view: it is both backward and forward-compatible. That means that it works well with legacy structures – a feature not unusual for systems. More unusually however, it claims forward compatibility, meaning that, provided you follow best practices with your .proto definitions, old code will still read new messages, simply ignoring fields that are not compatible. This makes migration much easier.<\/p>\n\n\n\n
Java message modeling best practices<\/strong><\/h2>\n\n\n\nWhile JSON is a highly flexible and convenient format for effective message modeling in Java, it is still important to use it in the right way. Here we offer a few best practices to help keep your JSON usable and extensible:<\/p>\n\n\n\n
\n- Use a single entry point<\/strong>. A root node or top-level object is not required by the standard, but a single entry point makes your data easier to handle.<\/li>\n\n\n\n
- Don’t use hyphens in your keys<\/strong>. Some parsers will interpret them as operators and developers will need to escape the keys. Instead, use underscores or camel case.<\/li>\n\n\n\n
- Use native datatypes<\/strong>. Ideally, your properties should only use JSON’s native types (string, number, boolean, null, object, array).<\/li>\n\n\n\n
- Don’t assume arrays are ordered<\/strong>. The JSON specification states that arrays are ordered, but developers don’t always comply.<\/li>\n\n\n\n
- Provide a unique identifier for each object<\/strong>. Just as in databases, a unique ID is important for your entities. If they describe a web resource, you may use the URL as an ID.<\/li>\n\n\n\n
- Give users sample metadata<\/strong>. JSON is excellent for flexibility and readability, but large, nested datasets can be hard to navigate. Users will benefit from sample metadata to aid interpretation.<\/li>\n\n\n\n
- Use references for attributes<\/strong>. Use a reference to a thing (@thing) rather than a string (“thing”) to preserve the unique identification of entities.<\/li>\n\n\n\n
- Use context caching<\/strong>. If you provide a context, set cache-control headers to permit caching. This can significantly improve processing time.<\/li>\n\n\n\n
- Nest related objects<\/strong>. If related objects are given inline, they should be nested. For bi-directional relationships, the order of nesting is arbitrary.<\/li>\n<\/ol>\n\n\n\n
Conclusions<\/strong><\/h2>\n\n\n\nIn this article we’ve outlined the basics of message modeling, focusing on JSON and its use for communications between Java applications. The techniques here are of course widely extensible and we hope this has provided some useful entry points for messaging in your distributed systems and applications. If you’re interested in seeing how message modeling is used in up-to-date real-world applications, you can discover more with Zucchetti<\/a>.<\/p>\n\n\n\n![\"zucchetti,](\"https:\/\/www.codemotion.com\/magazine\/wp-content\/uploads\/2023\/02\/BANNER_FOOTER_zucchetti-gen-23-975x250-1.png\")
<\/a><\/figure>\n","protected":false},"excerpt":{"rendered":"
In the era of the public Internet, we’re all very familiar with the effects of digital messaging. But it is most effective when its end-users have no awareness of how it takes place, nor of any latency or failures. Message protocols like HTTP and SMTP have long formed the bedrock of Internet communications<\/strong>. However, they are now joined by many more (and more secure) protocols for network operations as well as a much more intricate and subtle range of messaging systems that work across as well as within application architectures.<\/p>\n\n\n\n Standards are key to any messaging system. Communication cannot take place unless there is an understood message format that both sender and receiver can interpret in order to produce or process messages. Commonly used message formats include:<\/p>\n\n\n\n Some message formats are self-defining, meaning the message can be parsed without reference to a predefined model. This generally means that the message includes its own metadata along with the data<\/strong>. XML messages typically work in this way, by encoding properties in an intrinsically readable (and often human-readable) structure. JSON similarly can encode its attribute labels, meaning that such formats are extremely flexible for serialising all manner of digital objects.<\/p>\n\n\n\n JSON (JavaScript Object Notation) is used to store and transmit data as a series of attribute-value arrays. It is a lightweight, open standard format, based on plain text rather than binary data, meaning it is typically human as well as machine-readable. JSON was originally derived from JavaScript (hence the name), but it is now language-independent<\/strong>. The JSON standard<\/a> is now well-established and widely used to serialise objects in object-oriented languages like Java.<\/p>\n\n\n\n The Java language was originally devised with platform independence and networking in mind. That means effective messaging is key to its success. It’s no surprise then that Java supports a number of different JSON libraries. A typical setup could use:<\/p>\n\n\n\n To gain a better understanding of message modeling, it’s worthwhile taking a look at some practical implementations.<\/p>\n\n\n\n JSON Simple<\/a> is a utility for serialising and deserialising JSON for Java applications. The library is very lightweight, with the declared aims being simplicity and ease of use. With the latter in mind, it’s worth pointing out some features: lenient deserialisation means that it won’t break with missing commas or colons. Plus deserialisation interruptions are reported with line numbers, making error tracing easier. Serialising data can be as simple as:<\/p>\n\n\n The data can then be written to a file or stream as required for your transmission or storage systems. The JSONObject class used here is an extension of java.util.HashMap, which makes it an easy drop-in for any interfaces using that existing Java class. Similarly, JSON Simple’s JsonArray extends java.util.ArrayList facilitating similar integrations.<\/p>\n\n\n\n JSON Simple features strong typing, meaning data integrity is better guarded. It is not dependent on any other third-party libraries and is suitable for processing any serialisable data into JSON.<\/p>\n\n\n\n The JSON simple library provides an interface to facilitate modelling development.<\/strong><\/p>\n\n\n\n To create a model you need to create a Java class that implements the “Jsonable” interface. This interface requires the “toJson” method to be implemented in order to serialize everything into a string in json format.<\/p>\n\n\n\n It is advisable to create an “enum” to better define the characteristics of the keys.<\/p>\n\n\n\n It is also possible to create getter and setter methods for fields, constructors and utility methods to facilitate use by the programmer.<\/p>\n\n\n\n Finally, it is possible to further customize the classes by adding metadata useful for carrying out compatibility checks.<\/p>\n\n\n\n Protobuf (or Protocol Buffers<\/a>) is a platform-neutral mechanism for serialising data. It was originally developed by Google to improve messaging within their own suite of apps and services but is now available as a free, open-source format for general use. It can be used in any situations where XML or JSON may previously have been leveraged – its major claim is that it is smaller and faster than XML<\/a>. It integrates easily with Java and many other modern languages such as Python<\/a>, C++, Kotlin, Dart and Ruby.<\/p>\n\n\n\n Protobuf achieves its efficiencies by the use of a definition language, created in .proto files. This allows structuring to be declared only once (unlike the self-defining structure of XML). From there, automatic compilation processes data structures into highly compact units for storage and transmission, which can be quickly parsed by receiving systems.<\/p>\n\n\n\n It is worth mentioning a specific benefit of Protobuf from an implementation point of view: it is both backward and forward-compatible. That means that it works well with legacy structures – a feature not unusual for systems. More unusually however, it claims forward compatibility, meaning that, provided you follow best practices with your .proto definitions, old code will still read new messages, simply ignoring fields that are not compatible. This makes migration much easier.<\/p>\n\n\n\n While JSON is a highly flexible and convenient format for effective message modeling in Java, it is still important to use it in the right way. Here we offer a few best practices to help keep your JSON usable and extensible:<\/p>\n\n\n\n In this article we’ve outlined the basics of message modeling, focusing on JSON and its use for communications between Java applications. The techniques here are of course widely extensible and we hope this has provided some useful entry points for messaging in your distributed systems and applications. If you’re interested in seeing how message modeling is used in up-to-date real-world applications, you can discover more with Zucchetti<\/a>.<\/p>\n\n\n\nStandards<\/strong><\/h3>\n\n\n\n
\n
JSON libraries to communicate with Java<\/strong><\/h3>\n\n\n\n
\n
Implementing message modeling the easy way<\/strong><\/h2>\n\n\n\n
JSON Simple<\/strong><\/h3>\n\n\n\n
JSONObject myObject = new<\/span> JSONObject();\n\nmyObject.put(\"textField\"<\/span>, \"Some text\"<\/span>);\n\nmyObject.put(\"numericalField\"<\/span>, new<\/span> Integer(100<\/span>));\n\n\/\/ etc<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\nProtobuf<\/strong><\/h3>\n\n\n\n
Java message modeling best practices<\/strong><\/h2>\n\n\n\n
\n
Conclusions<\/strong><\/h2>\n\n\n\n
<\/a><\/figure>\n","protected":false},"excerpt":{"rendered":"