Каков самый простой способ разобрать файл INI на Java?

Я пишу замену устаревшему приложению на Java. Одно из требований состоит в том, что файлы ini, которые использовало старое приложение, должны читаться как есть в новом приложении Java. Формат этих файлов ini является обычным стилем Windows, с разделами заголовка и парами ключ = значение, используя # в качестве символа для комментариев.

Я пробовал использовать класс Properties из Java, но, конечно, это не сработает, если между разными заголовками есть конфликты имен.

Итак, вопрос в том, как проще всего прочитать этот INI-файл и получить доступ к ключам?

Я использовал библиотеку ini4j . Он легкий и с легкостью анализирует файлы ini. Кроме того, он не использует эзотерических зависимостей с 10 000 других файлов jar, поскольку одной из целей дизайна было использование только стандартного API Java.

Это пример использования библиотеки:

Ini ini = new Ini(new File(filename));
java.util.prefs.Preferences prefs = new IniPreferences(ini);
System.out.println("grumpy/homePage: " + prefs.node("grumpy").get("homePage", null));

Как уже упоминалось , для этого можно использовать ini4j . Приведу еще один пример.

Если у нас есть такой INI-файл:

[header]
key = value

В valueSTDOUT должно отображаться следующее :

Ini ini = new Ini(new File("/path/to/file"));
System.out.println(ini.get("header", "key"));

Проверьте учебники для большего количества примеров.

Всего 80 строк:

package windows.prefs;

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class IniFile {

   private Pattern  _section  = Pattern.compile( "\\s*\\[([^]]*)\\]\\s*" );
   private Pattern  _keyValue = Pattern.compile( "\\s*([^=]*)=(.*)" );
   private Map< String,
      Map< String,
         String >>  _entries  = new HashMap<>();

   public IniFile( String path ) throws IOException {
      load( path );
   }

   public void load( String path ) throws IOException {
      try( BufferedReader br = new BufferedReader( new FileReader( path ))) {
         String line;
         String section = null;
         while(( line = br.readLine()) != null ) {
            Matcher m = _section.matcher( line );
            if( m.matches()) {
               section = m.group( 1 ).trim();
            }
            else if( section != null ) {
               m = _keyValue.matcher( line );
               if( m.matches()) {
                  String key   = m.group( 1 ).trim();
                  String value = m.group( 2 ).trim();
                  Map< String, String > kv = _entries.get( section );
                  if( kv == null ) {
                     _entries.put( section, kv = new HashMap<>());   
                  }
                  kv.put( key, value );
               }
            }
         }
      }
   }

   public String getString( String section, String key, String defaultvalue ) {
      Map< String, String > kv = _entries.get( section );
      if( kv == null ) {
         return defaultvalue;
      }
      return kv.get( key );
   }

   public int getInt( String section, String key, int defaultvalue ) {
      Map< String, String > kv = _entries.get( section );
      if( kv == null ) {
         return defaultvalue;
      }
      return Integer.parseInt( kv.get( key ));
   }

   public float getFloat( String section, String key, float defaultvalue ) {
      Map< String, String > kv = _entries.get( section );
      if( kv == null ) {
         return defaultvalue;
      }
      return Float.parseFloat( kv.get( key ));
   }

   public double getDouble( String section, String key, double defaultvalue ) {
      Map< String, String > kv = _entries.get( section );
      if( kv == null ) {
         return defaultvalue;
      }
      return Double.parseDouble( kv.get( key ));
   }
}

Вот простой, но мощный пример использования класса apache HierarchicalINIConfiguration :

HierarchicalINIConfiguration iniConfObj = new HierarchicalINIConfiguration(iniFile); 

// Get Section names in ini file     
Set setOfSections = iniConfObj.getSections();
Iterator sectionNames = setOfSections.iterator();

while(sectionNames.hasNext()){

 String sectionName = sectionNames.next().toString();

 SubnodeConfiguration sObj = iniObj.getSection(sectionName);
 Iterator it1 =   sObj.getKeys();

    while (it1.hasNext()) {
    // Get element
    Object key = it1.next();
    System.out.print("Key " + key.toString() +  " Value " +  
                     sObj.getString(key.toString()) + "\n");
}

Конфигурация Commons имеет ряд зависимостей во время выполнения . Как минимум, требуются commons-lang и commons-logging . В зависимости от того, что вы с ним делаете, вам могут потребоваться дополнительные библиотеки (подробности см. В предыдущей ссылке).

Или со стандартным API Java вы можете использовать java.util.Properties :

Properties props = new Properties();
try (FileInputStream in = new FileInputStream(path)) {
    props.load(in);
}

В 18 строках расширение java.util.Propertiesдля разбора на несколько разделов:

public static Map<String, Properties> parseINI(Reader reader) throws IOException {
    Map<String, Properties> result = new HashMap();
    new Properties() {

        private Properties section;

        @Override
        public Object put(Object key, Object value) {
            String header = (((String) key) + " " + value).trim();
            if (header.startsWith("[") && header.endsWith("]"))
                return result.put(header.substring(1, header.length() - 1), 
                        section = new Properties());
            else
                return section.put(key, value);
        }

    }.load(reader);
    return result;
}

Другой вариант - Apache Commons Config также имеет класс для загрузки из файлов INI . У него есть некоторые зависимости во время выполнения , но для файлов INI он должен требовать только коллекции Commons, язык и ведение журнала.

Я использовал Commons Config для проектов с их свойствами и конфигурациями XML. Он очень прост в использовании и поддерживает несколько довольно мощных функций.

Вы можете попробовать JINIFile. Это перевод TIniFile из Delphi, но для java

https://github.com/SubZane/JIniFile

Лично я предпочитаю Confucious .

Это приятно, поскольку не требует никаких внешних зависимостей, он крошечный - всего 16 КБ и автоматически загружает ваш ini-файл при инициализации. Например

Configurable config = Configuration.getInstance();  
String host = config.getStringValue("host");   
int port = config.getIntValue("port"); 
new Connection(host, port);

Решение hoat4 очень элегантно и просто. Он работает для всех нормальных ini-файлов. Однако я встречал многих, у которых в ключе присутствовали неэкранированные пробелы .
Чтобы решить эту проблему, я загрузил и изменил копию java.util.Properties. Хотя это немного неортодоксально и краткосрочно, на самом деле модификации состояли из нескольких строк и были довольно простыми. Я внесу предложение сообществу JDK о внесении изменений.

Добавив внутреннюю переменную класса:

private boolean _spaceCharOn = false;

Я контролирую обработку, связанную со сканированием точки разделения ключ / значение. Я заменил код поиска пробелов небольшим частным методом, который возвращает логическое значение в зависимости от состояния указанной выше переменной.

private boolean isSpaceSeparator(char c) {
    if (_spaceCharOn) {
        return (c == ' ' || c == '\t' || c == '\f');
    } else {
        return (c == '\t' || c == '\f');
    }
}

Этот метод используется в двух местах частного метода load0(...).
Существует также общедоступный метод для его включения, но было бы лучше использовать исходную версию, Propertiesесли разделитель пробелов не является проблемой для вашего приложения.

Если есть интерес, я готов выложить код в свой IniFile.javaфайл. Он работает с любой версией Properties.

Используя ответ @Aerospace, я понял, что для файлов INI законно иметь разделы без каких-либо ключей и значений. В этом случае добавление к карте верхнего уровня должно произойти до того, как будут найдены какие-либо пары "ключ-значение", например (минимально обновлено для Java 8):

            Path location = ...;
            try (BufferedReader br = new BufferedReader(new FileReader(location.toFile()))) {
                String line;
                String section = null;
                while ((line = br.readLine()) != null) {
                    Matcher m = this.section.matcher(line);
                    if (m.matches()) {
                        section = m.group(1).trim();
                        entries.computeIfAbsent(section, k -> new HashMap<>());
                    } else if (section != null) {
                        m = keyValue.matcher(line);
                        if (m.matches()) {
                            String key = m.group(1).trim();
                            String value = m.group(2).trim();
                            entries.get(section).put(key, value);
                        }
                    }
                }
            } catch (IOException ex) {
                System.err.println("Failed to read and parse INI file '" + location + "', " + ex.getMessage());
                ex.printStackTrace(System.err);
            }

Это так просто ...

//import java.io.FileInputStream;
//import java.io.FileInputStream;

Properties prop = new Properties();
//c:\\myapp\\config.ini is the location of the ini file
//ini file should look like host=localhost
prop.load(new FileInputStream("c:\\myapp\\config.ini"));
String host = prop.getProperty("host");