[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 權威指南 1. [目錄設置](#) 1. [保留字](#) 1. [自定義分詞](#) 1. [字段設計](#) 1. [異常處理](#) # 開發規范 在開始任何開發之前，有必要先強調一下開發規范。開發規范并不是強制性的要求，而只是為了使項目及代碼更利于維護、閱讀而制定的一些習慣行為公約。 ### 1. 目錄設置[?]() 無論您是否將 `PHP-SDK` 的代碼拷出單獨使用，強烈建議保留現有的目錄結構。 開發的項目配置 ini 文件統一放入 `$prefix/sdk/php/app` 目錄。 自定義或擴展的類庫請統一放入 `$prefix/sdk/php/lib` 以便 `XS` 進行 `autoload`。 ### 2. 保留字[?]() 所有 `Xunsearch PHP-SDK` 的系統類庫定義時均以 `XS` 開頭，為避免沖突，請自行編寫代碼和定義時不要也以 `XS` 開頭。 ### 3. 自定義分詞[?]() Xunsearch 在項目配置時支持針對某些字段自定義分詞。每個自定義分詞功能單獨使用一個文件名，命名為 `XSTokenizerXyz.class.php`，其中 `Xyz` 是您自己的分詞名稱，文件統一放入 `$prefix/sdk/php/lib` 目錄，分詞類名即為 `XSTokenizerXyz`，該類必須實現[XSTokenizer](#) 接口。 ### 4. 字段設計[?]() 多數搜索項目可能都是和相關的數據庫聯動的，出于開發方便，強烈建議讓搜索項目的字段命名和實際數據庫內的命名一致。在此基礎下推薦以下命名規范： - 字段名都使用小寫命名，您可以根據自己的偏好選擇用單數或復數形式，但不要二者同時使用。 - 名字中的單詞應使用下劃線分割 (例如 product_order)。 - 只在搜索項目中設置搜索結果展示、搜索條件必須用到的字段，不要在搜索項目中保存無關字段。 ### 5. 異常處理[?]() 由于 `Xunsearch PHP-SDK` 全面采用面向對象技術，所有失敗的操作均拋出類型為 [XSException](#)的異常，請在執行主線中捕捉它。具體參見 [XSException 異常](#) 章節的有關介紹。 $Id$ [? 體驗 demo 項目](#) [開發流程 ?](#) Copyright ? 2008-2011 by [杭州云圣網絡科技有限公司](http://www.xunsearch.com) All Rights Reserved.