Hatena::ブログ(Diary)

cooldaemonの備忘録 RSSフィード

2012-05-14

Scala で Android アプリ開発(NDK 編)

下準備

始めに /path/to/hello-world/project/build.scala を次のように修正する。

// ..snip..

object AndroidBuild extends Build {
  lazy val main = Project (
    "Hello World",
    file("."),
    settings = General.fullAndroidSettings ++
               AndroidNdk.settings // これを追加
  )

  // ..snip..
}

次に /path/to/hello-world/src/main/jni/ を作成する。

$ make -p /path/to/hello-world/src/main/jni/

ラッパークラスを作る

ものは試しにファイルの情報を取得するラッパ /path/to/hello-world/src/main/scala/FileStat.scala を作成する。

package com.github.cooldaemon.HelloWorld

import _root_.java.io.File
import _root_.java.util.{Map => JMap}
import _root_.scala.collection.JavaConversions._

object extendFileStat {
  implicit def fileToFileStat(file: File): FileStat = new FileStat(file)
}

class FileStat(file: File) {
  System.loadLibrary("file_stat")

  @native private[this] def getStat(name: String): JMap[String, Long]
  def stat: Map[String, Long] = mapAsScalaMap(getStat(file.toString)).toMap
}

C 関連のファイルを用意する

.class ファイルを作るため一度コンパイルし、その後、javah でラッパクラスから C ヘッダファイルを作成する。

$ cd /path/to/hello-world
$ sbt
> compile
> exit
$ javah -o ./src/main/jni/file_stat.h -classpath ./target/scala-2.9.1/classes com.github.cooldaemon.HelloWorld.FileStat

sbt 経由で javah を実行する方法は試していない。

Makefile として /path/to/hello-world/src/main/jni/Android.mk を作成する。

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_MODULE    := file_stat
LOCAL_SRC_FILES := file_stat.c

#LOCAL_C_INCLUDES += $(SBT_MANAGED_JNI_INCLUDE)

include $(BUILD_SHARED_LIBRARY)

最後にファイル本体 /path/to/hello-world/src/main/jni/file_stat.c を作成する。

#include <sys/stat.h>
#include "file_stat.h"

jobject NewLong(JNIEnv* env, jlong value)
{
    jclass longClass = (*env)->FindClass(env, "java/lang/Long");
    jmethodID init = (*env)->GetMethodID(env, longClass, "<init>", "(J)V");
    jobject longObj = (*env)->NewObject(env, longClass, init, value);
    (*env)->DeleteLocalRef(env, longClass);
    return longObj;
}

JNIEXPORT jobject JNICALL Java_com_github_cooldaemon_HelloWorld_FileStat_getStat
  (JNIEnv *env, jobject obj, jstring name)
{
    jclass mapClass = (*env)->FindClass(env, "java/util/HashMap");
    jmethodID init = (*env)->GetMethodID(env, mapClass, "<init>", "(I)V"); 
    jobject mapObj = (*env)->NewObject(env, mapClass, init, 1);

    jmethodID put = (*env)->GetMethodID(env, mapClass, "put", "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");

    jboolean iscopy;
    const char *mfile = (*env)->GetStringUTFChars(env, name, &iscopy);    

    struct stat finfo;
    lstat(mfile, &finfo);

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "dev"),
        NewLong(env, finfo.st_dev)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "ino"),
        NewLong(env, finfo.st_ino)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "mode"),
        NewLong(env, finfo.st_mode)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "nlink"),
        NewLong(env, finfo.st_nlink)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "uid"),
        NewLong(env, finfo.st_uid)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "gid"),
        NewLong(env, finfo.st_gid)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "rdev"),
        NewLong(env, finfo.st_rdev)
    );

    (*env)->CallObjectMethod(env, mapObj, put,
        (*env)->NewStringUTF(env, "size"),
        NewLong(env, finfo.st_size)
    );

コンパイルしてみる。

$ sbt
> android:ndk-build

使用する

val f = new File(context.getFilesDir, "foo")
import extendFileStat._
f.stat foreach {case (k, v) => Log.d(k + ":" + v.toString)}

Scala で Android アプリ開発(AlertDialog 編)

毎回、AlertDialog を作るのは面倒なので、次のようなオブジェクトを作っておく。

package com.github.cooldaemon.HelloWorld

import _root_.android.content.Context
import _root_.android.app.{Dialog, AlertDialog => AAlertDialog}
import _root_.android.content.DialogInterface

object AlertDialog {
  def create(message: String)(f: () => Unit)(implicit c: Context): Dialog = {
    (new AAlertDialog.Builder(c))
      .setMessage(message)
      .setCancelable(true)
      .setPositiveButton("はい", new DialogInterface.OnClickListener() {
        override def onClick(dialog: DialogInterface, id: Int) {
          f.apply()
          dialog.dismiss()
        }
      })
      .setNegativeButton("いいえ", new DialogInterface.OnClickListener() {
        override def onClick(dialog: DialogInterface, id: Int) {
          dialog.cancel()
        }
      })
      .create()
  }
}

次のように onCreateDialog 内で使用する。

class FooActivity extends TypedActivity {
  // ..snip..

  object DialogID extends Enumeration {
    val WIFI,BLUETOOTH = Value
  }

  override protected def onCreateDialog(id: Int, args: Bundle): Dialog = id match {
    case id if id == DialogID.WIFI.id =>
      AlertDialog.create("Wi-Fi設定を行う") { () =>
        startActivity(new Intent(android.provider.Settings.ACTION_WIFI_SETTINGS))
      }
    case id if id == DialogID.BLUETOOTH.id =>
      AlertDialog.create("Bluetooth設定を行う") { () =>
        startActivity(new Intent(android.provider.Settings.ACTION_BLUETOOTH_SETTINGS))
      }
  }

  // ..snip..
}

Scala で Android アプリ開発(AsyncTask 編)

ScalaでAndroidアプリ作成時、AsyncTaskの可変長引数メソッドが使えないことへの対策とサンプル ― Gist を丸パクリ。

Scala は、可変長引数を持つメソッドを上書きできないので、可変長引数を上書き済みの /path/to/hello-world/src/main/java/com/github/cooldaemon/HelloWorld/AsyncTask.java を作成する。

package com.github.cooldaemon.HelloWorld;

public abstract class AsyncTask<Params, Progress, Result> extends android.os.AsyncTask<Params, Progress, Result> {
   @Override
   protected Result doInBackground(Params... params) {
      return doInBackground(params.length > 0 ? params[0] : null);
   }

   abstract protected Result doInBackground(Params param);

   @Override
   protected void onProgressUpdate(Progress... values) {
      onProgressUpdate(values.length > 0 ? values[0] : null);
   }

   protected void onProgressUpdate(Progress value) {}

   @SuppressWarnings({"unchecked"})
   protected final void publishProgress(Progress value) {
      super.publishProgress(value);
   }
}

用意した AsyncTask を継承して、別スレッドで処理したいタスクを記述する。

//可変長引数を使えない分は、case class で対応する
case class FooParam(foo: String, bar: String)

//  AsyncTask から Activity を操作する(doInBackground は除く)ために Activity のインスタンスを渡しておく
class FooTask(val activity: FooActivity) extends AsyncTask[FooParam, Int, Either[Throwable, Unit]] {
  override protected def onPreExecute() {
    // Activity に変化を加える。例えばダイアログの表示など
  }

  // doInBackground だけ別スレッドで動作する
  // doInBackground 内で publishProgress を使うと UI のスレッドに Int の値を送れる
  // 送った Int の値は onProgressUpdate で受け取れる
  override protected def doInBackground(param: FooParam): Either[Throwable, Unit] = {
    for {
      _     <- ham(param).right
      chick <- egg(param).right
      _     <- spam(param, chick).right
    } yield ()
  }

  override protected def onProgressUpdate(progress: Int) {
    // プログレスの更新
  }

  // AsyncTask の cancel メソッドを使用されると onCancelled が呼ばれる
  override protected def onCancelled() {
    // doInBackground の停止を促す。例えば doInBackground で参照しているフラグを onCancelled で更新するなど
  }

  override protected def onPostExecute(result: Either[HttpClientErrorResult, Unit]) {
    // Activity に変化を加える。例えばダイアログを消すなど
  }
}

このコードは、画面の回転に対応していない。

画面が回転すると Activity のインスタンスは置き換えられるが AsyncTask は残り続けるので AsyncTask が保持する Activity のインスタンスを置き換える必要がある。

また、画面の回転と ProgressDialog を組み合わせる場合、画面回転後に ProgressDialog を再表示する必要があり、onCreateDialog に頼る事になる。

ProgressDialog を再表示する場合、以前の ProgressDialog 進行状況を引き継いだり、キャンセル処理を正常に動作させる必要があるので、なるべく画面が回転しないように固定しておいた方が良い。

もし、どうしても AsyncTask + ProgressDialog + 画面回転に対応したいのであれば、Activity から操作できる AsyncTask と ProgressDialog を管理する object を用意する。

この辺りは、ダウンローダ編で詳しく解説する。

Scala で Android アプリ開発(Log 編)

ログを出力する際、ログ出力位置の情報も一緒に出力する。

package com.github.cooldaemon.HelloWorld

import _root_.android.util.{Log => ALog}

object Log {
  val TAG = "HelloWorld"
  
  def e(m: String) = printlog(ALog.e, m)
  def w(m: String) = printlog(ALog.w, m)
  def i(m: String) = printlog(ALog.i, m)
  def d(m: String) = printlog(ALog.d, m)
  def v(m: String) = printlog(ALog.v, m)
  
  private def printlog(f: (String, String) => Int, m: String): Int = {
    val st = ((new Throwable()).getStackTrace).apply(2)
    f(TAG, "%s.%s(%s:%s): %s".format(
      st.getClassName, st.getMethodName, st.getFileName, st.getLineNumber, m
    ))
  }
}

製品出荷時には、ログを出力しないよう注意。

2012-05-10

Scala で Android アプリ開発(ActionBarSherlock 編)

ActionBar は使いたいけれど、ターゲットの API Level が低い場合に重宝する ActionBarSherlock を Scala から使う。

sbt プロジェクト設定

まずは依存するライブラリを指定する。準備編を参考に作成したディレクトリ /path/to/hello-world の直下に main.sbt を作成する。

import sbt._
import Keys._
import AndroidKeys._

libraryDependencies ++= Seq(
  "com.actionbarsherlock" % "library" % "4.0.0-SNAPSHOT" artifacts(Artifact("library", "apklib", "apklib")),
  "android" % "compatibility-v4" % "r3-SNAPSHOT"
)

次に依存するライブラリの位置を指定する。/path/to/hello-world/project/build.scala を次のように修正する。

import sbt._

import Keys._
import AndroidKeys._

object General {
  val settings = Defaults.defaultSettings ++ Seq (
    name := "Hello World",
    version := "0.1",
    versionCode := 0,
    scalaVersion := "2.9.1",
    platformName in Android := "android-15", // android-10 から android-15 に変更
    resolvers += "ActionBarSherlock snapshots" at  "http://r.jakewharton.com/maven/snapshot/" // 新規追加
  )

// 以下、変更が無いので省略

最後に依存ライブラリを取得する。

$ cd /path/to/hello-world
$ sbt
> update
// 省略
[info] Resolving com.actionbarsherlock#library;4.0.0-SNAPSHOT ...
[info] Resolving android#compatibility-v4;r3-SNAPSHOT ...
// 省略
[info] Done updating.
[success] Total time: 4 s, completed 20XX/XX/XX XX:XX:XX
> exit

API Level の修正

AndroidManifest.xml 内の <uses-sdk> タグを次のように修正する。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.drops_market.Downloader">



  
  <uses-sdk android:minSdkVersion="7" android:targetSdkVersion="15"/>
</manifest>

Activity から使用する

package com.github.cooldaemon.HelloWorld

import _root_.android.app.Activity
import _root_.android.os.Bundle
import _root_.android.content.Context

// 新規に追加
import _root_.com.actionbarsherlock.app.SherlockActivity
import _root_.com.actionbarsherlock.view.{Menu, SubMenu, MenuItem}

// Activity を SherlockActivity に変更
class MainActivity extends SherlockActivity with TypedActivity {
  implicit lazy val c: Context = this
  
  override def onCreate(bundle: Bundle) {
    setTheme(R.style.Theme_Sherlock) // テーマを設定
    super.onCreate(bundle)
    setContentView(R.layout.main)

    findView(TR.textview).setText("hello, world!")
  }
  
  object MenuID extends Enumeration {
    val FOO,BAR,BAZ = Value
  }

  // 試しにメニューを追加してみる
  override def onCreateOptionsMenu(menu: Menu): Boolean = {
    menu
      .add(0, MenuID.FOO.id, Menu.NONE, "Foo")
      .setIcon(android.R.drawable.ic_menu_view)
      .setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM)
    
    val subMenu = menu.addSubMenu(0, MenuID.BAR.id, Menu.NONE, "Bar")

    subMenu.getItem
      .setIcon(android.R.drawable.ic_menu_more)
      .setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM)

    subMenu
      .add(0, MenuID.BAZ.id, Menu.NONE, "Baz")
      .setIcon(android.R.drawable.ic_menu_add)
      .setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM)

    true
  }

  override def onOptionsItemSelected(item: MenuItem): Boolean = {
    item.getItemId match {
      case id if id == MenuID.FOO.id => AtomicToast.show("Selected Foo")
      case id if id == MenuID.BAR.id => AtomicToast.show("Selected Bar")
      case id if id == MenuID.BAZ.id => AtomicToast.show("Selected Baz")
      case _ =>
    }
    true
  }
}

Toast 編で作成した AtomicToast を利用している。

テーマとして何が使えるか?SHOW_AS_ACTION_IF_ROOM って何よ?という疑問をお持ちの方は Google 先生にお尋ねください。

/path/to/hello-world/main.sbt に次のような設定していると…

javacOptions ++= Seq("-Xlint:unchecked")

scalacOptions ++= Seq("-verbose", "-unchecked", "-deprecation")

ものすごい数の ActionBarSherlock 関連の警告が出力されるが、ご愛嬌という事で。

Scala で Android アプリ開発(Toast 編)

Toast 表示中に Toast を表示すると問題があるらしい*1ので、次のようなラッパーオブジェクトを用意する。

package は、準備編で用意したもの。

package com.github.cooldaemon.HelloWorld

import _root_.android.content.Context
import _root_.android.widget.Toast

object AtomicToast {
  private[this] var toast: Toast = null

  def show(message: String)(implicit c: Context) = synchronized {
    if (toast != null) toast.cancel()
    toast = Toast.makeText(c, message, Toast.LENGTH_LONG)
    toast.show()
  }
}

これを Activity から使うには、次のようにする。

package com.github.cooldaemon.HelloWorld

// 省略

class MainActivity extends Activity with TypedActivity {
  implicit lazy val c: Context = this

  // 省略

  // 何らかのメソッドの中で…
    AtomicToast.show("Selected Foo")

  // 省略
}

implicit で Context を渡すのが嫌な方は適宜修正してご利用ください。

Scala で Android アプリ開発(準備編)

備忘という名の引き継ぎ的なアレ。Mac OSX 10.7 上で開発する事を前提とする。

sbt の準備

この辺りを見ながら sbt-launch.jar をダウンロードし、/usr/local/bin 配下に sbt-launch-0.11.3.jar という名前で保存する。

このままだと使い難いので、下記の Shell Script を用意する。

$ cat /usr/local/bin/sbt
java -Dhttp.proxyHost=XXX.XXX.XXX.XXX -Dhttp.proxyPort=XXXX -Xmx512M -Dfile.encoding=UTF-8 -jar `dirname $0`/sbt-launch-0.11.3.jar "$@"
パラメータ説明
-Dhttp.proxyHost=XXX.XXX.XXX.XXX -Dhttp.proxyPort=XXXXProxy 設定。Proxy を経由せずに外部と http/https 接続できるのであれば不要
-Xmx512M最大ヒープサイズ。環境に合わせて適度な値を…
-Dfile.encoding=UTF-8これを入れないと sbt console 上で日本語が使えない

giter8 の準備

まず cs コマンドをインストールする。

$ curl https://raw.github.com/n8han/conscript/master/setup.sh | sh

~/bin 配下にコマンドがインストールされるので ~/bin に PATH を通しておく。

次に g8 コマンドをインストールする。

$ cs n8han/giter8

Android SDK の準備

Android SDK | Android Developers から Mac OS X (intel) の android-sdk_r18-macosx.zip をダウンロードし、unzip で /usr/local 配下に伸張する。すると /usr/local/android-sdk-macosx が作成されるので下記の環境変数を設定する。

$ export ANDROID_SDK_HOME=/usr/local/android-sdk-macosx

zsh を利用しているなら .zshenv に上記を追加しておく。

また /usr/local/android-sdk-macosx/tools も作成されているので PATH を通しておく。

$ export PATH=$PATH:/usr/local/android-sdk-macosx/tools

zsh を利用しているなら .zshenv に下記を追加する。

path=(/usr/local/android-sdk-macosx/tools(N) $path)

次に /usr/local/android-sdk-macosx/tools/android を実行し Android SDK Manager を起動する。

$ android sdk

Proxy 設定が必要であれば、Android SDK Manager メニューから環境設定を選択し、Proxy settings の項目を穴埋めする。

Android SDK Manager 起動後、Tools フォルダ内の Android SDK Platforms-tools と Android X.X.X (API XX) の幾つか*2にチェックを入れ、下部の Install N package ボタンを押す。

すると、/usr/local/android-sdk-macosx/platform-tools と /usr/local/android-sdk-macosx/platforms/android-NN が作成される。platform-tools には adb コマンドが入っているので PATH を通しておく。

$ export PATH=$PATH:/usr/local/android-sdk-macosx/platform-tools

Android NDK の準備

Android NDK | Android Developers から Mac OS X (intel) の android-ndk-r8-darwin-x86.tar.bz2 をダウンロードし、tar jxf で /usr/local 配下に伸張する。すると /usr/local/android-ndk-r8 が作成されるので下記の環境変数を設定する。

$ export ANDROID_NDK_ROOT=/usr/local/android-ndk-r8

PATH も通しておく。

$ export PATH=$PATH:/usr/local/android-ndk-r8

準備した環境を試す

プロジェクトを作成する。

$ cd /path/to
$ g8 jberkel/android-app -b master

Template for Android apps in Scala

package [my.android.project]: com.github.cooldaemon.HelloWorld
name [My Android Project]: Hello World
main_activity [MainActivity]:
scala_version [2.9.1]:
api_level [10]:
useProguard [true]:

Applied jberkel/android-app.g8 in hello-world

コンパイルして実機にインストールする*3

$ cd /path/to/hello-world 
$ sbt
// メッセージ省略
> compile
// メッセージ省略
> android:install-device
// メッセージ省略
>

実機でアプリを起動すると hello, world! と表示される。


実践編へ続く。

*1:先に本記事のような対策をしてしまったので、困った経験がない

*2:実案件がターゲットとする API Level を選択する事

*3:USB デバックモードに設定した実機を Mac に接続する事を忘れないように…