最近のアクセス:
GeneXus をスマートデバイス用に拡張するための拡張ライブラリの概念

GeneXus 15 以降では、スマートデバイス用の拡張を容易に開発できるように、拡張ライブラリの概念が導入されています。

ライブラリの概念

ライブラリとは、スマートデバイス用の拡張ポイント (ユーザーコントロール外部オブジェクト、外部プロバイダーなど) の実装の詳細をグループ化する手段です。主に次の 2 つのコンポーネントで構成されます:
  • *.library 拡張子を持つ、XML に似たファイル。開発者は、各プラットフォームの拡張コンポーネントとそれらの実装内容をこのファイルにリストします。
  • 実装に必要なバイナリとその他の依存ファイル。
*.library ファイルでは、特別な意味を持つタグを定義します:
  • <ExtensionLibrary>...</ExtensionLibrary>
    ライブラリファイルの開始と終了を示すルートタグです。
    • <DependsOn>...</DependsOn>                    
                    .library に必要な依存関係を宣言します。最初は <ExtensionLibrary>ExtensionLibraryName</ExtensionLibrary> タイプのノードのみが許可されています (ExtensionLibraryName は、依存する拡張ライブラリ名を示す文字列)。たとえば、FirebaseAnalytics の拡張ライブラリが Firebase の拡張ライブラリに依存する場合は、Firebase の初期化コードを追加します。
  • <Implements>...</Implements>
    ライブラリで実装するコンポーネントをリストします。
    各項目のタグは GeneXus のオブジェクト名と一致する必要があります。次に例を示します。
    • <ExternalObject name="my_external_object" />
      外部オブジェクトの実装を表します。
       
    • <UserControl name="my_user_control" />
      ユーザーコントロールの実装を表します。
       
    • <NotificationProvider name="my_notification_provider" />
      通知プロバイダーの実装を表します。
       
    • <CacheProvider name="my_cache_provider" />
      キャッシュプロバイダーの実装を表します。
       
    • <StorageProvider name="my_storage_provider" />
      ストレージプロバイダーの実装を表します。
       
    • <Procedure name="my_procedure_name" />
      Procedure オブジェクトの実装の完全修飾名を表します。GeneXus 16 Upgrade 11 以降で使用できます。
 
  • <Android>...</Android>
    Android ジェネレーターに対する実装の依存関係を示します。
    また、特別なタグを定義します。
     
    • <ModuleClass>...</ModuleClass>
      エクステンションとそれを使用するコンポーネントをマッピングする目的で実行時にインスタンス化されるクラスです。オプションです*。
       
    • <GroupId>...</GroupId>
      ライブラリ (およびその一時的な依存関係) を実装する AAR ファイルが存在する Maven リポジトリのパッケージグループ識別子です。オプションです*。
    • <Name>...</Name>
      Maven リポジトリにおけるライブラリの名前です。オプションです*。
    • <Version>...</Version>
      Maven リポジトリにおけるライブラリのバージョンコードです。オプションです*。
    • <GradleExtensionFile>...<GradleExtensionFile>
      オプションです。ライブラリのビルドに使用される *.gradle ファイルです。このオプションは、外部ライブラリ参照を含める場合に使用します。
                       注: 拡張ライブラリの作成者は、Android 向けのライブラリ定義に標準の Maven リポジトリを追加する必要がなくなりました。標準の Maven リポジトリは既に含まれています。そのため、GeneXus 16 U5 以降ではこの拡張を含める必要がありません。
* GeneXus 17 Upgrade 4 以降ではこれらの値を追加する必要がなく、build.gradle の依存関係なしで拡張ライブラリを作成できるようになりました。
<iOS>...</iOS>
iOS ジェネレーターに対する実装の依存関係を示します。
項目属性: プラットフォーム
オプションです。このエクステンションの対象とする予定の Apple プラットフォームを示します。コンマ区切りで記入します。
値: iOS、tvOS、watchOS。
  • <ModuleClass>...</ModuleClass>
    オプションです。エクステンションとそれを使用するコンポーネントをマッピングする目的で実行時にインスタンス化されるクラスです。エクステンションを使用するコンポーネントがユーザーコントロールのみである場合はオプションです。
     
  • <PodFile>...</PodFile>
    オプションです。ライブラリの依存関係を示す *.pod の完全なファイル名です。
     
  • <XCProjExtensionFile>...</XCProjExtensionFile>
    オプションです。生成された Xcode プロジェクトを拡張するための XML ファイル名です。
     
  • <CopyListFile>...</CopyListFile>
    オプションです。生成したプロジェクトにコピーされる一連のファイルまたはディレクトリーをリストした XML ファイル名です。
  • <DisableBitcode>true</DisableBitcode>
    オプションです。 [ Bitcode ] プロパティをサポートしないエクステンションがプロジェクトに含まれる場合に、 [ Bitcode ] プロパティを無効にするために使用します。
  • また、特別なタグを定義します (詳細については、こちらのサイトを参照)。

たとえば、*.library ファイルが次のように定義されているとします:
<ExtensionLibrary>
    <Implements>
       <UserControl name="MyUserControl"/> 
       <UserControl name="MyUserControlVariant"/>
       <ExternalObject name="MyExternalObject"/>
    </Implements>
    <Android>
        <GroupId>com.example</GroupId>
        <Name>MyExtension</Name>
        <Version>1.0</Version>
        <ModuleClass>com.example.MyExtensionLibraryClassName</ModuleClass>
        <GradleExtensionFile>mylibraryextension.gradle</GradleExtensionFile>
    </Android>
    <iOS>
        <PodFile>MyExtension.Template.pod</Library>
        <ModuleClass>MyExtensionLibraryClassName</ModuleClass>
        <XCProjExtensionFile>MyExtension.XCExtensionTemplate.xml</XCProjExtensionFile>
        <CopyListFile>MyExtension.CopyListTemplate.xml</CopyListFile>
    </iOS>
</ExtensionLibrary>
前述のとおり、<ModuleClass> タグは、各コンポーネントが初期化されるクラスを参照しています。
mylibraryextension.gradle ファイルでは、次のようにパブリックリポジトリを参照し、必要なものすべてを追加できます:
repositories {
    jcenter()
}

Android の初期化コードのサンプル

class com.mypackage.MyExtensionLibraryClassName {

    @Override
    public void initialize(Context context) {

         UserControlDefinition ucDefinition = new UserControlDefinition("MyUserControl", MyUserControl.class);
         UcFactory.addControl(ucDefinition);

         UserControlDefinition ucDefinition = new UserControlDefinition("MyUserControlVariant", MyUserControlVariant.class);
         UcFactory.addControl(ucDefinition);

         ExternalApiDefinition apiDefinition = new ExternalApiDefinition("Module.Example.MyExternalObject", MyExternalObject.class);
         ExternalApiFactory.addApi(apiDefinition);

         //その他のコンポーネントの初期化
    }
}
ライブラリ自体では、実装対象のコンポーネントを詳細に定義します。外部オブジェクトでは、プラットフォーム固有のパラメーターを指定する必要はありません。

iOS の初期化コードのサンプル

@objc(MyExtensionLibraryClassName)
public class MyExtensionLibraryClassName: NSObject, GXExtensionLibraryProtocol {

    public func initializeExtensionLibrary(withContext context: GXExtensionLibraryContext) {

        GXActionExternalObjectHandler.register(MyGXActionExternalObjectHandlerSubclass.self, forExternalObjectName: "Module.Example.MyExternalObject")

        //その他のコンポーネントの初期化。ユーザーコントロールについては、その定義に基づいてマッピングが自動的に生成されるため除外

    }

}
実装には Swift 言語が使用されます。その場合、@objc(MyExtensionLibraryClassName) 表記を使用して、このクラスが実行時にリフレクションによってインスタンス化されるようにする必要があります。

使用可能バージョン

Android は GeneXus 15 Upgrade 3 以降でサポートされます。
iOS は GeneXus 15 Upgrade 6 以降でサポートされます。

参考情報







サブページ
Created: 18/10/29 01:05 by Admin Last update: 22/04/06 18:06 by Admin
カテゴリ
Powered by GXwiki 3.0