WorkManager — Kotlin API

WorkManager は、非同期タスクのスケジュールを簡単に設定するための一連の API を提供します。これにより、アプリが閉じられた場合やデバイスが再起動した場合にも実行されることが期待されるタスクを即時実行または遅延実行できます。また、WorkManager は Kotlin ユーザーに最大級のコルーチンのサポートを提供します。この投稿では、WorkManager Codelab の内容に基づいて、WorkManager とコルーチンの基本について説明します。では早速始めましょう。

WorkManager の基本

ユーザーが特定の画面から離れたり、アプリがバックグラウンド状態になったり、デバイスが再起動したりしても実行を続ける必要があるタスクには、WorkManager ライブラリを使うことが推奨されています。一般的には、以下のようなタスクが考えられます。

• ログのアップロード、データのレポーティング
• 画像へのフィルタの適用、画像の保存
• ローカルデータとネットワークの定期的な同期

ユーザーが画面などの特定のスコープを離れたときに即時実行したタスクが終了する可能性がある場合は、直接 Kotlin コルーチンを使うことを推奨します。

WorkManager Codelab では、画像をぼかしてその結果をディスクに保存します。これを実現するために必要なことを確認しましょう。

まず、work-runtime-ktx 依存性を追加しました。

implementation "androidx.work:work-runtime-ktx:$work_version"

そして、独自の Worker クラスを実装します。ここに、バックグラウンドで実行する実際の作業に必要なコードを含めます。Worker クラスを拡張し、doWork() メソッドをオーバーライドします。これは一番重要なクラスなので、のちほど詳しく説明します。最初の実装は次のようになります。

次に、作業のリクエストを作成します。今回の場合は、作業を一度だけ行いたいので、OneTimeWorkRequest.Builder を使います。入力として、ぼかしたい画像の Uri を設定します。

Kotlin のヒント: 入力データを作成するために、workDataOf 関数を使うことができます。この関数は、データビルダーを作成し、キーと値のペアを格納してデータを作成します。

作業のスケジュールを設定して実行するには、WorkManager クラスを使います。その際に、実行するタスクと、タスクへの制約を指定できます。

Worker による作業の実行

Worker を使うと、WorkManager は自動的にバックグラウンド スレッドで Worker.doWork() を呼び出します。doWork() から返される Result は、WorkManager サービスに作業が成功したかどうかと、失敗した場合には作業を再試行すべきかどうかを通知します。

Worker.doWork() は同期呼び出しです。バックグラウンドの作業全体をブロックありで実行し、メソッドが終了するときには完了していることになります。doWork() で非同期 API を呼び出して Result を返すと、コールバックが正しく動作しない場合があります。

非同期作業を行いたい場合

もう少し複雑な例として、ぼかしをかけたすべてのファイルの Uri をデータベースに保存する場合を考えてみましょう。

これを実現するために、以下を作成しました。

• 単純な BlurredImage エンティティ
• 画像の挿入と取得を行う dao クラス
• データベース

実装はこちらをご覧ください。

Kotlin でデータベースへのデータの保存やネットワーク リクエストなどの非同期作業を行う必要がある場合は、CoroutineWorker の利用を推奨します。

CoroutineWorker を使うと、Kotlin コルーチンを使って非同期作業を行えます。

doWork() メソッドは suspend メソッドです。つまり、中断を伴う dao を簡単に呼び出すことができます。

デフォルトで、doWork() は Dispatchers.Default を使います。この動作は必要な Dispatcher でオーバーライドできます。今回は、既に Room が挿入作業を別の Dispatcher に移動させているので、これを行う必要はありません。詳しくは、Room Kotlin API の投稿をご覧ください。

ぜひ CoroutineWorker を使って、ユーザーがアプリを閉じても完了しなければならない非同期作業を実行してみてください。

WorkManager についてもっと詳しく知りたい方は、今後のシリーズで詳しく解説しますので、ご期待ください。それまでの間は、Codelab やドキュメントをご覧ください。

• WorkManager ドキュメント
• WorkManager を扱う Codelab
• 高度な WorkManager Codelab

この記事は Florina Muntenescu による Android Developers Blog の記事 "MAD Skills Kotlin and Jetpack: wrap-up" を元に翻訳・加筆したものです。詳しくは元記事をご覧ください。

今回は MAD Skills シリーズの 1 つ、Kotlin と Jetpack についての動画と記事をまとめました。Android コードの表現力と簡潔さ、安全性を向上させ、Kotlin で非同期コードを実行しやすくするさまざまな方法を取り上げています。

それぞれのエピソードから、Kotlin と Jetpack についての最新情報をご確認ください。いくつかの具体的な API を取り上げ、API の使い方だけでなく、API が内部的にどのように動作しているか解説しています。また、すべてのエピソードには対応するブログ投稿があり、そのほとんどにサンプルか Codelab へのリンクが含まれているので、実際に試してみたり、コンテンツに関する理解を深めたりできます。また、Jetpack や Kotlin のエンジニアが登場するリアルタイム Q&A も実施しました。

この記事は Florina Muntenescu による Android Developers - Medium の記事 "More productivity with Kotlin" を元に翻訳・加筆したものです。詳しくは元記事をご覧ください。

Kotlin は簡潔なプログラミング言語として知られています。そしてそれは、高い生産性を意味します。そして実際に、Kotlin を使っている Android デベロッパーの 67% が、生産性が向上したと述べています。このブログ投稿では、Kotlin を使ってパートナーのエンジニアたちが生産性を向上させた方法をいくつか共有し、そのために役立つ Kotlin の機能も紹介します。

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

- public class Task {
-     private final String name;
-     private final Date deadline;
-     private final TaskPriority priority;
-     private final boolean completed;
-
-     private Task(String name, Date deadline, TaskPriority priority, boolean completed) {
-         this.name = name;
-         this.deadline = deadline;
-         this.priority = priority;
-         this.completed = completed;
-     }
-
-     public static class Builder {
-         private final String name;
-         private Date deadline;
-         private TaskPriority priority;
-         private boolean completed;
-
-         public Builder(String name) {
-             this.name = name;
-         }
-
-         public Builder setDeadline(Date deadline) {
-             this.deadline = deadline;
-         return this;
-         }
-
-         public Builder setPriority(TaskPriority priority) {
-             this.priority = priority;
-             return this;
-         }
-
-         public Builder setCompleted(boolean completed) {
-             this.completed = completed;
-             return this;
-         }
-
-         public Task build() {
-             return new Task(name, deadline, priority, completed);
-         }
-     }
-}
+ data class Task(
+     val name: String,
+     val deadline: Date = DEFAULT_DEADLINE,
+     val priority: TaskPriority = TaskPriority.LOW,
+     val completed: Boolean = false
+) 

　/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */
   
- public class Singleton{
-    private static volatile Singleton INSTANCE;
-    private Singleton(){}
-    public static Singleton getInstance(){
-        if (INSTANCE == null) {                // Single Checked
-            synchronized (Singleton.class) {
-                if (INSTANCE == null) {        // Double checked
-                    INSTANCE = new Singleton();
-                }
-            }
-        }
-        return INSTANCE;
-    }
-    private int count = 0;
-    public int count(){ return count++; }
- }

+ object Singleton {
+     private var count = 0
+     fun count(): Int {
+         return count++
+     }+ }

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

fun borrow(){
    library -= book
    val (title, author) = book
    println("Borrowed $title")
}　

この記事は David Winer による Android Developers Blog の記事 "The future of Kotlin Android Extensions" を元に翻訳・加筆したものです。詳しくは元記事をご覧ください。

Android Kotlin Extensions Gradle プラグイン（Android KTX と混同しないでください）は、2017 年にリリースされ、Kotlin による Android 開発に次の 2 つの便利な新機能をもたらしました。

• synthetics を使うと、findViewById の呼び出しを kotlinx.android.synthetic バインディングで置き換えることができます。
  
  
• Parcelize を使うと、@Parcelize アノテーションによってボイラープレートを削除し、Parcelable を簡単に作成できます。

しかしその後、Android ビルド ツールチェーンと密接に統合された公式サポート ライブラリ View Binding for Android がリリースされ、Kotlin synthetics と同等の機能が提供されるようになりました。Parcelize は現在も使用が推奨されていますが、Kotlin synthetics の使用についてはたとえば以下のようにさまざまな欠点が明らかになりました。

• グローバル ネームスペースが煩雑になる
  
• null 可能性情報を公開しない
  
• Kotlin コードでしか動作しない

Android Kotlin Extensions プラグインは、もともと JetBrains が開発したものです。そして私たちは、JetBrains とともに、synthetics のメンテナンスを続けることの賛否について議論してきました。その中では、可能な限り API を長期にわたってサポートできるよう努力すべきという視点もありましたが、その一方でユーザーにとって使いやすいアプリを作れるよう、デベロッパーの皆さんにベスト プラクティスを提供してコードベースを健全化することの重要性も指摘されました。

そして結論として、私たちのチームは共同で、推奨オプションである View Binding のサポートを続けることを優先し、来年 1 年をかけて synthetics のサポートを終了することを決めました。

• Parcelize を使っている方は、今後も同じアノテーションと API を利用できます。ただし、アノテーション パッケージは kotlin-parcelize に変更されます。また、モジュールレベルの Gradle ファイルで、android-kotlin-extensions の代わりにスタンドアロンの kotlin-parcelize プラグインを使う必要があります。Parcelize のドキュメントは、Android デベロッパー ドキュメント サイトで確認できます。
  
  
• Android Kotlin synthetics を使っている方は、View Binding に移行してください。詳しくは、移行ガイドをご覧ください。

サポートの終了期間は、2020 年 11 月 23 日（日本時間 11 月 24 日）にリリースされた Kotlin 1.4.20 から始まります。android-kotlin-extensions は少なくとも 1 年間は残されますが、2021 年 9 月またはそれ以降の Kotlin リリースでは削除されます。kotlin-parcelize プラグインのメンテナンスは長期的に続ける予定です。Parcelize で発生する問題についてのご連絡は、今後も Android Studio Issue Tracker にお寄せください。

Reviewed by Takeshi Hagikura - Developer Relations Team and Hidenori Fujii - Google Play Developer Marketing APAC

ユーザーは皆さんのアプリにシームレスな体験を期待しています。アプリがクラッシュすれば、低評価のレビューやアンインストールが増え、ブランドにダメージを与えてしまうでしょう。その一方で、コミュニティの皆さんとの対話の中で、Kotlin を採用する主な理由の 1 つはコードの高い安全性であるということをよく耳にします。実際に何社かのパートナーは、Kotlin を使ってコードの安定性を改善しています。この投稿では、その方法をいくつか紹介するとともに、Google Play ストアの統計結果にも注目し、Kotlin とクラッシュ数との間に相関関係があるかどうかを確認してみたいと思います。

この記事は Florina Muntenescu による Android Developers - Medium の記事 "Don’t argue with default arguments" を元に翻訳・加筆したものです。詳しくは元記事をご覧ください。

<!-- Copyright 2019 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 -->

// instead of:
fun play(toy: Toy){ ... }

fun play(){
    play(SqueakyToy)
}

 // use default arguments:
 fun play(toy: Toy = SqueakyToy)

fun startPlaying() {
    play(toy = Stick)
    play() // toy = SqueakyToy
}

<!-- Copyright 2019 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 -->

class Doggo(
    val name: String,
    val rating: Int = 11
)

val goodDoggo = Doggo(name = "Tofu")
val veryGoodDoggo = Doggo(name = "Tofu", rating = 12)

<!-- Copyright 2019 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 -->
     
// kotlin
fun play(toy: Toy = SqueakyToy) {... }

// java
DoggoKt.play(DoggoKt.getSqueakyToy());
DoggoKt.play(); // error: Cannot resolve method 'play()'

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

@JvmOverloads
fun play(toy: Toy = SqueakyToy) {… }

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

fun play(toy: Toy = SqueakyToy)
...
fun startPlaying() {
    play(toy = Stick)
    play() // toy = SqueakyToy
}


// decompiled Java code
public static final void play(@NotNull Toy toy) {
   Intrinsics.checkNotNullParameter(toy, "toy");
}

// $FF: synthetic method
public static void play$default(Toy var0, int var1, Object var2) {
   if ((var1 & 1) != 0) {
      var0 = SqueakyToy;
   }

   play(var0);
}

public static final void startPlaying() {
   play(Stick);
   play$default((Toy)null, 1, (Object)null);
}

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */
   
fun play(doggo: Doggo = goodDoggo, doggo2: Doggo = veryGoodDoggo, toy: Toy = SqueakyToy) {...}

fun startPlaying() {
    play2(doggo2 = myDoggo)
}

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */
   
public static final void play(@NotNull Doggo doggo, @NotNull Doggo doggo2, @NotNull Toy toy) {
...
 }

// $FF: synthetic method
public static void play$default(Doggo var0, Doggo var1, Toy var2, int var3, Object var4) {
  if ((var3 & 1) != 0) {
     var0 = goodDoggo;
  }

  if ((var3 & 2) != 0) {
     var1 = veryGoodDoggo;
  }

  if ((var3 & 4) != 0) {
     var2 = SqueakyToy;
  }

  play(var0, var1, var2);
}

public static final void startPlaying() {
    play2$default((Doggo)null, myDoggo, (Toy)null, 5, (Object)null);
 }

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

open class Doggo(
    val name: String,
    val rating: Int = 11
) {
    open fun play(toy: Toy = SqueakyToy) {...}
}

class PlayfulDoggo(val playfulness: Int, name: String, rating: Int) : Doggo(name, rating) {
    // error: An overriding function is not allowed to specify default values for its parameters
    override fun play(toy: Toy = Stick) { }
}

public void play(@NotNull Toy toy) {...  }

// $FF: synthetic method
public static void play$default(Doggo var0, Toy var1, int var2, Object var3) {
  if (var3 != null) {
     throw new UnsupportedOperationException("Super calls with default arguments not supported in this target, function: play");
  } else {
     if ((var2 & 1) != 0) {
        var1 = DoggoKt.getSqueakyToy();
     }

     var0.play(var1);
  }
}

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */
   
// kotlin declaration
class Doggo(
    val name: String,
    val rating: Int = 11
)

// decompiled Java code
public final class Doggo {
   ...

   public Doggo(@NotNull String name, int rating) {
      Intrinsics.checkNotNullParameter(name, "name");
      super();
      this.name = name;
      this.rating = rating;
   }

   // $FF: synthetic method
   public Doggo(String var1, int var2, int var3, DefaultConstructorMarker var4) {
      if ((var3 & 2) != 0) {
         var2 = 11;
      }

      this(var1, var2);
   }

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

// kotlin
val goodDoggo = Doggo("Tofu")

// decompiled Java code
Doggo goodDoggo = new Doggo("Tofu", 0, 2, (DefaultConstructorMarker)null);

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

// kotlin
class Doggo(
    val name: String,
    val rating: Int = 11
) {
    constructor(name: String, rating: Int, lazy: Boolean = true)    
}

// decompiled Java code
public final class Doggo {
   ...
   public Doggo(@NotNull String name, int rating) {
      ...
   }

   // $FF: synthetic method
   public Doggo(String var1, int var2, int var3, DefaultConstructorMarker var4) {
      if ((var3 & 2) != 0) {
         var2 = 11;
      }

      this(var1, var2);
   }

   public Doggo(@NotNull String name, int rating, boolean lazy) {
      ...
   }

   // $FF: synthetic method
   public Doggo(String var1, int var2, boolean var3, int var4, DefaultConstructorMarker var5) {
      if ((var4 & 4) != 0) {
         var3 = true;
      }

      this(var1, var2, var3);
   }
}

KTX ライブラリ

GitHub の Kotlin サンプル

Kotlin とコルーチン

Kotlin スタートガイド

Java プログラミング言語と C++

改善が続くツールチェーン

関連情報・ドキュメント

11 Weeks of Android:

第 2 週: 機械学習

第 3 週: プライバシーとセキュリティ

第 4 週: Android 11 の互換性

Reddit AMA でご質問にお答えします

オンラインセミナー シリーズ Android 11 Meetups

AndroidX

• CustomView 1.1.0: Openable インターフェースが新しく追加されました。このインターフェースは DrawerLayout 1.1.0 と SlidingPaneLayout 1.1.0 で実装され、Navigation 2.3.0 で使われています。
• DrawerLayout 1.1.0: ジェスチャー ナビゲーション インセットの処理が向上し、CustomView 1.1.0 に新しく追加された Openable インターフェースを実装しました。
• Emoji 1.1.0: この絵文字フォントに、Emoji 12 と 12.1 が加わりました。
• Navigation 2.3.0: このバージョンには、動的機能モジュール機能が組み込まれています（まだインストールされていないモジュールへのナビゲーションが可能になり、そのモジュールが自動的にダウンロードおよびインストールされます）。このリリースには、バックスタック内の以前の宛先への結果の返却、navigation-testing アーティファクトによるテスト機能の改善、NavigationUI の新しい Openable インターフェース（DrawerLayout と SlidingPaneLayout がこれを実装しています）のサポート、ディープリンクのサポート強化などの機能が含まれています。
• SlidingPaneLayout 1.1.0: このレイアウトで CustomView 1.1.0 の新しい Openable インターフェースを実装しました。
• SwipeRefreshLayout 1.1.0: このレイアウトで NestedScrollingChild3 と NestedScrollingParent3 を実装しました。

最近公開されたブログ記事と動画

Android 11 のシステム強化

ストレージのスコープ化についての FAQ

パッケージ可視性

アプリの動作の監査

Play Billing で課金する

Android 11 Q&A

バイオメトリック コードラボ

ADB （Android Developers Backstage） ポッドキャスト 新エピソード

またお会いしましょう

Android 11 Beta… リリース！

11 Weeks of Android:

第 1 週: 人と ID

第 2 週: 機械学習

第 3 週: プライバシーとセキュリティ

Android 11 Meetups

AndroidX

現在アルファ版

• Hilt: Android で依存性注入を行う新しい Hilt ライブラリの最初のリリースです。Dagger を利用して構築されており、Android で DI を行う際の推奨ライブラリです。
  
  なお、AndroidX のバージョンは 1.0.0-alpha01 となっていますが、このライブラリは既に Dagger と一緒に使われている Google の内部バージョンに由来しています。切り替え可能な方はぜひご利用ください。現在アルファ版ですので、ベータ版になる前に皆さんのフィードバックなどを取り入れて API が少し変更される予定です。また、後述する Hilt の記事や、Hilt を使うようになった IOSched アプリ（後述）のコードも忘れずにご覧ください。
• Paging 3.0.0: Paging ライブラリが完全に書き直されてから初めてのリリースです。コルーチンや Flow のメリットを得るために Kotlin で書き直されましたが、他のアプローチを好む方のため、RxJava や Guava ListenableFuture プリミティブもサポートしています。Paging を使えば、RecyclerView へのデータのロードが簡素化および最適化されます。非同期アップデートが使われているので、今回の変更によって Paging は今まで以上に強力なものになるはずです。
• Startup 1.0.0: アプリケーションの起動を高速化するライブラリです。大量の ContentProvider を生成するという従来のアプローチ（それぞれの起動時にかなりの負荷がかかります）をとるのではなく、1 つの ContentProvider をプーリングして利用するなど、起動時のタスクを簡素化して集約することでそれを実現します。
• Room 2.3.0: このバージョンは主にバグの修正ですが、新しい Paging 3 ライブラリ（前述）のサポートも追加されています。
• Benchmarking 1.1.0: このライブラリによって、コードのパフォーマンス テストが簡単になります。今回の最新リリースでは、割り当ての指標、Android Studio プロファイラ ツールとの統合、簡単なセットアップ、そして（もちろん）バグの修正に対応しています。ADB ポッドキャスト エピソード #121 では、チームに詳しい話を聞いていますので詳しくはこちらをお聞きください。
• Core 1.5.0: 今回のリリースは、ShortcutInfo、Notifications などの Android 11 の新しい API と同期をとっています。
• Security Crypto 1.1.0: その他の変更として、このライブラリでは API 21（Android Lollipop）までのリリースをサポートするようになりました。

現在安定版

• Fragment 1.2.5: 今回のバグ修正リリースで安定版になりました。いくつかの修正は、今後の 1.3.0 リリースにバックポートされます。

サンプルコード: IOSched

最近公開されたブログ記事と動画

Hilt で Android に依存性を注入

Jetpack の新機能

Android Studio によるデバッグ

• ほしい情報のみを確認できるように、logcat のフィルタを設定する
• （再起動してデバッガを使うのではなく）既に実行されているアプリにデバッガをアタッチする
• ブレークポイントに関するいくつかのヒント
• コードのどの部分かを突き止める際に役立つスタックトレース分析
• その他多数！（本当です。たくさんのヒントが詰まったとても長ーい記事です）

System Trace

具象化

最近公開されたドキュメント

Jetpack

Modern Andoird Development（最先端の Android 開発）

ADB （Android Developers Backstage） ポッドキャスト 新エピソード

ADB 142: 機械学習の学習

• Episode 142: Machine Learning Learning

ADB 141: 会話についての議論

• Episode 141: Discussing Conversations

またお会いしましょう