配置类 - Guice 的最佳实践

Question

背景：我正在使用 Google Guice，因此通过配置类更容易，但我认为这不是最好的方法。

我有一个存储一些路径的配置类：

class Configuration{
   String getHomePath();
   String getUserPath();
}

我还有一个需要“homepath”的类“a”和一个需要“userpath”的类“b”。

通过a类和b类的构造函数传递配置类好还是只通过特定路径传递好？

Answer 1

如果您确实正确使用 Guice，那么您的所有配置都应该出现在模块的 configure 方法中。所以：

1. 删除配置类。
2. 创建注释类，可能称为 HomePath 和 UserPath。
3. 其中类 a 使用 getHomePath() 将其替换为名为 homePath 的字符串字段成员。
4. 当类 b 使用 getUserPath() 时，将其替换为名为 userPath 的字符串字段成员。
5. 修改类a和b的构造函数为@Inject注释（应该已经是），并接受一个String参数，分别用@HomePath和@UserPath<注释/code> 并分配注入值的字符串字段成员。
6. 使用 .annotatedWith() 在模块的配置方法中创建绑定 定义正确的值；如果它们仅在运行时可用，请绑定提供者。

EG

class a {
  private String homePath;
  @Inject
  public a(@HomePath String homePath) {
    this.homePath = homePath;
  }
  public String tellMeAboutHome() {
    return "We live in a nice home called " + homePath;
  }
}

class customModule extends AbstractModule {
  public static final String userPath = "/home/rafael";

  public void configure() {
    bind(String.class).annotatedWith(HomePath.class).to("/home/");
    bind(String.class).annotatedWith(UserPath.class).to(userPath);
  }
}

如果创建注释对您来说工作量太大，请使用 @Named 注释 Guice 附带。

Answer 2

您的问题没有单一的答案，只有根据您的具体情况进行选择的选项。

如果您知道您的 Configuration 类将会增长并且如果您的 A 和 B 类可能会使用更多信息，然后将整个 Configuration 对象传递给其构造函数。注意：我知道这违反了 YAGNI 原则，但有时你可能知道你会需要它;-)

否则，你可以考虑使用 @Named 注入路径，以便减少 A 和 B 类的依赖性降至最低，这是一个很好的设计实践。

Answer 3

一般规则是使依赖图（哪些类了解或依赖于其他类/接口）的代码尽可能简单、规则和固定。

如果不传递 Configuration 类会使 a 或 b 对用户编写的类具有零依赖性，或者有必要避免依赖性循环，则使用单独的路径字符串。否则，如果“这个类可以以将来​​可能改变的方式访问配置信息”更有意义，则传递该类。

我会避免使用单例方法，特别是如果您已经设置了 Guice。