个人资料
在进行一些Java APP开发时,在一个配置文件中定义了许多环境特定的变量。 常见的定义文件有xml、properties甚至txt等格式。 Java具有标准配置格式的文件:properties类型的文件。 主要用于保存以propertyname=propertyvalue等样式保存的命名值对的内容。 读取properties文件的方法各种各样,网上也有很多说明。 这里主要对两种典型的方法进行比较。
问题场景
现在,假设您有一个config.properties文件,其中包含以下信息:
dbpassword=password
database=localhost
dbuser=user
我们想通过程序读取那个内容。
粗略地看,这个问题很简单。 然后,看看我们的第一个方法。
File IO
直接用File Stream的经典方法读取文件,进行分析不就可以了吗? 这个实现代码是以下:
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;
公共类app {
publicstaticvoidmain (string [ ] args ) {
Properties prop=new Properties (;
try {
prop.load (new文件输入(config/config.properties ) );
system.out.println (prop.getproperty ) (database );
system.out.println (prop.getproperty ) (dbuser );
system.out.println (prop.getproperty (' db password ' ) );
}catch(ioexceptione ) {
e .打印任务跟踪(;
}
}
}
此代码创建一个java.util.Properties对象,指定properties文件,然后用FileInputStream读取该InputStream作为参数properties对象的load方法分析了结果。 执行此操作将产生以下结果:
localhost
用户
密码
另一个需要注意的是,文件输入流的路径是当前相对路径。 这意味着config.properties文件必须位于class文件所在目录的config字目录下。
现在,在考虑其他方式之前,我们先来看看FileInputStream这种方式的特征。 在导入属性文件时,必须知道其路径。 如果采用文件输入流,则必须将文件的路径传递给程序。 如果找不到文件,程序将发生异常。 考虑到我们的程序在编译后往往部署在不同的生产环境中,如果每个环境都不一样,我们每次都会修改这个程序吗? 还是将配置文件所在的路径作为参数传递给程序? 这两种方式显然不太合适。 那么,有什么方法可以不用我修改程序或者故意把参数传递给程序吗? 另一种方法可以达到这个理想的结果。
类加载器
使用classloader的方法主要是使用getResourceAsStream方法加载属性文件。 有关具体细节,请查看以下示例:
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;
公共类新应用程序{
publicstaticvoidmain (string [ ] args ) {
Properties prop=new Properties (;
try {
prop.load (new app.class.getclass loader ).getresourceasstream (' config.properties ' ) );
system.out.println (prop.getproperty ) (database );
system.out.println (prop.getproperty (' dbuser ' ) );
system.out.println (prop.getproperty (' db password ' ) );
>} catch(IOException e) {e.printStackTrace();
}
}
}
这里我们并没有指定一个特定的路径给classloader,我们只是将文件名直接传给了它。如果我们将config.properties文件和class文件放在同一个目录下,结果运行正常。如果我们将properties放到其他地方则会碰到如下的错误:
Exception in thread "main" java.lang.NullPointerException
at java.util.Properties$LineReader.readLine(Properties.java:434)
at java.util.Properties.load0(Properties.java:353)
at java.util.Properties.load(Properties.java:341)
at NewApp.main(NewApp.java:10)
这是怎么回事呢?这是因为classloader每次会去classpath这些路径搜索需要装载的文件。如果不在这些路径下,则会报找不到文件的错误信息。所以说,只要我们将配置文件放在classpath的路径下,我们就可以保证它会被装载进来,而且程序就不会被改动了。这样就带来了一定的灵活性。比如说前面这个示例,如果我们将properties放到当前目录的config子目录下,该怎么装载它呢?
我们需要指定这个路径为classpath就可以了,所以我们运行如下的命令:
java -cp c:samplecodeconfig; NewApp
我们将看到正常运行的结果。这里我们是将代码放在c:samplecode这个路径下。仔细看看这种classloader装载的方法,其实它只是在一个指定的范围内来查找目标文件。我们在不同的环境下部署安装的时候则不需要去修改程序或给特定程序部分传参数来。我们只需要将需要加载的配置项文件配置到classpath中就可以。
当然,除了classloader这种装载properties的方式,还有其他几种具体的方法,比如class.getResourceAsStream(), ResourceBundle.getBundle()等几种方法,他们的本质上和classloader的方式都差不多。
classpath的作用
前面几个地方也一直提到classpath,那么这个classpath有什么作用呢?在哪些地方我们要用到它?这里也一并讨论一下。
我们通常写的一些简单的程序,比如说只是通过console显示结果的,很可能没有留意到classpath的作用。它是指定class所在路径的。在一些需要引用到其他类库的情况下,我们需要这些类库所在的具体位置,比如说我们把一个jar包放在一个lib的文件夹下面了,我们希望程序编译或者执行的时候要能够引用到它。可是java怎么知道引用它呢?这就是classpath的作用了。java虚拟机通过搜索指定的classpath路径变量,它会在这些路径里搜索和尝试装载这些需要的类库。如果能够装载成功则可以保证程序的正常运行,否则会产生错误。
所以说,classpath说白了就是一个指定类所在位置的路径以使得jvm可以识别和装载它们。
总结
操作properties文件的方式有好几种,考虑到properties文件主要是用于针对不同环境进行特定配置的,所以我们必须要保证用一种灵活的方式来加载它。使用classloader等加载的话不需要修改程序,只是需要在部署的时候针对特定环境配置好classpath就可以了。
参考材料