Dagger 2 系列（三）——@Module 和 @Provides注解介绍

置顶 Hirezy

于 2025-03-09 22:20:02 发布

阅读量835

点赞数 8

分类专栏： Android 设计模式文章标签： android

本文链接：https://blog.youkuaiyun.com/ljx1400052550/article/details/146139615

版权

Android 同时被 2 个专栏收录

99 篇文章

订阅专栏

设计模式

6 篇文章

订阅专栏

前言：

在上一篇Dagger 2 系列（二）——@Inject、@Component 注解介绍一文，了@Inject、@Component 注解，这篇文章，我们将会了解另外俩个注解：@Module 和 @Provides。

在这篇文章中你会看到什么：

@Module 是什么
@Provides 是什么
@Module 、@Provides 和@Component 如何协同作战。

1. 什么是 Module

既然在Dagger 2 系列（二）——@Inject、@Component 注解介绍一文中通过 @Inject 和 @Component 我们已经实现了 DI，那么为什么 Dagger2 还要实现其他的DI 方式。

其实在上文中我们实现的 DI 方式中我们不难发现，通过@Inject 的注解实体类的构造函数是必不可少，它标识着 Dagger2 可以实例化该类。那么当你需要实例化一个第三方的对象时，是不是懵逼了，因为你不可能注解第三方类的构造函数 – 比如说 Gson 类的构造函数。那么现在就需要 @Module 来充分发挥作用了。

其实Module 其实是一个简单工厂模式，Module 里面的方法都是创建相应类实例的方法。

简单工厂模式举个栗子

先定义简单的Say接口：

public interface Say {
    //登录验证
    public boolean saySomething();
}

Say接口的实现类一：

public class ChineseSay implements Say {

    @Override
    public void saySomething() {
       sysout("你好，我是好人")
    }

}

Say接口的实现类二：

public class EnglishSay implements Say {

    @Override
    public boolean saySomething() {
        sysout("hello ， i  am a good man")
    }

}

我们还需要一个工厂类SayManager，根据调用者不同的要求，创建出不同的对象并返回。而如果碰到不合法的要求，会返回一个Runtime异常。

public class SayManager {
    public static Say factory(String type){
        if(type.equals("chinese")){

            return new ChineseSay();

        }else if(type.equals("english")){

            return new EnglishSay();

        }else{
            /**
             * 这里抛出一个自定义异常会更恰当
             */
            throw new RuntimeException("没有找到登录类型");
        }
    }
}

测试类：

public class Test {
    public static void main(String[] args) {
        String type = "chinese";
        Say say = SayManager.factory(type);
       say.saySomething();
    }
}

简单分析工厂类优缺点：

优点

模式的核心是工厂类。这个类含有必要的逻辑判断，可以决定在什么时候创建哪一个类的实例，而调用者则可以免除直接创建对象的责任。简单工厂模式通过这种做法实现了对责任的分割，当系统引入新的说话方式（本例中）的时候无需修改调用者。

缺点

这个工厂类集中了所以的创建逻辑，当有复杂的多层次等级结构时，所有的业务逻辑都在这个工厂类中实现。什么时候它不能工作了，整个系统都会受到影响。

小节：

简单工厂模式，其实就是类的创建模式，又叫做静态工厂方法（Static Factory
Method）模式。简单工厂模式是由一个工厂对象决定创建出哪一种产品类的实例

了解了什么是工厂类，下面就举个栗子：
通过 @Module 的方式获得第三方类库的对象 – Gson(当然也可以获得自定义类对象)

@Module
public class AModule {

    @Provides
    public Gson provideGson(){
        return new Gson();
    }
}

你再该类中看到了两个注解：

通过 @Module 注解类
通过 @Provides 注解方法

1.1 添加多个 Module

一个 Component 可以含有多个 Module ，这样在寻找依赖实例时就会自动从多个 Module 中寻找。
添加多个 Module 的方法有两种：

1.1.1 Component 注解 – @Component(modules={××××，×××})

示例代码如下：

@Component(modules={ModuleA.class,ModuleB.class,ModuleC.class}) 
public interface AppComponent{
    ...
}

1.1.2 Module 注解 – @Module(includes={××××，×××})

示例代码如下：

@Module(includes={ModuleA.class,ModuleB.class,ModuleC.class})
public class FruitModule{
    ...
}
@Component(modules={FruitModule.class}) //添加多个Module
public interface AppComponent{
    ...
}

这种使用 Module的 includes 添加多Module 的方法一般用于构建更高层的Module时候使用,如在本例中

2. 什么是 Provides

@Provides 用以标注 Module 类中的方法，它的作用是标注该 Module 可以向外界提供的类的实例对象的方法，就像 AModule 中可以提供 Gson 实例对象的 provideGson() 方法。

3. Component – 管理 Module

此时 DI 不是通过 @Inject 注解类构造器的方式，那么这个注解器的使用方法肯定也有所变化。此时 Component 的职责是管理 Module，Component 中的属性允许 Module 可以加入到 Component，同时一个 Component 可以加入多个 Module。
依赖注入的具体工作流程：

在这里插入图片描述
若实例化过程中参数同样是需要依赖注入的，那么需要按照上图中的流程一样寻找相应的方法。如果遍历了组件中管理的 Module 类中的 @Provides 注解的方法，那么就会寻找该实例类的构造器中是否有被 @Inject 注解的，如果参数同样有需要依赖注入的，那么就重复以上过程。如果最终还是没有找到相应的初始化实例的方法，那么程序会报出相应的错误。

4. 代码示例

@Component(modules = UserTwoModule.class)
public interface UserTwoComponent {
    void injectToSecondActivity(SecondActivity mSecondActivity);
}

@Module
public class UserTwoModule {
    @Provides
    UserTwo provideUserTwo(){
        return new UserTwo("男",1243);
    }
}

public class SecondActivity extends AppCompatActivity {
    @Inject
    UserTwo mUserTwo;
    private static final String TAG = "SecondActivity";
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
     DaggerUserTwoComponent.builder().userTwoModule(new UserTwoModule()).build().injectToSecondActivity(this);
    }
}