在Java中解析INI文件的最简单方法是什么?

时间:2008-10-10 09:20:56

标签: java parsing ini

我正在为Java中的遗留应用程序编写替代品。其中一个要求是旧应用程序使用的ini文件必须按原样读入新的Java应用程序。此ini文件的格式是常见的Windows样式,带有标题部分和键=值对,使用#作为注释字符。

我尝试使用Java中的Properties类,但当然如果不同标题之间存在名称冲突,这将无效。

所以问题是,在这个INI文件中读取和访问密钥的最简单方法是什么?

13 个答案:

答案 0 :(得分:112)

我使用的库是ini4j。它很轻巧,可以轻松解析ini文件。此外,它不会对10,000个其他jar文件使用深奥的依赖,因为其中一个设计目标是仅使用标准Java API

这是关于如何使用库的示例:

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));

答案 1 :(得分:61)

作为mentionedini4j可用于实现此目的。让我再举一个例子。

如果我们有这样的INI文件:

[header]
key = value

以下内容应显示value到STDOUT:

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

查看the tutorials了解更多示例。

答案 2 :(得分:28)

简单到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 ));
   }
}

答案 3 :(得分:16)

这是一个简单但功能强大的示例,使用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 Configuration有一些runtime dependencies。至少需要commons-langcommons-logging。根据您正在使用的内容,您可能需要其他库(有关详细信息,请参阅上一个链接)。

答案 4 :(得分:12)

或者使用标准Java API,您可以使用java.util.Properties

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

答案 5 :(得分:8)

在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;
}

答案 6 :(得分:2)

另一个选项Apache Commons Config也有一个从INI files加载的类。它确实有一些runtime dependencies,但对于INI文件,它应该只需要Commons集合,lang和logging。

我在项目及其属性和XML配置上使用了Commons Config。它非常易于使用,并支持一些非常强大的功能。

答案 7 :(得分:2)

你可以试试JINIFile。是来自Delphi的TIniFile的翻译,但是对于java

https://github.com/SubZane/JIniFile

答案 8 :(得分:2)

我个人更喜欢Confucious

这很好,因为它不需要任何外部依赖,它很小 - 只有16K,并在初始化时自动加载你的ini文件。 E.g。

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

答案 9 :(得分:0)

hoat4 的解决方案非常优雅且简单。它适用于所有 sane ini文件。但是,我看到很多在 key 中具有转义空格字符的字符。
为了解决这个问题,我下载并修改了java.util.Properties的副本。虽然这有点不合常规,而且是短期的,但实际的mod只是几行而已,非常简单。我将向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的任何一个版本。

答案 10 :(得分:0)

使用@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);
            }

答案 11 :(得分:0)

您可以使用 ini4j 将 INI 转换为属性

    Properties properties = new Properties();
    Ini ini = new Ini(new File("path/to/file"));
    ini.forEach((header, map) -> {
      map.forEach((subKey, value) -> {
        StringBuilder key = new StringBuilder(header);
        key.append("." + subKey);
        properties.put(key.toString(), value);
      });
    });

答案 12 :(得分:-1)

就这么简单.....

//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");