https://github.com/pjfanning/jackson-scala-reflect-extensions

Extension to jackson-module-scala that uses scala-reflect to get type info
https://github.com/pjfanning/jackson-scala-reflect-extensions

jackson jackson-module-scala scala

Last synced: 26 days ago
JSON representation

Extension to jackson-module-scala that uses scala-reflect to get type info

• Host: GitHub
• URL: https://github.com/pjfanning/jackson-scala-reflect-extensions
• Owner: pjfanning
• License: apache-2.0
• Created: 2022-08-07T14:25:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-18T18:49:34.000Z (12 months ago)
• Last Synced: 2024-05-01T16:12:58.978Z (6 months ago)
• Topics: jackson, jackson-module-scala, scala
• Language: Scala
• Homepage:
• Size: 104 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build Status](https://github.com/pjfanning/jackson-scala-reflect-extensions/actions/workflows/ci.yml/badge.svg?branch=main)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/jackson-scala-reflect-extensions_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/jackson-scala-reflect-extensions_2.13)

# jackson-scala-reflect-extensions

Jackson Scala 2 support that uses [scala-reflect](https://docs.scala-lang.org/overviews/reflection/overview.html)

to get type info. The problem that this lib solves in described in this [FAQ entry](https://github.com/FasterXML/jackson-module-scala/wiki/FAQ#deserializing-optionint-seqint-and-other-primitive-challenges).

The lib can also auto-discover subtypes if you are using Jackson's polymorphism support ([@JsonTypeInfo annotation](https://www.baeldung.com/jackson-inheritance#2-per-class-annotations)). You can omit the `@JsonSubTypes` if you dealing with sealed traits.

This lib is designed to be used with [jackson-module-scala](https://github.com/FasterXML/jackson-module-scala). By default,

jackson-module-scala uses Java reflection to work out the class structure.

The Scala3 equivalent is [jackson-scala3-reflection-extensions](https://github.com/pjfanning/jackson-scala3-reflection-extensions).

`ScalaReflectExtensions` can be mixed into your ObjectMapper in as a similar way to jackson-module-scala's

[ClassTagExtensions](https://github.com/FasterXML/jackson-module-scala/blob/2.16/src/main/scala/com/fasterxml/jackson/module/scala/ClassTagExtensions.scala)

and [ScalaObjectMapper](https://github.com/FasterXML/jackson-module-scala/blob/2.16/src/main/scala-2.%2B/com/fasterxml/jackson/module/scala/ScalaObjectMapper.scala).

```scala

libraryDependencies += "com.github.pjfanning" %% "jackson-scala-reflect-extensions" % "2.16.0"

```

```scala

import com.fasterxml.jackson.databind.json.JsonMapper

import com.fasterxml.jackson.module.scala.DefaultScalaModule

import com.github.pjfanning.jackson.reflect.ScalaReflectExtensions

val mapperBuilder = JsonMapper.builder()

  .addModule(DefaultScalaModule)

val mapper = mapperBuilder.build() :: ScalaReflectExtensions

// this should also work but Jackson is moving to supporting only creating mapper instances from a builder

val mapper2 = new ObjectMapper with ScalaReflectExtensions

mapper2.registerModule(DefaultScalaModule)

val instance = mapper.readValue[MyClass](jsonText)

```