java加载文件的3种方式
一般我们加载文件都是以下3种方式进行加载,之前一直困扰我很久的关于文件加载的路径问题,今天我想自己写一个wiki page来记录下,总结下:
1,通过类加载器
这种方式是通过java自己的类加载器来加载文件,根目录为java类的打包出来后的根目录。相对目录就是当前类所在的包位置。如果你希望加载的文件是保存在类加载器能访问到的目录,推荐使用此加载方式(web应用中web-inf下的文件出于安全机制的考虑是不能通过web-inf进行加载的)
Java代码
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(filePath);
2,通过文件系统加载
这种方式是通过系统的文件系统机制进行加载,它接受的参数(文件路径)是一个绝对路径地址,你可能会觉得这样的话文件路径会在代码中hard coding,不优雅,当然你可以选择用很多种方式获得项目的路径再进行相应的相对路径拼装,至少我是这么做的。
Java代码
InputStream inputStream = new FileInputStream(file);
但是有个很重要的问题需要说明,看下面的例子(在weblogic应用服务器中):
其中使用到了Log4J作为日志输出工具,Log4J的配置文件log4j.propertes放在 DefaultWebApp\WEB-INF目录下。Log4J通过一个自动加载的Servlet进行初始化,初始化代码如下:
Java代码
ServletContext context = getServletContext();
org.apache.log4j.PropertyConfigurator.
configure(context.getRealPath("/")
+ "/WEB-INF/log4j.properties");
其中,context.getRealPath("/")得到当前Web应用的真实根目录,比如,如果你的WebLogic安装在D:\bea下,在Windows下context.getRealPath("/")通常会返回:D:\bea\wlserver6.1\config\mydomain\applications\DefaultWebApp。这样,和 "/ WEB-INF /log4j.properties"拼接后,就得到了log4j.properties文件的真实路径。现在一切正常!测试通过后,将DefaultWebApp下的所有文件打为一个.war包,进行部署时,发现系统报告找不到“D:\bea \wlserver6.1\null\ WEB-INF \log4j.properties”文件!如果你的应用中还需要读取其它已经被打包到war包中的文件,都会报告找不到文件。并且,系统并不会到D:\bea\wlserver6.1\config\mydomain\applications\DefaultWebApp 目录下寻找,而会到D:\bea\wlserver6.1\null下寻找。这是因为context.getRealPath("/")返回了null。
查看ServletContext的API文档,原来,对一个打包的应用来说,是没有RealPath的概念的,调用getRealPath 只会简单地返回null。其实,也很好理解,一个文件被打包入了.war文件,就不存在目录结构了(虽然包中仍然存在目录结构,但这不等同于文件系统中的目录结构)。所以,对war包中的资源是无法得到RealPath的。这样也就无从通过文件IO进行读取了。那么,如何读取war包中的资源呢?答案是使用ServletContext.getResourceAsStream(String)方法。那么,现在对于war应用可以成功运行,但如果现在不通过war部署,直接通过目录结构部署应用会不会又出现找不到资源的错误呢?请来看看 ServletContext.getResourceAsStream的API文档,
Java代码
# Returns a URL to the resource that is
# mapped to a specified path. The path
# must begin with a "/" and is interpreted
# as relative to the current context root.
# This method allows the servlet container
# to make a resource available to servlets
# from any source. Resources can be located
# on a local or remote file system,
# in a database, or in a .war file.
#
可见,通过getResourceAsStream可以获取包括本地文件系统、远程文件系统、war包等资源。不会出现上面担心的问题。
结论:在开发J2EE Web应用时,如果需要读取本应用中的文件,尽量使用ServletContext.getResourceAsStream进行,而不要使用文件IO。getRealPath在不同的服务器中获得的参数是不一样的,有些会返回空,有些会返回正常数据,这就要看服务器是否解包文件了,而且有些服务器中getRealPath是本身就以"/"结尾的,这里是最好进行下判断:
Java代码
realPath.endsWith("/")?realPath:(realPath+"/")
3,web程序可以通过ServletContext进行加载
一个特定资源的URL可以通过调用ServletContext.getResource(String path)得到,这儿的path参数必须以“/”开始,将被解析为相对于当前Servlet背景的根的相对路径。这个方法有别于基于类加载器的 java.lang.Class.getResource方法。假如你通过ServletContext.getResource方法请求了一个.jsp 页面,你得到的将是JSP的源码,要得到执行结果,可以使用RequestDispatcher对象的include方法。你也可以直接以输入流的形式得到资源,
Java代码
public InputStream getResourceAsStream(String path);
上个例子已经很好的联合文件io来对2者进行了比较了。
Java代码
inputStream = sc.getResourceAsStream(EnumConstants.SERVER_CONFIGURATION_FILEPATH.toString());
/**
*"SERVER_CONFIGURATION_FILEPATH" server configuration reflection class properties file path <b>"/config/server-config.properites"
*/
public static final EnumConstants SERVER_CONFIGURATION_FILEPATH = new EnumConstants("/config/server-config.properites");