West Hill 開発メモ

タグ:カスタムURLスキーム

westhillapp01://urlschemetest」のような独自のURLを使って、
Unity Androidアプリを起動する方法の実装メモです。

ブラウザや他のアプリからUnity Androidアプリを起動
custom_url_scheme_04
iOS版はこちら

実装時のバージョンはUnity4.0.1。

実装手段として、Androidのプラグインを作成してプロジェクトに組み込みます。
Unityが使用しているUnityPlayerActivityを継承する方法もあるのですが、
同時に使用しているプラグイン等との衝突を避けるために、
独自のActivityを作成して、カスタムURLスキームからの起動時には
独自のActivityを立ちあげる→UnityPlayerActivityへ遷移という実装にしました。

参考:Building Plugins for Android
   (「Extending the UnityPlayerActivity Java Code」以下)

①まずは、独自のActivityを含むjarライブラリを作成します。
eclipseで新規Androidプロジェクトを作って、
右クリック→Properties→AndroidでIsLibraryにチェック。
custom_url_scheme_02
②Unity Adnroidで使用しているクラスを参照するため、
以下パス内にある classes.jar ファイルを「libs」フォルダ内に配置します。
Winの場合:Unityのインストールパス\Editor\Data\PlaybackEngines\androidplayer\bin
Macの場合:Unityのインストールパス/Unity.app/Contents/PlaybackEngines/AndroidPlayer/bin


③独自URL経由で起動するActivityを作成します。
IntentReceiveActivity.java
public class IntentReceiveActivity extends Activity {

	/* アクティビティ保持用 */
	private static Activity mThisActivity;

	/* アクティビティ遷移ハンドラ */
	private static Handler mMoveActivityHandler = new Handler() {
		@Override
		public void handleMessage(Message msg) {
			// UnityPlayerProxyActivityへ遷移
			if (mThisActivity != null) {
				Intent i = new Intent(mThisActivity.getApplication(), UnityPlayerProxyActivity.class);
				mThisActivity.startActivity(i);
				mThisActivity.finish();
				mThisActivity = null;
			}
		}
	};

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);

		Context context = getApplicationContext();
		
		// SharedPreferences取得。UnityのPlayerPrefsでは、
		// バンドル名のSharedPreferencesを使用しているので合わせる
		SharedPreferences packagePrefs = context.getSharedPreferences(context.getPackageName(), Context.MODE_PRIVATE);
		SharedPreferences.Editor editor = packagePrefs.edit();
		
		// 指定のスキーム経由で起動されたフラグをSharedPreferencesに保存
		editor.putInt(getIntent().getData().getScheme(), 1);
		editor.commit();

		// アクティビティを保持
		mThisActivity = this;

		// アクティビティ遷移
		mMoveActivityHandler.sendEmptyMessageDelayed(0, 10);
	}

	@Override
	public void onBackPressed() {
		// バックキーで何もしない
		// super.onBackPressed();
	}
}
ここでは起動時のURLスキーム名をキーにしてSharedPreferencesにintのフラグを保存し、
Unityで使用している開始時のアクティビティUnityPlayerProxyActivityへ遷移するようにしています。

④↑で作成したAndroidプロジェクトをビルドして、「bin/」配下の プロジェクト名.jarファイル 
Unityプロジェクトビューのルート(フォルダ構成で言うとAssets直下)に「Plugins/Android」フォルダを作成して配置します。


⑤「Plugins/Android」フォルダに、 AndroidManifest.xml を作成します。
AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest
    xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.unity3d.player"
    android:installLocation="preferExternal"
    android:versionCode="1"
    android:versionName="1.0">
    <supports-screens
        android:smallScreens="true"
        android:normalScreens="true"
        android:largeScreens="true"
        android:xlargeScreens="true"
        android:anyDensity="true"/>

    <application
        android:icon="@drawable/app_icon"
        android:label="@string/app_name"
        android:debuggable="true">
        
        <activity android:name="com.unity3d.player.UnityPlayerProxyActivity"
                  android:label="@string/app_name"
                  android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
        <activity android:name="com.unity3d.player.UnityPlayerActivity"
                  android:label="@string/app_name"
                  android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">
        </activity>
        <activity android:name="com.unity3d.player.UnityPlayerNativeActivity"
                  android:label="@string/app_name"
                  android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">
            <meta-data android:name="android.app.lib_name" android:value="unity" />
            <meta-data android:name="unityplayer.ForwardNativeEventsToDalvik" android:value="true" />
        </activity>
         
        <!-- カスタムURLスキームからの起動用Activity -->
        <activity android:name="【ライブラリのパッケージ名】.IntentReceiveActivity">
            <intent-filter>
                <data android:scheme="【URLスキーム名】" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <action android:name="android.intent.action.VIEW" />
            </intent-filter>
        </activity>
         
    </application>
</manifest>
大事なのは<!-- カスタムURLスキームからの起動用Activity -->のIntentReceiveActivity定義部分です。
カスタムURLスキームリンク要求時に、指定のActivityでアプリを立ち上げる設定をしています。

【ライブラリのパッケージ名】の部分に①で作成したライブラリのパッケージ名を入れ、
【URLスキーム名】の部分を使用したい独自スキーム名にします。
※スキーム名は、URLの":"以前の部分になります。↑の例でいうと westhillapp01

※同時に使用しているプラグイン等でAndroidManifestが既に作られている場合には、
<!-- カスタムURLスキームからの起動用Activity -->部分のみ追記すれば問題ないです。


⑥Unity側で、カスタムURLスキームからの起動か否かを
以下のようにPlayerPrefsを使用して②で保存したフラグから判別することが出来ます。
bool launchFromCustomUrlScheme = PlayerPrefs.GetInt("【URLスキーム名】", 0) == 1 ? true: false;
PlayerPrefs.DeleteKey("【URLスキーム名】"); 

このエントリーをはてなブックマークに追加 Clip to Evernote

westhillapp01://urlschemetest」のような独自のURLを使って、
Unity iOSアプリを起動する方法の実装メモです。

ブラウザや他のアプリからUnity iOSアプリを起動
custom_url_scheme_03
Android版はこちら

実装時のバージョンはUnity4.0.1、Xcode4.6.1です。

Unityから吐き出されるXcodeプロジェクトに対して手動でURLスキームを設定出来るのですが、
同じ手順をビルドの度に行うのは億劫なので、Unity上でビルドする際に自動で設定されるようにします。 

参考:Build Player Pipeline

①Unityプロジェクトビューのルート(フォルダ構成で言うとAssets直下)に
「Editor」フォルダを作成し、中に"PostprocessBuildPlayer"という拡張子無しのファイルを作成します。
このファイルにスクリプトで記述した内容はビルド後に実行されるので、
Xcodeプロジェクトのinfo.plistに追記できます。

PostprocessBuildPlayer
#!/usr/bin/env python
 
import sys, os.path
 
install_path = sys.argv[1]
target_platform = sys.argv[2]
 
if target_platform != "iPhone": sys.exit()
 
info_plist_path = os.path.join(install_path, 'Info.plist')
 
file = open(info_plist_path, 'r')
plist = file.read()
file.close()
 
elements_to_add = '''
<key>CFBundleURLTypes</key>
<array>
 <dict>
  <key>CFBundleURLSchemes</key>
  <array>
   <string>【URLスキーム名】</string>
  </array>
 </dict>
</array>
'''
 
plist = plist.replace('<key>', elements_to_add + '<key>', 1)
 
file = open(info_plist_path, 'w')
file.write(plist)
file.close()
【URLスキーム名】の部分を使用したい独自スキーム名にします。
スキーム名は、URLの":"以前の部分になります。↑の例でいうと westhillapp01


②ターミナルにて「Editor」フォルダへ移動してPostprocessBuildPlayerへ以下コマンドで実行権限を与えます。
chmod +x PostprocessBuildPlayer
独自URLスキーム経由でアプリを起動するだけなら上記設定のみで可能です。

※吐き出されるXcodeプロジェクトのinfo.plistに「URL types - URL Schemes」の項目が無い場合はPostprocessBuildPlayerの実行に失敗しています。
この場合はUnityのコンソールビューのOpenEditorLogボタンでビルド実行時のログを見ることができるので、エラー情報など参照してください。
custom_url_scheme_01
自分は、PostprocessBuildPlayerの中身をBOM付きUTFで保存していたり、
改行コードがCRLFなどになってしまっていて何度か失敗しました…

ここから先はURLスキームからの起動をフックして、処理を分けたい等の場合の手順になります。


③Unityプロジェクトを一度iOS向けにビルドして、
XcodeプロジェクトからAppController.mmをコピーして、
Unityプロジェクトビューのルート(フォルダ構成で言うとAssets直下)に「Plugins/IOS」フォルダを作成して入れます。
「Plugins/IOS」にいれたソースファイルは、ビルド時にXcodeプロジェクト内の同名ファイルと自動で置き換えられます。

AppController.mm
内に↓の handleOpenURL 関数を追記します。
- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url
{
    if (!url) {  return NO; }
    
    // --- Custom URL Scheme Hook ---
    // スキーム名取得
    NSString *urlScheme = [url scheme];
    NSLog( @"url scheme used to open app: %@", urlScheme );
    // URLスキーム名でNSUserDefaultsに保存
    [[NSUserDefaults standardUserDefaults] setInteger:1 forKey:urlScheme];
    [[NSUserDefaults standardUserDefaults] synchronize];
    
    return YES;
}
ここで起動時のURLスキーム名をキーにしてNSUserDefaultsにintのフラグを保存しています。

※同時に使用しているプラグイン等で handleOpenURL 関数を使用してる場合には、
プラグイン側の同関数内に // --- Custom URL Scheme Hook --- の処理を追記すれば問題ないです。
自分の環境では、prime31SocialNetworkingPluginFacebookManager.mm
handleOpenURL を使用していたので、そちらにフック処理を追記しました。


④Unity側で、カスタムURLスキーム経由での起動か否かを
以下のようにPlayerPrefsを使用して③で保存したフラグから判別することが出来ます。
bool launchFromCustomUrlScheme = PlayerPrefs.GetInt("【URLスキーム名】", 0) == 1 ? true: false;
PlayerPrefs.DeleteKey("【URLスキーム名】");

このエントリーをはてなブックマークに追加 Clip to Evernote

このページのトップヘ