拼写检查框架

Android 平台提供了一个拼写检查框架，可让你在应用中实现和访问拼写检查。该框架是 Text Service API 之一。

要在应用中使用该框架，你需要创建一个 Android 服务，该服务会生成一个拼写检查器 session 对象。根据你提供的文本，会话对象会返回拼写检查器生成的拼写建议。

拼写检查器生命周期

下图展示了拼写检查器服务的生命周期

An image showing the lifecycle for the spelling checker service
图 1. 拼写检查器服务生命周期。

要启动拼写检查，你的应用会启动其拼写检查服务实现。应用中的客户端，例如 Activity 或单个 UI 元素，会向服务请求一个拼写检查会话，然后使用该会话获取文本建议。客户端终止操作时，它会关闭其拼写检查会话。如果需要，你的应用可以随时关闭拼写检查服务。

实现拼写检查器服务

要在应用中使用拼写检查框架，请添加一个包含会话对象定义的拼写检查服务组件。你还可以选择在应用中添加一个用于控制设置的 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 会自动使用拼写检查器

An image showing how the spell checker is automatically enabled in EditText
图 2. EditText 中的拼写检查。

但是，在其他情况下，你可能想要直接与拼写检查服务交互。下图显示了与拼写检查服务交互的控制流程

An image showing the diagram of the interaction with a spell checker service
图 3. 与拼写检查服务的交互。

Android 开源项目中的 LatinIME 输入法编辑器包含拼写检查的示例。