如何迁移Scala2中Shapeless2注解方案至Shapeless3？聚焦Poly2代码

关键迁移要点 #

Shapeless3相对于Shapeless2做了不少API调整，核心变化包括：

• 移除Poly2，统一使用Poly处理多参数多态函数
• AnnotationsAPI简化，不再需要Aux类型投影
• Generic的类型推导更简洁，直接通过Generic[T]获取泛型表示类型Repr
• 集合操作（如RightFolder、Zip）的包路径调整为shapeless3.ops.hlist
• 减少Lazy的强制使用，多数场景下可自动推导

迁移后的完整代码 #

import shapeless3.ops.hlist.{RightFolder, Zip}
import shapeless3.{Annotations, Generic, HList, HNil, Poly}
import scala.annotation.StaticAnnotation

object App {
  // 自定义注解
  case class MyAnnotation(func: String) extends StaticAnnotation

  // 替换原Poly2为Shapeless3的Poly
  object Collector extends Poly:
    // 匹配带有MyAnnotation的字段
    implicit def caseWithAnnotation[ACC <: HList, E]: Case2[(E, Some[MyAnnotation]), ACC, E :: ACC] =
      at: ((e, Some(MyAnnotation(func))), acc) =>
        println(func)
        e :: acc

    // 匹配无注解的字段
    implicit def caseWithoutAnnotation[ACC <: HList, E]: Case2[(E, None.type), ACC, E :: ACC] =
      at: ((e, None), acc) =>
        e :: acc

  // 定义Modifier trait，用于修改实例
  trait Modifier[T]:
    def modify(t: T): T

  // HList的默认Modifier实现（示例用，可根据需求替换）
  implicit def hListModifier[HL <: HList]: Modifier[HL] = identity(_)

  // 基于泛型和注解的Modifier隐式实例
  implicit def genericModifier[T, HL <: HList, AL <: HList, ZL <: HList](
    implicit
    gen: Generic.Aux[T, HL],
    modifier: Modifier[HL],
    annots: Annotations[MyAnnotation, T, AL],
    zip: Zip[HL, AL, ZL],
    folder: RightFolder[ZL, HNil, Collector.type, HL]
  ): Modifier[T] = new Modifier[T]:
    override def modify(t: T): T =
      val genericRepr = gen.to(t)
      println(s"原始泛型表示: $genericRepr")
      
      val annotations = annots()
      println(s"字段注解列表: $annotations")
      
      val zipped = zip(genericRepr, annotations)
      println(s"字段与注解配对结果: $zipped")
      
      val modifiedRepr = zipped.foldRight(HNil)(Collector)
      println(s"修改后的泛型表示: $modifiedRepr")
      
      gen.from(modifiedRepr)

  // 测试用例类，第二个字段带有MyAnnotation注解
  case class Test(a: String, @MyAnnotation("sha1") b: String)

  def main(args: Array[String]): Unit =
    val test = Test("A", "B")
    val modifier = implicitly[Modifier[Test]]
    
    val test1 = modifier.modify(test) // 会打印"sha1"
    println(s"修改后的实例: $test1") // 输出 Test(A,B)
}

代码说明 #

1. 注解定义：MyAnnotation继承自StaticAnnotation，用于标记需要特殊处理的字段。
2. Collector Poly：
   • 替换了原Shapeless2的Poly2，使用Shapeless3的Poly并定义Case2处理二元参数场景
   • 两个隐式实例分别处理带有注解和无注解的字段配对，这里示例仅打印注解的func值，实际可扩展为字段内容修改逻辑
3. Modifier trait：定义统一的修改接口，hListModifier提供HList的默认实现（示例直接返回原对象，可替换为实际修改逻辑）
4. 泛型Modifier实现：
   • 通过Generic将case class转换为HList表示
   • Annotations提取case class字段上的MyAnnotation，得到对应字段的注解列表（无注解的字段对应None）
   • Zip将字段HList和注解HList配对为元组HList
   • RightFolder通过Collector遍历配对后的HList，执行注解对应的处理逻辑
   • 最后将修改后的HList转换回原case class实例
5. 测试部分：创建带注解的Test实例，通过implicitly获取Modifier[Test]并执行修改操作，验证注解处理逻辑

内容的提问来源于stack exchange，提问作者pgrandjean