Union Platform(7) Union Server Module作成準備

Posted on 9月 5th, 2009 by naoto koshikawa

本エントリーでは、Server ModuleとRoom Moduleを作成する際の準備方法を紹介します。UnionのバージョンはUnion alpha3を使用します。

Union ServerはJAVA言語で記述されているため、Server Module、Room ModuleともにJAVA言語で作成します。JAVA言語での開発にはeclipseを使うと便利です。

eclipeを使ったModule作成の準備

eclipseを使ってModuleを作成する際の準備方法を簡単に紹介します。

eclipseのインストール

eclipseを未だインストールしていない場合は、elipseの公式サイトからアーカイブをダウンロードしインストールします。ダウンロードして来たeclipse-SDK-3.5-win32.zipを解凍しお好きな場所へ配置します。

今回はWindowsにインストールする例ですが、Mac OS Xでもほとんど同じです。
以下のように配置しました。これらのパスはご自身の環境に合わせて読み替えて頂ければと思います。

e:\eclipse
e:\workspace
e:\union

プロジェクトの作成

[File] -> [new] -> [Java Project]を選択します。
Project nameはお好きな名前で良いですが、今回はunion_platform等と入力します。
ContentsはCreate project from existing sourceを選択します。
Directory: に e:¥union と入力します。これはunion serverのディレクトリを指定して下さい。
[Next]をクリックします。
[Finish]をクリックします。

これでUnion ServerのModuleを作成するProjectが作成出来ました。

Source Folderの作成

.javaファイルを格納するSource Folderを作成します。

Package Explorerでunion_platform(プロジェクト名)からコンテキストメニューを表示します。
[New] -> [Source Folder]を選択します。
Folder name: に src と入力します。
[Finish]をクリックします。

e:¥union¥srcが作成されていれば成功です。ソース格納場所が出来上がりました。次はここにクラスを作成して行きます。

Classの作成

Package Explorerでunion_platform(プロジェクト名)からコンテキストメニューを表示します。
[New] -> [Class]を選択します。
Package:に作成したいパッケージ名を入力します。今回は、com.asmple.server.union.module.serverとしました。
Name:にPackageに所属させるクラス名を入力します。今回は、ServerModuleSampleとしました。
Interfaces:の横の[Add]をクリックします。
Choose interfaces: に Moduleと入力します。
Matching intems: に Module – net.user1.union.api と表示されるので、選択して[OK]をクリックします。
[Finish]をクリックします。

e:¥union¥src¥com¥asmple¥server¥union¥module¥server¥ServerModuleSample.javaが作成されていれば成功です。

ServerModuleSampleの編集

さて、以下のようなjavaファイルが自動で生成されますが、L:11のreturnをtrueに変更します。ここでtrueをreturnしておかないとModuleの初期化に失敗してしまいますので注意しましょう。

package com.asmple.server.union.module.server;
 
import net.user1.union.api.Module;
import net.user1.union.core.context.ModuleContext;
 
public class ServerModuleSample implements Module {
 
	@Override
	public boolean init(ModuleContext arg0) {
		// TODO Auto-generated method stub
		return false;
	}
 
	@Override
	public void shutdown() {
		// TODO Auto-generated method stub
 
	}
 
}

L:11を以下のように変更。

11	return true;

build.xmlの作成

antツールを使って、jarファイルを作成する準備をします。モジュールをいくつも作成した際に、jarにまとめてしまおうという考えです。以下のようなe:¥union¥build.xmを作成します。

<?xml version="1.0" encoding="Shift_JIS"?>
<project name="com_asmple_union_server_module" default="jar" basedir="." >
	<target name="jar">
		<jar basedir="./bin" jarfile="lib/com-asmple-server-union-module.jar" />
	</target>
</project>

antに登録

[Window] -> [Show View] -> Antを選択します。
Ant Viewの左のボタン(Add Buildfiles)をクリックします。
union_platform(プロジェクト名)配下のbuild.xml(先ほど作成したもの)を選択します。
Ant Viewに新しいBuildファイルが追加されます。
com_asmple_union_server_moduleを選択して、右から３番目の矢印アイコン(Run)をクリックします。

e:¥union¥lib¥com-asmple-server-union-module.jar が出来上がっていれば成功。これでClassファイルを更新した際には、AntのRunを実行することで、jarファイルを更新できます。

startup.bat(.sh)の編集

Windows環境の場合はstartup.batを編集します。

java -cp lib\union.jar;lib\stax-api-1.0.1.jar;lib\wstx-asl-3.2.6.jar net.user1.union.core.UnionMain start

lib\wstx-asl-3.2.6.jarの後ろに以下を追記します。

;lib\com-asmple-server-union-module.jar

Mac OS X, Linux環境の場合はstartup.shを編集します。

#!/bin/sh
java -cp lib/union.jar:lib/stax-api-1.0.1.jar:lib/wstx-asl-3.2.6.jar net.user1.union.core.UnionMain start &

lib/wstx-asl-3.2.6.jarの後ろに以下を追記します。

:lib/com-asmple-server-union-module.jar

union.xmlの編集

<union>
    <server>
        <admin>
            <port>9110</port>
    	    <password>password</password>
        </admin>
        <client_timeout>30</client_timeout>
    </server>
    <gateways>
	    <gateway id="IOGateway" type="flash:io">
	    	<port>9100</port>
            <policy_file>policy.xml</policy_file>
	    </gateway>  
        <gateway id="NIOGateway" type="flash:nio">
            <port>9101</port>
            <policy_file>policy.xml</policy_file>
        </gateway>         	    
    </gateways>
    <modules>
        <module>
            <id>serverStatsServerModule</id>
            <source type="class">net.user1.union.servermodule.ServerStatsServerModule</source>
            <attributes>
                <attribute name="interval">300</attribute>
            </attributes>
        </module>   
    </modules>
</union>

L:26の下に以下を追加

        <module>
            <id>serverModuleSample</id>
            <source type="class">com.asmple.server.union.module.server.ServerModuleSample</source>
        </module>

Union Server起動

startup.bat(.sh)を実行して下記のようなログが出力されれば、新しいServer Moduleのロードは成功です。

2009-09-05 16:22:52,046 INFO  - Loaded module type [class] with code [com.asmple.server.union.module.server.ServerModuleSample]
2009-09-05 16:22:52,046 WARN  - Server module [serverModuleSample] loaded.