外部化 DEFAULT 配置属性

Question

很多项目都在使用配置文件和 我发现了很多帖子如何阅读此配置文件，如何将它们外部化，但我找不到有关如何生成示例配置文件的任何信息。

例如，如果您有一个包含各种配置属性的 company.config 文件，我希望自动生成一个 company.sample.config 文件每次构建项目时从我的源代码中获取。此示例文件应包含项目使用的所有配置属性，以及默认值和 cmets。

我使用 Java 和 Gradle，所以我正在考虑一个 Gradle 插件。

那里有这样的东西吗？其他人是如何解决这个问题的？

---

稍后编辑：一些例子：

---

public class CompanyConfig {
private static final String PROPERTY1_DEFAULT = "Company.property1_default";
private static final String PROPERTY2_DEFAULT = "Company.property2_default";

/**
 * description 1
 */
private static final String PROPERTY1 = "Company.property1";
/**
 * description 2
 */
private static final String PROPERTY2 = "Company.property2";

private Config config;

public CompanyConfig(Config config) {
    this.config = config;
}

public String getProperty1() {
    return config.getProperty(PROPERTY1, PROPERTY1_DEFAULT);
}

public String getProperty2() {
    return config.getProperty(PROPERTY2, PROPERTY2_DEFAULT);
}
}

根据上述代码，sample.conf 文件应如下所示：

**description 1
*Company.property1=Company.property1_default

**description 2
*Company.property2=Company.property2_default

这样，我可以把sample.conf文件交给想配置项目的人。这个人不知道我项目中的配置属性，所以他/她需要一个属性列表和每个属性的默认值。而且由于引入了新的人员并删除了其他一些人员，因此必须在每次构建时生成示例文件。

希望这能澄清我在这里问的问题。

Answer 1

您可以借助 ant 构建脚本。参考下面的代码。

<project>
<target name="default">



<propertyfile file="company.sample.config" comment="sample properties here.">

<entry key="program.AUTHOR" default="RAIS" />
<entry key="program.COMPANY" default="IGT" />
<entry key="program.COPYRIGHT" default="now" type="date" pattern="yyyy" />
<entry key="program.DESCRIPTION" default="" />
<entry key="program.VERSION" default="1.0.0" />
<entry key="program.BUILDNUM" value="1" />
<entry key="program.BUILDDATE" type="date" value="now" pattern="yyyyMMDDHHmmss" />
</propertyfile>

</target>
</project>

Answer 2

我不知道有什么插件可以做到这一点，但如果你有一个不错的配置系统，那么它应该不难做到。例如，我使用基于 JSON 的配置系统：配置文件是一个简单的 JSON 文档，它直接映射到配置对象。要生成具有默认值的示例配置，您只需实例化基础对象并要求 JSON 将其写出，这是一个五行程序，可以轻松添加到构建脚本中。