วิธีที่ง่ายที่สุดในการแยกวิเคราะห์ไฟล์ INI ใน Java คืออะไร?

ฉันกำลังเขียนการแทนที่ดร็อปอินสำหรับแอปพลิเคชันเดิมใน Java ข้อกำหนดประการหนึ่งคือไฟล์ ini ที่แอปพลิเคชันรุ่นเก่าใช้จะต้องถูกอ่านใน Java Application ใหม่ รูปแบบของไฟล์ ini นี้เป็นรูปแบบ windows ทั่วไปโดยมีส่วนหัวและคู่คีย์ = ค่าโดยใช้ # เป็นอักขระในการแสดงความคิดเห็น

ฉันลองใช้คลาส Properties จาก Java แต่แน่นอนว่าจะใช้ไม่ได้หากมีการขัดแย้งของชื่อระหว่างส่วนหัวที่แตกต่างกัน

คำถามคืออะไรคือวิธีที่ง่ายที่สุดในการอ่านไฟล์ INI นี้และเข้าถึงคีย์

ห้องสมุดที่ผมเคยใช้เป็นini4j มีน้ำหนักเบาและแยกวิเคราะห์ไฟล์ ini ได้อย่างง่ายดาย นอกจากนี้ยังไม่ใช้การอ้างอิงที่เป็นความลับกับไฟล์ jar อื่น ๆ อีก 10,000 ไฟล์เนื่องจากหนึ่งในเป้าหมายการออกแบบคือการใช้ 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));

ในฐานะที่เป็นที่กล่าวถึง , ini4jสามารถนำมาใช้เพื่อให้บรรลุนี้ ให้ฉันดูอีกตัวอย่างหนึ่ง

หากเรามีไฟล์ INI เช่นนี้:

[header]
key = value

สิ่งต่อไปนี้ควรแสดงvalueเป็น STDOUT:

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 Configuration มีการอ้างอิงรันไทม์จำนวนหนึ่ง อย่างน้อยที่สุดจำเป็นต้องมีการบันทึกแบบcommons-langและcommons-logging คุณอาจต้องใช้ไลบรารีเพิ่มเติม (ดูลิงค์ก่อนหน้าสำหรับรายละเอียด) ทั้งนี้ขึ้นอยู่กับสิ่งที่คุณทำ

หรือด้วย Java API มาตรฐานคุณสามารถใช้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, lang และ logging เท่านั้น

ฉันใช้ Commons Config กับโปรเจ็กต์ที่มีคุณสมบัติและการกำหนดค่า XML มันใช้งานง่ายมากและรองรับคุณสมบัติที่ทรงพลังบางอย่าง

คุณสามารถลองใช้ JINIFile เป็นการแปล TIniFile จาก Delphi แต่สำหรับ java

https://github.com/SubZane/JIniFile

ผมเองชอบขงจื้อ

เป็นสิ่งที่ดีเนื่องจากไม่ต้องการการอ้างอิงภายนอกใด ๆ มันมีขนาดเล็กเพียง 16K และโหลดไฟล์ 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");