json4s jackson - How to ignore field using annotations

Question

I`m using json4s-jackson(version 3.2.11).

I'm trying to ignore field using annotations(like jackson java version).

Here's exmaple:

case class User(id: Long, name: String, accessToken: String)

Following code is not working.

@JsonIgnoreProperties(Array("accessToken"))
case class User(id: Long, name: String, @JsonProperty("accessToken") accessToken: String)

BEWARE: Json4s is [vulnerable under DoS/DoW attacks](https://github.com/json4s/json4s/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+denial)! — Andriy Plokhotnyuk, Aug 22 '20 at 07:48

score 9 · Answer 1 · answered Mar 01 '16 at 16:13

9

In json4s you can provide an instance of a field serialiser which can be configured to ignore or rename fields. Check the docs for more detail, but something like the following should work:

case class User(id: Long, name: String, accessToken: String)

val userSerializer = FieldSerializer[User](
  FieldSerializer.ignore("accessToken")
)

implicit val formats = DefaultFormats + userSerializer

answered Mar 01 '16 at 16:13

Steven Bakhtiari

3,227
2
20
24

how to make it work for multiple fields to be ignored? – Dragonborn Oct 26 '16 at 09:42

S.Karthik · Answer 2 · 2015-03-27T11:40:45.070

1

You can write a utility method, with Keys to remove as default parameter like this,

def removeKeys(entity:AnyRef, keys: List[String]=List("accessToken", "key1", "key2")): String= {
compact(Extraction.decompose(entity).removeField { x => keys.contains(x._1)})
}

edited Mar 27 '15 at 11:40

answered Mar 27 '15 at 08:42

S.Karthik

1,389
9
21

score 0 · Answer 3 · answered Aug 18 '20 at 18:54

0

Extending Steven Bakhtari's answer: if you want to ignore multiple fields you can do this:

FieldSerializer.ignore("config") orElse ignore("category")

as explained in this https://github.com/json4s/json4s/issues/90 issue

answered Aug 18 '20 at 18:54

Jan Vermeir

47
8

json4s jackson - How to ignore field using annotations

3 Answers3