サーバ開発者向けガイド
Personiumのサーバソフトウェアそのものの開発に貢献したい人向けのドキュメントです
サーバソフトウェアの構成
Personiumの主要構成要素は以下2つのJava Web アプリケーションプログラムで、いずれもサーブレットコンテナ上で動作します。
| モジュール名 | 概要 | JavaDoc |
|---|---|---|
| personium-core | Personiumのメインサーバプログラム | 準備中 |
| personium-engine | coreの配下でEngine機能を担当するサブサーバプログラム | 準備中 |
これらサーバプログラムをTomcatなどのJavaサーブレットコンテナで動作させ、NginxやApacheなどのリバースプロキシサーバ経由で適切に用いて構築することでPersoniumのUnitとなります。
またバックエンドとして以下のミドルウェアに依存しています。
| モジュール名 | 概要 | 必須 | 用途 |
|---|---|---|---|
| ElasticSearch | Scalable NoSQL Search Engine | Yes | Datastore to support our OData interface. |
| ActiveMQ | Java Message Service (JMS) 実装 | Yes | Event Handling |
| Memcached | 汎用の分散型メモリキャッシュシステム | no | Lock/Cache |
開発用環境の構築
開発用の環境を構築したい人は開発用環境の構築手順をご覧ください。
依存ライブラリとその管理
Personium のサーバモジュール (core/engine)は、それら共通的に使う機能などは以下のライブラリとして実装している部分があります。サーバの機能追加・変更に当たっては場合によってこれらライブラリを改造する必要となる場合もあります。
| ライブラリ | 概要 | 依存モジュール | JavaDoc |
|---|---|---|---|
| personium-lib-common | core/engineで共通的に使うユーティリティ | core, engine | 準備中 |
| personium-lib-es-adapter | ElasticSearchへの接続を担うモジュール。ElasticSearchバージョンアップに伴う軽微非互換を吸収することを主たる目的としています。 | core | 準備中 |
| personium-client-java | Personium のJava client ライブラリ. Engineで使用 | engine | 準備中 |
| personium-plugin-base | Personium プラグイン記述のためのベース | core | 準備中 |
| personium-ex-base | Personium エンジン拡張記述のためのベース | engine | 準備中 |
Personiumはこれらのライブラリのほかに多くのオープンソースライブラリを活用しています。 ライブラリの依存関係についてはMavenにて管理しており、上記のプロジェクトライブラリについては現在は以下にあるプロジェクトのmavenリポジトリで管理をしています。
http://personium.io/mvnrepo/
詳しくは各プロジェクトのルートにあるpom.xmlを参照してください。
ライセンスに関する考慮
Personiumプロジェクトでは私たちの成果物をApache 2.0ライセンスに基づいてユーザの皆さんに気軽に安心して使っていただけるよう、同ライセンスと互換性の高いライブラリのみで構成するポリシーとしています。具体的には再配布禁止条項を含むライセンスのライブラリは使用しないポリシーとしています。
品質のためのテスト
- Personiumのサーバソフトウェアは自動テスト でその品質を確保しています。
- Pull Resuest を発行時は、関連する部分の自動テストを実行してエラーがないことを確認してから発行してください。
- CI環境での全体自動テスト走行により、全テストPassであることはMergeの必要条件です。
- 新機能を開発するときは必ず対応する自動テストが必要です。