車輪の再発見みたいな？

prefabってなんやねん

Android developersのAndroid Gradle プラグインのネイティブ依存関係によると、ネイティブライブラリの依存関係をaarライブラリに含めて配布＆使うようにするAndroid Gradle Plugin(AGP)の仕組みということみたいです。

詳しくはAndroid developersを見てもらうことにして、とりあえずprefabを使ってaarでネイティブライブラリを公開してみたです。

特徴

よいことも悪いことも色々と…

• ネイティブライブラリの依存関係をaarに含めて配布できる。
  つまり、ヘッダーファイルだとか共有ライブラリをJavaのクラスが生き別れになってUnsatisfiedLinkErrorでわけわからんくなることがなくなる…かもしれない。
• NDKでのビルド時にAGPが自動的に依存関係を挿入してくれるので手作業で共有ライブラリやヘッダーファイルを設定する必要がなくなる…かもしれない。
• 1つのモジュールにつき1つのヘッダーファイルディレクトリしか指定できない、コレ結構面倒くさい。
• おなじプロジェクトの別モジュールのaarをprefabの対象として使うことはできない。
• STL=c++_sharedが実質的に必須。
• aarに含まれるネイティブライブラリをビルドしたときのNDKバージョンと使う側のアプリ/モジュールでビルドするときのNDKバージョンが異なるとトラブることが多い。
• prefabを含むaarが巨大になる😱
• うまく依存関係を解決できないことが多いﾅﾝﾃﾞﾔﾈﾝ
• prefab作成時のインクルードファイルの相対パスと、prefabを使うときのインクルードファイルの相対パスが同じになるようにした方がトラブりにくい。

作ってみた

作るだけなら簡単✌️
Android developersに書いてあるとおり、 prefabPublishing をtrueにして、prefab項目内に公開したいネイティブライブラリを記述だけです。

ここで気をつけないといけないのは2点です。

1. 「headers」であるにもかかわらず、ヘッダーファイルディレクトリとして指定できるのは1つだけ。
2. ネイティブライブラリ名にハイフン「-」を含む場合には記述に注意が必要。

1つ目のヘッダーファイルディレクトリとして指定できるのは1つだけというのはissuesにも上がっていますが、今のところ修正される見込みはなさそうです。
ただし、下位ディレクトリまで再帰的に含めてくれますので、ヘッダーファイルのディレクトリの構造を工夫して、複数のディレクトリを含む上位ディレクトリを指定するようにするととりあえずはいけそうです。
ただし複数のネイティブライブラリが同じディレクトリを参照してしまうと同じヘッダーファイルがあっちこっちに含まれて肥大化することになるので注意が必要です。

2つ目のネイティブライブラリ名にハイフン「-」を含む場合についてはAndroid developersやぐるぐる先生のお告げには明確な記述がありません。
なので、自分のネイティブライブラリにハイフン「−」を含む場合にはわけわからんエラーが出て途方に暮れることになります。

こんな感じで大量にエラーが出ますが、これをみてライブラリ名にハイフンが含まれているからだとわかる人はほとんど居ないと思います。

このときのprefabセクションの記述はこうなっていました。「libmedia-backport.so」をaarに含めようとしていたわけですが、先ほどのような意味不明な大量のエラーが出力されます。

対策は、わかってみれば簡単なのですが、先ほどのprefabセクションを少し書き換えます。
nameで実際のネイティブライブラリ名(先頭の「lib」を取り除いて拡張子もなし)を指定します。nameを指定しない場合にはセクション名がnameとして解釈されるのでライブラリ名にハイフンを含まなければname指定は不要なのですが、セクション名にはハイフンを含めることができないのです。

このときのaar内の構造をAndroid Studioで見るとこのようになります。ちゃんとmedia-backportが公開されていますね。

ということでaarでネイティブをライブラリを公開してみたでした。
次回はaarに含めたネイティブライブラリへリンクしてビルドしてみるよ(^.^)/~~~