使用Guice玩依赖注入

四月 21st, 2009 | 239 次阅读

Tags: Java Guice Posted in Java 技术杂项 :-)说点什么吧

Guice是Google的一个轻量级的依赖注入框架，使用这个框架可以很容易的实现模块间的依赖注入，有效提高模块之间的解耦和程度，使模块之间的交互更灵活、更容易维护。

下面先来看一下Guice的运行机制：

然后通过一个非常简单的例子来说明Guice的使用：

首先，建立一个接口，这个接口的实现就是需要被注入的服务：

public interface Im {
     public void say(String s);
     public boolean connect();
     public boolean disconnect();
}

然后，我们编写来个实现该接口的具体实现:

实现1,ImImpl：

public class ImImpl implements Im {
    @Override
    public boolean connect() {
          System.out.println("ImImpl connected!");
          return true;
    }  
   
    @Override
    public boolean disconnect() {
          System.out.println("ImImpl disconnected!");
          return true;
    }
      
    @Override
    public void say(String s) {
          System.out.println("ImImpl say:"+s);
    }  
}

实现2，ImMock：

public class ImMock implements Im {
  
    @Override
    public boolean connect() {
        System.out.println("ImMock connected!");
        return true;
    }
08
    @Override
    public boolean disconnect() {
        System.out.println("ImMock disconnected!");
        return true;
    }
 
    @Override
    public void say(String s) {
        System.out.println("ImMock say:"+s);
    } 
}

接下来，我们编写一个依赖于Im接口的类，MyIm：

import com.google.inject.Inject;
import edu.scut.emos.im.Im;
 
public class MyIm{   
05
    Im impl;
    
    @Inject
    public MyIm(Im impl){
        this.impl = impl;
    }
12
    public void doit(String detail){
        impl.connect();
        impl.say(detail);
        impl.disconnect();
    }
    
}

在第8行处，我们使用了@Inject注解，该注解用来告诉Guice框架，这里是一个注入点。

接着，我们要编写一个配置模块，用来配置被注入的具体服务以及注入的目标：

import com.google.inject.Binder;
import com.google.inject.Module;
import com.google.inject.Scopes;
import edu.scut.emos.im.Im;
import edu.scut.emos.im.ImImpl;
import edu.scut.emos.im.ImMock;
07
public class MyModule implements Module {
09
    Class<? extends Im> theClass = ImImpl.class;
    
    public void setInstance(int i){
        if(i>0){
             theClass = ImImpl.class;
        }else{
             theClass = ImMock.class;
        }
    } 
19
    @Override
    public void configure(Binder binder) {
        binder.bind(Im.class).to(theClass).in(Scopes.SINGLETON);      
    }
   
}

该配置模块实现了Guice的Module接口，实现它的cofigure，根据之前给出的时序图，我们知道Guice就是通过这个方法来实现注入的，所以能通过重写这个方法来绑定输入的具体服务和注入点。第22行代码详细描述了这个情况：将Im接口（Im.class）和具体的实现(theClass)绑定，范围指定是Scopes.SINGLETON，也就是说，每一次注入都是使用最初生成的那个服务实体对象，而不用另外再新建一个实体对象来注入，除非我们改变了被注入的服务。

最后来一个演示程序：

import com.google.inject.Guice;
import com.google.inject.Injector;
03
public class Main {
    public static void main(String[] args) {
        MyModule module = new MyModule();
        module.setInstance(1);
        Injector inj = Guice.createInjector(module);
        MyIm myIm = inj.getInstance(MyIm.class);
        myIm.doit("test");
       
        module.setInstance(0);
        inj = Guice.createInjector(module);
        myIm = inj.getInstance(MyIm.class);
        myIm.doit("test");
    }
}

程序的执行结果就是：

ImImpl connected!

ImImpl say:test

ImImpl disconnected!

ImMock connected!

ImMock say:test

ImMock disconnected!

前三行是由ImImpl输出的，后三行是由ImMock生成的，我们在程序的执行流程中，通过改变配置模块(myModule)的内容，通过Guice来为MyIm注入具体的Im实现，得到我们想要的MyIm对象。这就是Guice可以带给我们的最基本的注入功能，可以很方便很快捷地实现依赖注入，Guice还提供了很多的注入类型和配置选项，建议大家都去试试看。

Guice官方网站：http://code.google.com/p/google-guice/