前言
说起依赖注入(DI),相信你首先想到的必然是Spring,Spring是Java技术全家桶,是Java EE开发的一站式解决方案和实际开发标准。但本文并不聊它,而是介绍一款谷歌开源的轻量级依赖注入框架:Guice。
Guice在Java领域并不流行(相较于Spring),但因为它轻量级,所以可以作为你去学习理解DI的一个抓手,适合你去进行独立的分析和理解依赖注入的思想,毕竟程序员经常说的:思想都是相通的。
另外,学习它还有一个重要原因是有些流行框架/库使用了它作为基础DI库,如:Druid、Elastic Search、Play2以及我们熟悉的携程开源的Apollo和Netflix的Eureka。
正文
正所谓谷歌出品,必属精品,况且Guice还出自于它的广告这种多金部门,自然也不例外。Google Guice被大量应用于谷歌内部,然后2010年开源出来。虽然业界反响并不大,但是因为它的轻量级,有些流行的开源框架(如Druid、Apollo、Elastic Search、Play2)把它作为基础的DI组件。
轻量级是什么意思?
轻量级是一个相对概念,它至少应该有如下特征:
- 代码少
- 易维护
- 性能优异
Google Guice就是这么一个框架,它特别强调它的Lightweight特性。
Google Guice
Google Guice作为一个纯粹的DI框架,主要用于减轻你对工厂的需求以及Java代码中对new的使用。通过它来构建你的代码,能减少依赖,从而使得更容易更改以及更容易单元测试和重用。
下面我们就研究它的特性,然后辅以一定的代码示例对它展开基础学习。
公用基础代码
导包:
<dependency> <groupId>com.google.inject</groupId> <artifactId>guice</artifactId> <version>4.1.0</version> </dependency> <dependency> <groupId>com.google.inject.extensions</groupId> <artifactId>guice-multibindings</artifactId> <version>4.1.0</version> </dependency>
基础代码:
public interface Animal { void run(); } public class Dog implements Animal { @Override public void run() { System.out.println("dog run..."); } } public class Cat implements Animal { @Override public void run() { System.out.println("run run..."); } }
DI配置类(模块):
public class MainModule extends AbstractModule { @Override protected void configure() { bind(Animal.class).to(Dog.class); } }
测试类:
public class TestGuice { @Inject private Animal animal; 官方推荐使用构造器注入,但本类是测试类,为了方便就使用属性注入喽 当然喽,test类必须有空构造器~~~~这就另说了 //@Inject //public TestGuice(Animal animal){ // this.animal = animal; //} @Test public void fun1(){ Injector injector = Guice.createInjector(new MainModule()); // 为当前实例注入容器内的对象 injector.injectMembers(this); System.out.println(animal); System.out.println(injector.getInstance(Animal.class)); System.out.println(injector.getInstance(Animal.class)); animal.run(); } }
运行程序,控制台打印:
com.yourbatman.eurekaclient.guice.Dog@6fb0d3ed com.yourbatman.eurekaclient.guice.Dog@24b1d79b com.yourbatman.eurekaclient.guice.Dog@68ceda24 dog run...
这便是一个最简单的使用Guice来实现依赖注入的示例,和Spring的ApplicationContext还蛮像的有木有。针对此实例的输出,你应该也意识到此处一个非常非常不一样的不同:默认是多例的(每次get/注入的都是不同的实例)。
如何保证单例?
不同于Spring,它默认是多例的,因此需要我们做一些事情来保证单例。
1、使用@Singleton
注解
@Singleton public class Dog implements Animal { ... }
说明:该注解只能标注在实现类上,不能标注在接口/抽象类上
2、绑定时指定单例
bind(Animal.class).to(Dog.class).in(Singleton.class);
3、绑定一个现存的实例
bind(Animal.class).toInstance(new Dog());
以上三种方式处理后,使用依赖注入或者用API injector.getInstance()
得到的均会是同一个实例对象,这就是单例了。
绑定
任何需要依赖注入的资源,只有先实现了绑定才能注入,本处开始介绍它的绑定方式。
- 类名绑定:把实现类绑定到接口(当然也可以实现类绑到实现类),具体实例交给框架去帮你创建
bind(Animal.class).to(Dog.class);
- 实例绑定:绑定一个现有实例
bind(Animal.class).toInstance(new Dog())
注意:采用这种绑定,依赖注入时永远是单例(也就是这个实例)
- 连接绑定:对于已经绑定了的关系,可以无限一直连接下去
bind(Animal.class).to(Dog.class); bind(Dog.class).toInstance(new Dog(){ @Override public void run() { System.out.println("son dog"); super.run(); } });
Provider
绑定:类似于Spring的@Bean注解,适合完成需要编程逻辑完成的实例
见基础代码,略。
- 泛型绑定:支持泛型类型的绑定。借助
TypeLiteral
来完成
bind(new TypeLiteral<List<Animal>>(){}).toInstance(Arrays.asList(new Dog(),new Cat())); • 1
集合绑定:可在不同的Module内向同一个集合分别去绑定自己所要支持的内容,当然喽也可以在同一个Module内
Multibinder<Animal> multibinder = Multibinder.newSetBinder(binder(), Animal.class); multibinder.addBinding().toInstance(new Dog()); multibinder.addBinding().toInstance(new Cat());
说明:依赖于扩展包guice-multibindings
,需要导入这个jar才行