概要

【最終更新日】2017/07/03 (現在プレビュー版のため内容に変更があるかもしれません)

EmojiCompat サポートライブラリは古いバージョンの Android でも最新版の絵文字を表示できるようにする Google 製のライブラリです。

Android では OS のバージョンによって対応している絵文字が異なるため、OS が対応していない絵文字は □ のような文字 (Tofu) で表示されてしまいます。

EmojiCompat サポートライブラリを使用すると、ユーザーは Android OS のバージョンが古くても最新版の絵文字を見ることができます。

Android Developers : Emoji Compatibility
https://developer.android.com/topic/libraries/support-library/preview/emoji-compat.html#using-widgets-with-appcompat

おすすめ資料

▼ Androidエンジニアが抑えておくべき Unicode Emojiの知識 (DroidKaigi 2019)
(Youtube) https://www.youtube.com/watch?v=rsRnHCrWK8o
(スライド) https://speakerdeck.com/tacke_jp/unicode-emoji-for-android-engineer-droidkaigi09
「EmojiCompat で絵文字を変更できるのは分かったけど中では何をやっているの？」
「そもそも絵文字ってどうやって表現されてるの？」
上記の資料では絵文字の仕組みを理解することで EmojiCompat についての造詣が深まります。

EmojiCompat

サンプル

GitHub : googlesamples/android-EmojiCompat
https://github.com/googlesamples/android-EmojiCompat

ライブラリの導入

EmojiCompat は Android 4.4 (API 19) 以上で動作します。

EmojiCompat の導入方法は2通りあります。

• Downloadable fonts

Android O および Android Support Library 26 で導入された "Downloadable Fonts" の機能を使い Google Play サービス経由で絵文字データをダウンロードしてアプリで使用する方法です。
アプリ内に絵文字データを含める必要がないため、apk のサイズを抑えることができます。

• Bundled fonts

アプリに絵文字データを含める方法です。
絵文字データの分、apk のサイズが大きくなります。
(備考: 自環境では apk のサイズが 7MB 増加しました。assets に NotoColorEmojiCompat.ttf が追加されるようです)

Downloadable fonts

※ Android O プレビュー版必須だったためスキップ

Android Developer : Emoji Compatibility - Downloadable fonts configuration
https://developer.android.com/topic/libraries/support-library/preview/emoji-compat.html#downloadable-fonts
　
Android Developer : Downloadable fonts
https://developer.android.com/preview/features/downloadable-fonts.html

Bundled fonts

Bundled 版のEmojiCompat サポートライブラリを追加します。

dependencies {
    ...
    compile "com.android.support:support-emoji-bundled:26.0.0-beta2"
}

アプリ開始時に EmojiCompat の初期化を行う必要があります。
サンプルでは Application を継承したクラスで onCreate が呼ばれたときに行っています。

BundledEmojiCompatConfig のインスタンスを引数として、EmojiCompat.init(EmojiCompat.Config) メソッドをコールすることで EmojiCompat の初期化が行われます。

public class MyApplication extends Application {
@Override
    public void onCreate() {
       super.onCreate();
       EmojiCompat.Config config = new BundledEmojiCompatConfig(this);
       EmojiCompat.init(config);
    }
}

EmojiCompatを通して最新版の絵文字を表示させたい View は EmojiCompat 専用の View を使用する必要があります。
TextView であれば android.support.text.emoji.widget.EmojiTextView を使用します。
その他に専用の EditText, Button も用意されています。

<android.support.text.emoji.widget.EmojiTextView
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

通常のTextViewと同じように EmojiTextView.setText(CharSequence) で文字列をセットできます。
未対応の絵文字がセットされた場合には、EmojiCompat を通して最新版の絵文字が表示されます。

例.
Unicode 6.0 の絵文字まで対応している Android 5.1.1 で
Unicode 9.0 のキウイフルーツ (🥝: \ud83e\udd5d)
Unicode 10.0 のサンドイッチ (🥪: \ud83e\udd6a) を表示した場合

上. 通常版のTextView に上記2つをセットした場合
　Android 5.1.1では未対応の絵文字であるため Tofu が表示されてしまっている
下. EmojiTextView に上記2つをセットした場合
　2つの絵文字が正しく描画されている

AppCompat 対応

AppCompat 版のライブラリもあります。

dependencies {
      compile "com.android.support:support-emoji-appcompat:26.0.0-beta2"
}

View は android.support.text.emoji.widget パッケージの EmojiAppCompatTextView などの AppCompat 対応版を使用します。

v7 appcompat library が元になっており、EmojiAppCompatTextView であれば android.support.v7.widget.AppCompatTextView を継承しています。

<android.support.text.emoji.widget.EmojiAppCompatTextView
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

全ての絵文字を最新版に置き換えるかどうか

EmojiComapt.Config に対して setReplaceAll(boolean) で設定できる。
true にすると旧バージョンで使用可能な絵文字を最新バージョンの絵文字に置換する。
デフォルトはfalse。

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        EmojiCompat.Config config = new BundledEmojiCompatConfig(this);
        config.setReplaceAll(true);
        EmojiCompat.init(config);
    }
}

例. Android 5.1.1 での動作

上. setReplaceAll(false) or 未設定 の場合
　旧バージョンの絵文字は最新版のものに置換されずにそのまま表示される。
下. setReplaceAll(true) の場合
　旧版の絵文字が最新の絵文字に置換されて表示される
　( 撮影時は Android 8.0 用の絵文字が最新 )

遭遇したエラー

EmojiCompat.init() してない

Caused by: java.lang.IllegalStateException: EmojiCompat is not initialized.
Please call EmojiCompat.init() first

必ずアプリ開始時に EmojiCompat.init() しましょう。

絵文字をそのまま使用してエラー

setText("🥝") のように絵文字をそのまま使用することはできない。
setText("\ud83e\udd5d") のようにUTF-16の文字コードを使用する。

Android Studio 2.x でのエラー

Android Studio 2.x でプロジェクトを作成した場合に発生したエラー群。
(ライブラリの読み込みのエラーについては Android Studio 3.0 でプロジェクトを作成した場合、下記エラー群は発生しないんじゃないかなと思います)

ライブラリが読み込めない

サポートライブラリの仕様が変わったらしく、今まで Android SDK 経由でダウンロードしたライブラリを参照していた(と思われる)のを、maven 経由で参照する形式に変わったらしい。
下記のように build.gradle ファイルを変更する。

repositories{
    maven{
        url"https://maven.google.com"
    }
}

dependencies{
    ...
    compile'com.android.support:support-emoji:26.0.0-beta2'
    ...
}

ビルドするとエラー

Error:Error converting bytecode to dex:
Cause: Dex cannot parse version 52 byte code.
This is caused by library dependencies that have been compiled using Java 8 or above.
If you are using the 'java' gradle plugin in a library submodule add 
targetCompatibility = '1.7'
sourceCompatibility = '1.7'
to that submodule's build.gradle file.

説明文を読むにライブラリが Java 8 以上で作成されているために発生しているエラーと思われる。なのでプロジェクト自体をJava 8でビルドするように下記を追加した。

android{
    ....
    compileOptions{
        sourceCompatibilityJavaVersion.VERSION_1_8
        targetCompatibilityJavaVersion.VERSION_1_8
    }
}

にしたが再度エラー。

Error:Jack is required to support java 8 language features.
Either enable Jack or remove sourceCompatibility JavaVersion.VERSION_1_8.

Android Developer : Java 8 の言語機能を使う
https://developer.android.com/guide/platform/j8-jack.html?hl=ja
を参考に、Jackを有効にするとビルドが通るようになった。

android {
  ...
  defaultConfig {
    ...
    jackOptions {
      enabled true
    }
  }
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

Android バージョンと絵文字の歴史

http://emojipedia.org/google/android-4.3/
https://en.wikipedia.org/wiki/Android_version_history
などを参照しました。
Android バージョンによって使用可能な絵文字、実際に表示される絵文字が異なります。