Ignore None field while Encoding to json with Circe for Scala

Question

I am using scala 2.11.8 with circe 0.7.0

I am using scalajs to communicate with an API differentiating non existant field and null field in the sent JSON.

I am looking for a way of encoding to JSON a scala case class containing Option[T] fields that I would set to None to represent missing values:

case class Foo(
optionalFieldOne: Option[Int] = 42,
optionalFieldTwo: Option[Int] = null,
optionalFieldThree: Option[Int] = None
)

implicit FooEncoder: Encoder[Foo] = deriveEncoder[Foo]
val test = Foo()
//What the code actually produces
test.asJson.noSpace
//>{"optionalFieldOne": 42,"optionalFieldTwo":null, "optionalFieldThree":null}

//What I would like
test.asJson.noSpace
//>{"optionalFieldOne": 42,"optionalFieldTwo":null}

Is there any configuration possible provided by circe? Do you have any idea how to access it, I've already looked through all release notes, github issues and their website doc without success.

In the case such configuration options are not available, how would someone implement it properly?

score 2 · Answer 1 · answered Apr 06 '17 at 08:40

2

Use dropNullKeys:

@param dropNullKeys Determines if object fields with values of null are dropped from the output.

answered Apr 06 '17 at 08:40

OlivierBlanvillain

7,475
4
29
49

The issue here is that I want to keep null values and only ommit fields that are set to None. Here your solution would return `{"optionalFieldOne": 42}` . The second field is missing. I already read this solution in [link](https://github.com/circe/circe/issues/585) – amougel Apr 06 '17 at 08:45

score 1 · Answer 2 · answered Nov 19 '18 at 11:42

1

Use dropNullValues as mentioned in this link: https://github.com/circe/circe/issues/585

answered Nov 19 '18 at 11:42

Rajeev

4,222
7
33
52

score 0 · Answer 3 · answered Jun 08 '19 at 12:11

implicit class JsonWrapper(val json: Json) {
    def removeNulls(): Json = {
      val result = json match {
        case j1 if j1.isArray =>
          j1.mapArray(_.map(_.removeNulls()))

        case j2 if j2.isObject =>
          j2.mapObject(_.removeNulls())

        case v => v
     }
     result
    }
  }

implicit class JsonObjectWrapper(val json: JsonObject) {
    def removeNulls(): JsonObject = {
      json.mapValues{
        case v if v.isObject => v.removeNulls()
        case v if v.isArray  => v.mapArray(_.map(_.removeNulls()))
        case other                => other
      }.filter(!_._2.isNull)
    }
  }

Ignore None field while Encoding to json with Circe for Scala

3 Answers3