Dagger:注入一个班级的不同实例

时间:2014-01-20 22:16:06

标签: java dependency-injection nested dagger

我可以使用Dagger将不同的值注入到对象图深处的同一个类的几个实例中吗?我想避免通过图中的包含对象传递值(因此我可以在不影响其容器的情况下更改所包含对象的实现)。

这是一个人为的例子。对象图是一个Top,它包含一个Left和Right,每个都包含一个Show。所以Show有两个实例。

class Top {
  Left left;
  Right right;
  void encodeTwice(String data) {
    left.encode(data);
    right.encode(data.getBytes());
  }
}
class Left {
  Leaf leaf;
  void encode(String data) {
    leaf.write(URLEncoder.encode(data));
  }
}
class Right {
  Leaf leaf;
  void encode(byte[] data) {
    leaf.write(DatatypeConverter.printBase64Binary(data));
  }
}
interface Leaf {
  void write(String data);
}
class Show implements Leaf {
  String label;
  @Override public void write(String data) {
    System.out.println(label + ": " + data);
  }
}
// There might be other classes that implement Leaf.

我可以使用Dagger将不同的值注入Top.left.leaf.label和Top.right.leaf.label吗?

这是一次尝试。这是不能令人满意的,因为Left和Right依赖于Leaf的实现。我想在不涉及左或右的情况下注入Show.label。

ObjectGraph.create(new TopModule()).get(Top.class).encodeTwice("Hello!");

@Module(injects = Top.class)
public class TopModule {
  @Provides @Named("Left.leaf.label") String provideLeftLabel() {
    return "URL encoded";
  }
  @Provides @Named("Right.leaf.label") String provideRightLabel() {
    return "Base 64";
  }
}
class Top {
  @Inject Left left;
  @Inject Right right;
  void encodeTwice(String data) {
    left.encode(data);
    right.encode(data.getBytes());
  }
}
class Left {
  Leaf leaf;
  @Inject Left(@Named("Left.leaf.label") String label) {
    leaf = new Show(label);
  }
  void encode(String data) {
    leaf.write(URLEncoder.encode(data));
  }
}
class Right {
  Leaf leaf;
  @Inject Right(@Named("Right.leaf.label") String label) {
    leaf = new Show(label);
  }
  void encode(byte[] data) {
    leaf.write(DatatypeConverter.printBase64Binary(data));
  }
}
interface Leaf {
  void write(String data);
}
class Show implements Leaf {
  String label;
  Show(String label) {
    this.label = label;
  }
  @Override public void write(String data) {
    System.out.println(label + ": " + data);
  }
}

3 个答案:

答案 0 :(得分:10)

因此,这种抽象类型难以推理,因为基于LeftRightTop实际上我可能会改变方法。

我可以想到这个问题有三种方法:Leaf工厂,Leaf s按限定符区分,Leaf s按子图分类。

工厂

隐藏具有所需依赖关系的工厂背后的Leaf实现。

interface LeafFactory {
  Leaf create(String name);
}

class TopModule {
  // ...

  @Provide @Singleton LeafFactory provideLeafFactory() {
    return new LeafFactory() {
      @Override public Leaf create(String name) {
        return new Show(name);
      }
    };
  }
}

class Left {
  private final Leaf leaf;

  @Inject Left(@Named("..") String name, LeafFactory leafFactory) {
    leaf = leafFactory.create(name);
  }

  // ...
}

限定符

现在您通过限定符注释注入标签。除了使用Leaf个实例,你没有理由不能做同样的事情。

class TopModule {
  @Provides @Named("..") Leaf provideLeftLeaf() {
    return new Show("URL encoded");
  }

  @Provides @Named("..") Leaf provideRightLeaf() {
    return new Show("Base64 encoded");
  }
}

class Left {
  @Inject Left(@Named("..") Leaf leftLeaf) { .. }
}

注意:如果您还需要抽象,您仍然可以将标签名称作为参数注入provideFooLeaf方法。

子图

通过使用“叶子范围”扩展图形,您可以创建应用程序的单独部分(例如,“右”,“左”),它们只有一个Leaf实例。

@Module(addsTo = TopModule.class)
class LeafModule {
  private final String label;

  LeafModule(String label) {
    this.label = label;
  }

  @Provide @Singleton Leaf provideLeaf() {
    return new Show(label);
  }
}

现在我们可以.plus()将这个放到根对象图上以获得范围。

ObjectGraph ogRoot = ObjectGraph.create(new TopModule());
// ...
ObjectGraph ogLeft = ogRoot.plus(new LeafModule("URL encoded"));
Leaf left = ogLeft.get(Leaf.class);
ObjectGraph ogRight = ogRoot.plus(new LeafModule("Base64 encoded"));
Leaf right = ogRight.get(Leaf.class);

就像我说的那样,很难概括为适合您概述的抽象样本应用程序。但我希望你能看到子图如何允许你创建一个图形的专用版本,它是“根”图的超集。通过多次执行此操作,您可以更改用于注入类型的依赖项。

答案 1 :(得分:0)

杰克提出了不同选择的很好例子。根据我的理解,标签实际上是由左或右类定义的。您可以将字段移动到这些类并将它们传递给Leaf。如果你想要一个没有标签的Leaf你可以使用LabeledLeaf扩展接口,那么Left和Right可以使用LabeledLeaf实例来决定是否应该使用带标签的write方法。

您的示例设置实际上听起来很像Timber。你应该考虑看看我们如何得到Tree能够根据它们的实现写入不同的输出,并且有些能够被标记。最终结果的不同之处在于,Timber的API是静态方法,而不是您注入类中的组件。

答案 2 :(得分:0)

如果为注入类的每个实例创建一个单独的ObjectGraph,Dagger可以这样做。为了提供完整的图形,模块可以实现委托给子图的@Provides方法。感谢杰克沃顿提出的建议,这促使我采用这种技术。

以下是一个例子:

LeafModule leftLeaf = new ShowModule("URL encoded");
LeafModule rightLeaf = new ShowModule("Base 64");
ObjectGraph top = ObjectGraph.create(new TopModule(leftLeaf, rightLeaf));
top.get(Top.class).encodeTwice("Hello!");

@Module(injects = Top.class)
class TopModule {
  TopModule(LeafModule leftLeaf, LeafModule rightLeaf) {
    leftGraph = ObjectGraph.create(leftLeaf).plus(new MiddleModule());
    rightGraph = ObjectGraph.create(rightLeaf).plus(new MiddleModule());
  }
  private final ObjectGraph leftGraph;
  private final ObjectGraph rightGraph;
  @Provides Left getLeft() {
    return leftGraph.get(Left.class);
  }
  @Provides Right getRight() {
    return rightGraph.get(Right.class);
  }
  @Module(injects = {Left.class, Right.class},
          complete = false /* doesn't inject Leaf */)
  static class MiddleModule {
  }
}
/** A Dagger module that can provide a Leaf. */
interface LeafModule {
}
@Module(injects = Leaf.class)
class ShowModule implements LeafModule {
  ShowModule(String showLabel) {
    label = showLabel;
  }
  private final String label;
  @Provides @Named("Show.label") String getLabel() {
    return label;
  }
  @Provides Leaf provideLeaf(Show implementation) {
    return implementation;
  }
}
class Top {
  @Inject Left left;
  @Inject Right right;
  void encodeTwice(String data) {
    left.encode(data);
    right.encode(data.getBytes());
  }
}
class Left {
  @Inject Leaf leaf;
  void encode(String data) {
    leaf.write(URLEncoder.encode(data));
  }
}
class Right {
  @Inject Leaf leaf;
  void encode(byte[] data) {
    leaf.write(DatatypeConverter.printBase64Binary(data));
  }
}
interface Leaf {
  void write(String data);
}
class Show implements Leaf {
  @Inject @Named("Show.label") String label;
  @Override public void write(String data) {
    System.out.println(label + ": " + data);
  }
}