打包和资源文件的路径问题

对资源文件的操作

读取resources目录下的资源文件时，在IDE中可以使用下面方法来获取文件的路径。但工程打成jar包后这种方法则读取不到

this.getClass().getResource("/xxx").getPath();   

因为，在调试过程中(没有打包成Jar)，文件是真实存在于磁盘的某个目录。此时通过获取文件路径，是可以正常读取的，因为文件确实存在 而打包成jar以后，实际上文件是存在于jar这个文件里面的资源文件。在磁盘是没有真实路径的。所以通过该方法无法正确获取文件

在打成Jar包后正确的读取方式是通过流的方式：

//注意开头"/"，相对于调用类，共同的顶层路径
this.getClass().getResourceAsStream("/xxx");
//通过类加载器读取资源时路径不带"/"
this.getClass().getClassLoader().getResourceAsStream("xxx");

jar包内部的文件，应该通过Stream的方式读取，不能通过File来读取

部署在物理服务器上

若项目部署在物理服务器上，因为可以登录到服务器，有文件系统权限。

对于以后希望可修改的配置项(比如日志输出级别)，或调用到的第三方函数需要输入文件路径(比如hadoop设了kerberos后，登录集群需要调用UserGroupInformation.loginUserFromKeytab方法，需要传入user.key密钥文件的路径)

这些文件就不应该打入jar包中。对于前一种场景，需要修改的配置文件可以放在jar包外的路径，程序去加载相对路径下的配置文件，便于修改。对于第二种场景，同样可以在jar包外加载一个配置文件，在配置文件中指明所需文件的位置，可以是本地位置，也可以是网络上的位置

目录结构推荐jar包和配置文件夹同级

├── App.jar   
└── conf
	└── xxx.txt

//普通文件
new File("conf/xxx.txt")
//properties文件，如log4j的配置文件可这样读
PropertyConfigurator.configure("conf/log4j.properties")

部署在PaaS上

若项目部署在PaaS平台，无法访问文件系统，则资源文件只能打进Jar包。若要读取到文件路径，可以通过下面方式：

        InputStream resourceAsStream = PDFKitImpl.class.getClassLoader().getResourceAsStream("simfang.ttf");
        File file = File.createTempFile("simfang", "ttf");
        FileUtils.copyInputStreamToFile(resourceAsStream,file);
        IOUtils.closeQuietly(resourceAsStream);
        String path = file.getAbsolutePath();

通过apache的commons-io包下提供的方法，通过stream将jar包内的文件输出拷贝到jar包外，间接的来操作。
若项目中引入了spring，可以使用spring提供的ClassPathResource类，获取资源文件的流对象，FileCopyUtils.copyToByteArray读取文件内容。 或者用ResourceUtils.getURL

Maven打包

打包这块只希望整理出最佳实践，因为每个人习惯使用的IDE不同，所以打包发布项目应该只由构建工具负责，与IDE无关。所以在这不对IDEA自带的打包方式做整理

• 只对自己的代码打包，通过MANIFEST.MF指定依赖路径

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.4</version>
    <configuration>
        <archive>
            <manifest>
                <!--是否要把第三方jar放到manifest的classpath中-->
                <addClasspath>true</addClasspath>
                <useUniqueVersions>false</useUniqueVersions>
                <!--生成的manifest中classpath的前缀，因为要把第三方jar放到lib目录下，所以classpath的前缀是lib/-->
                <classpathPrefix>lib/</classpathPrefix>
                <!-- 应用的main class-->
                <mainClass>com.cmb.App</mainClass>
            </manifest>
        </archive>
    </configuration>
</plugin>

• Fat-Jar 连同项目的所有依赖一同打入一个jar包，方便部署

    <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <mainClass>Test</mainClass>
            </manifest>
        </archive>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
    </configuration>
    <!--下面是为了使用 mvn package命令，如果不加则使用mvn assembly-->
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

打包后，resouces目录下的文件应该在Jar包内部首层，目录结构如下
├── META-INF
│ └── MANIFEST.MF
├── xxx.txt
└── com
└── cmb
└── App.class
注意主清单文件中Main-Class为函数入口 若不是Fat-Jar时，注意Class-Path指明所依赖jar包的路径是否正确

• Spring-boot插件打包，Fat-Jar

<!-- mvn clean package -Dmaven.test.skip=true-->
<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	<configuration>
		<fork>true</fork>
		<!--jar包能直接执行，或注册为linux下服务-->
		<executable>true</executable>
	</configuration>
	<executions>
		<execution>
			<goals>
				<goal>repackage</goal>
			</goals>
		</execution>
	</executions>
</plugin>

Gradle打包

• application插件 推荐这种方法，不仅依赖跟jar分离，提供linux和windows下启动脚本，还能自动执行所有测试用例并生成测试报告。由于交付物不是一个jar包，可能不合适再PaaS平台上部署？

apply plugin: 'application'
mainClassName = 'com.cmb.appMainClass'

运行gradle build后，在build/distributions会有两个压缩文件，压缩文件包含了两个文件夹，bin为启动脚本，lib则是软件jar包和依赖。还可以执行./gradlew installDist生成未压缩文件目录build/install。

• Fat-Jar 添加下面脚本到build.gradle

jar {
    from {
        configurations.runtime.collect{zipTree(it)}
    }
    manifest {
        attributes 'Main-Class': 'com.cmb.appMainClass'
    }
}

• Fat-Jar 假如是spring-boot工程，可以用spring提供的插件打包

buildscript {
	ext {
		springBootVersion = '1.5.14.RELEASE'
	}
	repositories {
		maven {url "仓库地址"}
	}
	dependencies {
		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
	}
}

apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

buildscript中声明的是gradle脚本自身需要的资源，包括第三方插件的依赖，maven仓库地址等

参考资料

感谢同事的无私奉献！！！！！
在 jar 文件中读取 resources 目录下的文件
Classpath resource not found when running as jar
How to get files from resources folder. Spring Framework