Google Guice之绑定方式-低调大师

Google Guice之绑定方式

2021-03-23 343

在Guice中，注入器的工作是装配对象图，当请求某一类型实例时，注入器根据对象图来判断如何创建实例、解析依赖。要确定如何解析依赖就需要通过配置注入器的绑定方式。

要创建绑定(Binding)对象，可以继承自AbstractModule类，然后覆盖其configure方法，在方法调用bind()方法来指来定每一次绑定，这些方法带有类型检查，如果你使用了错误的类型编译器就会报告编译错误。如果你已经写好了Module类，则创建一个Module类对象作为参数传递给Guice.createInjector()方法用于创建一个注入器。

通过Module对象可以创建链接绑定(linked bindings)、实例绑定(instance bindings)、@Provides methods、提供者绑定(provider bindings)、构建方法绑定(constructor bindings)与无目标绑定(untargetted bindings)。这些绑定方式统称为内置绑定，相对应的还有种及时绑定，如果在解析一个依赖时如果在内置绑定中无法找到，那么Guice将会创建一个及时绑定。

一、链接绑定(LinkdedBindings)

链接绑定即映射一类型到它的实现类，例如映射TransactionLog接口到实现类DatabaseTransactionLog：

public class BillingModule extends AbstractModule {
  @Override 
  protected void configure() {
    bind(TransactionLog.class).to(DatabaseTransactionLog.class);
  }
}

这样，当你调用injector.getInstance(TransactionLog.class)方法，或者当注入器碰到TransactionLog依赖时，就会使用DatabaseTransactionLog对象。链接是从一类型到它任何的子类型，这包括接口实现类，类的子类；所以如下映射也是可以的：bind(DatabaseTransactionLog.class).to(MySqlDatabaseTransactionLog.class);
并且链接绑定支持链式写法：

public class BillingModule extends AbstractModule {
  @Override 
  protected void configure() {
    bind(TransactionLog.class).to(DatabaseTransactionLog.class);
    bind(DatabaseTransactionLog.class).to(MySqlDatabaseTransactionLog.class);
  }
}

在这种情况下，当请求一个TransactionLog类型对象时，注入器将返回一个MySqlDatabaseTransactionLog对象。

二、绑定注解

某些情况下你可能想为同一种类型设置多种绑定。这就可以通过绑定注解来实现，该注解与绑定的类型用于唯一结识一个绑定，合在一起称为Key。示例：

package example.pizza;

import com.google.inject.BindingAnnotation;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;

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

这里关键的是@BindingAnnotation元注解，当Guice描述到该注解时，就会把PayPal作为绑定注解。
然后在Module的configure方法中使用annotatedWith语句，如下：
bind(CreditCardProcessor.class).annotatedWith(PayPal.class).to(PayPalCreditCardProcessor.class);
这样就把CreditCardProcessor映射到了PayPalCreditCardProcessor。

用法如下：

public class RealBillingService implements BillingService {

@Inject
    public RealBillingService(@PayPal CreditCardProcessor processor,
        TransactionLog transactionLog) {
        ...
    }
}

还有一种情况，我们可以使用Guice已经定义好的@Named注解，例如：

public class RealBillingService implements BillingService {

  @Inject
  public RealBillingService(@Named("Checkout") CreditCardProcessor processor,
        TransactionLog transactionLog) {
        ...
  }
}

要绑定一具体名称，使用Names.named()来创建一个实现传给annotatedWith方法：

bind(CreditCardProcessor.class)
        .annotatedWith(Names.named("Checkout"))
        .to(CheckoutCreditCardProcessor.class);

因为编译器不会对字符串进行检查，Guice建议我们少使用@Named注解，但是我个人认为，只要自己写代码时只要名称不要写错，通过这种方法式是最容易为同一类型映射多个绑定的，这很类似Spring中的实现方式，Spring的@Service, @Controller, @Repository不就可以指定名称吗？

三、实例绑定(Instance Bindings)

通过实例绑定我们可以为某类型绑定一个具体的实例，这仅仅适用于这些实例类型没有其它依赖的情况，例如值对象：

bind(String.class)
        .annotatedWith(Names.named("JDBC URL"))
        .toInstance("jdbc:mysql://localhost/pizza");
    bind(Integer.class)
        .annotatedWith(Names.named("login timeout seconds"))
        .toInstance(10);

使用方式如下：

@Inject @Named("JDBC URL")
private String url

Guice建议我们避免使用.toInstance来创建复杂的对象，因为这会延迟应用启动。类似地，可以使用@Provides方法实现。

四、`@Provides`方法

当使用@Provides方法创建对象时，该方法必须定义在Module类中，并且它必须加以@Provides注解，该方法的返回值类型就是被绑定的对象。当注入器需要该类型的实例时，它就会来调用该方法。

public class BillingModule extends AbstractModule {
  @Override
  protected void configure() {
    ...
  }

  @Provides
  TransactionLog provideTransactionLog() {
    DatabaseTransactionLog transactionLog = new DatabaseTransactionLog();
    transactionLog.setJdbcUrl("jdbc:mysql://localhost/pizza");
    transactionLog.setThreadPoolSize(30);
    return transactionLog;
  }
}

如果在@Provides方法上有@PayPal或@Named("Checkout")绑定注解，Guice以绑定注解优先。Guice在调用@Provides方法之前会先解析该方法的依赖：

@Provides @PayPal
CreditCardProcessor providePayPalCreditCardProcessor(@Named("PayPal API key") String apiKey) {
    PayPalCreditCardProcessor processor = new PayPalCreditCardProcessor();
    processor.setApiKey(apiKey);
    return processor;
}

关于异常：Guice不允许在@Provides方法中抛出异常。如果有异常抛出，那么异常将会被包装在ProvisionException对象中。

五、提供者绑定(Provider Bindings)

如果@Provides方法越来越复杂，我们可能会想把它们移到一个单独的类中。一个提供者类实现了Provider接口，它是一个用于提供值的简单通用接口。

public interface Provider<T> {
  T get();
}

如果提供者实现类有其自己的依赖时，可以通过在其构造方法上添加@Inject注解进行注入，以保证值安全返回。

public class DatabaseTransactionLogProvider implements Provider<TransactionLog> {
  private final Connection connection;

  @Inject
  public DatabaseTransactionLogProvider(Connection connection) {
    this.connection = connection;
  }

  public TransactionLog get() {
    DatabaseTransactionLog transactionLog = new DatabaseTransactionLog();
    transactionLog.setConnection(connection);
    return transactionLog;
  }
}

最后使用.toProvider语句来绑定到提供者：

public class BillingModule extends AbstractModule {
  @Override
  protected void configure() {
    bind(TransactionLog.class)
        .toProvider(DatabaseTransactionLogProvider.class);
  }
}

六、无目标绑定

Guice允许我们创建绑定时不指定目标类，也就是没有to语句，这对于具体类或者使用了@ImplementedBy或@ProvidedBy注解类型很有用。例如：

bind(MyConcreteClass.class);
bind(AnotherConcreteClass.class).in(Singleton.class);

然而，在使用绑定注解时，我们依赖必须指定绑定目标，即它是一个具体类，例如：

bind(MyConcreteClass.class)
    .annotatedWith(Names.named("foo"))
    .to(MyConcreteClass.class);
bind(AnotherConcreteClass.class)
    .annotatedWith(Names.named("foo"))
    .to(AnotherConcreteClass.class)
    .in(Singleton.class);

七、构造方法绑定

有些时候你可能需要将某一类型绑定到任一构建方法，例如在@Inject注解无法添加到目标类构造方法，其原因可能是这个类是第三方提供的，或者说该类有多个构建方法参与依赖注入。此时@Provides方法是解决这个问题的最好方案，因为它可以明确指定调用哪个构造方法，而且不需要使用反射机制。但是使用@Provides方法在某些地方有限制，例如：手动创建对象不能在AOP中使用。

正是因为这个原因，Guice使用了toConstructor()进行绑定，这需要我们使用反射来选择构造方法与处理异常。

public class BillingModule extends AbstractModule {
  @Override 
  protected void configure() {
    try {
      bind(TransactionLog.class).toConstructor(
          DatabaseTransactionLog.class.getConstructor(DatabaseConnection.class));
    } catch (NoSuchMethodException e) {
      addError(e);
    }
  }
}

上这个例子中DatabaseTransactionLog类必须有一个带DatabaseConnection参数的构造方法，该构造方法中不需要使用@Inject注解Guice会自动调用该构造方法。每一条toConstructor()语句创建的绑定，其作用域是独立的，如果你创建了多个单例绑定并且使用目标类的同一个构造方法，每一个绑定还是拥有各自的实例。

八、及时绑定

当注入器需要某一类型实例的时候，它需要获取一个绑定。在Module类中的绑定叫做显示绑定，只要它们可用，注入器就可以使用它们。如果需要某一类型实例，但它又不是显示绑定，那么注入器将试图创建一个及时绑定(Just-In-Time bindings)，它也被称为JIT绑定与隐式绑定。

可用于创建及时绑定的情况如下：

有一个合适的构建方法，即非私有，不带参数或者标有@Inject注解的构造方法，例如：
```
public class PayPalCreditCardProcessor implements CreditCardProcessor {
 private final String apiKey;

 @Inject
 public PayPalCreditCardProcessor(@Named("PayPal API key") String apiKey) {
   this.apiKey = apiKey;
 }
}
```
Guice不会创建内部类实例除非它有static修饰符，因为内部类含有一个指向外问类的隐式引用，而这个隐式引用无法注入。
@ImplementedBy

@ImplementedBy注解于用告诉注入器某类型的缺省实现类型是什么，这与链接绑定很相似。为某一类型绑定一子类型如下：
```
@ImplementedBy(PayPalCreditCardProcessor.class)
public interface CreditCardProcessor {
 ChargeResult charge(String amount, CreditCard creditCard)
     throws UnreachableException;
}
```
@ImplementedBy(PayPalCreditCardProcessor.class)等效于下面的bind()语句：
```
bind(CreditCardProcessor.class).to(PayPalCreditCardProcessor.class);
```
如果某一类型即有bind()语句又有@ImplementedBy注解，则bind()语句优先。使用@ImplementedBy请小心，因为它为接口添加了编译时依赖。
@ProvidedBy

@ProvidedBy注解用于告诉注入器，Provider类的实现是什么，例如：
```
@ProvidedBy(DatabaseTransactionLogProvider.class)
public interface TransactionLog {
 void logConnectException(UnreachableException e);
 void logChargeResult(ChargeResult result);
}
```
这等价于bind(TransactionLog.class).toProvider(DatabaseTransactionLogProvider.class);
类似@ImplementedBy注解，如果某个类型既使用了bind()语句，又使用了@ProvidedBy注解，那么bind()语句优先。

-------------------------------- END -------------------------------

及时获取更多精彩文章，请关注公众号《Java精讲》。

微信关注我们

原文链接：https://blog.51cto.com/xtayfjpk/2669261

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

Linux系统集群架构线上项目配置实战（二）

写在前面前面介绍了项目的整体情况与初始化服务器环境优化配置方面的内容，由于实际生产需求不一样，优化配置的点也不一样，仅供大家参考！ 01配置SSH免密登录分发服务器使用全网备份服务器首先创建分发用户 [root@centos ~]# useradd fenfa -u 999 [root@centos ~]# echo "123456"|passwd --stdin fenfa Changing password for user fenfa. passwd: all authentication tokens updated successfully. [root@centos ~]# /bin/cp /etc/sudoers /etc/sudoers.bak [root@centos ~]# echo "fenfa ALL=(root) NOPASSWD:/usr/bin/rsync" >>/etc/sudoers [root@centos ~]# tail -1 /etc/sudoers fenfa ALL=(root) NOPASSWD:/usr/bin/rs...

2021-03-23

409

实践域以往被称为称为“过程域”，如：配置管理，现在叫做“实践域”。对于2.0版，则有25个适用的实践域。与以前版本的CMMI模型一样，“实践域”介绍了定义实践意图的关键活动的要求和描述。在新模型下，全部25个实践领都适用于成熟度为三级的组织。另外，值得注意的是，通用实践的要求（版本1.3中）不再定义为“通用实践”，而是被纳入特定的实践域。以前CMMI开发模型（版本1.3）的成熟度三级仅需要18个“过程域”，而在高成熟度等级（第4和第5级）则另外定义了四（4）个。行动（Doing）包括用于生产、购买和交付优质解决方案的能力域。确保质量(ENQ) – 帮助改进产品和服务质量需求开发和管理（RDM）使开发人员能够不断了解解决方案的需求和期望，并保持更新。目的：抽取需求，确保利益相关方的共同理解，并统一需求、计划和工作产品。价值：确保满足客户的需求和期望实践总结成熟度等级1 RDM 1.1记录要求。成熟度等级2 RDM 2.1抽取利益相关方的需求、期望、约束以及接口或连接。 RDM 2.2将利益相关方的需求、期望、约束以及接口或连接转换为优先的客户需求。RDM 2.3与需求提供者达成...

2021-03-23

344

资源下载

更多资源

优质分享App

近一个月的开发和优化，本站点的第一个app全新上线。该app采用极致压缩，本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题，腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构，目前腾讯云软件源站支持公网访问和内网访问。

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。