Scala宏编译期读取文件问题：基于文件内容生成Scala类

哈哈，这个编译期宏读文件的坑我踩过好几次！核心问题在于宏是运行在编译器进程里的，和你平时运行期读文件的类路径、上下文完全不一样，给你分两种场景详细说解决方案：

你之前找不到资源，大概率是因为编译期的类路径和运行期不重合——宏用的是编译器自己的类加载器，不是你项目运行时的类加载器。要解决这个，得确保资源文件能被编译器的类加载器找到：

步骤1：正确放置资源并配置构建工具 #

把资源文件放在src/main/resources（或src/test/resources），如果是sbt项目，要确保编译阶段资源会被复制到编译器能访问的路径。如果是多模块项目，宏所在模块需要能访问到这些资源，你可以在build.sbt里加：

Compile / unmanagedResourceDirectories += baseDirectory.value / "src/main/resources"

执行sbt compile后，检查target/scala-<version>/classes目录下有没有你的资源文件，确保它被正确复制了。

步骤2：在宏里读取资源 #

用宏上下文的类加载器（c.classLoader）来读取，别用运行期的getClass.getResource，示例代码：

import scala.util.Using
import scala.reflect.macros.blackbox

class GenerateFromFile extends StaticAnnotation {
  inline def apply(defn: Any): Any = ${ GenerateFromFileMacro.impl(defn) }
}

object GenerateFromFileMacro {
  def impl(c: blackbox.Context)(defn: c.Tree): c.Tree = {
    // 读取根路径下的schema.json，注意前面的斜杠
    val resourceStream = c.classLoader.getResourceAsStream("/schema.json")
    
    if (resourceStream == null) {
      c.abort(c.enclosingPosition, "编译期找不到资源文件schema.json，请检查资源路径和构建配置")
    }

    // 用Using安全处理流
    val fileContent = Using.resource(resourceStream) { stream =>
      scala.io.Source.fromInputStream(stream).mkString
    }

    // 这里用fileContent生成你的Scala类代码，比如用c.parse生成树
    val generatedCode = c.parse(s"""// 自动生成的类，基于schema.json
                                   |case class GeneratedClass(name: String, age: Int)
                                   |""".stripMargin)
    
    // 把生成的代码和原定义合并（根据你的需求调整）
    q"$defn; $generatedCode"
  }
}

如果要读和.scala源码同目录的文件，关键是从宏上下文里拿到当前被注解元素的源文件路径：

核心方法：利用enclosingPosition获取源文件 #

宏上下文的c.enclosingPosition包含了当前被注解代码的位置信息，其中sourceFile就是对应的.scala文件，通过它就能拿到父目录，进而找到同级文件：

def impl(c: blackbox.Context)(defn: c.Tree): c.Tree = {
  val pos = c.enclosingPosition
  pos.sourceFile match {
    case sourceFile: java.io.File =>
      // 获取源码文件的父目录
      val sourceDir = sourceFile.getParentFile
      // 假设要读同目录下的model.txt
      val targetFile = new java.io.File(sourceDir, "model.txt")
      
      if (!targetFile.exists()) {
        c.abort(pos, s"找不到同级文件：${targetFile.getAbsolutePath}")
      }

      val fileContent = scala.io.Source.fromFile(targetFile).mkString
      // 生成你的Scala类代码...
      val generatedCode = c.parse(s"""case class Model(content: String = "$fileContent")""")
      q"$defn; $generatedCode"

    case _ =>
      c.abort(pos, "无法获取源文件路径，可能是在REPL或非文件源码环境下运行")
  }
}

注意事项 #

• 如果你用IDE（比如IntelliJ）开发，要确保IDE的编译配置和sbt一致，有时候IDE会用自己的编译路径，导致文件找不到，建议先用sbt clean compile测试。
• 增量编译时，如果修改了外部文件，宏可能不会重新执行，这时候需要手动触发全量编译。
• 处理文件时一定要加异常判断，用c.abort给开发者明确的错误提示，别让编译失败得不明不白。

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