Как хранить настройки java программ?

Этот вопрос задает себе каждый разработчик любого серьезного приложения. Классическим решением этой задачи является использование класса Properties. Этот класс поддерживает коллекции свойств (properties) вида ключ/значение, где ключи и значения являются строками. Наличие методов сохранения и чтения коллекций в файлах, упрощает организацию физического хранения данных. Несмотря на удобство и простоту использования данного класса хочется обратить ваше внимание, что класс Properties является наследником устаревшего класса Hashtable [1]. Именно по этому рекомендуется использовать класс HashMap, который является аналогом Hashtable.

Для доступа к настройкам программы создадим класс AppSettings. Причем в блоке инициализации статических членов класса будет вызываться private конструктор данного класса. При этом создается единственный экземпляр данного объекта в статическую переменную SINGLETON при первом вызове из основного кода программы. Код, реализующий эту методику имеет вид:

public class AppSettings {
  private AppSettings() {
    fHashMap = new HashMap();
  }
  . . .

  private HashMap fHashMap;
  private static AppSettings SINGLETON;
  static {
    SINGLETON = new AppSettings();
  }
}

Таким образом к единственному экземпляру данного класса можно получить доступ из любого модуля программы, что напоминает глобальные переменные в других языках программирования. Коллекция HashMap позволяет хранить различные объекты, но мы пока ограничимся только строковыми. Методы доступа к данным могут иметь вид:

// Извлечение объекта из коллекции
public static Object get(String key) {
  return SINGLETON.fHashMap.get(key);
}

// Извлечение объекта из коллекции
// при отсутствии данных возвращается значение по умолчанию
public static Object get(String key, Object deflt) {
  Object obj = SINGLETON.fHashMap.get(key);
  if (obj == null) {
    return deflt;
  } else {
    return obj;
  }
}

// Для упрощения извлечения данных типа int
public static int getInt(String key, int deflt) {
  Object obj = SINGLETON.fHashMap.get(key);
  if (obj == null) {
    return deflt;
  } else {
    return new Integer((String) obj).intValue();
  }
}

// Добавление объекта в коллекцию
public static void put(String key, Object data) {
  //prevent null values. Hasmap allow them
  if (data == null) {
    throw new IllegalArgumentException();
  } else {
    SINGLETON.fHashMap.put(key, data);
  }
}

Раз уж мы отказались от использования класса Properties, то изменим формат хранения объектов коллекции на более прогрессивный xml формат. Структура xml файла будет иметь вид:

319
  424
  com.sun.java.swing.plaf.motif.MotifLookAndFeel

Данная структура позволит нам в будущем хранить не только значения вида ключ/значение, но и другие типы объектов. Пока же, мы ограничимся строками, аналогично классу Properties. Код построения DOM дерева заданной структуры и трансформации в xml файл будет иметь вид:

public static boolean save(File file) throws Exception {
  // Создаем новое DOM дерево
  DOMImplementation domImpl = new DOMImplementationImpl();
  Document doc = domImpl.createDocument(null, "app-settings", null);
  Element root = doc.getDocumentElement();
  Element propertiesElement = doc.createElement("properties");
  root.appendChild(propertiesElement);
  Set set = SINGLETON.fHashMap.keySet();
  if (set != null) {
    for (Iterator iterator = set.iterator(); iterator.hasNext(); ) {
      String key = iterator.next().toString();
      Element propertyElement = doc.createElement("property");
      propertyElement.setAttribute("key", key);
      Text nameText = doc.createTextNode(get(key).toString());
      propertyElement.appendChild((Node) nameText);
      propertiesElement.appendChild(propertyElement);
    }
  }
  // Сериализируем DOM дерево в файл
  DOMSerializer serializer = new DOMSerializer();
  serializer.serialize(doc, file);
  return true;
}

Класс сериализации DOM дерева позаимствован в [2]. Для обратной операции чтения данных в коллекцию создадим следующий метод:

public static boolean load(File file) throws Exception {
  DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
  DocumentBuilder builder = factory.newDocumentBuilder();
  Document doc = builder.parse(file);
  if (doc == null) {
    throw new NullPointerException();
  }
  NodeList propertiesNL = doc.getDocumentElement().getChildNodes();
  if (propertiesNL != null) {
    for (int i = 0; (i < propertiesNL.getLength()); i++) {
      if (propertiesNL.item(i).getNodeName().equals("properties")) {
        NodeList propertyList = propertiesNL.item(i).getChildNodes();
        for (int j = 0; j < propertyList.getLength(); j++) {
          NamedNodeMap attributes = propertyList.item(j).getAttributes();
          if (attributes != null) {
            Node n = attributes.getNamedItem("key");
            NodeList childs = propertyList.item(j).getChildNodes();
            if (childs != null) {
              for (int k = 0; k < childs.getLength(); k++) {
                if (childs.item(k).getNodeType() == Node.TEXT_NODE) {
                  put(n.getNodeValue(), childs.item(k).getNodeValue());
                }
              }
            }
          }
        }
      }
    }
    return true;
  } else {
    return false;
  }
}

А пример вызова методов класса AppSettings в теле программы, показан в следующем участке кода:

File file = new File(propDir, "settings.xml");
try {
  AppSettings.clear();
  AppSettings.load(file);
  String lnfName = UIManager.getLookAndFeel().getClass().getName();
  if (AppSettings.get(LF_KEY, lnfName) != lnfName) {
    UIManager.setLookAndFeel(
    (String) AppSettings.get(LF_KEY, lnfName));
    SwingUtilities.updateComponentTreeUI(MainFrame.this);
  }

  this.setSize(new Dimension(
  AppSettings.getInt(WIDTH_KEY, getWidth()),
  AppSettings.getInt(HEIGHT_KEY, getHeight())
  ));
} catch (Exception e) {
  e.printStackTrace();
}

Как видно из приведенного кода, все достаточно тривиально. Просто вызываем нужный метод класса AppSettings создавать экземпляр которого не требуется. Можно реализовать еще пару методов для извлечения часто используемых типов данных для удобства использования, например getString().

Код демонстрационного проекта приведен в appsettingsdemo.zip.

Литература:

1. Арнольд Кен, Гослинг Джеймс, Холмс Дэвид. “Язык программирования Java”. Пер. С англ. - М.: Издательский дом “Вилиамс”, 2001. - 624 с. ISBN 5-8459-0215-0 (рус.)
2. Brett McLaughlin “Java& XML, 2nd Edition”Publisher: O'Reilly. Second Edition September 2001. ISBN: 0-596-00197-5, 528 pages