本頁面由 Cloud Translation API 翻譯而成。

建立輸入法

輸入法編輯器 (IME) 是一種使用者控制項，可讓使用者輸入文字。Android 提供可擴充的輸入法架構，能讓應用程式為使用者提供其他輸入法。例如螢幕小鍵盤或語音輸入安裝輸入法編輯器後，使用者可以從系統設定中選取所需輸入法編輯器，並在整個系統中使用該系統。一次只能啟用一個輸入法編輯器。

如要在 Android 系統中新增輸入法編輯器，請建立 Android 應用程式，並加入能延伸 InputMethodService。此外，您通常會建立「設定」將選項傳送到輸入法編輯器服務的活動。個人中心也可以定義顯示在系統設定中的設定使用者介面。

本頁面涵蓋以下主題：

輸入法編輯器生命週期
在應用程式資訊清單中宣告輸入法編輯器元件
輸入法編輯器 API
設計輸入法編輯器 UI
從輸入法編輯器將文字傳送至應用程式
使用輸入法編輯器子類型
其他輸入法編輯器注意事項

如果您尚未使用輸入法編輯器，請閱讀簡介文章畫面上的輸入法首先。

輸入法編輯器生命週期

下圖說明輸入法編輯器的生命週期：

以下各節說明如何實作與依循這個生命週期

在資訊清單中宣告輸入法編輯器元件

在 Android 系統中，輸入法編輯器是內含特殊輸入法編輯器服務的 Android 應用程式。應用程式的資訊清單檔案必須宣告服務、要求必要權限、提供與 action.view.InputMethod 動作相符的意圖篩選器，並提供定義輸入法編輯器特性的中繼資料。此外，為了提供設定介面，讓使用者修改輸入法編輯器的行為時，您可以定義「設定」可以從中啟動系統設定。

下列程式碼片段宣告輸入法編輯器服務。應用程式會要求權限 BIND_INPUT_METHOD 為了讓服務將輸入法編輯器連結至系統，請設定符合動作的意圖篩選器 android.view.InputMethod，以及定義輸入法編輯器的中繼資料：

<!-- Declares the input method service. -->
<service android:name="FastInputIME"
    android:label="@string/fast_input_label"
    android:permission="android.permission.BIND_INPUT_METHOD">
    <intent-filter>
        <action android:name="android.view.InputMethod" />
    </intent-filter>
    <meta-data android:name="android.view.im"
               android:resource="@xml/method" />
</service>

下一段程式碼片段會宣告輸入法編輯器的設定活動。其中包含 ACTION_MAIN 符合表示此活動是輸入法編輯器應用程式的主要進入點：

<!-- Optional: an activity for controlling the IME settings. -->
<activity android:name="FastInputIMESettings"
    android:label="@string/fast_input_settings">
    <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
    </intent-filter>
</activity>

您也可以直接透過 UI 存取輸入法編輯器設定。

輸入法 API

輸入法編輯器適用的類別位於 android.inputmethodservice 和 android.view.inputmethod 套件中。KeyEvent 類別為因為處理鍵盤字元至關重要

輸入法編輯器的中央部分是服務元件，擴充了 InputMethodService 的類別。除了實作正常服務生命週期之外，這也類別具有回呼，可提供輸入法編輯器的 UI、處理使用者輸入內容，並將文字傳送至成為焦點根據預設，InputMethodService 類別提供大部分的實作方式，用於管理輸入法編輯器的狀態和瀏覽權限，並與目前的輸入欄位通訊。

下列類別也很重要：

BaseInputConnection: 定義通訊管道，從 InputMethod 傳回到接收其輸入內容的應用程式。可用來讀取遊標周圍的文字、將文字傳送至文字方塊，並將原始金鑰事件傳送至應用程式。應用程式必須擴充這個類別，而不是實作基礎介面 InputConnection。
KeyboardView: 是 View 的擴充功能，會轉譯鍵盤並回應使用者輸入事件。鍵盤配置是由 Keyboard 的例項指定，您可以在 XML 檔案中定義。

設計輸入法使用者介面

輸入法編輯器有兩個主要視覺元素：輸入檢視畫面和 候選項檢視畫面。您只需導入與您要設計的輸入方法

輸入檢視畫面

輸入檢視畫面是一種使用者介面，可讓使用者以鍵盤按鍵、手寫或手寫等格式輸入文字手勢。初次顯示輸入法編輯器時，系統會呼叫 onCreateInputView() 回呼。實作此方法時，您會建立想在輸入法編輯器視窗中顯示的版面配置，並將版面配置傳回系統。以下程式碼片段為實作範例 onCreateInputView() 方法：

Kotlin

override fun onCreateInputView(): View {
    return layoutInflater.inflate(R.layout.input, null).apply {
        if (this is MyKeyboardView) {
            setOnKeyboardActionListener(this@MyInputMethod)
            keyboard = latinKeyboard
        }
    }
}

Java

@Override
public View onCreateInputView() {
    MyKeyboardView inputView =
        (MyKeyboardView) getLayoutInflater().inflate(R.layout.input, null);

    inputView.setOnKeyboardActionListener(this);
    inputView.setKeyboard(latinKeyboard);

    return inputView;
}

在這個範例中，MyKeyboardView 是下列項目的自訂實作項目：算繪 Keyboard 的 KeyboardView。

待選項目檢視畫面

候選項目檢視畫面是使用者介面，輸入法編輯器可顯示潛在字詞更正或供使用者選擇的建議。在輸入法編輯器生命週期中，當系統準備好顯示候選項目檢視畫面時，系統會呼叫 onCreateCandidatesView()。實作此方法時，會傳回顯示字詞建議的版面配置；如果您不想顯示任何內容，則會傳回空值。空值回應是預設行為，所以如果您沒有提供或取得寫作建議

使用者介面設計注意事項

本節說明關於輸入法編輯器的使用者介面設計注意事項。

處理多種螢幕大小

輸入法編輯器的使用者介面必須能夠依據不同螢幕大小縮放，而且必須同時處理橫向和直向瀏覽模式。在非全螢幕輸入法編輯器模式中，應用程式應保留足夠空間來顯示文字欄位和任何相關的背景資訊，因此輸入法編輯器佔用的畫面不超過一半。全螢幕輸入法編輯器模式並不會造成任何問題。

處理不同的輸入類型

Android 文字欄位可讓您設定特定輸入類型，例如任意形式文字、數字、網址、電子郵件地址和搜尋字串。實作新的輸入法編輯器時，請偵測每個欄位的輸入類型，並為欄位提供適當的介面。不過，你不需要設定輸入法編輯器檢查使用者是否在輸入類型中輸入有效的文字。這是也就是文字欄位中

以拉丁文輸入法編輯器提供的 Android 平台文字為例輸入：

顯示拉丁文輸入法編輯器文字輸入內容的圖片 — **圖 2.** 拉丁文輸入法編輯器文字輸入。

以下是拉丁文輸入法編輯器為 Android 平台提供的介面數字輸入：

顯示拉丁文輸入法編輯器輸入數字的圖片 — **圖 3.** 拉丁輸入法編輯器數字輸入。

輸入欄位收到聚焦且輸入法編輯器開始時，系統會呼叫 onStartInputView()，並傳入 EditorInfo 物件，其中包含輸入類型與文字欄位其他屬性的詳細資料。在這個物件中這個 inputType 欄位包含文字欄位的輸入類型。

inputType 欄位是 int，包含多種不同資料的位元模式輸入類型設定如要測試文字欄位的輸入類型，請使用常數進行遮蓋 TYPE_MASK_CLASS, 輸入：

Kotlin

inputType and InputType.TYPE_MASK_CLASS

Java

inputType & InputType.TYPE_MASK_CLASS

輸入類型位元模式可以是下列任一值，包括：

TYPE_CLASS_NUMBER: 輸入數字的文字欄位。如圖 3 所示，拉丁文輸入法編輯器會顯示。
TYPE_CLASS_DATETIME: 輸入日期和時間的文字欄位。
TYPE_CLASS_PHONE: 輸入電話號碼的文字欄位。
TYPE_CLASS_TEXT: 輸入任何支援半形字元的文字欄位。

如需這些常數的詳細說明，請參閱 InputType。

inputType 欄位可包含其他位元，用於表示文字欄位類型的變化版本，例如：

TYPE_TEXT_VARIATION_PASSWORD: 用來輸入密碼的 TYPE_CLASS_TEXT 變化版本。輸入法會隨即顯示而不是實際文字
TYPE_TEXT_VARIATION_URI: 用於輸入網址和其他統一資源的 TYPE_CLASS_TEXT 變化版本 ID (URI)。
TYPE_TEXT_FLAG_AUTO_COMPLETE: TYPE_CLASS_TEXT 的變化版本，用於輸入應用程式從字典、搜尋或其他工具自動完成的文字。

測試這些變化版本時，請使用適當的常數遮蓋 inputType。您可以在 InputType 的參考說明文件中查看可用的遮蓋常數。

傳送簡訊至應用程式

當使用者透過輸入法編輯器輸入文字時，您可以傳送個別金鑰事件，或在應用程式的文字欄位中編輯遊標周圍的文字，將文字傳送至應用程式。無論是哪一種情況，您都必須使用 InputConnection 的例項來發送文字。如要取得這個例項，請呼叫 InputMethodService.getCurrentInputConnection()。

編輯遊標周圍的文字

當您處理現有文字的編輯時， BaseInputConnection 如下：

getTextBeforeCursor(): 傳回 CharSequence，其中包含在目前遊標位置之前要求的半形字元數量。
getTextAfterCursor(): 傳回 CharSequence，其中包含目前游標位置之後要求的半形字元數量。
deleteSurroundingText(): 刪除目前游標前面及後面的指定半形字元數量。
commitText(): 將 CharSequence 提交至文字欄位，並設定新的遊標位置。

例如，下列程式碼片段說明如何將遊標左側的四個半形字元替換成「Hello!」文字：

Kotlin

currentInputConnection.also { ic: InputConnection ->
    ic.deleteSurroundingText(4, 0)
    ic.commitText("Hello", 1)
    ic.commitText("!", 1)
}

Java

InputConnection ic = getCurrentInputConnection();
ic.deleteSurroundingText(4, 0);
ic.commitText("Hello", 1);
ic.commitText("!", 1);

支援在提交前編寫文字

如果輸入法編輯器會預測文字，或需要完成多個步驟來打造字符或字詞，您可以在文字欄位中顯示進度，直到使用者提交字詞為止，接著您可以將部分撰寫替換為完整文字內容。您可以將文字傳遞至 setComposingText() 時加上 span，藉此提供特殊的處理方式。

下列程式碼片段示範如何在文字欄位中顯示進度：

Kotlin

currentInputConnection.also { ic: InputConnection ->
    ic.setComposingText("Composi", 1)
    ic.setComposingText("Composin", 1)
    ic.commitText("Composing ", 1)
}

Java

InputConnection ic = getCurrentInputConnection();
ic.setComposingText("Composi", 1);
ic.setComposingText("Composin", 1);
ic.commitText("Composing ", 1);

攔截硬體金鑰事件

即使輸入法視窗沒有明確的焦點，仍會接收硬體按鍵事件即可取用或轉送至應用程式例如，您可能希望使用方向鍵在使用者介面中瀏覽，以便在撰寫過程中選取候選項目。您也可以擷取返回鍵，關閉所有來自輸入法視窗的對話方塊。

如要攔截硬體按鍵，請覆寫 onKeyDown() 和 onKeyUp()。

針對您不想自行處理的金鑰呼叫 super() 方法。

建立輸入法編輯器子類型

子類型可讓輸入法編輯器顯示輸入法編輯器支援的多個輸入模式和語言。子類型可以代表下列項目：

語言代碼，例如 en_US 或 fr_FR
輸入模式，例如語音、鍵盤或手寫
其他特定於輸入法編輯器的輸入樣式、表單或屬性，例如 10 鍵或 QWERTY 鍵盤版面配置

模式可以是任何文字，例如「鍵盤」或「語音」。子類型也可以公開顯示組合這類資源

子類型資訊用於通知列和輸入法編輯器設定提供的輸入法編輯器切換器對話方塊。資訊也允許該架構直接顯示特定輸入法編輯器子類型。建構輸入法編輯器時，請使用子類型設施，以便使用者識別和切換不同的輸入法編輯器語言和模式。

使用 <subtype> 元素在輸入法的 XML 資源檔案中定義子類型。以下程式碼片段定義包含兩種子類型的輸入法編輯器：美式英文語言代碼的鍵盤子類型，以及法語的另一個鍵盤子類型法國地區：

<input-method xmlns:android="http://schemas.android.com/apk/res/android"
        android:settingsActivity="com.example.softkeyboard.Settings"
        android:icon="@drawable/ime_icon">
    <subtype android:name="@string/display_name_english_keyboard_ime"
            android:icon="@drawable/subtype_icon_english_keyboard_ime"
            android:languageTag="en-US"
            android:imeSubtypeMode="keyboard"
            android:imeSubtypeExtraValue="somePrivateOption=true" />
    <subtype android:name="@string/display_name_french_keyboard_ime"
            android:icon="@drawable/subtype_icon_french_keyboard_ime"
            android:languageTag="fr-FR"
            android:imeSubtypeMode="keyboard"
            android:imeSubtypeExtraValue="someVariable=30,someInternalOption=false" />
    <subtype android:name="@string/display_name_german_keyboard_ime" ... />
</input-method>

如要確保使用者介面上的子類型標籤正確，請使用 `%s` 取得與子類型語言代碼標籤相同的子類型標籤。接下來的兩個程式碼片段會說明這一點。第一個程式碼片段會顯示部分輸入法 XML 檔案：

<subtype
    android:label="@string/label_subtype_generic"
    android:imeSubtypeLocale="en_US"
    android:icon="@drawable/icon_en_us"
    android:imeSubtypeMode="keyboard" />

下一段程式碼片段是部分輸入法編輯器的 strings.xml 檔案。字串資源 label_subtype_generic，輸入法使用者介面定義用於設定子類型標籤的定義如下：

<string name="label_subtype_generic">%s</string>

這項設定會使子類型的顯示名稱與語言代碼設定相符。例如，所有英文語言代碼中的顯示名稱都是「English (United States)」(英文 [美國])。

從通知列中選擇輸入法編輯器子類型

Android 系統可以管理所有輸入法編輯器提供的所有子類型。系統會將輸入法編輯器子類型視為自己所屬的輸入法編輯器使用者可以從通知列或「設定」應用程式前往可用的輸入法編輯器子類型的選單，如下圖所示：

從「系統設定」中選擇輸入法編輯器子類型

使用者也能在「語言與設定」部分中，控制子類型的使用方式輸入設定面板變更期間：

顯示「語言選項」選單的圖片 — **圖 5.** **Languages** 系統選單

切換輸入法編輯器子類型

使用者可以提供切換鍵，讓使用者輕鬆切換輸入法編輯器子類型，例如：鍵盤上的地球形狀語言圖示。這麼做可提升鍵盤的可用性，並方便使用者操作。如要啟用這項切換功能，請按照下列步驟操作：

在輸入法的 XML 資源檔案中宣告 supportsSwitchingToNextInputMethod = "true"。您的宣告必須類似於以下程式碼片段：

<input-method xmlns:android="http://schemas.android.com/apk/res/android"
        android:settingsActivity="com.example.softkeyboard.Settings"
        android:icon="@drawable/ime_icon"
        android:supportsSwitchingToNextInputMethod="true">

在 shouldOfferSwitchingToNextInputMethod() 方法。
如果這個方法傳回「是」，顯示切換鍵。
使用者輕觸切換鍵時，請呼叫 switchToNextInputMethod(), 傳遞 false值為「否」能讓系統平等處理所有子類型，無論其屬於哪個輸入法編輯器。指定「是」時，要求系統循環顯示。

一般輸入法編輯器注意事項

實作輸入法編輯器時，還需要考量以下幾點：

為使用者提供直接透過輸入法編輯器使用者介面設定選項的方法。
由於裝置上可能會安裝多個輸入法編輯器，因此請提供方法，讓使用者直接從輸入法使用者介面切換至其他輸入法編輯器。
快速開啟輸入法編輯器的 UI。視需要預先載入或載入任何大型資源，讓使用者只要輕觸文字欄位，就能立即查看輸入法編輯器。快取資源和檢視畫面，以供輸入法的日後叫用。
在輸入法視窗隱藏後，立即釋出大型記憶體配置，因此有足夠的記憶體可以執行如果輸入法編輯器隱藏幾秒鐘，請使用延遲訊息釋出資源。
請確保使用者能夠使用與輸入法編輯器相關聯的語言或語言代碼，盡可能輸入更多半形字元。使用者可能會在密碼或使用者名稱中使用標點符號，因此輸入法編輯器必須提供許多不同的半形字元，讓使用者輸入密碼才能存取裝置。