Skip to main content
Version: dev

Scala Serialization Guide

Apache Fory™ Scala provides optimized serializers for Scala types, built on top of Fory Java. It supports xlang mode for cross-language payloads and native mode for Scala/JVM-only object serialization. It supports all Scala object serialization:

  • case class serialization
  • pojo/bean class serialization
  • object singleton serialization
  • collection serialization (Seq, List, Map, etc.)
  • tuple and either types
  • Option types
  • Scala 2 and 3 enumerations

The library artifact supports Scala 2.13 and Scala 3. Schema IDL generated Scala source and macro-derived xlang serializers require Scala 3.

Features​

Fory Scala inherits all features from Fory Java, plus Scala-specific optimizations:

  • High Performance: JIT code generation, zero-copy, 20-170x faster than traditional serialization
  • Scala Type Support: Optimized serializers for case classes, singletons, collections, tuples, Option, Either
  • Default Value Support: Automatic handling of Scala class default parameters during schema evolution
  • Singleton Preservation: object singletons maintain referential equality after deserialization
  • Schema Evolution: Forward/backward compatibility for class schema changes

See Java Features for complete feature list.

Installation​

Add the dependency with sbt:

libraryDependencies += "org.apache.fory" %% "fory-scala" % "1.2.0"

JDK25+​

Scala uses the Fory Java core when running. On JDK25+, open java.lang.invoke to Fory. Use ALL-UNNAMED when Fory is on the classpath:

--add-opens=java.base/java.lang.invoke=ALL-UNNAMED

Use the Fory core module name when Fory is on the module path:

--add-opens=java.base/java.lang.invoke=org.apache.fory.core

Quick Start​

import org.apache.fory.Fory
import org.apache.fory.scala.ForyScala

case class Person(name: String, id: Long, github: String)
case class Point(x: Int, y: Int, z: Int)

object ScalaExample {
  val fory: Fory = ForyScala.builder()
    .withXlang(true)
    .build()

  fory.register(classOf[Person])
  fory.register(classOf[Point])

  def main(args: Array[String]): Unit = {
    val p = Person("Shawn Yang", 1, "https://github.com/chaokunyang")
    println(fory.deserialize(fory.serialize(p)))
    println(fory.deserialize(fory.serialize(Point(1, 2, 3))))
  }
}

Xlang Mode And Native Mode​

Use xlang mode for cross-language payloads and schemas shared with other Fory implementations. Xlang mode is the default Scala wire mode through the JVM builder, and Scala examples that use it set .withXlang(true) explicitly so the mode choice is visible.

Use native mode for Scala/JVM-only traffic. Native mode is selected with .withXlang(false) and inherits the JVM native-mode object serialization path from Fory Java while adding Scala-specific serializers for case classes, collections, tuples, options, and enumerations. It is optimized for JVM and Scala type systems and is the right path for same-language Scala/JVM framework replacement payloads. Compatible mode is enabled by default. Set .withCompatible(false) only when every reader and writer uses the same Scala/JVM schema and you want faster serialization and smaller size.

See Configuration for Scala builder setup and Java Native Serialization for the full JVM native-mode behavior.

Built on Fory Java​

Fory Scala is built on top of Fory Java. Most configuration options, features, and concepts from Fory Java apply directly to Scala. Refer to the Java documentation for:

Scala-Specific Documentation​