迅搜開發(fā)規(guī)范

在開始任何開發(fā)之前，有必要先強(qiáng)調(diào)一下開發(fā)規(guī)范。開發(fā)規(guī)范并不是強(qiáng)制性的要求，而只是 為了使項(xiàng)目及代碼更利于維護(hù)、閱讀而制定的一些習(xí)慣行為公約。

1. 目錄設(shè)置

無論您是否將 PHP-SDK 的代碼拷出單獨(dú)使用，強(qiáng)烈建議保留現(xiàn)有的目錄結(jié)構(gòu)。

開發(fā)的項(xiàng)目配置 ini 文件統(tǒng)一放入 $prefix/sdk/php/app 目錄。

自定義或擴(kuò)展的類庫請(qǐng)統(tǒng)一放入 $prefix/sdk/php/lib 以便 XS 進(jìn)行 autoload。

2. 保留字

所有 Xunsearch PHP-SDK 的系統(tǒng)類庫定義時(shí)均以 XS 開頭，為避免沖突，請(qǐng)自行編寫 代碼和定義時(shí)不要也以 XS開頭。

3. 自定義分詞

Xunsearch 在項(xiàng)目配置時(shí)支持針對(duì)某些字段自定義分詞。每個(gè)自定義分詞功能單獨(dú)使用一個(gè) 文件名，命名為XSTokenizerXyz.class.php，其中 Xyz 是您自己的分詞名稱，文件統(tǒng)一 放入 $prefix/sdk/php/lib 目錄，分詞類名即為 XSTokenizerXyz，該類必須實(shí)現(xiàn) XSTokenizer 接口。

4. 字段設(shè)計(jì)

多數(shù)搜索項(xiàng)目可能都是和相關(guān)的數(shù)據(jù)庫聯(lián)動(dòng)的，出于開發(fā)方便，強(qiáng)烈建議讓搜索項(xiàng)目的字段命名 和實(shí)際數(shù)據(jù)庫內(nèi)的命名一致。在此基礎(chǔ)下推薦以下命名規(guī)范：

• 字段名都使用小寫命名，您可以根據(jù)自己的偏好選擇用單數(shù)或復(fù)數(shù)形式，但不要二者同時(shí)使用。

• 名字中的單詞應(yīng)使用下劃線分割 (例如 product_order)。

• 只在搜索項(xiàng)目中設(shè)置搜索結(jié)果展示、搜索條件必須用到的字段，不要在搜索項(xiàng)目中保存無關(guān)字段。

5. 異常處理

由于 Xunsearch PHP-SDK 全面采用面向?qū)ο蠹夹g(shù)，所有失敗的操作均拋出類型為 XSException 的異常，請(qǐng)?jiān)趫?zhí)行主線中捕捉它。具體參見 XSException 異常 章節(jié)的有關(guān)介紹。