如何为项目专属SBT自动插件添加可访问资源？

首先明确：你的需求完全可行，只是SBT对./project目录下的构建项目有特定的资源目录约定——直接把资源和插件源码放同目录的常规方法之所以无效，是因为SBT不会自动把那些目录纳入构建项目的类路径。

下面是一步步的实现方案：

1. 调整资源目录结构 #

在./project目录下创建标准的资源目录：src/main/resources。这个目录是SBT默认识别的构建项目资源目录（因为./project本身就是一个独立的Scala项目，专门用来构建你的主项目）。

举个例子：

• 如果你的插件类是com.example.MyAutoPlugin，想要访问和类同包的资源plugin-config.properties，就把资源放在./project/src/main/resources/com/example/plugin-config.properties
• 如果资源是全局通用的（比如根路径下的default-settings.json），直接放在./project/src/main/resources/default-settings.json即可

2. 正确调用资源 #

在你的自动插件类里，使用getClass.getResourceAsStream时注意路径写法：

• 相对路径（相对于当前类的包）：直接写资源文件名，比如和插件类同包时：

  val configStream = getClass.getResourceAsStream("plugin-config.properties")
  

• 绝对路径（从类路径根开始）：前面加斜杠，比如访问根路径的资源：

  val settingsStream = getClass.getResourceAsStream("/default-settings.json")
  

3. 验证（可选） #

如果还是拿不准资源是否被正确加载，可以在插件里打印类路径来确认：

println("构建项目类路径：" + getClass.getClassLoader.getResource(".").getPath)

运行SBT命令时，你会看到./project/target/scala-<version>/classes目录（资源会被复制到这里）在类路径里。

常见坑点提醒 #

• 不要把资源直接放在./project根目录或者插件源码所在的./project/src/main/scala子目录里，SBT不会把这些位置的文件当作资源复制到类路径
• 路径区分大小写，尤其是在Linux/macOS环境下，文件名拼写错误会直接导致找不到资源
• 如果是多模块项目，要确保资源放在对应模块的./project目录下，而不是根项目的./project

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