Cucumber は各シナリオの前に各Glueコードクラスの新しいインスタンスを作成するため、ステップから状態が漏洩することはありません。

• 注：Spring を使用する場合、ステップの状態を共有するために使用されている Spring Bean には、ScenarioScopeアノテーション を使用できます。このアノテーションにより、これらの Bean はシナリオ間で永続化されず、状態が漏洩しません。
• 注：Guice を使用する場合、ステップ定義クラスには常にスコープScenarioScopedを使用する必要があります。

こちらも参照してください 依存性注入。

プログラミング言語が JVM 言語の場合、Glue コード（ステップ定義とフック）をクラスで記述します。

Cucumber は、各シナリオの前に、Glue コードクラスの新しいインスタンスを作成します。

Glue コードクラスに空のコンストラクタがある場合、他に何も必要ありません。ただし、ほとんどのプロジェクトでは、依存性注入 (DI) モジュールを使用してコードをより適切に整理し、ステップ定義間で状態を共有するとメリットがあります。

使用可能な依存性注入モジュールは次のとおりです。

• PicoContainer（アプリケーションで他の DI モジュールを使用していない場合に推奨されます）
• Spring
• Guice
• OpenEJB
• Weld
• Needle

PicoContainer を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-picocontainer</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-picocontainer', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。詳細については、PicoContainer を使用した状態共有を参照してください。

Spring を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-spring</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-spring', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。

Guice を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-guice</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-guice', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。詳細については、Guice を使用した状態共有を参照してください。

OpenEJB を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-openejb</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-openejb', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。

Weld を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-weld</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-weld', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。

Needle を使用するには、pom.xmlに次の依存関係を追加します。

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-needle</artifactId>
    <version>7.20.1</version>
    <scope>test</scope>
</dependency>

または、Gradle を使用している場合は、次を追加します。

compile group: 'io.cucumber', name: 'cucumber-needle', version: '7.20.1'

まだドキュメントはありませんが、コードはGitHubにあります。

DI フレームワークを使用する場合、ステップ定義、フック、トランスフォーマーなどはすべて、フレームワークのインスタンスインジェクターによって作成されます。

Cucumber の例テストは通常小さく、依存関係はありません。しかし、現実の世界では、テストは多くの場合、インジェクターによって供給される必要があるアプリケーション固有のオブジェクトインスタンスへのアクセスを必要とします。これらのインスタンスをステップ定義で使用できるようにする必要があります。これにより、アクションを適用し、配信された結果をテストできます。

DI フレームワークを使用した Cucumber の使用が通常発生する理由は、テスト対象のアプリケーションでも同じフレームワークを使用しているためです。そのため、Cucumber で使用するカスタムインジェクターを構成する必要があります。このインジェクターは、テストとアプリケーションのインスタンスを結び付けます。

Google Guice を使用した典型的なステップ定義の例を次に示します。Cucumber 提供の Guice インジェクターを使用すると、必要な appService メンバーをインスタンス化できず、失敗します。

package com.example.app;

import static org.junit.Assert.assertTrue;

import io.cucumber.java.en.When;
import io.cucumber.java.en.Then;
import io.cucumber.guice.ScenarioScoped;
import com.example.app.service.AppService;
import java.util.Objects;
import javax.inject.Inject;

@ScenarioScoped
public final class StepDefinition {

    private final AppService appService;

    @Inject
    public StepDefinition( AppService appService ) {
        this.appService = Objects.requireNonNull( appService, "appService must not be null" );
    }

    @When("the application services are started")
    public void startServices() {
        this.appService.startServices();
    }

    @Then("all application services should be running")
    public void checkThatApplicationServicesAreRunning() {
        assertTrue( this.appService.servicesAreRunning() );
    }
}

AppServiceの実装には、通常Guiceモジュールによって提供される必要がある、追加の引数と設定が必要になる場合があります。Guiceモジュールはインジェクターの設定に使用され、次のようなものになります。

package com.example.app.service.impl;

import com.example.app.service.AppService;
import com.google.inject.AbstractModule;

public final class ServiceModule extends AbstractModule {
    @Override
    protected void configure() {
        bind( AppService.class ).to( AppServiceImpl.class );
        // ... (further bindings)
    }
}

実際のインジェクターは次のように作成されます: injector = Guice.createInjector( new ServiceModule() );

つまり、独自のインジェクターを作成し、Cucumberがそれを使用するように指示する必要があります。

Cucumberが特定のオブジェクトを必要とするたびに、オブジェクトファクトリを使用します。Cucumberにはデフォルトのオブジェクトファクトリがあり（Guiceの場合）、デフォルトのインジェクターを作成し、オブジェクトの作成をそのインジェクターに委任します。インジェクターをカスタマイズする場合は、独自のオブジェクトファクトリを提供し、代わりにそれをCucumberが使用するように指示する必要があります。

package com.example.app;

import io.cucumber.core.backend.ObjectFactory;
import io.cucumber.guice.CucumberModules;
import io.cucumber.guice.ScenarioScope;
import com.example.app.service.impl.ServiceModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.Stage;

public final class CustomObjectFactory implements ObjectFactory {

    private Injector injector;

    public CustomObjectFactory() {
        // Create an injector with our service module
        this.injector =
          Guice.createInjector( Stage.PRODUCTION, CucumberModules.createScenarioModule(), new ServiceModule());
    }

    @Override
    public boolean addClass( Class< ? > clazz ) {
        return true;
    }

    @Override
    public void start() {
        this.injector.getInstance( ScenarioScope.class ).enterScope();
    }

    @Override
    public void stop() {
        this.injector.getInstance( ScenarioScope.class ).exitScope();
    }

    @Override
    public < T > T getInstance( Class< T > clazz ) {
        return this.injector.getInstance( clazz );
    }
}

これはGuiceのデフォルトのオブジェクトファクトリですが、インジェクターに独自のバインディングを追加しています。Cucumberはjava.util.ServiceLoaderを通じてオブジェクトファクトリを読み込みます。ServiceLoaderがカスタム実装を検出できるようにするには、META-INF/services/io.cucumber.core.backend.ObjectFactoryファイルを提供する必要があります。

com.example.app.CustomObjectFactory
#
# ... additional custom object factories could be added here
#

これで、Cucumberがカスタムオブジェクトファクトリを使用するように指示する必要があります。これを実現する方法はいくつかあります。

Cucumberをコマンドラインから実行する場合、カスタムオブジェクトファクトリを引数として指定できます。

java io.cucumber.core.cli.Main --object-factory com.example.app.CustomObjectFactory

Cucumberは、存在する場合、プロパティファイル（cucumber.properties）を使用します。カスタムオブジェクトファクトリはこのファイルで指定でき、Cucumberの実行時に読み込まれます。cucumber.propertiesファイルには、次のエントリが必要です。

cucumber.object-factory=com.example.app.CustomObjectFactory

JUnit 4とTestNG用のCucumberモジュールを使用すると、JUnit/TestNGテストを通じてCucumberを実行できます。カスタムオブジェクトファクトリは、@CucumberOptionsアノテーションを使用して設定できます。JUnit 5については、cucumber-junit-platform-engineのドキュメントを参照してください。

Cucumberは多くの場合、イベントバスでイベントを発行します。例：-フィーチャファイルの解析中-テストシナリオの実行時

各イベントには、一意の識別子としてUUIDがあります。UUIDジェネレーターは、cucumber.uuid-generatorプロパティを使用して設定できます。

| UUIDジェネレーター | 機能 | パフォーマンス[百万UUID/秒] | 代表的な使用例 | |——————————————————-|————————————————————————————————————————————————————————————————————|————————————|——————————————————————————————————————————————————————————————————————————————————————————–| | io.cucumber.core.eventbus.RandomUuidGenerator |

• スレッドセーフ
• 単一JVM/複数JVMで衝突なし

• スレッドセーフ
• 同じクラスローダー内では衝突なし
• 異なるクラスローダー/JVMではほぼ衝突なし
• 同じクラスローダーのインスタンスを使用して生成されたUUIDはソート可能です

実際のプロジェクトでのパフォーマンス向上は、フィーチャのサイズによって異なります。

ジェネレーターが指定されていない場合、RandomUuidGeneratorが使用されます。

RandomUuidGeneratorとIncrementingUuidGeneratorのどちらもプロジェクトのニーズに合わない場合は、カスタムUUIDジェネレーターを定義できます。これは、次の方法で行います。

1. UUIDクラスジェネレーターを作成します。例：java package mypackage.mysubpackage; import io.cucumber.core.eventbus.UuidGenerator; public class MyUuidGenerator implements UuidGenerator { @Override public UUID generateId() { return ... } }
2. クラスパス上のファイルMETA-INF/services/io.cucumber.code.eventbus.UuidGenerator（例：Mavenのresourcesディレクトリ）を使用して、ジェネレーターのクラス名を含むSPIとしてUUIDジェネレーターを定義します：java mypackage.mysubpackage.MyUuidGenerator

このUUIDジェネレーターは、デフォルトのRandomUuidGeneratorをオーバーライドします。

META-INF/services/...ファイルに複数のUUIDジェネレーターが含まれている場合、またはクラスパスに複数のMETA-INF/services/...がある場合、cucumber.uuid-generatorプロパティを設定して、目的のジェネレーターを選択する必要があります。

最小限の設定については、Cucumber-JVMのspring-java-junit5の例を参照してください。