guice的能力简述

Posted 2021-03-09 simoncook

guice这个google出的bean容器框架，ES有用到他。

能干什么

1. 是一个bean容器
2. 能AOP

能力细分与使用方式

1. 以module创建injector。可以看成是一个容器。Module需要自定义且继承自他的AbstractModule。覆写config方法完成装配关系的确定。详细参见这里
   
2. 绑定顶层接口到具体实现类。bind(TransactionLog.class).to(DatabaseTransactionLog.class); 支持bind(A).to(B) 然后链式的 bind(B).to(C)
3. 支持在构造函数上打上Inject注解标签，用于注入字段
4. 支持自定义注解用于标志装配目标，比如自定义注解Paypal。 对于加了PayPal注解的参数，注入PaypalCreditCardProcessor实现，其余的注入GoogleCheckoutProcessor实现。bind(CreditCardProcessor.class).annotatedWith(PayPal.class).to(PaypalCreditCardProcessor.class);
5. 对于加了Named注解 其值为testnamed的地方注入TestNamedCreditCardProcessor实现。bind(CreditCardProcessor.class).annotatedWith(Names.named("testnamed")).to(TestNamedCreditCardProcessor.class);
6. 结合Named注解 可以将一个参数绑定一个特定的instance 而不是一个实现类。bind(Integer.class).annotatedWith(Names.named("chargeTimeout")).toInstance(200);
7. 可以使用Provides注解 主动对外提供创建的bean 有点类似 Spring的@Bean注解，这种方式可以对bean做自定义加工。相当于反转了bind的那个动作 同时也可以结合 自定义注解 使用 比如上面的@Paypal 效果相同。但是这种方式创建的bean不能参与AOP 因为instance是用户创建的嘛,所以任何额外逻辑编编织不进去了。那怎么解决这个问题，guice在bind后提供了toConstructor方法去指定实现类。这样就连Inject注解都不需要了。因为这个实现类可能是三方提供的。
8. 用自定义注解的方式结合bindInterceptor方式完成 本质上是个拦截器 AOP这些接口遵循AOP联盟约定。 有点类似jfinal的理念。

部分示例代码

全部的参见这里

测试主类

package com.code260.ss.guice.demo.bill;

import com.google.inject.Guice;
import com.google.inject.Injector;

public class TestMain {

    public static void main(String[] args) {

        /**
         * 1. 以module创建injector
         */
        Injector injector = Guice.createInjector(new BillingModule());

        RealBillingService billingService = injector.getInstance(RealBillingService.class);
        billingService.chargeOrder(null,null);

        TestCustomAnnotationBillingService testCustomAnnotationBillingService = injector.getInstance(TestCustomAnnotationBillingService.class);
        testCustomAnnotationBillingService.chargeOrder(null,null);

        TestNamedBillingService testNamedBillingService = injector.getInstance(TestNamedBillingService.class);
        testNamedBillingService.chargeOrder(null,null);

    }
}

module

package com.code260.ss.guice.demo.bill;

import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.matcher.Matcher;
import com.google.inject.matcher.Matchers;
import com.google.inject.name.Names;

public class BillingModule extends AbstractModule {

    @Override
    protected void configure() {

        /**
         * 2. 绑定接口到实现类
         */

        /**
         * LinkedBindings
         * 支持 bind(A).to(B) 然后链式的 bind(B).to(C)
         * to完之后 还支持in in后面接的是Scope 有Singleton
         */
        bind(TransactionLog.class).to(DatabaseTransactionLog.class);
        bind(CreditCardProcessor.class).to(GoogleCheckoutProcessor.class);

        /**
         * 6. 结合Named注解 可以将一个参数绑定一个特定的instance 而不是一个实现类
         */
        bind(Integer.class).annotatedWith(Names.named("chargeTimeout")).toInstance(200);

        /**
         * 4. 对于加了PayPal注解的参数，注入PaypalCreditCardProcessor实现，其余的注入GoogleCheckoutProcessor实现
         */
        bind(CreditCardProcessor.class).annotatedWith(PayPal.class).to(PaypalCreditCardProcessor.class);

        /**
         * 5. 对于加了Named注解 其值为testnamed的地方注入TestNamedCreditCardProcessor实现
         */
        bind(CreditCardProcessor.class).annotatedWith(Names.named("testnamed")).to(TestNamedCreditCardProcessor.class);

        /**
         * 8. 用自定义注解的方式结合bindInterceptor方式完成 本质上是个拦截器 有点类似jfinal的理念
         */
        bindInterceptor(Matchers.any(), Matchers.annotatedWith(NonWeekend.class), new NotOnWeekendsInterceptor());

    }

    /**
     * 7. 可以使用Provides注解 主动对外提供创建的bean 有点类似 Spring的@Bean注解，这种方式可以对bean做自定义加工
     * 相当于反转了bind的那个动作  同时也可以结合 自定义注解 使用 比如上面的@Paypal 效果相同
     * 但是这种方式创建的bean不能参与AOP 因为instance是用户创建的嘛,所以任何额外逻辑编编织不进去了。
     * 那怎么解决这个问题，guice在bind后提供了toConstructor方法去指定实现类。
     * 这样就连Inject注解都不需要了。因为这个实现类可能是三方提供的
     * @return
     */
    @Provides
    public AlertService provideAlertService() {
        RedAlertService redAlertService = new RedAlertService();
        redAlertService.setTestAttribute();
        return redAlertService;
    }
}

用于AOP的拦截器类

package com.code260.ss.guice.demo.bill;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;

public class NotOnWeekendsInterceptor implements MethodInterceptor {
    public Object invoke(MethodInvocation methodInvocation) throws Throwable {
        System.out.println("do something before NotOnWeekendsInterceptor invoke");
        Object result =  methodInvocation.proceed();
        System.out.println("do something after NotOnWeekendsInterceptor invoke");
        return result;
    }
}