Android原生拼音输入法分析

在Android官方Blog介绍了Android平台输入法的生命周期，如下图

（图片来自 http://android-developers.blogspot.com/search/label/Input%20methods ）

当一个可编辑的文本框获得焦点时，系统就会启动当前输入法，首先调用当前输入法的onCreate()函数。

Android系统的输入法通常都派生自基类 android.inputmethodservice.InputMethodService ，基类 InputMethodService 定义了Android输入法的公共API集合，其中onCreate就是其中的一个API函数。各个具体的输入法实现根据需要重载实现这些API的全部或者一部分。

Android SDK提供了一个最简单的输入法示例， SoftKeyboard  ，这个示例可以在SDK安装目录下samples/plaform-X下找到（其中X为SDK的API level数，如cupcake为3，donut为4，froyo为8）。 SoftKeyboard  的onCreate()函数代码如下：
       @Override public void onCreate() {
             super.onCreate();
             mWordSeparators = getResources().getString(R.string.word_separators);
       }
除了简单调用父类的同名函数外，从资源文件中读出单词分隔符的串并保存在成员变量里。每个输入法在被创建时要进行的初始化不尽相同。如Android源代码树在packags/inputmethods子目录下还有其它具体的输入法实例。（参考文档 http://android.git.kernel.org/?p=platform/packages/inputmethods/LatinIME.git;a=tree ）可以把Android源码取到本地计算机，还可以在线浏览另一个输入法实例LatinIME的onCreate()函数，它要做的工作就复杂得多：创建键盘，读取系统信息，注册系统铃声变化的监听器等等。

回来PinyinIME（也在Android源码的packags/inputmethods下）的onCreate()函数，省略掉与LatinIME类似的代码。
       @Override
       public void onCreate() {
             ...
             startPinyinDecoderServic e();
             ...
       }
函数startPinyinDecoderServic e（）检测PinyinDecoderService服务如果未运行，则通过系统函数bindService（）来启动它。bindService的第2个参数对象有2个成员函数会在PinyinDecoderService服务启动过程中被调用：
onServiceConnected()      -- PinyinDecoderService建立，PinyinDecoderService.onBind()返回的binder对象作为函数的第2个参数传入。
onServiceDisconnected() --  PinyinDecoderService结束。

关于bindService()的第2个参数以及其在进程间调用的作用可参见 http://developer.android.com/guide/developing/tools/aidl.html ，在PinyinIME中，它是ServiceConnection接口的一个实现，onServiceDisconnected（）什么都不用做，onServiceConnected()在PinyinDecoderService建立时被调用，远程service进程的binder对象作为函数的第2个参数传入。输入法作为客户端进程，需要借助以下辅助函数把传入的binder对象转化成可用的接口：
IPinyinDecoderService.Stub.asInterface（）
PinyinIME输入法把转化后的接口对象保存在类DecodingInfo对象mDecInfo的mIPinyinDecoderService成员，以供其后的调用：
       public class PinyinDecoderServiceConn ection implements ServiceConnection {
             public void onServiceConnected(ComponentName name, IBinder service) {
                   mDecInfo.mIPinyinDecoderService = IPinyinDecoderService.Stub
                               .asInterface(service);
             }
             ....
       }

mDecInfo.mIPinyinDecoderService的声明如下：
       public class DecodingInfo {
             ......
            
             private IPinyinDecoderService mIPinyinDecoderService;
             ......
       }

现在再来看在输入法（客户端进程）调用bindService时，服务端进程启动的详细过程：
因为第1个参数Intent对象的类名在调用前被设成PinyinDecoderService.class，所以系统进程响应bindService时，如果服务未运行时首先调用PinyinDecoderService的onCreate()
       @Override
       public void onCreate() {
             super.onCreate();
             mUsr_dict_file = getFileStreamPath("usr_dict.dat").getPath();
             ......
             initPinyinEngine();
       }
接下来调用PinyinDecoderService的onBind()函数，并把返回的binder对象传给前面说过的ServiceConnection.onServiceConnected():
       @Override
       public IBinder onBind(Intent intent) {
             return mBinder;
       }

辅助的初始化函数initPinyinEngine（）首先打算系统静态字典资源文件res/raw/dict_pinyin.dat，然后把用户字典名写到一个byte数组里，最后把静态字典文件信息与用户字典名作为参数，调用本地c/c++函数nativeImOpenDecoderFd（）。

onBind函数返回的binder对象，就是
private final IPinyinDecoderService.Stub mBinder = new IPinyinDecoderService.Stub() {
       ....
};

当PinyinDecoderService创建时，初始化工作包括了收集系统静态字典文件信息以及用户字典路径信息，然后调用C++代码接口nativeImOpenDecoderFd完成底层服务的启动（另一个C++代码接口nativeImOpenDecoder也完成同样的功能，除了传递不同的参数）。

下图是C++函数nativeImOpenDecoderFd的原形如下：
JNIEXPORT jboolean JNICALL nativeImOpenDecoderFd(JNIEnv* env, jclass jclazz,
                                                                          jobject fd_sys_dict,
                                                                          jlong startoffset,
                                                                          jlong length,
                                                                          jbyteArray fn_usr_dict) {...}

函数的调用栈如下图示：


函数首先从Java虚拟机空间通过JNI接口取得静态系统字典文件描述符并克隆到本地C++程序空间文件描述符newfd和保存用户字典文件名的字节数组fud。然后与传入的静态字典文件开始位置的偏移startoffset和文件长度longth一起作为参数调用函数im_open_decoder_fd（），最后关闭newfd，并释放Java虚拟机分配的用来保存用户字典文件名的字节数组（调用JNI接口函数释放）

函数im_open_decoder_fd声明在文件include/pinyinime.h里，从注释可以看到，Android平台的系统静态字典是内嵌在整个应用程序的apk文件内:
   
    bool im_open_decoder_fd(int sys_fd, long start_offset, long length,
                                        const char *fn_usr_dict);

题外话：
1. PinyinIME把系统静态字典文件是dict_pinyin.dat，在源码树中会放在目录res/raw/下。
2. 因为Android的工具aapt在生成apk文件时默认地会编译并压缩res/下的文件，而系统静态字典文件则不需要被压缩（否则在读取该文件时需要解压缩），在Android.mk文件需要指定以下选项告诉aapt工具不压缩所有.dat文件：
LOCAL_AAPT_FLAGS := -0 .dat
3. Java文件可以通过Resource类的函数openRawResourceFd读取apk内嵌在apk文件内的系统静态字典文件信息，返回到一个AssetFileDescriptor类对象实例（以下代码从apk文件读出res/raw/dict_pinyin.dat文件信息，参数不需要文件后缀名）：
AssetFileDescriptor afd = getResources().openRawResourceFd(R.raw.dict_pinyin);
AssetFileDescriptor类包含3个关键信息，文件描述符，要读取的文件数据的起始偏移和该文件数据的长度，详情参考 http://developer.android.com/reference/android/content/res/AssetFileDescriptor.html

现在回来看看函数im_open_decoder_fd的实现：
在文件share/pinyinime.cpp保存一个类型为MatrixSearch的全局变量matrix_search，当函数im_open_decoder_fd被调用的时候，创建新的atrixSearch对象，保存到变量matrix_search（如果变量在赋值前还保存着先前的实例，则要先删除以释放内存），然后对新建的实例对象调用init_fd函数，文件描述符，文件数据起始偏移和文件数据长度，还有用户字典文件名数组都作为参数传递到类MatrixSearch的成员函数init_fd。

类MatrixSearch在头文件include/matrixsearch.h里声明，它完成PinyinIME底层服务的核心功能，从接收/增加/修改输入的拼音序列，然后解析分组拼音序列，再到系统字典有用户字典中去查询匹配的汉字候选序列并返回给上层应用程序都在此类中完成。关于这个类及其相关的数据结构打算用独立的篇幅介绍，在此先略过，重点来关注它实例化以后的初始函数init_fd执行过程：
1）初始化，为类成员分配内存空间并初始化。包括创建下面用到的系统字典DictTrie实例和用户字典实例UserDict。
2）装载系统静态字典文件内容到字典树dict_trie（指针和对象类型均为DictTrie）
3）装载用户字典内容到user_dict_（指针和对象类型分别为AtomDictBase和派生的UserDict）,然后应用用系统词频校对用户字典。

4）把状态清0，进入准备就绪状态。

转载自：http://blog.sina.com.cn/s/blog_4177a2e20100lsh0.html