Xamarin.FormsでiOSのネイティブコードを使用して苦労した件について

Xamarin.FormsでiOSの自作ネイティブライブラリを使用しようとしてハマった話。
普通にiOSでやれば簡単だったけど、Cross-platformにしようとしたら面倒だったという話。

環境


  • mac book pro/El Capitan
  • Xamarin 5.10.3

手順


  1. 新規ソリューションの作成でCross-platform / Xamarin.Forms Appを作る
  2. ネイティブバインディング用のプロジェクトとして、iOS / Bindings Libraryを作る
  3. Sharpieなどを使ってバインディングコードを書く
    → ここあたりにやり方が描かれている。
  4. 1で作られたiOS用のプロジェクトに2のネイティブバインディングのアセンブリを参照設定で追加しようとする。
    → プロジェクト参照では、Xamarin.iOSとmonotouchで互換性がないのでNGと怒られるので、「.Net Assembly」タブの「ブラウズ」で無理くり参照設定する。
  5. ビルド
    → エラーになってビルドが通らなくなる。

対応

結局、csprojファイルを直接書き換えることで対応した。
いじる対象のcsprojファイルはバインディング側のプロジェクトファイルだ

/Project/PropertyGroup/ProjectTypeGuids要素を修正する。


    <ProjectTypeGuids>{8FFB629D-F513-41CE-95D2-7ECE97B6EEEC};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>

となっている箇所を

    <ProjectTypeGuids>{6BC8ED88-2882-458C-8E55-DFD12B67127B};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>

に変更する。
この要素は、プロジェクトのタイプを示していて、<ProjectTypeGuids>[作ったプロジェクトの種類(例えばiOSのアプリとかAndroidのアプリとか)を示す。]:[C#ということを示す。]</ProjectTypeGuids> という意味のようだ。
もともとのプロジェクトの種類が「Xamarin.iOS」だったところを、「Monotouch」へ変更する。なぜならXamarin.FormsのiOS側のプロジェクトのタイプが「Monotouch」で「Xamarin.iOS」と互換性がないからだ。

またこれに伴って、Xamarin.iOSの参照設定が使えなくなったので、参照設定で「Xamarin.iOS」を削除して、代わりに「monotouch」を追加する。
こうすることで、ネイティブバインディングプロジェクトのビルド自体は通るようになる。

次に、参照設定する側も同様にビルドをすると、エラーが発生しって相変わらずうまくいかない。
  • ネイティブバインディングから.aファイルが取り出せない。
というエラーになる。
実は本来であれば、コンパイルされたネイティブコードの.aファイルはリソースとして丸々入るのだが、今回の修正で、.aファイルはリソースに入らないという問題が発生し、そのため、参照先で.aファイルが取り出せないエラーが発生するようである。

仕方がないので、無理やりリソースに入れることとする。やり方は以下の通りだ。
  • ソリューションウインドウの、埋め込みする.aファイルで右クリックする。
  • 表示されたコンテキストメニューからビルドアクション > EmbeddedResourceを選択する。
これによって、.aファイルがリソースに含まれるようになる。

再度、参照設定する側でリビルドを行うが、今度は「MT5210」と言ったエラーが発生する。これは、ここによるとリンクしたライブラリのシンボル解決ができないということのようだ。
調べた結果、.aファイルのリソースの埋め込み名称と.aファイルをプロジェクトにドロップするときに自動生成される「〜.linkwith.cs」の中の参照先名の記述を変えてやれば良いことがわかった。

例えば、Hoge.aというネイティブライブラリをプロジェクトにドロップすると、linkwith.csでは

 [assembly: LinkWith("Hoge.a", SmartLink = true, ForceLoad = true)]

という記述が自動生成されるが、上記の「Hoge.a」という記述が生成されるアセンブリのリソース名になっていないと、参照設定する側で前述のリンクエラーが発生してしまう。
デフォルトだと、プロジェクトの名前空間名が修飾されるので、例えば「namaekuukan」というデフォルトネームスペースだったら、

 [assembly: LinkWith("namaekuukan.Hoge.a", SmartLink = true, ForceLoad = true)]

に変更する必要がある。
実際にどのようなリソース名で埋め込まれているかを調べるにはILSpyなどを使うと捗る。
この状態でソリューションビルドすることで（念のためクリーンアップしたほうが良い）、ビルドエラーが発生せずに、参照設定する側からネイティブライブラリを呼び出すことができるようになる。

なお、細かいところでは、
  • 「monotouch」に参照設定を変更したらusingしている箇所も「Monotouch.」と変更が必要になる
  • [assembly: LinkWithにリンカーフラグをつけたりする必要があったり
    →自分のところでは、「LinkerFlags = "-lstdc++"」を追記しました。
と言ったことが起きるので注意されたい。

コメント

コメントを投稿

このブログの人気の投稿

シンボルサーバーを設定する

シンボルサーバーを設定した（する）ので自分用のメモ シンボルサーバーを設定する マイコンピュータの環境設定の環境変数「_NT_SYMBOL_PATH」にシンボルサーバーへのパスを設定します。 例えば、 D:\symbols \\symserver\symbols http://msdl.microsoft.com/download/symbols にシンボルサーバーだよと設定したい場合、環境変数に Srv*D:\symbols*\\symserver\symbols*http://msdl.microsoft.com/download/symbols というように設定します。 これを設定しておくと、「D:\symbols」と「\\symserver\symbols」共有フォルダにシンボルファイルが格納されます。 シンボルサーバーへシンボルの追加 共有フォルダへシンボルファイルを追加する場合、「symstore.exe」を使用します。 これはMicrosoft Debugging Tools for Windowsのパッケージに含まれています。 例えば、「C:\svn\projects」フォルダ下に生成されたシンボルファイルを共有フォルダに登録したい場合、以下のように実行します。 symstore.exe add /f "c:\svn\projects\*.pdb" /s "\\symserver\sysmbols" /r このコマンドで「C:\svn\projects」フォルダ下の*.pdbファイルを再帰的探して共有フォルダに設定します。
続きを読む

マルチモニタをやめてみた

クラムシェルをやってみたくて一時的にマルチモニタをやめてみたら意外に作業が捗る事がわかった 理由を考えたところ作業スペースが有効に使え、マルチモニタのときは狭くて使って無かった紙とペンを使うようになったことと、何より集中力が上がった気がする。 目の前に余計な物がないのが良いみたいだ。 マルチモニタと作業効率でググると良いことしか書いてないページばかり引っ掛かるが、シングルモニタと集中力でググると真逆のことが書かれていて面白い。 マルチモニタ派の人は作業効率おしだがシングル派はかつてマルチモニタを使っていた人ばかりというのがより説得力がある。 結局は人それぞれなのかもしれないが、試しに片方のモニタの電源オフしてみるのも良いかも知れない
続きを読む

Xamarinのxamlのデータバインディングのpart4について訳してみた。

Part4. データバインディングの基礎 データバインディングは２つのオブジェクトのプロパティをリンクし、片方の変更を契機に もう片方の変更を発生させることができます。 これは大変価値のあるツールです。そしてデータバインディングはソースコード上で完璧に 定義することができ、XAMLはそのショートカットと利便性を提供します。 その結果として、バインティングがXamarin.Formsのマークアップ拡張は最も重要な機能 の一つとなります。 データバインディング データバインティングは２つのオブジェクトのプロパティを接続し、ソースからターゲットへ 呼び出しを行います。コードの中では、２つのステップが要求されます。 一つ目は、ターゲットオブジェクトのBindingContextプロパティを必ずソースオブジェクト にセットする必要があります。 二つ目は、SetBindingメソッド（しばしばBindingクラスと組み合わせて使用される）で、 ソースオブジェクトのプロパティに、そのオブジェクトのプロパティをバインドするために、 ターゲットオブジェクトから呼び出されなければなりません。 ターゲットプロパティは、バインディング可能なプロパティである必要があります。 つまり、ターゲットオブジェクトは必ずBindingObjectから継承されている必要があります。 オンラインのXamain.Formsのドキュメントでは、プロパティはバインド可能なプロパティで あることを示しています。 マークアップ中では、これらは同じ２つのステップが要求され、バインディングマークアップ の拡張機能は、SetBindingの呼び出しと、Bindingクラスの代わりに使用されます。 しかしながら、これらはターゲットオブジェクトのBindingContextへセットする単一の テクニックではありません。 しばしば、StaticResourceもしくはx:Staticマークアップ拡張機能を使用して、コード ビハインドのファイルからこれらは設定されます。 バインディングが最も頻繁に使用されるのは、画面表示系のプログラムとベースのデータモデル を接続する時で、しばしばMVVM(Model-View-ViewModel)アプリケーションアーキテクチャ で実現されます。MVVMについては
続きを読む