Scala Pickling 完全指南：从零开始掌握高效 Scala 序列化框架

Scala Pickling 完全指南：从零开始掌握高效 Scala 序列化框架

【免费下载链接】picklingFast, customizable, boilerplate-free pickling support for Scala项目地址: https://gitcode.com/gh_mirrors/pi/pickling

Scala Pickling 是一个为 Scala 设计的自动序列化框架，它快速、无样板代码，并且允许用户轻松切换不同的序列化格式（如二进制或 JSON），甚至可以提供自定义的序列化格式。本文将为你提供一个全面的指南，帮助你从零开始掌握这个强大的框架。

为什么选择 Scala Pickling？

Scala Pickling 与其他序列化框架相比有许多独特之处：

多格式支持

Scala Pickling 支持多种序列化格式，包括二进制和 JSON。你可以通过简单地导入正确的隐式 pickle 格式来更改序列化数据的格式。例如，要使用 JSON 格式，只需导入scala.pickling.json._。

自动序列化

无需任何样板代码，Scala Pickling 可以自动序列化任意类实例。你不需要注册类或实现任何方法，只需导入scala.pickling包并调用实例上的pickle方法即可。

类型安全

Scala Pickling 提供了更强的类型安全性。与 Java 序列化不同，错误要么表现为编译时错误，要么仅在 unpickling 时表现为运行时错误，不会传播到程序的任意点。

面向对象支持

Scala Pickling 基于函数式编程中的 pickler combinators 概念，但扩展了传统形式以处理开放类层次结构。这意味着如果你序列化一个子类实例，然后尝试将其 unpickle 为超类，你仍然会得到原始子类的实例。

编译时处理

Scala Pickling 的序列化相关代码通常在编译时生成并内联到需要的地方，因此性能非常高。只有在静态（编译时）生成失败时，才会使用反射作为回退。

快速开始

添加依赖

要在 sbt 项目中使用 Scala Pickling，只需在构建文件中添加以下依赖：

libraryDependencies += "org.scala-lang.modules" %% "scala-pickling" % "0.10.1"

基本用法

以下是一个简单的示例，展示如何使用 Scala Pickling 序列化和反序列化一个 case class：

import scala.pickling.Defaults._, scala.pickling.json._ case class Person(name: String, age: Int) val pkl = Person("foo", 20).pickle // pkl: pickling.json.pickleFormat.PickleType = JSONPickle({ // "$type": "Person", // "name": "foo", // "age": 20 // }) val person = pkl.unpickle[Person] // person: Person = Person(foo,20)

高级特性

禁用循环对象图

默认情况下，Pickling 可以序列化循环对象图（例如，用于序列化双向链表）。但是，这需要在运行时进行簿记。如果已知序列化的对象是非循环的（例如，简单列表或树），则可以使用以下导入禁用此额外的簿记：

import scala.pickling.shareNothing._

如果在紧密循环中序列化对象，此导入可以显著提高性能。

无反射的静态序列化

对于像Any这样的类型，Pickling 使用运行时反射，因为在编译时没有足够的信息。但是，Pickling 支持静态模式，确保不使用运行时反射。在这种模式下，序列化需要运行时反射的对象会导致编译时错误。

以下导入启用静态序列化：

import scala.pickling.static._ // 避免运行时反射

按需导入

Pickling 允许你导入特定部分（函数、操作、picklers 和格式），以便自定义每个部分：

import scala.pickling._ // 仅导入名称 import scala.pickling.json._ // 导入 PickleFormat import scala.pickling.static._ // 避免运行时 pickler // 导入 pickle 操作 import scala.pickling.Defaults.{ pickleOps, unpickleOps } // 或者导入 pickle 函数 // import scala.pickling.functions._ // 导入特定类型的 picklers import scala.pickling.Defaults.{ stringPickler, intPickler, refPicklerUnpickler, nullPickler } case class Pumpkin(kind: String) // 使用宏手动生成 pickler implicit val pumpkinPickler = Pickler.generate[Pumpkin] implicit val pumpkinUnpickler = Unpickler.generate[Pumpkin] val pckl = Pumpkin("Kabocha").pickle val pump = pckl.unpickle[Pumpkin]

自定义协议栈

Pickling 还提供了 traits，允许你混合和匹配自己的便利对象进行导入。如果你是库作者，你可以提供包含 pickling 部分（操作、函数、picklers、格式）的便利对象：

case class Apple(kind: String) val appleProtocol = { import scala.pickling._ new pickler.PrimitivePicklers with pickler.RefPicklers with json.JsonFormats { // 为 Apple 手动生成 pickler implicit val applePickler = PicklerUnpickler.generate[Apple] // 不回退到运行时 picklers implicit val so = static.StaticOnly // 提供自定义函数 def toJsonStringA: Pickler: String = functions.pickle(a).value def fromJsonStringA: Unpickler: A = functions.unpickleA) } }

然后，库用户可以像这样导入appleProtocol：

import appleProtocol._ toJsonString(Apple("honeycrisp")) // res0: String = { // "$type": "Apple", // "kind": "honeycrisp" // } fromJsonString(res0) // res1: Apple = Apple(honeycrisp)

获取开发版本

如果你想运行 scala/pickling 的最新开发版本（0.10.2-SNAPSHOT），你还需要将 Sonatype "snapshots" 仓库解析器添加到你的构建文件中：

libraryDependencies += "org.scala-lang.modules" %% "scala-pickling" % "0.10.2-SNAPSHOT" resolvers += Resolver.sonatypeRepo("snapshots")

你也可以直接下载 0.10.1 jar 文件（Scala 2.10，Scala 2.11）。

总结

Scala Pickling 是一个功能强大、灵活且高性能的序列化框架，为 Scala 开发者提供了自动、类型安全的序列化解决方案。通过本文的指南，你应该能够快速上手并充分利用其各种特性。无论你是需要简单的对象序列化，还是复杂的自定义协议，Scala Pickling 都能满足你的需求。

如果你想深入了解更多技术细节，可以参考 Instant Pickles: Generating Object-Oriented Pickler Combinators for Fast and Extensible Serialization 这篇论文，或者查看项目的测试代码，如 core/src/test/scala/scala/pickling/binary/ 目录下的各种测试用例。

希望这篇指南能帮助你更好地理解和使用 Scala Pickling，让你的 Scala 项目序列化工作变得更加简单高效！ 🚀

【免费下载链接】picklingFast, customizable, boilerplate-free pickling support for Scala项目地址: https://gitcode.com/gh_mirrors/pi/pickling