CDI 可移植扩展

codingman included in Jakarta EE Persistence Java

2018-08-22 1999 words 4 minutes

Contents

1. 概述

在本教程中，我们将介绍 CDI（上下文和依赖注入）的一个有趣特性，称为 CDI 可移植扩展。

首先，我们将从了解它的工作原理开始，然后我们将了解如何编写扩展。我们将完成为 Flyway 实现 CDI 集成模块的步骤，因此我们可以在 CDI 容器启动时运行数据库迁移。

本教程假定您对 CDI 有基本的了解。查看这篇文章以了解 CDI 的介绍。

2. 什么是 CDI 可移植扩展？

CDI 可移植扩展是一种机制，通过它我们可以在 CDI 容器之上实现附加功能。在引导时，CDI 容器扫描类路径并创建有关已发现类的元数据。

在此扫描过程中，CDI 容器会触发许多只能由扩展程序观察到的初始化事件。这就是 CDI 可移植扩展发挥作用的地方。

CDI 可移植扩展会观察这些事件，然后将信息修改或添加到容器创建的元数据中。

3. Maven依赖

让我们首先在pom.xml中添加 CDI API 所需的依赖项。实现一个空扩展就足够了。

<dependency>
    <groupId>javax.enterprise</groupId>
    <artifactId>cdi-api</artifactId>
    <version>2.0.SP1</version>
</dependency>

为了运行应用程序，我们可以使用任何兼容的 CDI 实现。在本文中，我们将使用 Weld 实现。

<dependency>
    <groupId>org.jboss.weld.se</groupId>
    <artifactId>weld-se-core</artifactId>
    <version>3.0.5.Final</version>
    <scope>runtime</scope>
</dependency>

您可以检查是否有任何新版本的 API 和实现已在 Maven 中心发布。

4. 在非 CDI 环境中运行 Flyway

在开始集成 Flyway和 CDI 之前，我们应该先看看如何在非 CDI 环境中运行它。

那么让我们看看下面这个取自Flyway 官网的例子：

DataSource dataSource = //...
Flyway flyway = new Flyway();
flyway.setDataSource(dataSource);
flyway.migrate();

正如我们所见，我们只使用了需要DataSource实例的Flyway实例。

我们的 CDI 可移植扩展稍后将生成Flyway和 Datasource bean。出于本示例的目的，我们将使用嵌入式 H2 数据库，并通过DataSourceDefinition注释提供DataSource属性。

5. CDI 容器初始化事件

在应用程序引导时，CDI 容器首先加载和实例化所有 CDI 可移植扩展。然后，在每个扩展中，如果有的话，它会搜索并注册初始化事件的观察者方法。之后，它执行以下步骤：

在扫描过程开始之前触发BeforeBeanDiscovery事件
执行扫描归档 bean 的类型发现，并为每个发现的类型触发ProcessAnnotatedType事件
触发 AfterTypeDiscovery事件
执行 bean 发现
触发 AfterBeanDiscovery事件
执行 bean 验证并检测定义错误
触发 AfterDeploymentValidation事件

CDI 可移植扩展的目的是观察这些事件，检查有关已发现 bean 的元数据，修改此元数据或添加到它。

在 CDI 可移植扩展中，我们只能观察这些事件。

6. 编写 CDI 可移植扩展

让我们看看如何通过构建我们自己的 CDI 可移植扩展来挂钩其中的一些事件。

6.1. 实现 SPI 提供程序

CDI 可移植扩展是接口javax.enterprise.inject.spi.Extension 的 Java SPI 提供者。查看这篇文章以了解 Java SPI 的介绍。

首先，我们从提供Extension实现开始。稍后，我们将向 CDI 容器引导事件添加观察者方法：

public class FlywayExtension implements Extension {
}

然后，我们添加一个包含以下内容的文件名META-INF/services/javax.enterprise.inject.spi.Extension：

com.blogdemo.cdi.extension.FlywayExtension

作为 SPI，此Extension在容器引导之前加载。因此可以注册 CDI 引导事件上的观察者方法。

6.2. 定义初始化事件的观察者方法

在此示例中，我们在扫描过程开始之前让 CDI 容器知道Flyway类。这是在 *registerFlywayType()*观察者方法中完成的：

public void registerFlywayType(
  @Observes BeforeBeanDiscovery bbdEvent) {
    bbdEvent.addAnnotatedType(
      Flyway.class, Flyway.class.getName());
}

在这里，我们添加了有关Flyway类的元数据。**从现在开始，它的行为就好像它被容器扫描了一样。**为此，我们使用了*addAnnotatedType()*方法。

接下来，我们将观察 ProcessAnnotatedType 事件以使Flyway类成为 CDI 托管 bean：

public void processAnnotatedType(@Observes ProcessAnnotatedType<Flyway> patEvent) {
    patEvent.configureAnnotatedType()
      .add(ApplicationScoped.Literal.INSTANCE)
      .add(new AnnotationLiteral<FlywayType>() {})
      .filterMethods(annotatedMethod -> {
          return annotatedMethod.getParameters().size() == 1
            && annotatedMethod.getParameters().get(0).getBaseType()
              .equals(javax.sql.DataSource.class);
      }).findFirst().get().add(InjectLiteral.INSTANCE);
}

首先，我们使用*@ApplicationScoped和@FlywayType注解对Flyway* 类进行注解，然后我们搜索Flyway.setDataSource(DataSource dataSource)方法并使用@Inject 对其进行注解。

上述操作的最终结果与容器扫描以下Flyway bean 的效果相同：

@ApplicationScoped
@FlywayType
public class Flyway {
 
    //...
    @Inject
    public void setDataSource(DataSource dataSource) {
      //...
    }
}

下一步是使DataSource bean 可用于注入，因为我们的Flyway bean 依赖于DataSource bean。

为此，我们将处理将DataSource Bean 注册到容器中，并且我们将使用AfterBeanDiscovery事件：

void afterBeanDiscovery(@Observes AfterBeanDiscovery abdEvent, BeanManager bm) {
    abdEvent.addBean()
      .types(javax.sql.DataSource.class, DataSource.class)
      .qualifiers(new AnnotationLiteral<Default>() {}, new AnnotationLiteral<Any>() {})
      .scope(ApplicationScoped.class)
      .name(DataSource.class.getName())
      .beanClass(DataSource.class)
      .createWith(creationalContext -> {
          DataSource instance = new DataSource();
          instance.setUrl(dataSourceDefinition.url());
          instance.setDriverClassName(dataSourceDefinition.className());
              return instance;
      });
}

正如我们所见，我们需要一个提供DataSource属性的 DataSourceDefinition。

我们可以使用以下注解来注解任何托管 bean：

@DataSourceDefinition(
  name = "ds", 
  className = "org.h2.Driver", 
  url = "jdbc:h2:mem:testdb")

为了提取这些属性，我们观察ProcessAnnotatedType事件以及 @WithAnnotations 注释：

public void detectDataSourceDefinition(
  @Observes @WithAnnotations(DataSourceDefinition.class) ProcessAnnotatedType<?> patEvent) {
    AnnotatedType at = patEvent.getAnnotatedType();
    dataSourceDefinition = at.getAnnotation(DataSourceDefinition.class);
}

最后，我们监听AfterDeployementValidation事件以从 CDI 容器中获取所需的Flyway bean，然后调用*migrate()*方法：

void runFlywayMigration(
  @Observes AfterDeploymentValidation adv, 
  BeanManager manager) {
    Flyway flyway = manager.createInstance()
      .select(Flyway.class, new AnnotationLiteral<FlywayType>() {}).get();
    flyway.migrate();
}