akka/akka-core

Write a guide of how to use protobuf in a project

Open

#15,987 opened on Sep 29, 2014

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Description

How to write a non-trivial akka message serializer for protobuf.

Here is an example of a non-trivial protobuf serializer:

https://github.com/akka/akka/blob/master/akka-contrib/src/main/protobuf/DistributedPubSubMessages.proto

https://github.com/akka/akka/blob/master/akka-contrib/src/main/scala/akka/contrib/pattern/protobuf/DistributedPubSubMessageSerializer.scala

https://github.com/akka/akka/blob/master/akka-contrib/src/test/scala/akka/contrib/pattern/protobuf/DistributedPubSubMessageSerializerSpec.scala

https://github.com/akka/akka/blob/master/akka-contrib/src/main/resources/reference.conf#L35-L43

The generated protobuf classes: https://github.com/akka/akka/blob/master/akka-contrib/src/main/java/akka/contrib/pattern/protobuf/msg/DistributedPubSubMessages.java

Also, the sbt plugin should be mentioned: https://github.com/patriknw/akka-data-replication/blob/master/build.sbt

Contributor guide

Tech stack
scalajava
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala knowledgeAkka frameworkProtocol Bufferssbt build tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Study the linked example files: DistributedPubSubMessages.proto, DistributedPubSubMessageSerializer.scala, the test spec, and the reference.conf. Also review the sbt plugin setup in build.sbt. Use these as templates to write a comprehensive guide on implementing a protobuf serializer in an Akka project.