インポート

LiQ Container を使用するには、最低限以下のインポート文が必要です。

import jp.liq.container.Container;
import static jp.liq.container.ContainerVocabulary.*;

最小の設定

LiQ Container を使うための最小のコードはたったこれだけです。

Container container = new Container();
sentinel.configure(container);

sentinel はインタフェース ContainerVocabulary に定義された static フィールドです。 LiQ Container では、このようにインタフェースに定義された static フィールドを起点にして Container の設定を行います。

ContainerVocabulary には他にも Container を設定するための語彙となる static フィールドが いくつか定義されています。これらの static フィールドを参照するには、static インポートを 使用するか、使用したいクラスで ContainerVocabulary を実装します。

この設定によって、Container はコンストラクタを一つ持つ任意の具象クラスを インスタンス化することができるようになります。

インスタンスの取得

では実際に、以下に示すクラス A のインスタンスを取得してみましょう。

public class A {
    private B b;

    public A(B b) {
        this.b = b;
    }
    
    public B getB() {
        return b;
    }
}

public class B {
}

このクラス A のインスタンスを取得するコードは以下のようになります。

A a = container.get(A.class);

assertNotNull(a);
assertNotNull(a.getB());

この例において、クラス A のコンストラクタにはクラス Bのインスタンスを渡す 必要があります。 Container は A をインスタンス化する前に、 まず B をインスタンス化し、Bをコンストラクタの引数に渡して A を インスタンス化する、という処理を行います。

このように、Container はあるクラスのインスタンスを生成する際に必要となる他のクラスの インスタンスを再帰的に取得します。

sentinel ではインスタンス化出来ないクラス

例えば、以下のようなクラスCは、複数のコンストラクタを持つため、sentinelによってインスタンス 化することは出来ません。インスタンス化するときに、どのコンストラクタを使ってよいのか、 判断できないからです。

public class C {
    private A a;

    public C() {
        
    }

    public C(A a) {
        this.a = a;
    }

    public A getA() {
        return a;
    }
}

ファクトリメソッドの定義

この時、Cのインスタンスを生成するファクトリメソッド createC を以下のように定義することができます。

public class CFactory {
    @Factory
    public C createC(A a) {
        return new C(a);
    }
}

Container の設定

ここで、Cのインスタンスをメソッド createC によって、生成するように設定するコードは、 以下のようになります。

Container container = new Container();

B b = new B();

components.configure(container)
    .define(component.factory(new CFactory())) //1. 
    .define(component.instance(B.class, b));

sentinel.configure(container);

C c = container.get(C.class);

assertSame(b, c.getA().getB());

1. の設定によって、CFactory のインスタンスメソッドのうち、アノテーション jp.liq.container.vocabulary.Factory が付与されたものが、そのメソッドの戻り値として指定されたクラスを生成するために使用されるようになります。

メソッドの引数は、Container がそのクラスのインスタンスを自動的に取得して渡します。

ファクトリクラスの指定

なお、1. の設定の代わりに、以下のようにCFactory のクラスオブジェクトを指定することもできます。

components.configure(container)
    .define(component.factory(CFactory.class))
    .define(component.instance(B.class, b));

この場合、まず Container は 他のクラスと同様に、CFactory のインスタンスを生成してから、 createC メソッドを呼び出します。

Field Injection の設定

sentinel が生成したインスタンスに対して Field Injection を行うには、 以下のようにします。

Container container = new Container();

sentinel.configure(container).with(injector.toFields());

Inject したいフィールドには、以下のように アノテーション import jp.liq.container.vocabulary.Inject を付与します。

public class D {
    @Inject
    public A a;
}

これによって、以下のようにDのインスタンスを取得したときに、フィールド a に A のインスタンスが自動的に設定されます。

D d = container.get(D.class);

assertNotNull(d.a);

Method Injection の設定

sentinel が生成したインスタンスに対して Method Injection を行うには、 以下のようにします。

Container container = new Container();

sentinel.configure(container).with(injector.toMethods());

Inject したいメソッドには、以下のように アノテーション import jp.liq.container.vocabulary.Inject を付与します。

public class E {
    private A a;

    public A getA() {
        return a;
    }

    @Inject
    public void setA(A a) {
        this.a = a;
    }
}

これによって、以下のようにDのインスタンスを取得したときに、メソッド setAの引数に に A のインスタンスが自動的に渡されます。

E e = container.get(E.class);

assertNotNull(e.getA());