Function/core - Nimbus Wiki - Nimbus

[基本機能] DIコンテナ

DIコンテナとは、Dependency Injection Containerの略で、依存性注入を行えるコンテナの事です。
依存性注入とは、例えば、ある機能Aを提供するABeanがある時、Aの機能を提供するためには、その下位機能として機能Bが必要であるとします。 機能BがBBeanによって提供されるならば、ABeanが機能Aを提供するためには、BBeanが存在する事が前提になります。 このような場合、ABeanはBBeanに依存していると言います。
DIコンテナは、この依存関係を満たすために、まずBBeanを生成して、次にABeanを生成します。更に、ABeanにBBeanの参照を渡してあげます。これが、依存性注入です。

関連するパッケージは、以下です。

• jp.ossc.nimbus.core

概要

Nimbusは、サービスと呼ばれるライフサイクルを持ったオブジェクトをメモリ中にホスティングして、サービスを提供するDIコンテナを持ちます。
サービスをホスティングするには、サービス定義と呼ばれるXML定義ファイルで、サービスを配置します。サービス定義では、サービスの起動順序を制御するためにサービス同士の依存関係を定義したり、サービスに設定値を定義したりする事ができます。

サービス

Nimbusにおけるサービスとは、ライフサイクルを持ち、アプリケーションに対して機能を提供するJava Beansです。

ライフサイクルは、生成（create）、開始(start)、停止（stop）、破棄（destory）の４つのサイクルです。
生成は、サービス内部のインスタンス変数の初期化などを行います。また、生成の直後に依存性注入が行われます。
開始は、サービスが機能を提供する準備を行います。開始が完了すると機能提供が可能になります。
停止は、サービスが提供する機能を停止します。
破棄は、サービス内部のインスタンス変数を破棄します。

通常、サービスは、以下の３つのインタフェースを実装します。

• アプリケーションに対して、機能を提供する任意のインタフェース
• DIコンテナに対して、ライフサイクルを提供するServiceインタフェース
• JMXサーバに対して、管理機能を提供するMBeanインタフェース

但し、これら３つのインタフェースを実装しないPOJO（Plained Old Java Object）でも、サービスとしてホスティングする事もできます。
Nimbusでは、これらの３つのインタフェースを実装した様々なサービスを提供します。また、アプリケーション開発者が独自のサービスを実装して、ホスティングさせる事もできます。

以下に基本的なサービスの実装例を示します。

アプリケーション向け機能を提供するインタフェースMessage.java

 public interface Message{
     public void displayMessage();
 }

JMXサーバに対して、管理機能を提供するMBeanインタフェースMessageServiceMBean.java

 public inetrface MessageServiceMBean extends jp.ossc.nimbus.core.ServiceMBean{
     public void setMessage(String message);
     public String getMessage();
 }

サービスMessageService.java

 public class MessageService extends jp.ossc.nimbus.core.ServiceBase implements Message, MessageServiceMBean{
     
     private String message;
     
     // JMXサーバ向けのMBeanインタフェースを実装
     public void setMessage(String message){
         this.message = message;
     }
     public String getMessage(){
         return message;
     }
     
     // DIコンテナ向けのServiceインタフェースを実装
     // jp.ossc.nimbus.core.ServiceBaseを継承する事で、実装したいライフサイクルだけを実装する事ができる
     public void startService() throws Exception{
         if(message == null){
             throw new Exception("メッセージが設定されていません");
         }
     }
     
     // アプリケーション向けのインタフェースを実装
     public void displayMessage(){
         System.out.println(message);
     }
 }

サービス定義

Nimbusでは、XMLファイルでサービスをDIコンテナに配置する定義を記述します。この定義ファイルをサービス定義ファイルと呼びます。

サービス定義ファイルでは、おおまかには以下を定義する事ができます。

• デフォルトのログサービスを定義する
• サーバ環境変数を定義する。
• サービスをグルーピングするサービスマネージャを定義する
• マネージャ環境変数を定義する。
• サービスを定義する
  • サービスの名前を定義する
  • サービスのクラス名を定義する
  • サービスの生成種別（シングルトン、ファクトリ、スレッドローカル、テンプレート）を定義する
  • サービスのコンストラクタインジェクションを定義する
  • サービスのフィールドインジェクションを定義する
  • サービスの属性インジェクションを定義する
  • サービスのメソッドインジェクションを定義する
• サービスの依存関係を定義する

サービス定義ファイルの詳細な、定義ルールは、DTDファイルを参照して下さい。

以下に、簡単なサービス定義の例を示します。

service-definition.xml

 <?xml version="1.0" encoding="Shift_JIS"?>
 <!DOCTYPE server PUBLIC
   "-//Nimbus//DTD Nimbus 1.0//JA"
   "http://nimbus.sourceforge.jp/dtd/nimbus-service_1_0.dtd">
 <server>
     
     <manager>
         
         <service name="Message"
                  code="MessageService ">
             
             <attribute name="Message">こんにちは</attribute>
             
         </service>
         
     </manager>
     
 </server>

以下にサービス定義の読み込み方法、及びサービスの取得方法を示します。

 import jp.ossc.nimbus.core.ServiceManagerFactory;
 
 // サービス定義を読み込む
 if(ServiceManagerFactory.loadManager("service-definition.xml") && ServiceManagerFactory.checkLoadManagerCompleted()){
     System.out.println("サービス定義の読み込みに成功しました。");
 }else{
     System.out.println("サービス定義の読み込みに失敗しました。");
     System.exit(-1);
 }
 
 // サービスを取得する
 Message message = (Message)ServiceManagerFactory.getServiceObject("Message");

サンプルは、以下。

• サンプル１：サービス定義ファイルに、サービスを登録して、サービスを取得してみよう。
• サンプル２：サービス定義ファイルでインジェクションしてみよう。
• サンプル３：サービスをファクトリ化してみよう。
• サンプル４：サービスをJBoss Application Serverにデプロイしてみよう。
• サンプル５：サービスをJMXサーバに登録してみよう。
• サンプル６：変数をサービス定義から参照してみよう。
• サンプル７：サービス定義を条件に応じて切り替えてみよう。
• サンプル８：サービス定義ファイルをスタンドアローンに読み込もう。
• サンプル９：サービス定義ファイルをテンプレート化してみよう。