OS X用のAir Native Extensions（ANE）の開発

すべてのhabroyuzeryにこんにちは。 OS Xのネイティブ拡張を作成した経験を共有したいと思います。

AIRは単純に素晴らしいクロスプラットフォーム環境です。 プラットフォーム固有のチップを使用するまでは。 ブラウザフラッシュゲームをOS X用のデスクトップフラッシュゲームに変えるタスクを与えられたときに遭遇したのはこの問題でした。AIR環境を使用したこれらすべては、数時間で私によって行われました。トピックには情報がいっぱいです。 最も興味深いことは、GameCenter、In-App-Purchaseなど、さまざまなAppleサービスをゲームに接続する必要が生じたときに始まりました。 そして、ここで私は困難に遭遇しました。 実際には、無料のものを含む既製のANEがたくさんあるということです。 しかし問題は、これらすべてのソリューションがiOSでのみ機能することです。 OS Xには、既製のライブラリはありませんが、これらのライブラリの作成に関する情報でさえ、何年も前のいくつかのインターネットリソースから少しずつ収集する必要があり、常にいくつかの落とし穴や氷山にさえ陥りました。

ここで、蓄積された知識と経験をすべて1か所に集め、共有して、ケシのネイティブライブラリを作成することに決めた場合に経験する苦労を少なくとも少し軽減したいと思います。 OS X用の4つの拡張機能を開発した後、それほど複雑で洗練されたようには見えません。

だから。 仕事のために、私は使用しました：
AIR 16
Flex 4.6.0;
Adobe Flash Builder 4.6またはIntelliJ IDEA 14（ライブラリの作成にはFlash Builderを使用しましたが、IntelliJ IDEAでも同じことができます。しかし、私がIntelliJ IDEAで開発したプロジェクトです。好みの問題だと思います）。
Xcode 6.1.1;
OS X Yosemite（10.10.1）;

ANEを作成するプロセス全体を3つの部分に分割します。

パート1 Objective-c

ほとんどのネイティブコードを記述してネイティブエクステンションの作成を開始する方が理にかなっていると思いますが、いずれにしても、ネイティブコードの変更に何度も戻る必要があります。

Xcodeで新しいプロジェクトを作成することから始めます。 ファイル->新規->プロジェクト...（Cmd + Shift + N）。 次に、OX X->フレームワークとライブラリ-> Cocoa Framworkを選択します。



フレームワークの名前を考え出します。 名前は何でも構いませんが、将来的には、将来のネイティブライブラリで使用されることはありません。



その後、ヘッダーファイルが1つある空のプロジェクトが作成されます。



ネイティブライブラリが、Objective-Cで何らかの方法で実行する必要がある単純な単一の関数を実装する予定の場合、実装ファイル（* .m）のみを使用してヘッダーファイルなしで実行できます。 しかし、本格的なクラスでの作業について説明します。

コードを記述する前に、Adobe AIR.frameworkライブラリをプロジェクトに追加する必要があります。 プロジェクトを右クリックし、「ファイルを「...」に追加」を選択します。 AIRに必要なライブラリが保存されているため、AIRの新しいバージョンが既にあることを願っています。 ここで見つけることができます：../AIR_FOLDER/runtimes/air/mac/Adobe AIR.framework。

その後、プロジェクトは次のようになります。



プロジェクト用の32ビットターゲットプラットフォーム（i386）もインストールする必要があります（目的ではありません）。 執筆時点では、Adobe AIR.frameworkは32ビットプラットフォームでのみ機能していました。 ビルド設定の同じプロジェクト設定で、自動参照を探し、Objective-Cの自動参照カウントをNoに設定します。



また、出力ファイルのパスを変更して、ソースと同じ場所に配置します。 誰にとってより便利です。



まず、コンテキストの初期化子（コンテキスト）とライブラリ自体を定義する必要があります（オプションで、ファイナライザも定義できます）。

最初に、コンテキスト初期化子を定義します。 奇妙なことに、as3部分のコンテキストを初期化するときに呼び出されますが、それについては後で詳しく説明します。 プロジェクトで複数のネイティブライブラリを使用する場合、イニシャライザの一意の名前を呼び出すことは非常に重要です。 コンテキスト初期化子は、as3コードから使用できる関数も定義します。

だから。 次のようにコンテキスト初期化子を宣言します。

FREContext AirCtx = nil; //   void MyAwesomeNativeExtensionContextInitializer(void* extData, const uint8_t* ctxType, FREContext ctx, uint32_t* numFunctionsToTest, const FRENamedFunction** functionsToSet) { NSLog(@"[MyANE.Obj-C] Entering ContextInitinalizer()"); *numFunctionsToTest = 1; // ,     as3 .        .    -  . FRENamedFunction* func = (FRENamedFunction*) malloc(sizeof(FRENamedFunction) * *numFunctionsToTest); func[0].name = (const uint8_t*) "initLibrary"; //  ,         as3. func[0].functionData = NULL; //  NULL.        NULL. func[0].function = &init; //   FREObject()  ojbective-c  //   // func[n].name = (const uint8_t*) "name"; // func[n].functionData = data; // func[n].function = &function; *functionsToSet = func; AirCtx = ctx; NSLog(@"[MyANE.Obj-C] Exiting ContextInitinalizer()"); } 

コンソールにメッセージを出力するNSLog関数は、メインプロジェクトを開発しているIDEコンソールでもトレースの形式でメッセージを出力することに注意してください。

次に、ライブラリ自体の初期化子を定義します。 その中で、イニシャライザとコンテキストファイナライザへのリンクを示します。 後でライブラリのアセンブリで使用します。

 void MyAwesomeNativeExtensionInitializer(void** extDataToSet, FREContextInitializer* ctxInitializerToSet, FREContextFinalizer* ctxFinalizerToSet ) { NSLog(@"[MyANE.Obj-C] Entering ExtInitializer()"); *extDataToSet = NULL; *ctxInitializerToSet = &MyAwesomeNativeExtensionContextInitializer; //   *ctxFinalizerToSet = &MyAwesomeNativeExtensionContextFinalizer; //  () NSLog(@"[MyANE.Obj-C] Exiting ExtInitializer()"); } 

次に、アクションスクリプトコードから使用できる唯一の関数について説明します。 この関数内では、iOS SDKの使用など、さまざまなネイティブのObjective-Cメソッドを呼び出すことができます。

 FREObject (init) (FREContext context, void* functionData, uint32_t argc, FREObject argv[]){ NSLog(@"[MyANE.Obj-C] Hello World!"); return nil; } 

便宜上、ディレクティブを使用できます。

 #define DEFINE_ANE_FUNCTION(fn) FREObject (fn)(FREContext context, void* functionData, uint32_t argc, FREObject argv[]) 

上記のディレクティブを使用すると、はるかに簡単で短い関数を定義できます。

 DEFINE_ANE_FUNCTION(init){ NSLog(@"[MyANE.Obj-C] Hello World!"); return nil; } 

ビルドを作成します（Command + B）。 その結果、最初に示したパスに、最初に示した名前と同じ名前のフレームワークが表示されるはずです。

最も単純なObjective-Cライブラリが用意されています。 できるのは、トレースで文字列を出力することだけです。 しかし、その作業を実証するためには十分です。 ここで、ANE-AS3ライブラリの後半を作成する必要があります。

パート2 アクションスクリプト

アクションスクリプト用のライブラリを作成するには、ActionScriptで開発する可能性がある任意のIDEを使用できます。 しかし、私はそのような目的で標準のIDEを使用しました-Flash Builder。

ライブラリの作成は非常に簡単です。ファイル->作成-> Flexライブラリプロジェクト。

ライブラリを呼び出して、必ずAdobe AIRライブラリを接続します。 実際、1つのクラスに対してこれを行います。これにより、コンテキストを操作できます。



新しいActionScriptクラスをすぐに作成し（デフォルトパッケージで作成するとさらに便利になります）、flash.events.EventDispatcherから継承します（一般的には、何からでも継承できますが、まったく継承できませんが、EventDispatcherクラスでは許可されます）インスタンスにイベントをディスパッチします。これは、要求されたデータの一部（GCフレンドのリスト、利用可能なIAPのリスト）がすぐに来ないiOS SDKで作業するときに非常に便利です。 これがメインクラスになり、ライブラリを操作するときに使用します。

最初に、コンテキストのインスタンスを取得する必要があります。 これは次のように行われます。

 var extCtx:ExtensionContext = ExtensionContext.createExtensionContext("my.awesome.native.extension", null); 

静的createExtensionContextメソッドは、extensionContextインスタンスを作成します。 ここでは、拡張機能のID、この場合は「my.awesome.native.extension」、およびコンテキストタイプを渡す必要があります。 タイプは、複数のライブラリ実装の場合にのみ指定する必要があります。 1つの実装が計画されている場合、nullを型として渡すことができます。

プロジェクトで同時に使用できるのは、特定のタイプのコンテキストである1つの（シングルトン）インスタンスのみです。 個人的には、多数のネイティブ拡張を作成した後、この拡張を複数実装する必要はありませんでした。 したがって、この場合、1つの実装を持つことで、基本的にANE全体に対して1つのインスタンスができます。 したがって、コンストラクターを1回呼び出す必要があり、将来は既に作成されたオブジェクトを取得するだけです。

実装する最も簡単なオプションは、オブジェクトのインスタンスを返す特定の静的関数を呼び出すか、コンストラクタがない場合はコンストラクタを介して新しいものを作成することです。

最初に、コンストラクターについて説明します（プロジェクトから呼び出すことはありません）。

 private static var _instance:MyANE; //    private var extCtx:ExtensionContext; //  public function MyANE(target:IEventDispatcher=null) { if (!_instance) { if (this.isSupported) { extCtx = ExtensionContext.createExtensionContext("my.awesome.native.extension", null); //   if (extCtx != null) { trace('[MyANE.AS3] extCtx is okay'); } else { trace('[MyANE.AS3] extCtx is null.'); } } _instance = this; } else { throw Error('[MyANE.AS3] This is a singleton, use getInstance, do not call the constructor directly'); //  ,     } } 

また、ANEがMacで実行しようとしていることを確認する必要があります。

 public function get isSupported():Boolean { return Capabilities.manufacturer.indexOf('Macintosh') > -1; } 

ここで、ライブラリのインスタンスを取得する必要があるたびにアクセスする関数について説明します。

 public static function getInstance():MyANE { return _instance != null ? _instance : new MyANE(); } 

この時点で、初期化が完了しました。 これで、Objective-Cのメソッドを使用できます。 コンテキストインスタンスクラスメソッド呼び出し（）を使用してネイティブコードから関数を呼び出すことができます。このメソッド呼び出しは、ネイティブコードのコンテキスト初期化子で指定された関数名の1つと引数として関数パラメーターを渡す必要があります。 この例では、「initLibrary」という関数を1つだけ説明しました。 彼女はパラメータを受け入れません。まあ、何も渡しません。

 public function init():void { extCtx.call("initLibrary"); } 

プロジェクトを保存します。 ライブラリは自動的にコンパイルされ、デフォルトでは、プロジェクトのルートにあるbinディレクトリに配置されます。
したがって、最も基本的な機能を提供しました。 これで最後の部分に移動できます。

パート3。 図書館集会

最後に、2つのネイティブライブラリがあります。 必要なのは、それらを完全なANEに接続することです。

最初に、拡張機能を記述する記述子が必要です。 次の* .xmlファイルになります。

 <extension xmlns="http://ns.adobe.com/air/extension/3.9"> <id>my.awesome.native.extension</id> <versionNumber>1.0.0</versionNumber> <platforms> <platform name="MacOS-x86"> <applicationDeployment> <nativeLibrary>MyANE.framework</nativeLibrary> <initializer>MyAwesomeNativeExtensionInitializer</initializer> <finalizer>MyAwesomeNativeExtensionFinalizer</finalizer> </applicationDeployment> </platform> <platform name="default"> <applicationDeployment/> </platform> </platforms> </extension> 

ここに：
id-リゾルバーのID。as3部分でコンテキストインスタンスを作成するときに指定したIDと一致する必要があります。
nativeLibrary-Objective-Cからコンパイルされたフレームワーク
初期化子、ファイナライザ-ライブラリの初期化子とファイナライザ（コンテキストではない）。これはOjbective-Cパートでも説明しました。

ネイティブコードがないデフォルトプラットフォームの実装を作成することもお勧めします。 さて、推奨事項に従ってください、それは難しくありません。

ライブラリの最後の部分の準備ができたので、ビルドを開始できます。 そして、ここから楽しみが始まります。

便宜上、アセンブリ用に別のフォルダーを作成することをお勧めします。そうしないと、混乱とおridgeが発生します。 次のフォルダー構造を使用します。


どこで

• _out-アセンブリの実際のフォルダー。
  
  • default-プラットフォームのデフォルト実装
    
    • library.sfw-組み立てられたas3-partを解凍して得られるswf
  • mac-macプラットフォームの実装
    
    • library.sfw-組み立てられたas3-partを解凍して得られるswf
    • MyANE.framework-コンパイルされたObjective-Cパーツ
  • extension.xml-拡張記述子
  • MakeANE.shは、ライブラリを迅速に構築するための単なるスクリプトです
• ActionScript3とObjective-Cは、ライブラリのプロジェクトパーツフォルダーです。

library.sfwで個別に。 はい、これはライブラリの一部であり、別々にする必要がありますが、同時に、組み立てられたas3ピースも必要です。 取得するには、アセンブルされたas3ライブラリを通常のzipアーカイブとして解凍する必要があります（これと同じas3ライブラリを保持します）。

あとは、AIR開発ツール（ADT）を使用して拡張機能を構築するだけです。 ここで見つけることができます：../AIR_FOLDER/bin/adt

アセンブリには、次のスクリプト（_outフォルダーから）を使用します。
AIR_FOLDER / bin / adt -package -target ane MyANE.ane extension.xml -swc ../ActionSript3/bin/MyANE.swc -platform MacOS-x86 -C mac。 -platform default -C default。

これで、コンパイル済みのネイティブライブラリであるMyANE.aneファイルが完成しました。 しかし、これでさえ終わりではありません。 OS Xプロジェクトでネイティブライブラリを使用しようとすると、本当の楽しみが始まります。 繰り返しになりますが、iOSにはたくさんのチュートリアルとさまざまなFAQがありますが、判明したように、OS Xではタンバリンだけでなく他の儀式を実行する必要があります。

最後の部分。 プロジェクトへのネイティブライブラリの統合

そのため、独自の書面ライブラリがあります。 ここに、完成した* .aneファイルがあります。 取って使用します。 しかし、違います。 開発中にOS Xでネイティブライブラリを使用するために、それは必要ありません。 しかし、もちろん、私たちの努力は無駄ではありませんでした。 次のことを行うだけです（IntelliJ IDEAのプロセスについて説明しますが、Flash Builderの場合もプロセスは似ており、場合によってはさらに簡単です）。

1. * .aneファイルを通常のzipアーカイブとして、拡張子のID + .aneとまったく同じ名前を持つフォルダーに解凍します。 この場合、「my.awesome.native.extension.ane」になります。 このフォルダをプロジェクト内の新しいディレクトリにコピーすることをお勧めします。 たとえば、既に解凍された拡張機能が含まれているこのlibs-aneがあります。
2. IntelliJ IDEAでは、プロジェクト設定で、このディレクトリを追加しないでください。
3. プロジェクト内の別のディレクトリに、アセンブルされたas3ライブラリを追加します。 libs-swcと呼ばれるこのディレクトリがあります。
4. このディレクトリは、プロジェクトに応じてすでに追加されています。 リンクタイプがマージされました。
5. ADL起動パラメーターで、次のオプション-extdir / ABSOLUTE_PATH_TO_PROJECT / libs-aneを追加する必要があります。 IntelliJ IDEAでは、これらのオプションは「実行」->「構成の編集」->「AIRデバッグランチャーオプション」にあります。
   
6. プロジェクト記述子で、「extensions」ブロックにネイティブ拡張のIDを追加します
   

    <extensions> <extensionID>my.awesome.native.extension</extensionID> </extensions> 

これで、デバッグにネイティブ拡張を使用できます。 しかし、もう1つあります。 おそらくご存知のように、iOS SDKには、Finderから起動された場合にのみ正常に機能するクラスがいくつかあります。 これを行うには、同じIntelliJ IDEAを使用して、ネイティブバンドルをビルドして使用できます。 しかし、問題は、ネイティブ拡張を統合する以前の方法ではバンドルを構築できないことです。 しかし、アセンブリは依然として有用である可能性があるため、もう少し作業する必要があります。 * .aneを覚えていますか？ だから今、その時が来ました。

1. すべての* .aneは、プロジェクト内の次の個別のディレクトリに追加する必要があります。 anesという名前のこのフォルダーがあります。
   IntelliJ IDEAでは、プロジェクトの設定で、このディレクトリも追加します。 接続のタイプはANEになり、それを変更することはできません（これが、バンドルを収集してデバッグモードで同時に動作することが不可能な理由です）。 さらにデバッグのために-このディレクトリを依存関係から削除し、バンドルのアセンブリのために-追加します。
2. しかし、いずれにせよ、外部ライブラリとしてanesが必要です。 これを行うには、追加のbuildパラメーターを説明する追加のbuild-config.xmlファイルを使用します。 このbuild-config.xmlでは、外部ライブラリのパスとしてanesディレクトリを指定する必要があります。 最も単純なオプションは次のようになります。
   
   

    <?xml version="1.0"?> <flex-config> <target-player>16.0.0</target-player> <swf-version>23</swf-version> <compiler> <external-library-path> <path-element>${flexlib}/libs/player/{targetPlayerMajorVersion}.{targetPlayerMinorVersion}/playerglobal.swc</path-element> <path-element>anes</path-element> </external-library-path> <as3>true</as3> <library-path> <path-element>libs-swc</path-element> </library-path> </compiler> </flex-config> 

   
   追加のbuild-configファイルを使用するには、プロジェクト設定に追加する必要があります。 プロジェクト構造->追加のコンパイラ構成ファイル。
   
   
   
   まあ、またはより簡単に、追加のコンパイラオプションで、パラメーターを追加できます： "-external-library-path path-element anes"
   
   

これで、ネイティブバンドルを収集できます。 これは、単にBuild-> Package AIR Applicationによって実行されます。 ターゲットとして、* .appを使用します。



さて、出力では、ANEを使用する作業ドラフトを備えた既製のネイティブバンドルを取得します。

以上です。 ご清聴ありがとうございました。この記事が誰かの役に立つことを願っています。 これはHabréに関する私の最初の記事なので、記事を改善する方法について建設的な批判とアドバイスを聞きたいです。 また、コメントの質問に間違いなく答え、できれば記事を補足します。

このトピックに興味がある場合は、as3とネイティブコード間のさまざまなデータの交換、イベントなどについても話したいと思います（ただし、これらは既に情報を見つけるのが少し簡単な一般的な概念ですが）。