コンテンツにスキップ

モジュール開発

ここでは、STOCK-MAN アプリ (開発コードネーム: Storex 1) モジュールの開発とサンプルモジュールについて説明します。

サンプルモジュール

クイックスタートとして素早く内容を理解して開発を開始するために、簡単なサンプルを GitHub で公開しています。これらのモジュールは単純なテキストファイルやフォルダに読み書きする内容になっていますので、そのままバイナリをダウンロードして組み込み、アプリをまずは「使ってみる」こともできます。

開発可能なモジュールの種類

次の２種類のモジュールを開発できます。

開発要件

  • Visual Studio 2017 以上 (Express 2017 for Windows Desktop 可)
  • 適切なバージョンの Microsoft .NET Framework (SDK <= モジュール <= アプリ本体)
  • STOCK-MAN SDK (次のセクション)

STOCK-MAN SDK

Nuget (with prereleases)

新規でモジュールを開発する場合は、nuget.org で公開している適切なバージョンの NuGet パッケージへの参照をプロジェクトに追加してください。モジュールで使用可能な SDK のバージョンは、原則アプリで直接参照する SDK とメジャー番号が同じで、且つマイナー番号が同じか低いものです。例えばアプリで v1.2.0 が参照されている場合、モジュールで使用可能なのは v1.0.0 以上 v1.3.0 未満です。

API リファレンス

Storex.Core on fuget.org

SDK に含まれる API のリファレンスです。必要に応じて参照してください。

配置

ビルドしたアセンブリファイル (.dll) を任意のフォルダーに配置し、アプリの設定でフォルダーを指定します。フォルダーは複数指定できます。

データ保管モジュールの開発

データ保管モジュールをアプリで認識するには IRepositoryModule インターフェイスの実装と、次のような属性の指定が必要です。

Text Only
1
2
3
4
' Visual Basic の例
<RepositoryModuleExport("3051d137-3611-4911-b71c-8ecaeb7f9a7c", "社内DB", Description = "xx サーバーの SQL Server")>
Public Class MyRepositoryModule
    Implements IRepositoryModule
C#
1
2
3
// C# の例
[RepositoryModuleExport("3051d137-3611-4911-b71c-8ecaeb7f9a7c", "社内DB", Description = "xx サーバーの SQL Server")]
public class MyRepositoryModule : IRepositoryModule

また属性にはモジュールに関する次の追加情報 (メタデータ) が必要です。

名前 説明
Id モジュールを一意に識別できる文字列。Guid の文字列表現推奨。
DisplayName モジュールの表示名。
Description モジュールの補足説明。 省略可。

ユーザー認証モジュールの開発

ユーザー認証モジュールをアプリで認識するには IAuthenticationModule インターフェイスの実装と、次のような属性の指定が必要です。

Text Only
1
2
3
4
' Visual Basic の例
<AuthenticationModuleExport("42dc1253-5ca5-43ce-8eb9-558c8094cf5a", "社員証認証")>
Public Class MyAuthenticationModule
    Implements IAuthenticationModule
C#
1
2
3
// C# の例
[AuthenticationModuleExport("42dc1253-5ca5-43ce-8eb9-558c8094cf5a", "社員証認証")]
public class MyAuthenticationModule : IAuthenticationModule

また属性にはモジュールに関する次の追加情報 (メタデータ) が必要です。

名前 説明
Id モジュールを一意に識別できる文字列。Guid の文字列表現推奨。
DisplayName モジュールの表示名。
Description モジュールの補足説明。 省略可。

パッケージ化への対応とモジュール設定の永続化

STOCK-MAN は MSIX パッケージ化 された Windows デスクトップアプリです。このようなアプリには従来には無かった制限事項があり、特にアプリ設定 (この場合はモジュール設定) の永続化に関して追加で対処すべきことがあります。詳しくは次のパッケージ化されたアプリ用ツールキット 'WAP Toolkit' のドキュメントをご覧ください。

  1. 開発コードネーム各は各種ファイル名やパッケージ名、ソースコードの他、GitHub 等の開発者用向けサービスやリソースのURL にも使用しています。 ↩