Emoji-Kompatibilität

Compose ausprobieren

Jetpack Compose ist das empfohlene UI-Toolkit für Android. Informationen dazu, wie Sie Emoji in Compose unterstützen können.

Emoji-Support →

Achtung:Seit Ende 2021 wird die androidx.emoji:emoji-Bibliothek nicht mehr unterstützt. Stattdessen wird androidx.emoji2:emoji2 verwendet, das in androidx.appcompat eingebunden ist.

Um moderne Emojis zu unterstützen und die Abwärtskompatibilität mit niedrigeren Android-Versionen zu vereinfachen, wird empfohlen, zur androidx.emoji2:emoji2-Bibliothek zu migrieren. Weitere Informationen zur Implementierung finden Sie unter Unterstützung moderner Emojis.

Die EmojiCompat-Supportbibliothek soll dafür sorgen, dass Android-Geräte immer die neuesten Emojis verwenden. Dadurch wird verhindert, dass in Ihrer App fehlende Emojis als ☐ angezeigt werden. Das bedeutet, dass auf Ihrem Gerät keine Schriftart zum Anzeigen des Texts vorhanden ist. Wenn Sie die EmojiCompat-Supportbibliothek verwenden, müssen Ihre App-Nutzer nicht auf Android-Betriebssystemupdates warten, um die neuesten Emojis zu erhalten.

Abbildung 1: Emoji-Vergleich

Weitere Informationen finden Sie in den folgenden Ressourcen:

• Beispiel-App „Emoji Compatibility“ Java | Kotlin

Wie funktioniert EmojiCompat?

Die EmojiCompat-Supportbibliothek bietet Klassen zur Implementierung der abwärtskompatiblen Emoji-Unterstützung auf Geräten mit Android 4.4 (API-Level 19) und höher. Sie können EmojiCompat entweder mit gebündelten oder herunterladbaren Schriftarten konfigurieren. Weitere Informationen zur Konfiguration finden Sie in den folgenden Abschnitten:

• Konfiguration herunterladbarer Schriftarten
• Konfiguration gebündelter Schriftarten

EmojiCompat identifiziert Emojis für ein bestimmtes CharSequence, ersetzt sie bei Bedarf durch EmojiSpans und rendert schließlich die Emoji-Glyphen. Abbildung 2 veranschaulicht den Vorgang.

Abbildung 2. EmojiCompat-Prozess

Konfiguration herunterladbarer Schriftarten

Die Konfiguration für herunterladbare Schriftarten verwendet die Support-Bibliothek für herunterladbare Schriftarten, um eine Emoji-Schriftart herunterzuladen. Außerdem werden die erforderlichen Emoji-Metadaten aktualisiert, die die EmojiCompat-Supportbibliothek benötigt, um mit den neuesten Versionen der Unicode-Spezifikation Schritt zu halten.

Support-Bibliotheksabhängigkeit hinzufügen

Wenn Sie die EmojiCompat-Supportbibliothek verwenden möchten, müssen Sie die Classpath-Abhängigkeiten Ihres App-Projekts in Ihrer Entwicklungsumgebung ändern.

So fügen Sie Ihrem Anwendungsprojekt eine Supportbibliothek hinzu:

1. Öffnen Sie die build.gradle-Datei Ihrer Anwendung.
2. Fügen Sie die Support-Bibliothek dem Bereich dependencies hinzu.

Groovy

dependencies {
    ...
    implementation "androidx.emoji:emoji:28.0.0"
}

Kotlin

dependencies {
    ...
    implementation("androidx.emoji:emoji:28.0.0")
}

Konfiguration der herunterladbaren Schriftart initialisieren

Sie müssen EmojiCompat initialisieren, um die Metadaten und die Schriftart zu laden. Da die Initialisierung einige Zeit dauern kann, wird sie in einem Hintergrundthread ausgeführt.

So initialisieren Sie EmojiCompat mit der Konfiguration für herunterladbare Schriftarten:

1. Erstellen Sie eine Instanz der Klasse FontRequest und geben Sie die Autorität des Schriftartenanbieters, das Paket des Schriftartenanbieters, die Schriftartenabfrage und eine Liste mit Hash-Sets für das Zertifikat an. Weitere Informationen zu FontRequest finden Sie im Abschnitt Herunterladbare Schriftarten programmatisch verwenden in der Dokumentation zu herunterladbaren Schriftarten.
2. Erstellen Sie eine Instanz von FontRequestEmojiCompatConfig und stellen Sie Instanzen von Context und FontRequest bereit.
3. Initialisieren Sie EmojiCompat, indem Sie die Methode init() aufrufen und die Instanz von FontRequestEmojiCompatConfig übergeben.

Kotlin

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        val fontRequest = FontRequest(
                "com.example.fontprovider",
                "com.example",
                "emoji compat Font Query",
                CERTIFICATES
        )
        val config = FontRequestEmojiCompatConfig(this, fontRequest)
        EmojiCompat.init(config)
    }
}

Java

public class MyApplication extends Application {
  @Override
   public void onCreate() {
     super.onCreate();
     FontRequest fontRequest = new FontRequest(
       "com.example.fontprovider",
       "com.example",
       "emoji compat Font Query",
       CERTIFICATES);
     EmojiCompat.Config config = new FontRequestEmojiCompatConfig(this, fontRequest);
     EmojiCompat.init(config);
   }
}

4. Verwenden Sie EmojiCompat-Widgets in Layout-XML-Dateien. Wenn Sie AppCompat verwenden, lesen Sie den Abschnitt EmojiCompat-Widgets mit AppCompat verwenden.

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

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

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

Weitere Informationen zum Konfigurieren von EmojiCompat mit der Konfiguration für herunterladbare Schriftarten finden Sie in der Beispiel-App „Emoji Compatibility“ (Java | Kotlin).

Bibliothekskomponenten

Abbildung 3: Bibliothekskomponenten im EmojiCompat-Prozess

Widgets: EmojiEditText, EmojiTextView, EmojiButton

Standard-Widget-Implementierungen für die Verwendung mit EmojiCompat, TextView, EditText und Button.

EmojiCompat

Wichtigste öffentliche Oberfläche für die Support-Bibliothek. Sie führt alle externen Aufrufe aus und koordiniert sich mit den anderen Teilen des Systems.

EmojiCompat.Config

Konfiguriert die Singleton-Instanz, die erstellt werden soll.

EmojiSpan

 Eine ReplacementSpan-Unterklasse, die die Zeichen (Sequenzen) ersetzt und das Glyphen rendert.

EmojiCompat Schriftart

EmojiCompat verwendet eine Schriftart zum Anzeigen von Emojis. Diese Schriftart ist eine modifizierte Version der Android-Emoji-Schriftart. Die Schriftart wird so geändert:

• Um die Rückwärtskompatibilität für das Rendern von Emojis zu gewährleisten, werden alle Emoji-Zeichen mit einem einzelnen Unicode-Codepoint im Supplemental Private Use Area-A von Unicode ab U+F0001 dargestellt.
• Zusätzliche Emoji-Metadaten werden in einem Binärformat in die Schriftart eingefügt und zur Laufzeit von EmojiCompat geparst. Die Daten sind in der meta-Tabelle der Schriftart mit dem privaten Tag Emji eingebettet.

Konfigurationsoptionen

Sie können die EmojiCompat-Instanz verwenden, um das Verhalten von EmojiCompat zu ändern. Sie können die folgenden Methoden aus der Basisklasse verwenden, um die Konfiguration festzulegen:

• setReplaceAll(): Gibt an, ob EmojiCompat alle gefundenen Emojis durch EmojiSpans ersetzen soll. Standardmäßig versucht EmojiCompat, zu erkennen, ob das System ein Emoji rendern kann, und ersetzt diese Emojis nicht. Wenn diese Option auf true festgelegt ist, werden alle gefundenen Emojis in EmojiCompat durch EmojiSpans ersetzt.
• setEmojiSpanIndicatorEnabled(): Gibt an, ob EmojiCompat ein Emoji durch ein EmojiSpan ersetzt hat. Wenn dieser Parameter auf true gesetzt ist, wird mit EmojiCompat ein Hintergrund für EmojiSpan gezeichnet. Diese Methode wird hauptsächlich zum Debugging verwendet.
• setEmojiSpanIndicatorColor(): Legt die Farbe für die Anzeige eines EmojiSpan fest. Der Standardwert ist GREEN.
• registerInitCallback: Informiert die App über den Status der EmojiCompat-Initialisierung.

Kotlin

val config = FontRequestEmojiCompatConfig(...)
        .setReplaceAll(true)
        .setEmojiSpanIndicatorEnabled(true)
        .setEmojiSpanIndicatorColor(Color.GREEN)
        .registerInitCallback(object: EmojiCompat.InitCallback() {
            ...
        })

Java

EmojiCompat.Config config = new FontRequestEmojiCompatConfig(...)
       .setReplaceAll(true)
       .setEmojiSpanIndicatorEnabled(true)
       .setEmojiSpanIndicatorColor(Color.GREEN)
       .registerInitCallback(new InitCallback() {...})

Initialisierungs-Listener hinzufügen

Die Klassen EmojiCompat und EmojiCompat bieten die Methoden registerInitCallback() und unregisterInitCallback() zum Registrieren eines Initialisierungs-Callbacks. Erstellen Sie zum Verwenden dieser Methoden eine Instanz der Klasse EmojiCompat.InitCallback. Rufen Sie diese Methoden auf und übergeben Sie die Instanz der EmojiCompat.InitCallback-Klasse. Wenn die Initialisierung der EmojiCompat-Supportbibliothek erfolgreich ist, ruft die Klasse EmojiCompat die Methode onInitialized() auf. Wenn die Bibliothek nicht initialisiert werden kann, ruft die Klasse EmojiCompat die Methode onFailed() auf.

Rufen Sie die Methode getLoadState() auf, um den Initialisierungsstatus zu einem beliebigen Zeitpunkt zu prüfen. Es wird einer der folgenden Werte zurückgegeben: LOAD_STATE_LOADING, LOAD_STATE_SUCCEEDED oder LOAD_STATE_FAILED.

EmojiCompat mit AppCompat-Widgets verwenden

Wenn Sie AppCompat widgets verwenden, können Sie EmojiCompat-Widgets verwenden, die von AppCompat widgets abgeleitet sind.

1. Fügen Sie die Support-Bibliothek dem Abschnitt „dependencies“ hinzu.

   Groovy

   dependencies {
       ...
       implementation "androidx.emoji:emoji-bundled:$version"
   }

   Kotlin

         dependencies {
             implementation("androidx.emoji:emoji-appcompat:$version")
         }
         

   Groovy

         dependencies {
             implementation "androidx.emoji:emoji-appcompat:$version"
         }
         

2. Verwenden Sie EmojiCompat AppCompat Widget-Widgets in XML-Layouts.

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

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

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

Konfiguration gebündelter Schriftarten

Die EmojiCompat-Supportbibliothek ist auch in einer gebündelten Schriftartversion verfügbar. Dieses Paket enthält die Schriftart mit den eingebetteten Metadaten. Das Paket enthält auch ein BundledEmojiCompatConfig, das die AssetManager verwendet, um die Metadaten und Schriftarten zu laden.

Hinweis:Die Schriftart ist mehrere Megabyte groß.

Support-Bibliotheksabhängigkeit hinzufügen

Wenn Sie die EmojiCompat-Supportbibliothek mit gebündelter Schriftkonfiguration verwenden möchten, müssen Sie die Classpath-Abhängigkeiten Ihres App-Projekts in Ihrer Entwicklungsumgebung ändern.

So fügen Sie Ihrem Anwendungsprojekt eine Supportbibliothek hinzu:

1. Öffnen Sie die build.gradle-Datei Ihrer Anwendung.
2. Fügen Sie die Support-Bibliothek dem Bereich dependencies hinzu.

Groovy

dependencies {
    ...
    implementation "androidx.emoji:emoji:28.0.0"
}

Kotlin

dependencies {
    ...
    implementation("androidx.emoji:emoji:28.0.0")
}

Gebündelte Schriftarten zum Konfigurieren von EmojiCompat verwenden

So konfigurieren Sie EmojiCompat mit gebündelten Schriftarten:

1. Verwenden Sie BundledEmojiCompatConfig, um eine Instanz von EmojiCompat zu erstellen und eine Instanz von Context anzugeben.
2. Rufen Sie die Methode init() auf, um EmojiCompat zu initialisieren, und übergeben Sie die Instanz von BundledEmojiCompatConfig.

Kotlin

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        val config = BundledEmojiCompatConfig(this)
        EmojiCompat.init(config)
    }
}

Java

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

EmojiCompat ohne Widgets verwenden

EmojiCompat verwendet EmojiSpan, um korrekte Bilder zu rendern. Daher muss jede angegebene CharSequence in Spanned-Instanzen mit EmojiSpans umgewandelt werden. Die Klasse EmojiCompat bietet eine Methode zum Konvertieren von CharSequences in Spanned-Instanzen mit EmojiSpans. Mit dieser Methode können Sie die verarbeiteten Instanzen anstelle des Roh-Strings verarbeiten und im Cache speichern, was die Leistung Ihrer Anwendung verbessert.

Kotlin

val processed = EmojiCompat.get().process("neutral face \uD83D\uDE10")

Java

CharSequence processed = EmojiCompat.get().process("neutral face \uD83D\uDE10");

EmojiCompat für IME verwenden

Mit der EmojiCompat-Supportbibliothek können Tastaturen die Emojis rendern, die von der Anwendung unterstützt werden, mit der sie interagieren. IMEs können mit der Methode hasEmojiGlyph() prüfen, ob EmojiCompat ein Emoji rendern kann. Diese Methode verwendet einen CharSequence eines Emojis und gibt true zurück, wenn EmojiCompat das Emoji erkennen und rendern kann.

Die Tastatur kann auch die Version der EmojiCompat-Supportbibliothek prüfen, die von der App unterstützt wird, um zu ermitteln, welche Emojis in der Palette gerendert werden sollen. Um die Version zu prüfen, sofern verfügbar, muss die Tastatur prüfen, ob die folgenden Tasten im EditorInfo.extras-Bundle vorhanden sind:

• EDITOR_INFO_METAVERSION_KEY

Wenn der Schlüssel im Bundle vorhanden ist, stellt der Wert die Version der Emoji-Metadaten dar, die von der App verwendet wird. Wenn dieser Schlüssel nicht vorhanden ist, verwendet die App EmojiCompat nicht.

• EDITOR_INFO_REPLACE_ALL_KEY

Wenn der Schlüssel vorhanden und auf true gesetzt ist, bedeutet das, dass die App die Methode SetReplaceAll() aufgerufen hat. Weitere Informationen zur EmojiCompat-Konfiguration finden Sie im Abschnitt Konfigurationsoptionen.

Nachdem die Tastatur die Schlüssel im EditorInfo.extras-Bundle erhalten hat, kann sie mit der Methode hasEmojiGlyph() prüfen, ob die App ein bestimmtes Emoji rendern kann. Dabei ist metadataVersion der Wert für EDITOR_INFO_METAVERSION_KEY.

EmojiCompat mit benutzerdefinierten Widgets verwenden

Sie können die Methode process() immer verwenden, um die CharSequence in Ihrer App vorzuverarbeiten und sie jedem Widget hinzuzufügen, das Spanned-Instanzen rendern kann, z. B. TextView. Außerdem bietet EmojiCompat die folgenden Widget-Hilfsklassen, mit denen Sie Ihre benutzerdefinierten Widgets mit minimalem Aufwand mit Emoji-Unterstützung erweitern können.

• EmojiTextViewHelper
• EmojiEditTextHelper

Beispiel-TextView

Kotlin

class MyTextView(context: Context) : AppCompatTextView(context) {

    private val emojiTextViewHelper: EmojiTextViewHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiTextViewHelper(this).apply {
            updateTransformationMethod()
        }
    }

    override fun setFilters(filters: Array<InputFilter>) {
        super.setFilters(emojiTextViewHelper.getFilters(filters))
    }

    override fun setAllCaps(allCaps: Boolean) {
        super.setAllCaps(allCaps)
        emojiTextViewHelper.setAllCaps(allCaps)
    }
}

Java

public class MyTextView extends AppCompatTextView {
   ...
   public MyTextView(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       getEmojiTextViewHelper().updateTransformationMethod();
   }

   @Override
   public void setFilters(InputFilter[] filters) {
       super.setFilters(getEmojiTextViewHelper().getFilters(filters));
   }

   @Override
   public void setAllCaps(boolean allCaps) {
       super.setAllCaps(allCaps);
       getEmojiTextViewHelper().setAllCaps(allCaps);
   }

   private EmojiTextViewHelper getEmojiTextViewHelper() {
       ...
   }
}

EditText-Beispiel

Kotlin

class MyEditText(context: Context) : AppCompatEditText(context) {

    private val emojiEditTextHelper: EmojiEditTextHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiEditTextHelper(this).also {
            super.setKeyListener(it.getKeyListener(keyListener))
        }
    }

    override fun setKeyListener(input: KeyListener?) {
        input?.also {
            super.setKeyListener(emojiEditTextHelper.getKeyListener(it))
        }
    }

    override fun onCreateInputConnection(outAttrs: EditorInfo): InputConnection {
        val inputConnection: InputConnection = super.onCreateInputConnection(outAttrs)
        return emojiEditTextHelper.onCreateInputConnection(
                inputConnection,
                outAttrs
        ) as InputConnection
    }
}

Java

public class MyEditText extends AppCompatEditText {
   ...
   public MyEditText(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(getKeyListener()));
   }

   @Override
   public void setKeyListener(android.text.method.KeyListener keyListener) {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(keyListener));
   }

   @Override
   public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
       InputConnection inputConnection = super.onCreateInputConnection(outAttrs);
       return getEmojiEditTextHelper().onCreateInputConnection(inputConnection, outAttrs);
   }

   private EmojiEditTextHelper getEmojiEditTextHelper() {
       ...
   }
}

Häufig gestellte Fragen

• Wie starte ich den Schriftart-Download?

Die Emoji-Schriftarten werden bei der ersten Anfrage heruntergeladen, sofern sie nicht auf dem Gerät vorhanden sind. Die Downloadplanung ist für die App transparent.

• Wie lange dauert die Initialisierung?

Nachdem die Schriftart heruntergeladen wurde, dauert die Initialisierung von EmojiCompat etwa 150 Millisekunden.

• Wie viel Arbeitsspeicher wird von der EmojiCompat-Supportbibliothek verwendet?

Derzeit wird die Datenstruktur zum Suchen des Emojis in den Speicher der App geladen und belegt etwa 200 KB.

• Kann ich EmojiCompat für eine benutzerdefinierte TextView verwenden?

Ja. EmojiCompat bietet Hilfsklassen für benutzerdefinierte Widgets. Es ist auch möglich, einen bestimmten String vorzuverarbeiten und in Spanned zu konvertieren. Weitere Informationen zu Widget-Hilfsklassen finden Sie im Abschnitt EmojiCompat mit benutzerdefinierten Widgets verwenden.

• Was passiert, wenn ich Widgets in Layout-XMLs auf Geräten hinzufüge, auf denen Android 4.4 (API-Level 19) oder niedriger ausgeführt wird?

Sie können die EmojiCompat-Supportbibliothek oder ihre Widgets in Ihre Anwendungen einbinden, die Geräte mit Android 4.4 (API-Level 19) oder niedriger unterstützen. Wenn auf einem Gerät jedoch eine Android-Version vor API-Level 19 ausgeführt wird, befinden sich EmojiCompat und die zugehörigen Widgets im Status „Kein Vorgang“. Das bedeutet, dass sich EmojiTextView genau wie ein reguläres TextView verhält. EmojiCompat-Instanz. Sie wechselt sofort in den Status LOAD_STATE_SUCCEEDED, wenn Sie die Methode init() aufrufen.

Zusätzliche Ressourcen

Weitere Informationen zur Verwendung der EmojiCompat-Bibliothek finden Sie unter EmojiCompat.