Android依赖注入框架Dagger2学习笔记

简书博客迁移https://www.jianshu.com/u/43a04ef9d4c6

---

依赖注入

面向对象编程的一种设计模式，目的是为了降低程序中类与类之间的依赖引起的耦合。

在Java中，依赖注入有

• 通过接口注入
• 通过set方法注入
• 通过构造方法注入
• 通过注解注入

---

Dagger2

官网

为什么要用Dagger

• 让你不需要初始化对象。也就是说任何对象声明完了就能直接用。另外一种说法：使用类和被依赖的对象构造分开，这样如果我们需要改变被依赖类的构造方法,不必改动每一个使用类。

• 降低大型项目的耦合度

  我们为什么要把Dagger2,MVP以及Rxjava引入项目中?

---

简单的示例

比如现在我们要在RecycleView中显示一系列数据，那么我们需要在Activity中引用RecyclerViewAdapter。

最原始的构造方法注入的写法

MainActivity

public class MainActivity extends AppCompatActivity {
    List list = new ArrayList<>();
    RecyclerView recyclerView;
    ARecyclerViewAdapter aRecyclerViewAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        recyclerView = (RecyclerView) findViewById(R.id.rv);
        for (int i = 0; i < 30; i++) {
            list.add("item" + i);
        }
        recyclerView.setLayoutManager(new LinearLayoutManager(this));
        //实例化并传入list数据
        aRecyclerViewAdapter = new ARecyclerViewAdapter(list);
        recyclerView.setAdapter(aRecyclerViewAdapter);
    }
}

adapter

public class ARecyclerViewAdapter extends RecyclerView.Adapter<ARecyclerViewAdapter.AViewHolder>{

    private List list ;

    public ARecyclerViewAdapter(List list) {
        this.list = list;
    }

    @Override
    public AViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_item, parent, false);
        return new AViewHolder(view);
    }

    @Override
    public void onBindViewHolder(AViewHolder holder, int position) {
        holder.textView.setText(list.get(position));
    }

    @Override
    public int getItemCount() {
        return list.size();
    }

    public class AViewHolder extends RecyclerView.ViewHolder{
        TextView textView;
        public AViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.tv);
        }
    }
}

现在用Dagger2来改造，总体来说就是4步：
- 1 在Adapter构造器中加入@Inject注解
- 2 构建 Module
- 3 构建 Component
- 4 完成依赖注入

1 MainActivity中

public class MainActivity extends AppCompatActivity {
    List list = new ArrayList<>();


    RecyclerView recyclerView;
    //1 这里对注入类声明并用注解@Inject标记
    @Inject
    ARecyclerViewAdapter aRecyclerViewAdapter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        recyclerView = (RecyclerView) findViewById(R.id.rv);
        for (int i = 0; i < 30; i++) {
            list.add("item" + i);
        }
//        aRecyclerViewAdapter = new ARecyclerViewAdapter(list);


        ....
        ....
        recyclerView.setLayoutManager(new LinearLayoutManager(this));
        recyclerView.setAdapter(aRecyclerViewAdapter);
    }


}

在ARecyclerViewAdapter中

@Inject
public ARecyclerViewAdapter(List<String> list) {
        this.list = list;
    }

其实就是在俩个地方加了Inject注解

2 写Module

@Module
public class ListModule {
    List<String> list;
    //引入数据
    public ListModule(List<String> list) {
        this.list = list;
    }

     //提供数据
    @Provides
    @ActivityScope
    List<String> provideList(){
        return list;
    }
}

原来的adapter的构造方法是

 public ARecyclerViewAdapter(List<String> list) {
        this.list = list;
    }

这里这个list要从MainActivity中注入到adapter的，用module来提供数据，上面的provideList()方法就是提供数据的，用了Provides注解。这里adapter只有一个参数，如果有多个参数，同理都在Module中用provide开头方法提供。

@ActivityScope 是一个自定义的范围注解，作用是允许对象被记录在正确的组件中，当然这些对象的生命周期应该遵循 Activity 的生命周期

import java.lang.annotation.Retention;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;

 import javax.inject.Scope;

 @Scope
 @Retention(RUNTIME)
 public @interface ActivityScope {
}

3 Component

负责注入依赖

@ActivityScope
@Component(modules = {ListModule.class})
public interface ListComponent {
    void inject(MainActivity mainActivity);
}

这里void inject(MainActivity mainActivity)要注意这里必须是真正消耗依赖的类型 MainActivity

4 在MainActivity中

onCreate方法中

DaggerListComponent.builder().listModule(new ListModule(list)).build().inject(this);

这样就完了

---

为什么用Dagger

我们为什么要把Dagger2,MVP以及Rxjava引入项目中?
Dagger——Android上的依赖注入框架

参考资料

Dagger 2: Step To Step
Dagger2从入门到放弃再到恍然大悟
Using Dagger2 in Android
Dagger是什么和我们怎么通过使用它获得收获

---

end