一个简单的不能再简单的配置管理工具类

在正式的项目编码过程中，一个成熟的程序员是不会允许出现任何hard code即硬编码的字符的。比如“user.name”、“user.password”等等。所有的这些配置项，都需要通过配置文件进行配置，然后从配置文件取值。这也是我们通常说的配置读写分离。

当然我一开始入行的时候，也是直接在代码中写死所有的值，这样的写法可维护性太差了。后来也是通过不断的学习总结出这样的一个工具类，当然我们也知道像spring这么优秀的框架，早就集成了读取配置文件配置项的注解，在类成员上直接写上@Value即可取到值。在这里我们暂且不说，而是自己从头到尾写一个这样的工具类。

配置管理组件可以复杂，也可以很简单，对于简单的配置管理组件来说，只需要开发一个类，在第一次访问它的时候，就从对应的properties文件读取配置项，并提供外界获取某个配置key对应的value方法。如果是特别复杂的配置管理组件，那么可能需要使用一些软件设计中的设计模式，比如单例模式。可能需要管理多个不同的properties，甚至是xml类型的配置文件。我们今天就写一个简单的配置管理工具类即可，下面让我们直接开始编码吧。

/**
 * 配置管理组件<br>
 * 
 * @author Administrator
 *
 */
public class ConfigurationManager {

  private static Properties prop = new Properties();

  /**
   * 静态代码块<br>
   * 
   * Java中，每一个类第一次使用的时候，就会被Java虚拟机（JVM）中的类加载器，去从磁盘上的.class文件中<br>
   * 加载出来，然后为每个类都会构建一个Class对象，就代表了这个类。<br>
   * 
   * 每个类在第一次加载的时候，都会进行自身的初始化，那么类初始化的时候，会执行哪些操作的呢？<br>
   * 就由每个类内部的static {}构成的静态代码块决定，我们自己可以在类中开发静态代码块<br>
   * 类第一次使用的时候，就会加载，加载的时候，就会初始化类，初始化类的时候就会执行类的静态代码块<br>
   * 
   * 因此，对于我们的配置管理组件，就在静态代码块中，编写读取配置文件的代码<br>
   * 这样的话，第一次外界代码调用这个ConfigurationManager类的静态方法的时候，就会加载配置文件中的数据<br>
   * 
   * 而且，放在静态代码块中，还有一个好处，就是类的初始化在整个JVM生命周期内，有且仅有一次，也就是说<br>
   * 配置文件只会加载一次，然后以后就是重复使用，效率比较高；不用反复加载多次<br>
   */
  static {
    try {
      // 通过一个“类名.class”的方式，就可以获取到这个类在JVM中对应的Class对象
      // 然后再通过这个Class对象的getClassLoader()方法，就可以获取到当初加载这个类的JVM
      // 中的类加载器（ClassLoader），然后调用ClassLoader的getResourceAsStream()这个方法
      // 就可以用类加载器去加载类加载路径中的指定的文件
      // 最终可以获取到一个针对指定文件的输入流（InputStream）
      InputStream in = ConfigurationManager.class.getClassLoader()
          .getResourceAsStream("my.properties");

      // 调用Properties的load()方法，给它传入一个文件的InputStream输入流
      // 即可将文件中的符合“key=value”格式的配置项，都加载到Properties对象中
      // 加载过后，此时，Properties对象中就有了配置文件中所有的key-value对了
      // 然后外界其实就可以通过Properties对象获取指定key对应的value
      prop.load(in);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * 获取指定key对应的value<br>
   * 
   * <p>
   * 第一次外界代码，调用ConfigurationManager类的getProperty静态方法时，JVM内部会发现
   * ConfigurationManager类还不在JVM的内存中。<br>
   * 
   * <p>
   * 此时JVM，就会使用自己的ClassLoader（类加载器），去对应的类所在的磁盘文件（.class文件）中
   * 去加载ConfigurationManager类，到JVM内存中来，并根据类内部的信息，去创建一个Class对象
   * Class对象中，就包含了类的元信息，包括类有哪些field（Properties prop）；有哪些方法（getProperty）。<br>
   * 
   * <p>
   * 加载ConfigurationManager类的时候，还会初始化这个类，那么此时就执行类的static静态代码块
   * 此时咱们自己编写的静态代码块中的代码，就会加载my.properites文件的内容，到Properties对象中来。<br>
   * 
   * <p>
   * 下一次外界代码，再调用ConfigurationManager的getProperty()方法时，就不会再次加载类，不会再次初始化
   * 类，和执行静态代码块了，所以也印证了，我们上面所说的，类只会加载一次，配置文件也仅仅会加载一次。<br>
   * 
   * @param key
   * @return value
   */
  public static String getProperty(String key) {
    return prop.getProperty(key);
  }

  /**
   * 获取整数类型的配置项
   * 
   * @param key
   * @return value
   */
  public static Integer getInteger(String key) {
    String value = getProperty(key);
    try {
      return Integer.valueOf(value);
    } catch (Exception e) {
      e.printStackTrace();
    }
    return 0;
  }

  /**
   * 获取布尔类型的配置项
   * 
   * @param key
   * @return value
   */
  public static Boolean getBoolean(String key) {
    String value = getProperty(key);
    try {
      return Boolean.valueOf(value);
    } catch (Exception e) {
      e.printStackTrace();
    }
    return false;
  }

  /**
   * 获取Long类型的配置项
   * 
   * @param key
   * @return
   */
  public static Long getLong(String key) {
    String value = getProperty(key);
    try {
      return Long.valueOf(value);
    } catch (Exception e) {
      e.printStackTrace();
    }
    return 0L;
  }

}

如上，我们写了一个简单的工具类，在类第一次使用初始化的时候去读取classpath下的my.properties文件并加载文件中的数据。下面我们在classpath下创建my.properties文件，并使用key=value形式写两个测试数据。

test.key.1=testKey1
test.key.2=testKey2

接下来，我们做个简单的测试。

public class ConfigurationManagerTest {

  public static void main(String[] args) {
    System.out.println("test.key.1=" + ConfigurationManager.getProperty("test.key.1"));
    System.out.println("test.key.2=" + ConfigurationManager.getProperty("test.key.2"));
  }
}

// 控制台输出
test.key.1=testKey1
test.key.2=testKey2