java使用ini4j读写和修改ini配置文件(支持section)

定义:ini文件主要由三部分构成,paramaters、section和comment组成,其中paramaters由键值对构成,用来存储数据,section是一个区块,每个区块下有所属的键值对,comment是注释,对paramaters和section进行标注和解释。

使用工具类ini4j

  • 引入依赖jar包
<dependency>
    <groupId>org.ini4jgroupId>
    <artifactId>ini4jartifactId>
    <version>0.5.4version>
dependency>
  • 创建.ini文件的实例对象(可有可无,我这是为了测试方便)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class IniFileEntity {
    private String section;
    private String key;
    private String value;
}
  • 创建.ini文件
//我把这个写在了工具类里面(Ini4jUtils)
public static boolean creatIniFile(String filePath,List<IniFileEntity> filecontent) throws IOException {
    File file = new File(filePath);
    if(file.exists()){
        return false;
    }
    file.createNewFile();
    Ini ini = new Ini();
    ini.load(file);

    //将文件内容保存到ini对象中
    filecontent.stream().forEach((entity)->{
        ini.add(entity.getSection(),entity.getKey(),entity.getValue()== null ? "": entity.getValue());
    });
    //将文件内容保存到文件中
    ini.store(file);
    return true;
}
//  测试
@Test
public void test(){
    List<IniFileEntity> list = Arrays.asList(new IniFileEntity("ldap","ip","1.1.1.1"),
                                             new IniFileEntity("ldap","ipPort","8567"),
                                             new IniFileEntity("test","isUsed","true"));
    System.out.println(Ini4jUtils.creatIniFile("D:\\abc\\test.ini",list));
}

java使用ini4j读写和修改ini配置文件(支持section)_第1张图片

  • 读取.ini文件
/**
 * 存储文件中的内容
 */
@Data
public class Ini4jFileVo {
    private String ip;
    private String ipPort;
    private String isUsed;
}

/**
* 读取ini文件的内容
* @param iniFile ini文件
* @param fileContent ini文件中的key对应文件中的section,value对应i你文件section下的一个或多个key值
* @return
* @throws IOException
* @throws NoSuchFieldException
* @throws IllegalAccessException
*/
public static Ini4jFileVo readIniFile(File iniFile, Map<String,List<String>> fileContent) throws IOException, NoSuchFieldException, IllegalAccessException {
    Ini4jFileVo fileVo = new Ini4jFileVo();
    Ini ini = new Ini();
    ini.load(iniFile);
    Section section = null;
    Field field = null;
    for(String key : fileContent.keySet()){
        section = ini.get(key);
        for (String value: fileContent.get(key)) {
            field = fileVo.getClass().getDeclaredField(value);
            field.setAccessible(true);
            field.set(fileVo, section.get(value));
        }
    }

    /**
      * 这个是简略版的
      *    Section section = ini.get("ldap");
      *  fileVo.setIp(section.get("ip"));
      *   fileVo.setIpPort(section.get("port" ));
      *
      *  section = ini.get("test");
      *   fileVo.setIsUsed(section.get("isUsed"));
      */
    return fileVo;
}

//测试
@Test
public void testReadFile(){
    File file = new File("D:\\abc\\test.ini");
    Map<String,List<String>> fileContent = new HashMap<>();
    fileContent.put("ldap",Arrays.asList("ip","ipPort"));
    fileContent.put("test",Arrays.asList("isUsed"));
    Ini4jFileVo fileVo = Ini4jUtils.readIniFile(file,fileContent);
    System.out.println(fileVo);
}

//打印结果----Ini4jFileVo(ip=1.1.1.1, ipPort=8567, isUsed=true)
  • 修改.ini文件
/**
* 修改文件内容
* @param iniFile ini文件
* @param updateData 更新的数据
* @throws IOException
*/
public static void updateIniFile(File iniFile,Map<String,Map<String,String>> updateData) throws IOException {
    Ini ini = new Ini();
    ini.load(iniFile);
    Section section = null;
    Map<String,String> dataMap = null;
    for (String sect : updateData.keySet()){
        section = ini.get(sect);
        dataMap = updateData.get(sect);
        for (String key : dataMap.keySet()){
            section.put(key,dataMap.get(key) == null ? "" :
            dataMap.get(key));
        }
    }
    ini.store(iniFile);
}

@Test
public void testUpdateFile(){
    //修改
    File file = new File("D:\\abc\\test.ini");
    Map<String,Map<String,String>> updateData = new HashMap<>();
    Map<String,String> ldap = new
    HashMap<>();
    ldap.put("ip","8.8.8.8");
    updateData.put("ldap",ldap);
    Ini4jUtils.updateIniFile(file,updateData);


    Map<String,List<String>> fileContent = new HashMap<>();
    fileContent.put("ldap",Arrays.asList("ip","ipPort"));
    fileContent.put("test",Arrays.asList("isUsed"));
    Ini4jFileVo fileVo = Ini4jUtils.readIniFile(file,fileContent);
    System.out.println(fileVo);
}

//测试结果----Ini4jFileVo(ip=8.8.8.8, ipPort=8567, isUsed=true)

注意:

ini4j这个jar包对\、=做了转义处理,如果其他框架调用这个生成的文件可能会出现奇怪的问题,这个是我在开发的时候遇到的bug

你可能感兴趣的:(java)