注入实例时将参数传递给提供者方法

Question

我是 Dagger 2 的新手。我创建了一个模块，它有一个提供者方法，该方法接受一个字符串参数：

@Module
public class MyModule {

  @Provides
  Student provideStudent(String name) {
    return new Student(name); 
  }
}

在注入student的时候应该如何传递参数name？ @Inject Student student?但是在哪里/如何传递name？

Answer 1

您希望将一个对象 (String name) 作为参数提供给您的组件，以便其他部分可以使用它。你基本上有两种选择。

模块构造函数参数

使用模块参数是您在引入Component.Builder 之前会使用的“经典”方法。

你所做的就是将你需要的东西添加到你的模块构造函数中，然后从模块中提供它。

@Module
public class MyModule {

  private String name;

  MyModule(String name) {
    this.name = name;
  }

  // -----------------------------------------------
  // you could obviously just use the field directly
  @Provides
  Student provideStudent() {
    return new Student(name); 
  }


  // ---------------------------------------------------------------------
  // alternatively you'd add a Qualifier and add the argument to the graph
  @Provides
  @Named("name")
  String provideName() {
    return name; 
  }

  // then you can use it...
  @Provides
  Student provideStudent(@Named("name") String name) {
    return new Student(name); 
  }

}

直接使用名称的第一个选项意味着它仅在 that 模块中可用。如果要使用构造函数注入或使用限定字符串，则必须将其添加到图中，如第二个所示。

使用任何一种方法，您都必须手动将模块添加到组件中，因为模块不再使用默认构造函数。这也是你现在提供论点的地方。

DaggerMyComponent.builder()
        .myModule(new MyModule("some name"))
        .build();

组件生成器

相同的概念但不同的方法是使用组件构建器来实现相同的目标——将某些东西绑定到图表。

@Component(modules = MyModule.class)
interface MyComponent {

    @Component.Builder
    interface Builder {

        @BindsInstance Builder name(@Named("name") String name);

        MyComponent build();
    }
}

@Module
class MyModule {

    @Provides
    Student provideStudent(@Named("name") String name) {
        return new Student(name);
    }

}

在这里，您也只需将一个对象添加到可以使用的图表中。在这里，您也必须将其添加到组件构建器中

DaggerMyComponent.builder()
        .name("some name")
        .build();

Answer 2

您可以创建一个Student 工厂并注入它，而不是直接注入Student：

public class Student {
    public Student(String name, Knowledge knowledge) {}

    public static class Factory {
        private Knowledge knowledge;

        @Inject
        public Factory(Knowledge knowledge) {
            this.knowledge = knownledge;
        }

        public Student create(String name) {
            return new Student(name, knowledge);
        }
    }
}

或者 Kotlin 中的相同代码：

class Student(name: String, knowledge: Knowledge) {
    class Factory @Inject constructor(private val knowledge: Knowledge) {
        fun create(name: String) = Student(name, knowledge)
    }
}

这允许在Student 实例化上传递name 参数，如下所示：

public class MyClass {
    @Inject
    public Student.Factory studentFactory;
    private Student student;

    public void setupStudent() {
        this.student = studentFactory.create("Student's name");
    }
}

Answer 3

我的问题是如何注入一个有名字的学生实例可以 硬编码。

name 是Student 的依赖关系，这个依赖关系是要解决的。为此，您需要一个带注释的@Provide 方法，该方法返回String。由于类型通常由返回类型推断，在String 的情况下，您还必须使用注释@Named

@Provides
@Named("Name")
public String provideName() {
    return "My name";
}

然后改变你的方法

@Provides
Student provideStudent(@Named("Name") String name) {
   return new Student(name); 
}

这样 dagger2 知道如何解决 String 来构建 Student