scalapb-json / scalapb-circe Goto Github PK

View Code? Open in Web Editor NEW

40.0 4.0 11.0 422 KB

Json/Protobuf convertors for ScalaPB use circe

License: MIT License

Scala 100.00%

scalapb protobuf json scala scala-js circe

scalapb-circe's Introduction

scalapb-circe

The structure of this project is hugely inspired by scalapb-json4s

Dependency

Include in your build.sbt file

core

libraryDependencies += "io.github.scalapb-json" %% "scalapb-circe" % "0.15.1"

for scala-js or scala-native

libraryDependencies += "io.github.scalapb-json" %%% "scalapb-circe" % "0.15.1"

macros

libraryDependencies += "io.github.scalapb-json" %% "scalapb-circe-macros" % "0.15.1"

Usage

JsonFormat

There are four functions you can use directly to serialize/deserialize your messages:

JsonFormat.toJsonString(msg) // returns String
JsonFormat.toJson(msg) // returns Json

JsonFormat.fromJsonString(str) // return MessageType
JsonFormat.fromJson(json) // return MessageType

Implicit Circe Codecs

You can also import codecs to support Circe's implicit syntax for objects of type GeneratedMessage and GeneratedEnum.

Assume a proto message:

message Guitar {
  int32 number_of_strings = 1;
}

import io.circe.syntax._
import io.circe.parser._
import scalapb_circe.codec._

Guitar(42).asJson.noSpaces // returns {"numberOfStrings":42}

decode[Guitar]("""{"numberOfStrings": 42}""") // returns Right(Guitar(42))
Json.obj("numberOfStrings" -> Json.fromInt(42)).as[Guitar] // returns Right(Guitar(42))

You can define an implicit scalapb_circe.Printer and/or scalapb_circe.Parser to control printing and parsing settings. For example, to include default values in Json:

import io.circe.syntax._
import io.circe.parser._
import scalapb_circe.codec._
import scalapb_circe.Printer

implicit val p: Printer = new Printer(includingDefaultValueFields = true)

Guitar(0).asJson.noSpaces // returns {"numberOfStrings": 0}

Finally, you can include scalapb GeneratedMessage and GeneratedEnums in regular case classes with semi-auto derivation:

import io.circe.generic.semiauto._
import io.circe.syntax._
import io.circe._
import scalapb_circe.codec._ // IntelliJ might say this is unused.

case class Band(guitars: Seq[Guitar])
object Band {
  implicit val dec: Decoder[Band] = deriveDecoder[Band]
  implicit val enc: Encoder[Band] = deriveEncoder[Band]
}
Band(Seq(Guitar(42))).asJson.noSpaces // returns {"guitars":[{"numberOfStrings":42}]}

Credits

scalapb-circe's People

Contributors

Stargazers

Watchers

Forkers

ngbinh xuwei-k leetoo showmant sideeffffect yoeluk scala-steward-bot alexklibisz jkobejs ghostdogpr kostadinalmishev

scalapb-circe's Issues

Allow for supplying custom encoders to ScalaPB ones

For example, the API I'm using requires me to send Map[String, A] as {"key": $string, "value": $a} and not {$string: $a}. I've created a custom Map[String, A: Encoder] to do this but it isn't picked up by scalapb-circe.

Deserializing Array field throws exceptions

message EcpmA {
  required string dummy = 1;
}
message EcpmR {
    required string meta = 1;
    repeated EcpmRequestAdvertiserMessage checks = 2 [(scalapb.field).collection_type="Array"];
}

    import scalapb_circe.json._
    val er = EcpmR(meta, Array(EcpmA("something")))
    println(s"${er.asJson}")

scalapb version=0.10.0
scalapb_circe version = 0.7.1

Exception

[E] Exception in thread "main" scalapb_json.JsonFormatException: [Lcom.chartboost.adrel.models.messages.InterfaceMessages.EcpmRequestAdvertiserMessage;@4218d6a3
[E]     at scalapb_circe.Printer.serializeMessageField(JsonFormat.scala:117)
[E]     at scalapb_circe.Printer.$anonfun$toJson$1(JsonFormat.scala:159)
[E]     at scala.collection.Iterator.foreach(Iterator.scala:943)
[E]     at scala.collection.Iterator.foreach$(Iterator.scala:943)
[E]     at scala.collection.AbstractIterator.foreach(Iterator.scala:1431)
[E]     at scala.collection.IterableLike.foreach(IterableLike.scala:74)
[E]     at scala.collection.IterableLike.foreach$(IterableLike.scala:73)
[E]     at scala.collection.AbstractIterable.foreach(Iterable.scala:56)
[E]     at scalapb_circe.Printer.toJson(JsonFormat.scala:156)
[E]     at scalapb_circe.JsonFormat$.$anonfun$protoToEncoder$1(JsonFormat.scala:460)
[E]     at io.circe.Encoder$$anon$3.apply(Encoder.scala:127)
[E]     at io.circe.syntax.package$EncoderOps$.asJson$extension(package.scala:10)
[E]     at com.chartboost.adrel.serving.Main$.main(Main.scala:1020)
[E]     at com.chartboost.adrel.serving.Main.main(Main.scala)

Implicit encoder/decoder pairs for GeneratedMessage that call the macros

This would allow for myPbMessage.asJson and myJson.as[PbMessage].

Accept both JSON name and original field name when deserializing json to proto message

scalapb-json4s parser accepts both JSON name and original field name when deserializing JSON to proto message.
scalapb-circe doesn't have support for that, you can by using preservingProtoFieldNames flag pick if you want to parse using original field or JSON name, but you cannot do both.

scalapb-json4s introduced a change in this commit scalapb/scalapb-json4s@9d81da5