Dagger2使用记录
Dagger2是由google开始维护的依赖注入框架,从Dagger(由square公司开发)开始发展而来。
废话不多说上github地址:https://github.com/google/dagger
官方帮助文档地址:http://google.github.io/dagger/
内容一:为什么用Dagger2
首先使用依赖注入框架的优势很明显,不了解的同学google一下你就知道。 然后为什么Dagger2呢,因为他是google维护的嘛,android都是google在维护,问什么不用呢你说是吧 其实另一点重要的是使用起来比前一代dagger更方便简洁,且功能同样强大, 配合butterknife这类专注view注入框架合用效果更好,谁用谁知道,一般人我不告诉他。
内容二:如何使用Dagger2
我们要使用依赖注入框架首先需要解决三个问题,会解决了就知道怎么用了,这个和使用java_web中springMVC是一样一样的。
三个问题分别是:1.注入什么.2.怎么注入,3注入哪里.
问题一:注入什么
在Dagger2中有两种方式来声明哪些是可以注入的
方式一: 使用javax.inject.Inject包里的注解符:@Inject
在对象构造函数上写明@Inject 标明此类被请求时可以由Dagger2框架生成。
class Thermosiphon implements Pump { private final Heater heater; @Inject Thermosiphon(Heater heater) { this.heater = heater; } }
在类的字段上写明@Inject的时候标明此处需要Dagger2框架注入。
class CoffeeMaker { @Inject Heater heater; @Inject Pump pump; }
方式一有些不足比如:
接口不能够构造。
第三方类不能被注解
可配置对象必须被配置(设置属性之类的)
所以这里有了方式二:使用@Provide注解符
用@Provides来注解方法,方法名有个provide前缀,所以下面代码的意思为请求Heater类型对象的时候返回一个ElectricHeater实例对象。
@Provides Heater provideHeater() { return new ElectricHeater(); }
所有@Provides注解的方法必须属于@Module注解的类(有个Moudule后缀),如:
@Module class DripCoffeeModule { @Provides Heater provideHeater() { return new ElectricHeater(); } @Provides Pump providePump(Thermosiphon pump) { return pump; } }
前缀后缀的作用都在于区分自己写的类和方法
问题二:怎么注入
问题一解决,就知道那些是可以被注入的了,所以套用官方一句话就是说:我们有了一个类的依赖图。进入这个依赖图的根,就怎么使用这个依赖图了。
在Dagger2中呢是创建个接口,然后使用@Component注解符,指明modules(provides标注的可被注入的对象),
@Component(modules = DripCoffeeModule.class) interface CoffeeShop { CoffeeMaker maker(); }
然后再使用Dagger2框架生产的类(上面创建的接口加Dagger前缀)来具体操作。
CoffeeShop coffeeShop = DaggerCoffeeShop.builder() .dripCoffeeModule(new DripCoffeeModule()) .build();
问题三:哪里需要注入
用官方的简单例子来解释并不太容易理解,后面会具体展示如何在android代码中实现,这里只是思想提供
在刚才的接口中可以声明例如
void inject(Book book);
然后在需要把需要注入的类Book传入inject方法就OK,更详细理解看下面内容
内容三:在Android中使用
下嘛是豁然开朗的代码示例:来源是github上的,呵呵。
需要注意的一点就是需要在gradle中应用apt插件,并Make project后才能出现Dagger为前缀的类。
project.gradle中加入apt:
buildscript { repositories { jcenter() } dependencies { classpath 'com.android.tools.build:gradle:1.2.3' classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4' // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files } } allprojects { repositories { jcenter() } }
然后在module的gradle里面:
apply plugin: 'android-apt' //...省略 dependencies { compile 'com.google.dagger:dagger:2.0.1' apt 'com.google.dagger:dagger-compiler:2.0.1' }
然后点击build就能使用Dagger前缀的接口实现类
1.首先使用@Provides声明可以注入的东西。
@Module public class TestModule { private final BaseApplication mBaseApplication; public TestModule(BaseApplication mBaseApplication) { this.mBaseApplication = mBaseApplication; } //@ForApplication是过滤注解,看github上的源码就知道怎么用了 //地址:https://github.com/google/dagger/blob/master/examples/android-simple/src/main/java/com/example/dagger/simple/ForApplication.java @Provides @Singleton @ForApplication BaseApplication provideApplicationContext() { return mBaseApplication; } //@Singleton表示单例 @Provides @Singleton LocationManager provideLocationManager() { return (LocationManager) mBaseApplication.getSystemService(Application.LOCATION_SERVICE); } }
2.然后是怎么注入以及哪里需要注入就写在一起看,清楚地点
/** * 注入范围 */ @Singleton @Component(modules = TestModule.class) public interface ApplicatoinComponent { void inject(BaseApplication baseApplication); void inject(BaseActivity baseActivity); void inject(MainActivity mainActivity); } @Inject LocationManager locationManager; private ApplicatoinComponent applicatoinComponent; @Override public void onCreate() { super.onCreate(); applicatoinComponent = DaggerBaseApplication_ApplicatoinComponent .builder().testModule(new TestModule(this)) .build(); applicatoinComponent.inject(this);//申明需要注入的位置,这个方法调用后,locationmanager就被注入了,可以使用 }
补充一点在activity中注入如下:
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); ((BaseApplication) getApplicationContext()).getApplicatoinComponent().inject(this);//此activity中的需要被注入的对象就被注入了 }
欢迎留言