当有大量常量时，定义常量的正确方法是什么？

Question

我正在编写一些需要定义大量常量的代码。它主要处理Marketplace 常量（可能是美国、英国、印度、日本）和关联的MarketplaceMerchantMapping，它基本上将MerchantID 映射到MarketplaceID。

例如：

public enum Marketplace {

    US("US"),
    JP("JP"),
    UK("UK"),
    IN("IN"),
    NZ("NZ"),
    CA("CA"),
    FR("FR"),
    ... 
    ...

  // This could go up to some 400 marketplaces

    private final String stringValue;

    public boolean isWest() {
        return this == US || this == CA || this == UK;
    }

    public boolean isEast() {
        return this == IN || this == NZ || this == JP;
    }

}

public enum MarketplaceMerchantMapping {

    USMAP(MarketplaceID.US, MerchantID.US, Marketplace.US),
    JPMAP(MarketplaceID.JP, MerchantID.JP, Marketplace.JP),
    UKMAP(MarketplaceID.UK, MerchantID.UK, Marketplace.UK),
    NZMAP(MarketplaceID.NZ, MerchantID.NZ, Marketplace.NZ),
    INMAP(MarketplaceID.IN, MerchantID.IN, Marketplace.IN),
    CAMAP(MarketplaceID.CA, MerchantID.CA, Marketplace.CA),
    FRMAP(MarketplaceID.FR, MerchantID.FR, Marketplace.FR),
    ...
    ... 

   // THis can go up to 400 Marketplaces * Number of merchantIds in each marketplace.


}

还有其他类似的常量定义为枚举或静态常量。

这确实是不可扩展的，因为每次我们添加对新市场和商家的支持时，我们都需要更新大量文件并对其进行测试，而这些配置更改本身会占用大量开发人员时间。

理想情况下，我想知道是否有某种方法可以在某个配置文件中定义这些常量并读取这些文件以创建常量。有没有办法通过读取和解析一些配置文件来创建这样的枚举常量？

如果我有一个包含以下条目的配置文件：

配置文件.cfg：

WestMarketplaces = ("US", "AG", "MX", "CA", ...) // Expand this later as required
EastMarketplaces = ("IN", "AU", "SG", "JP", ...) // Expand this later as required
EUMarketplaces = ("UK", "FR", "SP", ...) // Expand this later as required

WestMerchantIds = ("WA", "WB", "WC", "WD", ...) // Expand this later as required
WestMerchantIds = ("EA", "EB", "EC", "WD", ...) // Expand this later as required
EUMerchantIds = ("EUA", "EUB", "EUC", "WDD", ...) // Expand this later as required

marketplaceMerchantMapping = {
  "US" = "WA";
  "CA" = "WB";
  "MX" = "WC";
  "AU" = "EA";
  "IN" = "EB";
  "JP" = "EC";
  "UK" = "EUA";
  "FR" = "EUB";
...
} // Expand this later as required

那么，它可以从配置文件中读取这些常量并构建适当的枚举或静态常量吗？

这可能吗？

Answer 1

枚举必须在编译时“已知”。所以只要你使用 Enums （我知道你因为类型安全、IDE 支持等原因愿意使用它们） 您必须编写它们，如果它们中有很多相互连接，这确实很乏味。

现在你要求的是（如果我理解正确的话）：

• 我想定义一个配置文件 (json/yaml) 随便
• 基于此文件，我需要创建“某物”以在运行时使用。

我在这里建议一种相当不普及的方法（至少根据我的经验），但这肯定有助于完成工作：

想法 1：如果它很乏味，为什么不自动化呢？

想法 2如果您喜欢使用枚举，为什么不创建枚举？

所以基本上我建议在构建时生成代码（并且生成枚举很简单，因为它们没有任何实际逻辑要完成）。

所以如果你决定走这条路，你需要做几件事：

• 确保在编译实际类之前完成代码生成，否则您将无法在类中使用自动生成的代码。

• 确保正确生成代码。现在在过去这是一个非常痛苦的过程，但现在有一个不错的小库，名为 Java Poet，它使代码生成变得非常简单。

• 确保此方法将与您的构建工具集成。例如，如果您使用 maven，请考虑创建一个 maven 插件，该插件将触发代码生成过程并将其保存在 target/generated-sources 中。然后将其附加到generated-sources 阶段（显然在compile 阶段之前运行），当Java 编译器开始编译您的类时，生成的源代码将无法区分。

为了给你一个例子，我可以向你推荐我最近为一个非常相似的问题做的一个宠物项目（如果这听起来像是一个自我广告，我很抱歉，我从来没有“推销自己”所以，我这样做是因为我真的相信从技术上讲，如果你决定走这条路，这会有所帮助，因为从技术上讲，它包含所有粘合在一起的部分）：

所以我的目标是自动化异常创建（可以说比枚举生成稍微复杂一些），就像你一样，我认为创建一些配置 yaml 文件是一个好主意，将有关异常的信息（traceIds ，消息，参数等）并让构建过程创建实际的Java异常代码。

源代码在 Github 上一个名为 Simplex（简单异常处理库）的项目中可用。它有 maven 插件供参考，使用 Java Poet 的生成器等。

Answer 2

当无法使用数据库时，维护良好 XLS 表可能是下一个最佳选择。连同经过良好测试的获取工作表数据的过程，以从中生成代码，或用作某种属性配置输入。

正如 OP 自己认为的那样：当需要维护如此大量的“关键”属性时，Java 源代码并不理想，但更重要的是，需要定期更新。

当然，这里的关键方面是：维护良好。每个人都必须遵循一个明确定义的过程，并且整个“链”，从对 XLS 进行更改（理想情况下以版本控制的方式），到生成构建时所需的工件应该简单且经过良好测试。

Answer 3

如果你只是想以更易读的方式编写枚举，你可以为它们添加一个属性：

public enum Marketplace {
     US("US", false, true),
     JP("JP", true, false),
     UK("UK", false, true),
     IN("IN", true, false),
     NZ("NZ", true, false),
     CA("CA", false, true),
     FR("FR", false, false);

     // This could go uptp some 400 marketplaces

     private final String stringValue;

     /** Markers for the getters */
     private final boolean isWest, isEast;

     Marketplace(String stringValue, boolean isEast, boolean isWest) {
         this.stringValue = stringValue;
         this.isEast = isEast;
         this.isWest = isWest;
     }

     public boolean isWest() {
         return isWest;
     }

     public boolean isEast() {
         return isEast;
     }
}

从技术上讲，如果您将其设为枚举的属性，您可以轻松地将它们保存在数据库中。如果您没有可用的数据存储，则必须在源代码中维护它们。