Cách dễ nhất để phân tích cú pháp tệp INI trong Java là gì?

Tôi đang viết một trình thay thế thả vào cho một ứng dụng cũ trong Java. Một trong những yêu cầu là các tệp ini mà ứng dụng cũ đã sử dụng phải được đọc nguyên trạng trong Ứng dụng Java mới. Định dạng của tệp ini này là kiểu cửa sổ phổ biến, với các phần tiêu đề và cặp key = value, sử dụng # làm ký tự để nhận xét.

Tôi đã thử sử dụng lớp Thuộc tính từ Java, nhưng tất nhiên điều đó sẽ không hoạt động nếu có xung đột tên giữa các tiêu đề khác nhau.

Vì vậy, câu hỏi là, cách dễ nhất để đọc tệp INI này và truy cập các khóa là gì?

Thư viện tôi đã sử dụng là ini4j . Nó nhẹ và phân tích cú pháp các tệp ini một cách dễ dàng. Ngoài ra, nó không sử dụng phụ thuộc bí truyền cho 10.000 tệp jar khác, vì một trong những mục tiêu thiết kế là chỉ sử dụng API Java tiêu chuẩn

Đây là một ví dụ về cách sử dụng thư viện:

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

Như đã đề cập , ini4j có thể được sử dụng để đạt được điều này. Hãy để tôi đưa ra một ví dụ khác.

Nếu chúng ta có tệp INI như thế này:

[header]
key = value

Thông tin sau sẽ hiển thị valuethành STDOUT:

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

Kiểm tra các hướng dẫn để biết thêm ví dụ.

Đơn giản như 80 dòng:

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

Dưới đây là một ví dụ đơn giản nhưng mạnh mẽ, sử dụng cấu hình HierarchicalINIConfiguration của lớp apache :

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

Cấu hình Commons có một số phụ thuộc thời gian chạy . Ở mức tối thiểu, ghi nhật ký commons-lang và commons là bắt buộc. Tùy thuộc vào những gì bạn đang làm với nó, bạn có thể yêu cầu các thư viện bổ sung (xem liên kết trước để biết chi tiết).

Hoặc với API Java tiêu chuẩn, bạn có thể sử dụng java.util .

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

Trong 18 dòng, mở rộng java.util.Propertiesđể phân tích cú pháp thành nhiều phần:

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

Một tùy chọn khác là Apache Commons Config cũng có một lớp để tải từ các tệp INI . Nó có một số phụ thuộc thời gian chạy , nhưng đối với các tệp INI, nó chỉ yêu cầu bộ sưu tập Commons, lang và ghi nhật ký.

Tôi đã sử dụng Commons Config trên các dự án có thuộc tính và cấu hình XML của chúng. Nó rất dễ sử dụng và hỗ trợ một số tính năng khá mạnh mẽ.

Bạn có thể thử JINIFile. Là bản dịch của TIniFile từ Delphi, nhưng dành cho java

https://github.com/SubZane/JIniFile

Cá nhân tôi thích Nho giáo hơn .

Nó rất hay, vì nó không yêu cầu bất kỳ phụ thuộc bên ngoài nào, nó rất nhỏ - chỉ 16K và tự động tải tệp ini của bạn khi khởi tạo. Ví dụ

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

Giải pháp của hoat4 rất thanh lịch và đơn giản. Nó hoạt động cho tất cả các tệp ini lành mạnh . Tuy nhiên, tôi đã thấy nhiều có ký tự khoảng trắng chưa thoát trong khóa .
Để giải quyết vấn đề này, tôi đã tải xuống và sửa đổi một bản sao của java.util.Properties. Mặc dù đây là một chút không chính thống và ngắn hạn, các bản mod thực tế chỉ có một vài dòng và khá đơn giản. Tôi sẽ đưa ra một đề xuất cho cộng đồng JDK để bao gồm các thay đổi.

Bằng cách thêm một biến lớp bên trong:

private boolean _spaceCharOn = false;

Tôi kiểm soát quá trình xử lý liên quan đến việc quét tìm điểm phân tách khóa / giá trị. Tôi đã thay thế mã tìm kiếm ký tự khoảng trắng bằng một phương thức private nhỏ trả về boolean tùy thuộc vào trạng thái của biến trên.

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

Phương pháp này được sử dụng ở hai nơi trong phương thức private load0(...).
Cũng có một phương pháp công khai để bật tính năng này, nhưng sẽ tốt hơn nếu sử dụng phiên bản gốc của Propertiesnếu dấu phân cách không gian không phải là vấn đề đối với ứng dụng của bạn.

Nếu có hứng thú, tôi sẵn sàng đăng mã vào IniFile.javatệp của mình . Nó hoạt động với một trong hai phiên bản của Properties.

Sử dụng câu trả lời của @Aerospace, tôi nhận ra rằng các tệp INI có các phần không có bất kỳ khóa-giá trị nào là hợp pháp. Trong trường hợp này, việc bổ sung vào bản đồ cấp cao nhất sẽ xảy ra trước khi tìm thấy bất kỳ khóa-giá trị nào, ví dụ: (được cập nhật tối thiểu cho 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);
            }

Nó chỉ đơn giản như thế này .....

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