Android 平台提供了一个拼写检查工具框架,可让您在应用中实现和使用拼写检查功能。该框架是文本服务 API 之一。
如需在应用中使用该框架,您需要创建一个可生成拼写检查工具会话对象的 Android 服务。根据您提供的文本,会话对象会返回拼写检查工具生成的拼写建议。
拼写检查工具生命周期
下图显示了拼写检查工具服务的生命周期:
![显示拼写检查工具服务生命周期的图片](https://developer.android.google.cn/static/resources/articles/images/spellcheck_lifecycle.png?authuser=5&hl=lv)
为了启动拼写检查,您的应用会开始实现拼写检查工具服务。应用中的客户端(例如 activity 或各个界面元素)向服务请求拼写检查工具会话,然后使用该会话获取文本建议。当客户端终止其操作时,它会关闭其拼写检查工具会话。如有必要,您的应用可以随时关闭拼写检查服务。
实现拼写检查工具服务
如需在您的应用中使用拼写检查工具框架,请添加包含会话对象定义的拼写检查工具服务组件。您还可以向应用中添加用于控制设置的可选 activity。添加一个描述拼写检查工具服务的 XML 元数据文件,并向清单文件添加适当的元素。
拼写检查工具类
使用以下类定义服务和会话对象:
-
SpellCheckerService
的子类SpellCheckerService
会同时实现Service
类和拼写检查工具框架接口。在您的子类中,实现以下方法:createSession()
- 一种工厂方法,用于将
SpellCheckerService.Session
对象返回给要检查拼写的客户端。
-
SpellCheckerService.Session
的实现- 拼写检查工具服务提供给客户端的对象,可让客户端将文本传递给拼写检查工具并接收建议。在此类中,实现以下方法:
onCreate()
- 由系统调用以响应
createSession()
。在此方法中,您可以根据当前的语言区域和其他详细信息初始化SpellCheckerService.Session
对象。 onGetSentenceSuggestionsMultiple()
- 执行实际的拼写检查。此方法会返回一个
SentenceSuggestionsInfo
数组,其中包含针对传递给它的句子的建议。
(可选)您可以实现
onCancel()
(它可处理请求以取消拼写检查)、onGetSuggestions()
(它可处理文字建议请求)或onGetSuggestionsMultiple()
(它可批量处理文字建议请求)。
拼写检查工具清单和元数据
除了代码之外,还应为拼写检查工具提供适当的清单文件和元数据文件。
清单文件定义了用于控制设置的应用、服务和 activity,如以下示例所示:
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.android.samplespellcheckerservice" > <application android:label="@string/app_name" > <service android:label="@string/app_name" android:name=".SampleSpellCheckerService" android:permission="android.permission.BIND_TEXT_SERVICE" > <intent-filter > <action android:name="android.service.textservice.SpellCheckerService" /> </intent-filter> <meta-data android:name="android.view.textservice.scs" android:resource="@xml/spellchecker" /> </service> <activity android:label="@string/sample_settings" android:name="SpellCheckerSettingsActivity" > <intent-filter > <action android:name="android.intent.action.MAIN" /> </intent-filter> </activity> </application> </manifest>
想要使用该服务的组件必须请求 BIND_TEXT_SERVICE
权限,以确保只有系统绑定到该服务。该服务的定义还指定了 spellchecker.xml
元数据文件,这将在下一节中介绍。
元数据文件 spellchecker.xml
包含以下 XML:
<spell-checker xmlns:android="http://schemas.android.com/apk/res/android" android:label="@string/spellchecker_name" android:settingsActivity="com.example.SpellCheckerSettingsActivity"> <subtype android:label="@string/subtype_generic" android:subtypeLocale="en” /> <subtype android:label="@string/subtype_generic" android:subtypeLocale="fr” /> </spell-checker>
元数据指定拼写检查工具用于控制设置的 activity。它还定义了拼写检查工具的子类型。在这种情况下,子类型定义拼写检查工具可以处理的语言区域。
从客户端访问拼写检查工具服务
使用 TextView
和 EditText
视图的应用会自动受益于拼写检查,因为 TextView
会自动使用拼写检查工具:
![展示如何在 EditText 中自动启用拼写检查工具的图片](https://developer.android.google.cn/static/images/ui/spellchecker_edittext.png?authuser=5&hl=lv)
EditText
中的拼写检查。
不过,在其他情况下,您可能希望直接与拼写检查工具服务交互。下图显示了与拼写检查工具服务交互的控制流程:
![显示拼写检查工具服务的交互示意图的图片](https://developer.android.google.cn/static/resources/articles/images/spellcheck_client_flow.png?authuser=5&hl=lv)
Android 开源项目中的 LatinIME 输入法包含拼写检查的示例。