Swift 使用 InputMethodKit 寫輸入法

2016 年 10 月 3 日

最近更改：4月9日, 2022

如何在 iOS 上寫一款輸入法？這個問題已經被很多人解答過了。你可以輕易通過 Google 找到一篇詳細的教程。但是，在 macOS 上寫一款輸入法就沒那麼簡單了。

好吧，嚴格來講，是指用 Swift 在 macOS 上寫一款輸入法很難。主要的原因是從來沒有人做過這件事情。

目前能夠獲取的資料，除了蘋果官方的 API 說明（一點用也沒有），以及官方的 demo（很詳細但過時了，而且還是用 OC 寫的。）之外，幾乎什麼都沒有了。

現在我寫這篇文章就是來總結一下，如果你想用 Swift 3 開始寫一個 macOS 能用的輸入法，需要繞過哪些坑。

Info.plist中

對於輸入法來說，需要在這個文件當中做一些額外的配置，大部分的配置你只需要對比蘋果官方推出的 Demo 即可 —— 它們大部分都是正確的。

有一點沒有說明的地方在於，你的束 identifier 需要按照一定的格式來寫——也就是說，這個字段中必須包含輸入法這個關鍵詞。

比如說，我的輸入法叫這個名字 LogInputMac ，那麼我就不能寫成同.logcg.LogInputMac ，這樣的話 macOS 就不能把它識別為輸入法（就算放進了 /資源庫/輸入方法/ 也不行），你必須把輸入法這個關鍵字加進去，而且最好不要放在最後，應該放在前三個點（.）之內。比如說像我這樣：同.logcg.輸入法.LogInputMac 。

另外，對於 Swift，你還需要做一下單獨的操作，如果你就這樣將編譯好的 APP 放進 /資源庫/輸入方法/ ，那麼雖然 macOS 可以識別輸入法，但實際上不會有任何作用——你的 IMKInputController 是完全不會被加載的。

這是因為 macOS 找不到你的 IMKInputController 類，為此，我們應該把 InputMethodServerControllerClass 和 InputMethodServerDelegateClass 字段的內容改成以 $(PRODUCT_MODULE_NAME). 前綴的形式，也就是說，應該寫成這樣：

使用斯威夫特與InputMethodKit工作

AppDelegate.swift

由於 InputMethodKit 的運作方式與普通 APP 不同，我們需要在應用一開始就初始化 IMKServer 類，大多數人的第一反應就是把它放到在applicationDidFinishLaunching(_ : ) 裡去執行，正相反，~~由於 Swift 沒有 main 函數，我們可以直接把它聲明為全局變量而不需要先聲明再給全局變量賦值~~，我們把它寫在在applicationDidFinishLaunching 裡，同時你也可以在這裡做一些額外的準備工作，比如拷貝一下詞庫：

import Cocoa

import InputMethodKit

let kConnectionName = "LogInputMac_2_Connection"

var server = IMKServer()

var candidatesWindow = IMKCandidates()

@NSApplicationMain

class AppDelegate: NSObject, NSApplicationDelegate {

func applicationDidFinishLaunching(_ aNotification: Notification) {

// Insert code here to initialize your application

server = IMKServer(name: kConnectionName, bundleIdentifier: Bundle.main.bundleIdentifier)

candidatesWindow = IMKCandidates(server: server, panelType: kIMKSingleRowSteppingCandidatePanel, styleType:kIMKMain)

LogInputIMEngine.shared.cleanUp()

}

func applicationWillTerminate(_ aNotification: Notification) {

// Insert code here to tear down your application

}

打印(_:)

由於 Swift 不像 OC 都是用 NSLog 來輸出控制台消息，大家都還是喜歡用打印(_:) 來實現打印終端內容——對於輸入法來說，你不能這樣調試程序了。

如果你直接用 Xcode 執行你的輸入法，是沒有任何效果的。想要測試輸入法，就必須將它放到 /資源庫/輸入方法/ 中然後加載。這樣的話，即使你使用 Xcode attach 到輸入法的進程，也不會得到任何終端輸出。

這時候就需要使用的NSLog ，它可以方便地將輸入法的消息輸出到控制台中，這樣你就可以打開控制台，然後查看進程的信息了。

調試

對於輸入法來說，在 osx 下它是一個全局的東西，所以你很難去對它進行 debug，總之，我們還是可以讓開發過程盡可能的舒服，首先，你需要更改輸入法目錄的權限：

1	sudo chmod -R 777 /Library/Input\ Methods

這樣就可以讓 Xcode 直接編譯到目錄了，然後，在 Xcode 裡編輯 target，

建立設置 > 所有 > 建立地點 > 每-組態建立製品路徑 > 調試

把對應的值改為： /圖書館/輸入方法

這樣你就可以直接編譯，在系統偏好設置中添加一次即可，以後編譯都能事實生效，不用來回重啟或者註銷了。

值得注意的是：千萬不要添加斷點……

註釋

yulei 說:

2024 年 9 月 9 日在午安 1:36

文章很有用！可能有些合作機會，請問怎麼聯絡你？

回复
於然說:

2021 年 11 月 23 日在午安 5:57

您好，我有一個輸入方案的發明專利，想要發行一個輸入法的APP,不知你有沒有興趣合作。

回复
1. 落格博客 說:
  
  2021 年 12 月 1 日在午安 8:16
  
  你好朋友，抱歉回复的晚了，前段時間比較忙……
  合作可以有，不過我只能以外包、兼職等方式和你合作，不做技術入股後期分紅的方案，如果你能接受的話，咱就進一步談談，看看是一次性付費我按你需求開發交付，還是按工作時間付費進行開發。
  當然，將來開發完成後，維護工作和開發新功能等費用，咱們可以另外再談或者以後再談的。
  
  至於開發的代碼，可以完全歸你所有，如果有涉及到我現在再用的算法相關代碼，我們可以另行討論（如果可能，也可以授權互換等等……
  
  回复
棕色說:

2020 年 8 月 28 日在上午 10:22

我不知道哪裡錯了,每次啟動都會出現[IMKServer _createConnection]: *無法*註冊NSConnection名稱= com.logcg.inputmethod_Connection錯誤,您是否遇到過這問題,怎麼解決的

回复
1. 落格博客 說:
  
  2020 年 8 月 28 日在午安 6:55
  
  檢查你代碼裡的 NSConnection name，也就是 IMKServer(name: kConnectionName, bundleIdentifier: 束.主要.bundleIdentifier) 裡的實際參數和 Info.plist 裡輸入方法連接名稱中設置的是否完全一致。
  
  回复
穆罕默德Mominul Huque 說:

2018 年 10 月 23 日在上午 2:33

感謝這個見地的帖子! 我也對著你提到我想寫使用雨燕的輸入法這些絆腳石. 這是很可悲的是有沒有可用的輸入法這是寫在斯威夫特學習的榜樣. 我編譯您上傳名為FlyMac的例子時有錯誤. 它也沒有你在這個帖子中提到的編輯喜歡它不使用 $(PRODUCT_MODULE_NAME) 在InputMethodServerControllerClass財產. 這將是一個很大的幫助我，如果你上傳的工作示例.

非常感謝!

回复
1. R0uter 說:
  
  2018 年 10 月 23 日在上午 10:55
  
  嗨，您好, 在 InputMethodServerControllerClass 現場你需要插入您的 IMKInputController 子類名, 在我的項目, 數字輸入控制器.
  
  該編譯錯誤是該項目在某種程度上失去了APPICON文件, 然而, 我已經更新了項目，現在, 在斯威夫特 4.2.
  
  https://www.logcg.com/wp-content/uploads/2016/10/FlyMac-1.zip
  
  回复
pingback的: macOS 鍵盤按鍵 event 的三種截獲方式 | 落格博客
西蒙·彼得森 說:

2017 年 6 月 9 日在午安 10:39

非常有幫助的花花公子! 非常感謝你! 我是缺少有關部分 $(PRODUCT_MODULE_NAME) 控制器名稱前!

回复
1. R0uter 說:
  
  2017 年 6 月 9 日在午安 10:42
  
  ；）
  
  回复
阿德萊德 說:

2016 年 12 月 18 日在上午 6:19

你好我很高興，我發現您的博客, 我真的發現你意外, 當我
一直在尋找在AOL的其他東西, 無論如何，我
現在這裡wokuld只想說感謝
很多關於一個了不起的帖子和周圍激動人心的博客 (我也很喜歡這個主題/設計),
我沒有時間去broiwse這一切在momernt但我
救它，也增加了你的RSS源, 所以當我有時間我會回來的TTO閱讀更多, 請不要
保持了出色的工作.

回复
1. R0uter 說:
  
  2017 年 5 月 31 日在上午 2:33
  
  ：）謝謝! BRO.
  
  Sry基因CUS我剛剛發現我忘了到現在為止回复… XD
  
  然而, 希望你喜歡.
  
  回复

落格博客

Swift 使用 InputMethodKit 寫輸入法

Info.plist中

AppDelegate.swift

打印(_:)

調試

延伸閱讀

關於作者

R0uter

註釋

發表評論取消回复

Swift 使用 InputMethodKit 寫輸入法

Info.plist中

AppDelegate.swift

打印(_:)

調試

延伸閱讀

相關文章：

關於作者

R0uter

註釋

發表評論 取消回复

發表評論取消回复