Gradle修改属性文件时如何保持原有属性顺序？

这个问题的核心在于Java标准库中的Properties类本质上是基于哈希表（Hashtable）实现的，它并不会保留属性在文件中的原始顺序。要解决这个问题，我们需要改用有序的属性存储实现，以下是不需要额外依赖的最优方案：

方案：自定义有序属性类 #

我们可以创建一个继承自Properties的子类，重写它的初始化方法，将底层存储替换为LinkedHashMap——这个集合类会维护键值对的插入顺序，正好符合我们保留原始属性顺序的需求。

修改后的完整任务代码如下：

task addVersion {
    // 定义有序属性类，基于LinkedHashMap维护属性顺序
    class OrderedProperties extends Properties {
        @Override
        protected void init(int initialCapacity) {
            this.table = new LinkedHashMap<>(initialCapacity)
        }
    }

    File configPropFile = file(configFilePath)
    def configProperties = new OrderedProperties()
    configProperties.load(configPropFile.newDataInputStream())
    
    def versions = configProperties.getProperty('product.versions')
    if (!versions.contains("1.2")) {
        configProperties.setProperty('product.versions', versions + ',' + "1.2")
    }
    
    // 存储时指定UTF-8编码，避免默认编码导致的乱码问题（可选但推荐）
    configProperties.store(new OutputStreamWriter(new FileOutputStream(configPropFile), "UTF-8"), null)
}

关键说明 #

1. 有序存储原理：LinkedHashMap会记录每个键值对的插入顺序，替换Properties默认的Hashtable后，读取文件时的属性顺序会被完整保留，修改后写入文件也会维持这个顺序。
2. 编码优化：原代码中直接使用configPropFile.newWriter()会依赖系统默认编码，可能导致乱码。改用OutputStreamWriter指定UTF-8编码是更健壮的做法。

如果你的项目已经引入了Apache Commons Configuration库，也可以直接使用org.apache.commons.configuration2.PropertiesConfiguration（它默认就是有序的），但上面的自定义类方案不需要额外依赖，更轻量。

内容的提问来源于stack exchange，提问作者user1731553