随着所有类型应用的表情符号使用率都快速增加,Unicode 每年都会更新标准的表情符号集。
如果您的应用显示互联网内容或提供文本输入,我们强烈建议您支持最新的表情符号字体。否则,之后的表情符号可能会显示为名为“豆腐块” (☐) 的小方块或其他错误呈现的表情符号序列。
Android 版本 11(API 级别 30)及更低版本无法更新表情符号字体,因此必须手动更新在这些版本上显示表情符号字体的应用。
以下是新式表情符号的示例。
示例 | 版本 |
---|---|
🫠 🫱🏼🫲🏿 🫰🏽 | 14.0(2021 年 9 月) |
😶🌫️ 🧔🏻♀️ 🧑🏿❤️🧑🏾 | 13.1(2020 年 9 月) |
🥲 🥷🏿 🐻❄️ | 13.0(2020 年 3 月) |
🧑🏻🦰 🧑🏿🦯 👩🏻🤝👩🏼 | 12.1(2019 年 10 月) |
🦩 🦻🏿 👩🏼🤝👩🏻 | 12.0(2019 年 2 月) |
androidx.emoji2:emoji2
库可让您更轻松地向后兼容较低的 Android 版本。emoji2
库是 AppCompat
库的依赖项,无需进一步配置即可运行。
Compose 中的表情符号支持
BOM 2023 年 3 月 (Compose UI 1.4) 支持最新表情符号版本,包括向后兼容旧版 Android(低至 API 21)。本页将介绍如何在 View 系统中配置新式表情符号。如需了解详情,请参阅 Compose 中的表情符号页面。
前提条件
如需确认您的应用正确显示较新的表情符号,请在搭载 Android 10(API 级别 29)或更低版本的设备上启动它。此页面包含新式表情符号,您可以显示用于测试。
使用 AppCompat 支持最新的表情符号
AppCompat
1.4 支持表情符号。
如需使用 AppCompat
支持表情符号,请执行以下操作:
检查您的模块是否依赖
AppCompat
库版本 1.4.0-alpha01 或更高版本。build.gradle // Ensure version is 1.4.0-alpha01 or higher. implementation "androidx.appcompat:appcompat.$appcompatVersion"
确保显示文本的所有 activity 都扩展
AppCompatActivity
类。Kotlin
MyActivity.kt class MyActivity: AppCompatActivity { ... }
Java
MyActivity.java class MyActivity extends AppCompatActivity { ... }
如需测试集成,请在搭载 Android 10 或更低版本的设备上启动应用并显示以下测试字符串。确保所有字符都能正确渲染。
- 14.0:🫠, 🫱🏼🫲🏿, 🫰🏽
- 13.1:😶🌫️, 🧔🏻♀️, 🧑🏿❤️🧑🏾
- 13.0:🥲, 🥷🏿, 🐻❄️
- 12.1:🧑🏻🦰, 🧑🏿🦯, 👩🏻🤝👩🏼
- 12.0:🦩, 🦻🏿, 👩🏼🤝👩🏻
您的应用会在所有提供与 emoji2
兼容的可下载字体提供程序的设备(例如由 Google Play 服务提供支持的设备)上自动显示向后兼容的表情符号。
如果您的应用使用了 AppCompat,但是显示豆腐块 (□)
在某些情况下,即使您添加了 AppCompat
库,您的应用也可能会显示豆腐,而不是正确的表情符号。以下是可能的说明和解决方案。
您要在最近刷写的设备或新的模拟器上运行应用
清除应用的 Google Play 服务数据,以清除启动期间可能发生的任何字体缓存。这通常可在几个小时后解决此问题。
如需清除应用数据,请执行以下操作:
在 Android 设备上打开设置。
点按应用和通知。
点按查看所有应用或应用信息。
滚动浏览应用,然后点按 Google Play 服务。
点按存储和缓存。
点按清除缓存。
您的应用未使用 AppCompat 文本相关类
如果您没有扩展 AppCompatActivity
或在代码中实例化视图(例如 TextView
),则可能会发生这种情况。请检查以下方面:
- activity 会扩展
AppCompatActivity
。 - 如果要在代码中创建视图,请使用正确的
AppCompat
子类。
在膨胀 XML 时,AppCompatActivity
会自动膨胀 AppCompatTextView
而不是 TextView
,因此您无需更新自己的 XML。
测试手机不支持可下载字体
请验证 DefaultEmojiCompatConfig.create
是否会返回非 null 配置。
使用较低 API 级别的模拟器尚未升级 Google Play 服务
使用版本较低的 API 级别的模拟器时,您可能需要更新 emoji2
的捆绑 Google Play 服务,以查找字体提供程序。为此,请在模拟器上登录 Google Play 商店。
如需验证是否安装了兼容的版本,请执行以下操作:
运行以下命令:
adb shell dumpsys package com.google.android.gms | grep version
检查
versionCode
是否高于211200000
。
在不使用 AppCompat 的情况下支持表情符号
如果您的应用不能包含 AppCompat
,则可以直接使用 emoji2
。这需要完成更多工作,因此请仅在您的应用无法使用 AppCompat
时使用此方法。
如需在没有 AppCompat
库的情况下支持表情符号,请执行以下操作:
在应用的
build.gradle
文件中,添加emoji2
和emoji2-views
。build.gradle def emojiVersion = "1.0.0-alpha03" implementation "androidx.emoji2:emoji2:$emojiVersion" implementation "androidx.emoji2:emoji2-views:$emojiVersion"
emoji2-views
模块提供实现EmojiCompat
的TextView
、Button
和EditText
的子类。请不要在包含AppCompat
的应用中使用它,因为它已实现EmojiCompat
。在 XML 和代码中,无论您在何处使用
TextView
、EditText
或Button
,请改用EmojiTextView
、EmojiEditText
或EmojiButton
。activity_main.xml <androidx.emoji2.widget.EmojiTextView ... /> <androidx.emoji2.widget.EmojiEditText ... /> <androidx.emoji2.widget.EmojiButton ... />
添加
emoji2
模块后,系统会在应用启动后立即使用默认的可下载字体提供程序自动加载表情符号字体。无需进一步配置。如需测试集成,请在搭载 Android 11 或更低版本的设备上启动应用,并显示以下测试字符串。确保所有字符都能正确渲染。
- 14.0:🫠, 🫱🏼🫲🏿, 🫰🏽
- 13.1:😶🌫️, 🧔🏻♀️, 🧑🏿❤️🧑🏾
- 13.0:🥲, 🥷🏿, 🐻❄️
- 12.1:🧑🏻🦰, 🧑🏿🦯, 👩🏻🤝👩🏼
- 12.0:🦩, 🦻🏿, 👩🏼🤝👩🏻
不搭配微件使用 EmojiCompat
EmojiCompat
使用 EmojiSpan
渲染正确的图片。因此,它必须将任何给定的 CharSequence
对象转换为包含 EmojiSpan
对象的 Spanned
对象。EmojiCompat 类提供 process()
方法,可将 CharSequences
转换为 Spanned
实例。使用此方法,您可以在后台调用 process()
并缓存结果,从而提高应用的性能。
Kotlin
val processed = EmojiCompat.get().process("neutral face \uD83D\uDE10")
Java
CharSequence processed = EmojiCompat.get().process("neutral face \uD83D\uDE10");
将 EmojiCompat 用于输入法
借助 EmojiCompat
类,键盘可以呈现与其互动的应用所支持的表情符号。输入法 (IME) 可以使用 getEmojiMatch()
方法检查 EmojiCompat
的实例是否能够呈现表情符号。此方法接受表情符号的 CharSequence
,如果 EmojiCompat
可以检测并呈现表情符号,则返回 true
。
键盘还可以检查应用支持的 EmojiCompat
版本,以确定要在 palette 中呈现的表情符号。如需检查版本(如果可用),键盘可以在 EditorInfo.extras
软件包中查找以下键:
EDITOR_INFO_METAVERSION_KEY
:表示应用使用的表情符号元数据的版本。如果该键不存在,则说明应用未使用EmojiCompat
。EDITOR_INFO_REPLACE_ALL_KEY
:如果该键存在且设置为true
,则应用会将EmojiCompat
配置为替换所有表情符号,即使系统中存在这些表情符号也是如此。
详细了解如何配置 EmojiCompat 的实例。
在自定义视图中使用表情符号
如果您的应用具有作为 TextView
的直接或间接子类(例如 Button
、Switch
或 EditText
)的自定义视图,并且这些视图可以显示用户生成的内容,则它们必须分别实现 EmojiCompat
。
具体过程因您的应用是否使用 AppCompat
库而异。
为使用 AppCompat 的应用添加自定义视图
如果您的应用使用 AppCompat
,请扩展 AppCompat
实现,而不是平台实现。您可以参考下表,了解如何在 AppCompat
中扩展视图:
不要扩展… | 扩展 |
---|---|
TextView
|
AppCompatTextView
|
EditText
|
AppCompatEditText
|
ToggleButton
|
AppCompatToggleButton
|
Switch
|
SwitchCompat
|
Button
|
AppCompatButton
|
CheckedTextView
|
AppCompatCheckedTextView
|
RadioButton
|
AppCompatRadioButton
|
CheckBox
|
AppCompatCheckBox
|
AutoCompleteTextView
|
AppCompatAutoCompleteTextView
|
MultiAutoCompleteTextView
|
AppCompatMultiAutoCompleteTextView
|
为不用 AppCompat 的应用添加自定义视图
如果您的应用不使用 AppCompat
,请使用 emoji2-views-helper
模块中旨在用于自定义视图的视图集成辅助程序。AppCompat
库正是使用这些辅助程序来实现表情符号支持。
完成以下步骤,以便针对不使用 AppCompat
的应用支持自定义视图。
添加
emoji2-views-helper
库:implementation "androidx.emoji2:emoji2-views-helper:$emojiVersion"
按照相关说明在应用的自定义视图中添加
EmojiTextViewHelper
或EmojiEditTextHelper
。如需测试集成,请在搭载 Android 10 或更低版本的设备上启动应用并显示以下测试字符串。确保所有字符都能正确渲染。
- 14.0:🫠, 🫱🏼🫲🏿, 🫰🏽
- 13.1:😶🌫️, 🧔🏻♀️, 🧑🏿❤️🧑🏾
- 13.0:🥲, 🥷🏿, 🐻❄️
- 12.1:🧑🏻🦰, 🧑🏿🦯, 👩🏻🤝👩🏼
- 12.0:🦩, 🦻🏿, 👩🏼🤝👩🏻
用于处理 emoji2 的可选功能
在应用中添加 emoji2
库后,您可以添加本部分所述的可选功能。
将 emoji2 配置为使用其他字体或可下载字体提供程序
如需将 emoji2
配置为使用其他字体或可下载字体提供程序,请执行以下操作:
将以下代码添加到清单中,即可停用
EmojiCompatInitializer
:<provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" android:exported="false" tools:node="merge"> <meta-data android:name="androidx.emoji2.text.EmojiCompatInitializer" tools:node="remove" /> </provider>
执行以下其中一项操作:
通过调用
DefaultEmojiCompatConfiguration.create(context)
使用默认配置。创建您自己的配置,以使用
EmojiCompat.Config
从其他来源加载字体。此类提供了几个选项来修改EmojiCompat
行为,如以下部分所述。
修改 EmojiCompat 行为
您可以使用 EmojiCompat.Config
的实例来修改 EmojiCompat
行为。
最重要的配置选项是 setMetadataLoadStrategy()
,它控制着 EmojiCompat
何时加载字体。调用 EmojiCompat.load()
后,字体加载会立即开始,这会触发所有必要的下载。除非应用提供用于下载字体的线程,否则系统会创建一个线程。
LOAD_STRATEGY_MANUAL
可让您控制何时调用 EmojiCompat.load()
,而 LOAD_STRATEGY_DEFAULT
可让加载在 EmojiCompat.init()
的调用中同步开始。
大多数应用使用 LOAD_STRATEGY_MANUAL
,以便控制字体加载的线程和时间。您的应用必须延迟到第一个屏幕显示之后,以免引入启动延迟。EmojiCompatInitializer
遵循这一做法,会将表情符号字体的加载延迟到第一个屏幕恢复之后。
使用基类中的以下方法设置配置的其他方面:
setReplaceAll()
:确定EmojiCompat
是否将其找到的所有表情符号替换为EmojiSpan
的实例。默认情况下,当EmojiCompat
推断系统可以渲染某个表情符号时,它不会替换该表情符号。设置为true
时,EmojiCompat
会将所有表情符号替换为EmojiSpan
对象。setEmojiSpanIndicatorEnabled()
:指示EmojiCompat
是否将表情符号替换为EmojiSpan
对象。设置为true
时,EmojiCompat
会为EmojiSpan
绘制背景。此方法主要用于调试目的。setEmojiSpanIndicatorColor
:设置颜色以指示EmojiSpan
。默认值为GREEN
。registerInitCallback()
:用于通知应用有关EmojiCompat
初始化的状态。
添加初始化监听器
EmojiCompat
和 EmojiCompat.Config
类提供了用于注册和取消注册初始化回调的 registerInitCallback()
和 unregisterInitCallback()
方法。您的应用使用这些回调等到 EmojiCompat
完成初始化后,再在后台线程或自定义视图中处理表情符号。
如需使用这些方法,请创建 EmojiCompat.InitCallback
类的实例。调用这些方法并传入 EmojiCompat.InitCallback
类的实例。初始化成功时,EmojiCompat
类会调用 onInitialized()
方法。如果库初始化失败,EmojiCompat
类会调用 onFailed()
方法。
在任何时候,如需检查初始化状态,请调用 getLoadState()
方法。此方法会返回以下某个值:LOAD_STATE_LOADING
、LOAD_STATE_SUCCEEDED
或 LOAD_STATE_FAILED
。
通过 emoji2 支持捆绑式字体
您可以使用 emoji2-bundled
工件将表情符号字体捆绑到应用中。不过,由于 NotoColorEmoji
字体超过 10 MB,因此我们强烈建议您的应用尽可能使用可下载字体。emoji2-bundled
工件适用于在不支持可下载字体的设备上的应用。
如需使用 emoji2-bundled
工件,请执行以下操作:
添加
emoji2-bundled
和emoji2
工件:implementation "androidx.emoji2:emoji2:$emojiVersion" implementation "androidx.emoji2:emoji2-bundled:$emojiVersion"
将
emoji2
配置为使用捆绑的配置:Kotlin
EmojiCompat.init(BundledEmojiCompatConfig(context))
Java
EmojiCompat.init(new BundledEmojiCompatConfig(context));
按照上述步骤添加
emojicompat
(无论是否包含AppCompat
),测试集成。请确保测试字符串正确显示。- 14.0:🫠, 🫱🏼🫲🏿, 🫰🏽
- 13.1:😶🌫️, 🧔🏻♀️, 🧑🏿❤️🧑🏾
- 13.0:🥲, 🥷🏿, 🐻❄️
- 12.1:🧑🏻🦰, 🧑🏿🦯, 👩🏻🤝👩🏼
- 12.0:🦩, 🦻🏿, 👩🏼🤝👩🏻
自动化 EmojiCompat 配置的影响
系统使用启动库、EmojiCompatInitializer
和 DefaultEmojiCompatConfig
应用默认配置。
在应用中的第一个 activity 恢复后,初始化程序会安排加载表情符号字体。这种短暂的延迟可让您的应用显示其初始内容,而不会因后台线程中加载字体而造成任何潜在延迟。
DefaultEmojiCompatConfig
会查找实现 EmojiCompat
接口的系统安装的可下载字体提供程序,如 Google Play 服务。在采用 Google Play 服务的设备上,这将使用 Google Play 服务加载字体。
初始化程序会创建一个后台线程来加载表情符号字体,字体下载最多可能需要 10 秒才能完成下载。下载字体后,在后台线程上初始化 EmojiCompat
大约需要 150 毫秒。
推迟 EmojiCompat
的初始化,即使您停用 EmojiCompatInitializer
也是如此。如果您手动配置 EmojiCompat
,请在它显示应用的第一个屏幕后调用 EmojiCompat.load()
,以免在首次加载屏幕时发生后台争用。
加载后,EmojiCompat
会使用约 300 KB 的 RAM 来保存表情符号元数据。