【scala】scala枚举类最佳实现及其jackson序列化方式

lisacumt

已于 2024-07-09 11:18:18 修改

阅读量354

点赞数 3

文章标签： scala 开发语言

于 2024-02-21 16:54:56 首次发布

本文链接：https://blog.csdn.net/lisacumt/article/details/136215426

版权

本文介绍了如何在Jackson2.14及以上版本中支持Scala的枚举类型，包括Sealedtrait/caseobject的使用，以及如何在SpringBoot中配置和处理带有枚举类型的序列化与反序列化。还提到了caseobject的局限性以及解决方法。

摘要由CSDN通过智能技术生成

参考文章：

官网参考：
jackson是支持scala内部的Enumeration的，但是jackson版本需要新一些，比如2.14后。
jackson github
jackson-module-scala github
enumeratum github

scala各个枚举类方式对比：
最好的就是：
scala2: sealed trait/abstract class + case object，并继承第三方enumeratum方式，其中enumeratum作用就是使用了内部findValues方法便于获取所有单例。
scala3: 内置的enum实现，暂时不晓得咋用
Using Enumerations in Scala Best Practices
Scala Enumerations

springboot默认使用jackson，需要配置jackson moulde的实现
Spring Boot集成Scala

优势：
保证了，序列化前后枚举对象的唯一性。
序列化后字符串也较美观。

上代码：
Direction.scala

import com.fasterxml.jackson.databind.annotation.{JsonDeserialize, JsonSerialize}
import enumeratum._

@JsonSerialize(using = classOf[DirectionSerializer])
@JsonDeserialize(using = classOf[DirectionDeserializer])
sealed abstract class Direction(val index: Int,val name: String) extends EnumEntry{

}
object Direction extends Enum[Direction] {
  val values = findValues

  case object From extends Direction(0, "from")
  case object To extends Direction(1, "to")
}

DirectionSerde.scala

import com.fasterxml.jackson.core.{JsonGenerator, JsonParser}
import com.fasterxml.jackson.databind.{DeserializationContext, SerializerProvider}
import com.fasterxml.jackson.databind.deser.std.StdDeserializer
import com.fasterxml.jackson.databind.ser.std.StdSerializer


class DirectionSerializer extends StdSerializer[Direction](classOf[Direction]) {
  override def serialize(value: Direction, gen: JsonGenerator, serializers: SerializerProvider): Unit = {
    // 使用类名称：From，To。
    gen.writeString(value.getClass.getSimpleName.replaceAll("[$]", ""))
  }
}

class DirectionDeserializer() extends StdDeserializer[Direction](classOf[Direction]) {
  override def deserialize(p: JsonParser, ctxt: DeserializationContext): Direction = {
    val str = p.readValueAs(classOf[String])
    // 使用enumeratum.Enum.withNameInsensitive 方法通过对象名称获取对象。
    Direction.withNameInsensitive(str)
  }
}

测试：

import com.fasterxml.jackson.core.`type`.TypeReference
import com.fasterxml.jackson.databind.{DeserializationFeature, ObjectMapper}
import com.fasterxml.jackson.databind.json.JsonMapper
import com.fasterxml.jackson.module.scala.DefaultScalaModule
import org.scalatest.funsuite.AnyFunSuite

import scala.collection.immutable

case class Vector(value: Int, direction: Direction)

class TestDirection extends AnyFunSuite {

  def getMapper: ObjectMapper = {
    var mapper: ObjectMapper = JsonMapper.builder()
      .addModule(DefaultScalaModule)
      .build()
    mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
    mapper
  }

  val mapper = getMapper

  test("serde") {
    val ob1 = Direction.From
    val str1 = mapper.writeValueAsString(ob1)
    println(str1) // "From"
    val ob2 = mapper.readValue(str1, classOf[Direction])
    println(ob1 == ob2) // true

    val vtr1 = Vector(10, Direction.To)
    val vtr2 = Vector(20, Direction.From)
    val ls1: immutable.List[Vector] = List(vtr1, vtr2)
    val str2 = mapper.writeValueAsString(ls1)
    println(str2) // [{"value":10,"direction":"To"},{"value":20,"direction":"From"}]
    val ls2: immutable.List[Vector] = mapper.readValue(str2, new TypeReference[List[Vector]] {})
    println(ls2) // List(Vector(10,To), Vector(20,From))
    println(ls1(0).direction == ls2(0).direction) // true
  }
}