Dagger2学习笔记

什么是依赖注入

依赖注入(Dependency Injection),简单理解A持有B的依赖,通过构造函数或者setter方法将B的实例传入A就是依赖注入。

关于Dagger2

Dagger2是在编译期根据注解通过APT自动生成模板代码的方式实现依赖注入。编译期注解比反射性能更好,解耦更彻底,方便测试。
github地址:https://github.com/google/dagger
官网:https://dagger.dev/

使用

主要的注解:

  • @Inject 标记被依赖对象的构造方法和依赖方的成员变量
  • @Component 标识依赖注入类,该类注入方法,参数为接收注入的对象
  • @Module 标识依赖提供类,其@Provides方法的返回值表示提供的依赖对象
  • @Provides 标识@Module类中的public方法,方法带参时dagger会递归查找参数被@Inject标记的构造方法以提供实例
  • @Scope 依赖注入对象的作用域,通过自定义被@Scope注解的注解可以控制依赖注入对象的作用范围。@Singleton是它的一个默认实现,其单例是在component的生命周期内,如果多个类中用不同的component对象注入得到的是不同实例
  • @Qualifier 同@Name类似,如果有两个@Provides方法的返回值一样可以通过@Qualifier或者@Name区分
  • @Name
MVP+Dagger2

MVP应该是android开发应用最广泛的框架了,其将视图层view、逻辑层presenter和数据层model分开各自负责不同的功能,通过接口回调处理结果。结合Dagger后可以使解耦更加彻底,更加方便管理依赖,但同时也提高了学习成本,实现一个简单功能MVP原本就需要创建大量的类现在更加复杂。瑕不掩瑜,有人根据MVP和Dagger开发了很多实用框架,arms就是一个不错的框架 https://github.com/JessYanCoding/MVPArms 下面要写的就是一个简化版Demo

正文

已登录为例首先创建MVP必要的组件LoginActivity、LoginPresenter、LoginContract.View、LoginContract.Model
这里LoginActivity不是真正的Activity只是为了方便说明MVP模式

public class LoginActivity implements LoginContract.View {

    @Inject
    public LoginPresenter mPresenter;

    public LoginActivity() {
        
    }

    public void login(String id, String pwd) {
        // Presenter尚未注入,此时mPresenter为null
        mPresenter.login(id, pwd);
    }

    @Override
    public void refreshUI() {
        System.out.println("LoginActivity refresh UI");
    }

    public static void main(String[] args) {
        LoginActivity loginActivity = new LoginActivity();
        loginActivity.login("xiaoming", "123");
    }

}

成员变量持有LoginPresenter的依赖,Dagger会根据@Inject注解优先查找LoginPresenter被@Inject注解的构造函数,如果有参数就递归查找参数被@Inject注解的构造函数

public class LoginPresenter extends BasePresenter<LoginContract.Model, LoginContract.View>{

    @Inject
    public LoginPresenter(LoginContract.Model model, LoginContract.View view) {
        super(model, view);
        System.out.println("LoginPresenter constructor is invoked");
    }


    public void login(String id, String pwd) {
        System.out.println("LoginPresenter login() id = "+id +", pwd = "+pwd);
        boolean login = mModel.login("id = " + id + ", pwd = " + pwd);
        if (login) {
            mRootView.refreshUI();
        }
    }
}
public interface LoginContract {


    interface View extends IView{
        void refreshUI();
    }

    interface Model extends IModel{
        boolean login(String params);
    }

}

回调接口View和Model由contract管理,LoginModel实现LoginContract.Model, presenter持有model依赖由dagger根据@Inject提供

public class LoginModel implements LoginContract.Model {

    @Inject
    public LoginModel() {
        System.out.println("LoginModel constructor is invoked");
    }

    @Override
    public boolean login(String params) {
        System.out.println("LoginModel login() is invoked params = "+params);
        return true;
    }
}

View实现在LoginActivity中,Component注入时传入Module,由Module的provide方法提供

@Module
public class LoginModule {

    private LoginContract.View view;

    public LoginModule(LoginContract.View view) {
        this.view = view;
    }

    @Provides
    public LoginContract.View provideView() {
        return this.view;
    }

    @Provides
    public LoginContract.Model provideModel(LoginModel model) {
        return model;
    }
}

最后LoginComponent接口提供inject注入方法并指明提供依赖的Module

@Component(modules = LoginModule.class)
public interface LoginComponent {

    void inject(LoginActivity loginActivity);
}

以上各类创建完成后编译一下项目,Dagger会根据Component自动生成类名为Dagger+LoginComponent格式的注入类,在LoginActivity中完成注入

    public LoginActivity() {
        DaggerLoginComponent.builder()
                .loginModule(new LoginModule(this))
                .build()
                .inject(this);
    }

最后可以把部分常用代码封装进基类中

public class BaseActivity<P extends BasePresenter> {

    @Inject
    public P mPresenter;

    public BaseActivity() {

    }
}
public class BasePresenter<M extends IModel, V extends IView> {

    protected M mModel;
    protected V mRootView;

    public BasePresenter(M model, V view) {
        mModel = model;
        mRootView = view;
    }
}
结语

Dagger还有许多用法就不一一列举了,最后还是感谢开源感谢arms的作者(传送门https://github.com/JessYanCoding)

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • dagger2的缘由背景 dagger2除了也有一段时间了,但是现在各大开源项目都在使用它,虽然感觉他的用处并不是...
    vison123阅读 3,214评论 0 1
  • Dagger2 转载请注明原作者,如果你觉得这篇文章对你有帮助或启发,可以关注打赏。 前言本文翻译自Google ...
    轻云时解被占用了阅读 11,704评论 4 31
  • 系列文章:Dagger2学习笔记(一)Dagger2学习笔记(二) 依赖注入是一种十分好的技巧,它能解偶高层次模块...
    嘉伟咯阅读 3,573评论 0 3
  • 前言 项目开撸阶段,准备接入Dagger2,再重新学起来!这篇文章主要是记录对dagger2的学习,从基本使用,到...
    dashixun阅读 2,472评论 0 0
  • 天黑不怕!我坚信天终究会亮。 ————我是糖二组糖友“ 受伤的猪” 到现在我都清楚的记得, 7...
    糖世界阅读 4,624评论 0 4