Scala编译器插件能否修改case类自动生成的访问器方法？

背景说明 #

在Scalac编译流程的parser阶段结束后，如下定义的case class：

case class ExampleCaseClass(var s:String, var i:Int) extends ContextuallyMutable

会生成如下中间形式：

Clazz(case class ExampleCaseClass extends ContextuallyMutable with scala.Product with scala.Serializable {
  <caseaccessor> <paramaccessor> var s: String = _;
  <caseaccessor> <paramaccessor> var i: Int = _;
  def <init>(s: String, i: Int) = {
    super.<init>();
    ()
  }
})

通过如下运行时反射调用：

ExampleCaseClass("Can a Scala compiler plugin transform the autogenerated accessor methods of scala case classes?", 42).getClass.getMethods.foreach(println(_))

可查看到更多公共方法，其中包含后续编译阶段生成的属性访问器方法：

public int ExampleCaseClass.i()
public java.lang.String ExampleCaseClass.s()
public void ExampleCaseClass.i_$eq(int)
public void ExampleCaseClass.s_$eq(java.lang.String)

问题解答 #

问题1：访问器生成阶段与修改手段 #

• 这些case类的访问器方法由Scalac的合成（synthetic）逻辑生成，具体执行阶段为namer阶段之后、typer阶段早期，属于Scala编译器原生逻辑，和Java编译器无关。
• 要修改或阻止这些方法生成，需要使用Scala编译器的全局阶段插件，在访问器合成阶段之前插入自定义逻辑，或者直接覆写case类的默认合成规则。

问题2：可行的实现方案 #

你之前的方案出现冲突的核心原因是修改时机晚于参数标记的解析阶段，或者没有同时屏蔽编译器的默认合成逻辑，可行方案如下：

1. 优先在typer阶段之前注入自定义的访问器方法，同时给注入的方法加上<synthetic>和<caseaccessor>标记，让编译器认为目标方法已经存在，不会再重复生成默认版本，避免命名冲突。
2. 如果需要完全移除默认访问器，可以在namer阶段结束后，先移除原字段的<caseaccessor>标记，再手动补全需要的访问逻辑，同时要确保和case类自动生成的apply、unapply、equals、hashCode方法的字段引用保持一致，避免参数名或逻辑错位。
3. 不需要调整构造函数本身的参数定义，只需要拦截编译器对case类字段的访问器合成逻辑即可，避免破坏构造、apply方法的默认生成规则。

问题3：跨编译目标的实现说明 #

• Scala编译器插件完全可以修改这些合成的访问器方法，这些方法100%由Scala编译器生成，和Java编译器无关，不需要借助Javac插件实现。
• 针对Scala.js和Scala Native编译目标，使用同样的Scala编译器插件逻辑即可生效，两者都是基于Scalac的前端编译流程生成中间IR，再转成对应目标的二进制/JS代码，前端合成访问器的逻辑和JVM目标完全一致，只需要确保你的插件没有依赖JVM特有的API即可跨目标复用。

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