本教程主要详细讲解Guice依赖注入中的Procider服务注入实现,一般都是用于外部服务的注入,比如实现Redis等。

基础环境


技术 版本
Java 1.8+
Guice 4.2.3

初始化项目


  • 初始化项目
  1. mvn archetype:generate -DgroupId=com.edurt.sli.guice -DartifactId=guice-binder-provider -DarchetypeArtifactId=maven-archetype-quickstart -Dversion=1.0.0 -DinteractiveMode=false
  • 修改pom.xml增加Guice依赖
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <parent>
  6. <artifactId>spring-learn-integration</artifactId>
  7. <groupId>com.edurt.sli</groupId>
  8. <version>1.0.0</version>
  9. </parent>
  10. <modelVersion>4.0.0</modelVersion>
  11. <artifactId>guice-binder-provider</artifactId>
  12. <name>Guice依赖注入(Provider)</name>
  13. <properties>
  14. <system.java.version>1.8</system.java.version>
  15. <guice.version>4.2.3</guice.version>
  16. <lombok.version>1.18.2</lombok.version>
  17. </properties>
  18. <dependencies>
  19. <dependency>
  20. <groupId>com.google.inject</groupId>
  21. <artifactId>guice</artifactId>
  22. <version>${guice.version}</version>
  23. </dependency>
  24. <dependency>
  25. <groupId>org.projectlombok</groupId>
  26. <artifactId>lombok</artifactId>
  27. <version>${lombok.version}</version>
  28. </dependency>
  29. </dependencies>
  30. <build>
  31. <plugins>
  32. <plugin>
  33. <groupId>org.apache.maven.plugins</groupId>
  34. <artifactId>maven-compiler-plugin</artifactId>
  35. <version>${plugin.maven.compiler.version}</version>
  36. <configuration>
  37. <source>${system.java.version}</source>
  38. <target>${system.java.version}</target>
  39. </configuration>
  40. </plugin>
  41. </plugins>
  42. </build>
  43. </project>

guice: guice就是我们核心要使用的依赖

实现Provider注入


如果想要注入一个服务我们可以使用Provider进行实现。

  • 创建com.edurt.sli.guice.provider文件夹,并在该文件夹下创建Service接口文件,用于添加我们需要测试的函数
  1. package com.edurt.sli.guice.provider;
  2. public interface Service {
  3. void println(String input);
  4. }
  • 创建Service接口的实现类JavaService,用于实现接口中的方法,代码如下
  1. package com.edurt.sli.guice.provider;
  2. public class JavaService implements Service {
  3. @Override
  4. public void println(String input) {
  5. System.out.println(input);
  6. }
  7. }
  • 创建JavaServiceProvider类,用于实现注入
  1. package com.edurt.sli.guice.provider;
  2. import com.google.inject.Provider;
  3. public class JavaServiceProvider implements Provider<Service> {
  4. @Override
  5. public Service get() {
  6. return new JavaService();
  7. }
  8. }
  • 创建用于测试注入的应用类JavaProviderApplication,代码如下
  1. package com.edurt.sli.guice.provider;
  2. import com.google.inject.*;
  3. public class JavaProviderApplication {
  4. @Inject
  5. private Service service;
  6. public static void main(String[] args) {
  7. Injector injector = Guice.createInjector(new Module() {
  8. @Override
  9. public void configure(Binder binder) {
  10. binder.bind(Service.class).toProvider(JavaServiceProvider.class);
  11. }
  12. });
  13. JavaProviderApplication application = injector.getInstance(JavaProviderApplication.class);
  14. application.service.println("Hello Java");
  15. }
  16. }

我们运行程序输出

  1. Hello Java

我们注意看binder的配置中,我们使用的是toProvider将实现类绑定到了Service接口中,这样就实现了对Provider的注入。

自动注入服务


  • 创建自动注入服务GuiceService接口类,代码如下:
  1. package com.edurt.sli.guice.provider;
  2. import com.google.inject.ProvidedBy;
  3. @ProvidedBy(value = GuiceServiceProvider.class)
  4. public interface GuiceService {
  5. void say(String input);
  6. }

注意我们使用@ProvidedBy标志了接口的实现类,这样的话我们就可以实现自动注入。

  • 创建GuiceServiceImpl接口实现类,代码如下
  1. package com.edurt.sli.guice.provider;
  2. public class GuiceServiceImpl implements GuiceService {
  3. @Override
  4. public void say(String input) {
  5. System.out.println(input);
  6. }
  7. }
  • 创建GuiceServiceProvider注入类,代码如下
  1. package com.edurt.sli.guice.provider;
  2. import com.google.inject.Provider;
  3. public class GuiceServiceProvider implements Provider<GuiceService> {
  4. @Override
  5. public GuiceService get() {
  6. return new GuiceServiceImpl();
  7. }
  8. }
  • 创建GuiceAutoProviderApplication应用类,代码如下
  1. package com.edurt.sli.guice.provider;
  2. import com.google.inject.Guice;
  3. import com.google.inject.Inject;
  4. public class GuiceAutoProviderApplication {
  5. @Inject
  6. private GuiceService guiceService;
  7. public static void main(String[] args) {
  8. GuiceAutoProviderApplication application = Guice.createInjector().getInstance(GuiceAutoProviderApplication.class);
  9. application.guiceService.say("Guice Service");
  10. }
  11. }

这样就实现了我们不需要去绑定Module就可以实现注入。

打包文件部署


  • 打包数据
  1. mvn clean package -Dmaven.test.skip=true -X

运行打包后的文件即可

  1. java -jar target/guice-binder-provider-1.0.0.jar

源码地址