关于getResource()感想

前言

在开发中，无意间看到一个工具类FreeMarkerUtil，先不看其内容，光看类名，大概能知道，是用来渲染ftl文件的一个工具类。

这里不禁产生一个疑问：FreeMarkerUtil在渲染ftl时，是如何定位到ftl文件的位置？

详解

看其源码，有一个静态块：

static {

// ....无关代码省略

String ftlPath = FreeMarkerUtil.class.getClassLoader().getResource("").getPath() +"mailTemplate";

// ....无关代码省略

}

单看上面一行代码，也不难理解，通过getResource()定位FreeMarkerUtil该类所在的classPath，然后拼接mailTemple（mailTemple这个文件夹下集中存放了所有flt文件），最终得到一个完整的ftl文件路径。

那么问题又来了，classPath到底是哪个路径？

其实，classPath的设定与具体的IDE工具有关。

不同于eclipse帮你设置好输出目录的做法，IntelliJ IDEA的编译后的文件的输出目录需要自己设置，并且还分了工程输出目录和模块输出目录

我用的是Idea，所以，通过查看project structure可以发现，class在编译之后，会直接放到target/classes目录下，同时一些资源文件也会一起放到该目录下，具体如下图所示。

这里也稍微扩展开来讲一下classes，因为网上很多人说classPath是指WEB-INF下的classes目录，或者lib目录，这种说法没啥问题，主要还是因为Idea能够自己手动指定java类编译之后的输出目录，所以会产生一些疑惑

classes是一个定位资源入口，目录下用来存放：

a1. 各种资源配置文件，eg.init.properties,log4j.properties,struts.xml

a2. 存放模板文件eg.actionerror.ftl

a3. 编译后的class文件，对应的是项目开发时src目录编译文件

讲到这里， String ftlPath = FreeMarkerUtil.class.getClassLoader().getResource("").getPath() +"mailTemplate";

这行代码其实是可以解释清楚了，如何来获取资源文件路径。

只不过，还需要扩展开来看看Class类提供的getResource方法的一些用法：

public class TestMain {

public static void main(String[] args) {

System.out.println(TestMain.class.getResource(""));

System.out.println(TestMain.class.getResource("/"));

}

重点关注一下：

System.out.println(TestMain.class.getResource(""));

System.out.println(TestMain.class.getResource("/"));

这两行代码，第一行入参无“/”，第二个有“/”

输出结果如下所示。

可以看到：

1 如果入参无"/"，那么返回的是TestMain的路径，也就是TestMain.class经过编译之后，所存放的路径（Idea默认会把编译后的类放到target/classes这个目录下。

2 如果有“/”，则只会返回target/classes这个顶层目录。

3 如果参数为一个具体的文件名，如 System.out.println(TestMain.class.getResource("A.properties"));，则会去查找与TestMain同级目录下是否有A.properties这个文件

4 当然，如果入参是“/A.properties”这样形式的，也很容易理解，即在target/classes目录下，来查找A.properties这个资源文件。

知识点其实不难，但是也算是补充了一下一些小空白：

1 class.getResource()方法用于获取当前类所在路径，classpath。而且classpath指的是java类编译之后存放的路径（我这里是target/classes）

2 class.getResource()入参是否带有"/"，也有区别，不带"/"，返回的是当前类的全路径，带“/”返回target/classes这个顶层目录。

3 当然还有很多其他类似方法来获取资源文件，比如Class.getClassLoader().getResource，这个方法在使用上与class.getResource()大同小异，但需要注意的是：前者入参开头不能带有“/”，且默认路径就是target/classes