Java项目中资源文件查找问题

最新推荐文章于 2024-08-16 09:50:38 发布

EIOT

最新推荐文章于 2024-08-16 09:50:38 发布

阅读量1.1k

点赞数 1

文章标签： java

本文链接：https://blog.csdn.net/m0_57225567/article/details/126032079

版权

1. 问题的提出

在学习JDBC连接时，希望采用配置文件存储信息，并在代码中读取配置文件的方式来进行驱动的注册和连接的建立。所以采用以下代码

public void connection(){
        try{
            
            InputStream is = JdbcConnection.class.getResourceAsStream("jdbc.properties");
            Properties po = new Properties();
            po.load(is);
            
            String username = po.getProperty("username");
            String password = po.getProperty("password");
            String url      = po.getProperty("url");
            String driver   = po.getProperty("driver");
            
            Class.forName(driver);
            Connection conn = DriverManager.getConnection(url, username, password);
            
            System.out.println(conn);
        } catch (IOException | ClassNotFoundException | SQLException e){
            e.printStackTrace();
        }
    }

jdbc.properties文件位置如下

但是，报错了。原因很明显就是文件没找到

所以要解决这个问题，就要知道文件应该放哪？以及应该怎么传文件名？

2. 解决过程

2.1 怎么传文件名

按照常理，首先都会去看看这个方法Class::getResourceAsStream()是以什么为根目录来找文件的，就去看看手册是怎么说的。

手册中说，在代理之前，要先根据传进来的实参构造出资源的绝对名字（可以理解为绝对路径，但是这个绝对路径是相对于一个路径下的，后面会讲到），构造的方法如下：

1、如果以'/'开头，那'/'后面的就是绝对名字

2、否则，就要加上相应的包的名字。举个例子，如果一个文件a.txt在包com.org.test包下，那么如果传入"a.txt"，构造出来的绝对名字就是 "com/org/test/a.txt"。

2.2 文件应该放哪

我们都知道，src/main/java下的.java文件编译成.class文件后会放到target/classes文件夹下，src/main/resources/下的文件会直接拷贝到target/classes文件夹下。

程序在运行过程中，读取文件都是根据classpath路径，即target/classes目录，也就是上面绝对名字相对的那个路径。

2.3 解决方法

知道了上面这些，就可以解决之前的那个问题了。首先，应该把jdbc.properties文件放在resources文件夹下。然后修改一下传入的文件名，加上'/'。

InputStream is = JdbcConnection.class.getResourceAsStream("/jdbc.properties");

成功连接到了数据库。

3. 进一步探索

3.1 把jdbc.properties文件放在java目录下行不行？

回到最开始的代码，根据2.1和2.2两点，如果jdbc.properties文件能够按照对应的目录关系生成到classes目录下（即 java/com/zhc/jdbc/jdbc.properties => classes/com/zhc/jdbc/jdbc.properties）；由于不加'/'传入文件名，会加上对应的包名，即/com/zhc/jdbc/jdbc.properties。这样应该是可以读取到这个配置文件，但是还是报错了，因为这个配置文件并没有按我们所想地拷贝到classes的对应目录下。

因为，在IDEA的Maven项目中，默认代码目录（src/main/java）下的xml、properties等资源文件是不会被编译的，而是直接舍弃，所以不会在classes下的对应目录里看到。要想让java目录下的资源文件可以被编译过去，就需要在pom.xml中进行如下配置，就是把properties文件也包含在编译的过程中

    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

这样也可以成功读取到文件，并连接到数据库。

3.2 Class::getResourceAsStream 和 ClassLoader::getResourceAsStream的区别

上面说到了，Class::getResourceAsStream方法会代理给ClassLoader::getResourceAsStream，但是在代理之前要对传入的资源名字进行转换，转换为资源的绝对名字。

所以，Class::getResourceAsStream需要的参数是资源的相对名字，而ClassLoader::getResourceAsStream需要的参数是资源的绝对名字。

举个例子

当资源文件jdbc.properties放在resources目录下时

InputStream is = JdbcConnection.class.getResourceAsStream("/jdbc.properties");
InputStream is = JdbcConnection.class.getClassLoader().getResourceAsStream("jdbc.properties");

当资源文件jdbc.properties放在java目录的包下时（com.zhc.jdbc包）

InputStream is = JdbcConnection.class.getResourceAsStream("jdbc.properties");
InputStream is = JdbcConnection.class.getClassLoader().getResourceAsStream("com/zhc/jdbc/jdbc.properties");