Google Guice: Java 依赖注入框架

发布时间：2023-05-17

Google Guice是一种轻量级的依赖注入框架，它通过使用Java注解将依赖关系绑定到代码中，从而简化了对象的创建和管理。

一、Google Guice的PDF文档

Google Guice提供了详细的文档和指南，以帮助开发人员快速了解和使用Guice。其中包括Google Guice用户指南和Google Guice API文档。 Google Guice用户指南包括了Guice基础、@Inject注解、Provider、Scope等内容，可以帮助开发者更好地理解Guice的工作原理。API文档则提供了Guice的详细代码实现和使用说明，方便开发者在实际项目中使用Guice。 以下是一个简单的使用Guice的示例。我们先创建一个接口HelloWorld以及它的实现类HelloWorldImpl。

public interface HelloWorld {
    void sayHello();
}
public class HelloWorldImpl implements HelloWorld {
    public void sayHello() {
        System.out.println("Hello World!");
    }
}

然后我们使用Guice创建并绑定依赖。

public class GuiceInjector {
    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new Module() {
            public void configure(Binder binder) {
                binder.bind(HelloWorld.class).to(HelloWorldImpl.class);
            }
        });
        HelloWorld helloWorld = injector.getInstance(HelloWorld.class);
        helloWorld.sayHello();
    }
}

在上面的示例中，我们通过Module对象使用bind方法将HelloWorld接口绑定到HelloWorldImpl实现类。然后使用Injector的getInstance方法获取HelloWorld接口的实例，使用sayHello方法输出“Hello World!”。

二、Google Guice Auto

Google Guice Auto是一种Guice扩展库，它可以简化Guice代码的编写，减少手动配置和绑定。Guice Auto可以自动扫描Java类，找到使用了特定注解的类或方法，然后自动将它们绑定到Guice容器中。 下面是一个使用Guice Auto进行依赖注入的示例。我们先创建一个服务接口Service以及它的实现类ServiceImpl。在ServiceImpl类上使用@AutoBind注解，指示Guice Auto将它绑定到Guice容器中。

public interface Service {
    void execute();
}
@AutoBind
public class ServiceImpl implements Service {
    public void execute() {
        System.out.println("Service execution");
    }
}

然后我们创建一个Guice模块MyModule，使用@AutoBindModule注解标记它。在MyModule类中使用AutoBindModules注解，指示Guice Auto扫描ServiceImpl类并将其绑定到容器中。

@AutoBindModule
public class MyModule extends AbstractModule {
    @Override
    protected void configure() {
    }
}

最后，我们使用Guice.createInjector方法创建一个Injector实例，并且使用MyModule模块进行依赖注入。

public class GuiceAutoInjector {
    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new MyModule());
        Service service = injector.getInstance(Service.class);
        service.execute();
    }
}

在上面的示例中，我们使用MyModule模块进行依赖注入。Guice Auto会自动扫描ServiceImpl类，并将其绑定到容器中。然后使用Injector的getInstance方法获取Service接口的实例，使用execute方法执行Service。

三、Google Guice和Spring

虽然Google Guice和Spring都是Java依赖注入框架，但它们之间有一些重要的区别。 首先，Google Guice更加轻量级和简单，并且不需要XML文件进行配置。相比之下，Spring非常复杂，并且需要大量的XML文件进行配置。 其次，Google Guice更加注重Java代码的优雅和简洁，使用了大量的注解来简化依赖注入过程。而Spring则过于复杂，使用XML文件配置依赖注入。 以下是一个使用Spring进行依赖注入的示例。我们先创建一个接口HelloWorld以及它的实现类HelloWorldImpl。

public interface HelloWorld {
    void sayHello();
}
public class HelloWorldImpl implements HelloWorld {
    public void sayHello() {
        System.out.println("Hello World!");
    }
}

然后我们创建一个Spring配置文件applicationContext.xml，配置依赖关系。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
    <bean id="helloWorld" class="com.example.HelloWorldImpl" />
</beans>

最后，我们在Java代码中使用ApplicationContext获取HelloWorld实例。

public class SpringInjector {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        HelloWorld helloWorld = (HelloWorld) context.getBean("helloWorld");
        helloWorld.sayHello();
    }
}

在上面的示例中，我们使用XML文件进行配置依赖注入，然后使用ApplicationContext获取HelloWorld实例。

四、Google Guice注入多实例

Google Guice可以使用@Provides和@Scope注解在同一个应用程序中注入多个实例。@Provides注解用于指定依赖项的提供程序，而@Scope注解用于指定依赖项的生命周期。 下面是一个使用Guice注入多实例的示例。我们先创建一个接口Vehicle以及它的两个实现类Car和Bike。

public interface Vehicle {
    void start();
}
public class Car implements Vehicle {
    public void start() {
        System.out.println("Car started");
    }
}
public class Bike implements Vehicle {
    public void start() {
        System.out.println("Bike started");
    }
}

然后我们创建一个Module类，在其中使用@Provides注解提供Vehicle实例。在这个示例中，我们提供了两个Vehicle实例：一个Car实例和一个Bike实例。

public class VehicleModule extends AbstractModule {
    @Provides @Named("car")
    @Singleton
    Vehicle provideCar() {
        return new Car();
    }
    @Provides @Named("bike")
    @RequestScoped
    Vehicle provideBike() {
        return new Bike();
    }
}

在上面的示例中，我们使用@Provides注解提供两个Vehicle实例：一个带有@Singleton注解的Car实例和一个带有@RequestScoped注解的Bike实例。 最后，我们在Java代码中获取Vehicle实例，并使用它们的start方法。

public class MultiInstanceInjector {
    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new VehicleModule());
        Vehicle car = injector.getInstance(Key.get(Vehicle.class, Names.named("car")));
        Vehicle bike = injector.getInstance(Key.get(Vehicle.class, Names.named("bike")));
        car.start();
        bike.start();
    }
}

在上面的示例中，我们使用Injector的getInstance方法获取@Named("car")和@Named("bike")的Vehicle实例，并调用它们的start方法。

五、Google Guice自定义注解

除了在Guice中使用现有的注解外，也可以使用自定义注解。自定义注解可以简化依赖注入过程，并提供更好的代码可读性和可维护性。 以下是一个使用自定义注解进行依赖注入的示例。我们先创建一个自定义注解@Alpha，表示依赖项Alpha。

@BindingAnnotation @Target({ FIELD, PARAMETER, METHOD }) @Retention(RUNTIME)
public @interface Alpha {
}

然后我们创建一个类AlphaImpl，使用@Alpha注解标记它。

public class AlphaImpl implements AlphaInterface {
    public void doSomething() {
        System.out.println("AlphaImpl doSomething");
    }
}
public interface AlphaInterface {
    void doSomething();
}

在上面的示例中，我们使用@Alpha注解标记了AlphaImpl类，表示这是依赖项Alpha的实现类。然后我们创建了一个AlphaInterface接口，这样我们就可以在代码中使用AlphaInterface接口代替AlphaImpl类。 接下来我们创建一个Module类，在其中使用@Provides注解提供依赖项Alpha的实例。

public class AlphaModule extends AbstractModule {
    @Override protected void configure() {}
    @Provides @Alpha AlphaInterface createAlphaInstance() {
        return new AlphaImpl();
    }
}

在上面的示例中，我们使用@Provides注解提供了依赖项Alpha的实例，同时使用@Alpha注解绑定了它们。 最后，我们在Java代码中获取AlphaInterface实例，并使用它的doSomething方法。

public class AlphaInjector {
    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new AlphaModule());
        AlphaInterface alpha = injector.getInstance(Key.get(AlphaInterface.class, Alpha.class));
        alpha.doSomething();
    }
}

在上面的示例中，我们使用Key.get方法获取带有@Alpha注解的AlphaInterface实例，并调用它的doSomething方法。

推荐文章