# API開發實例 #### 一、先簡單回答兩個問題： 1、PHP 可以開發客戶端？ 答：不可以，因為PHP是腳本語言，是負責完成 B/S架構 或 C/S架構 的S部分，即：服務端的開發。（別去糾結 GTK、WinBinder） 2、為什么選擇 PHP 作為開發服務端的首選？ 答：跨平臺（可以運行在UNIX、LINUX、WINDOWS、Mac OS下）、低消耗（PHP消耗相當少的系統資源）、運行效率高（相對而言）、MySQL的完美搭檔，本身是免費開源的，...... #### 二、如何使用 PHP 開發 API（Application Programming Interface，應用程序編程接口） 呢？ 做過 API 的人應該了解，其實開發 API 比開發 WEB 更簡潔，但可能邏輯更復雜，因為 API 其實就是數據輸出，不用呈現頁面，所以也就不存在 MVC（API 只有 M 和 C）， 1、和 WEB 開發一樣，首先需要一些相關的參數，這些參數，都會由客戶端傳過來，也許是 GET 也許是 POST，這個需要開發團隊相互之間約定好，或者制定統一規范。 2、有了參數，根據應用需求，完成數據處理，例如：任務進度更新、APP內購、一局游戲結束數據提交等等 3、數據邏輯處理完之后，返回客戶端所需要用到的相關數據，例如：任務狀態、內購結果、玩家信息等等 數據怎么返給客戶端？ 直接輸出的形式，如：JSON、xml、TEXT 等等。 4、客戶端獲取到你返回的數據后，在客戶端本地和用戶進行交互 ## 臨時寫的一個簡單 API 例子： ``` <?php $output?=?array(); $a?=?@$_GET['a']???$_GET['a']?:?''; $uid?=?@$_GET['uid']???$_GET['uid']?:?0; if?(empty($a))?{ ????$output?=?array('data'=>NULL,?'info'=>'坑爹啊!',?'code'=>-201); ????exit(json_encode($output)); } //走接口 if?($a?==?'get_users')?{ ????//檢查用戶 ????if?($uid?==?0)?{ ????????$output?=?array('data'=>NULL,?'info'=>'The?uid?is?null!',?'code'=>-401); ????????exit(json_encode($output)); ????} ????//假設?$mysql?是數據庫 ????$mysql?=?array( ????????10001?=>?array( ????????????'uid'=>10001, ????????????'vip'=>5, ????????????'nickname'?=>?'Shine?X', ????????????'email'=>'979137@qq.com', ????????????'qq'=>979137, ????????????'gold'=>1500, ????????????'powerplay'=>?array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8), ????????????'gems'=>?array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), ????????????'ctime'=>1376523234, ????????????'lastLogin'=>1377123144, ????????????'level'=>19, ????????????'exp'=>16758, ????????), ????????10002?=>?array( ????????????'uid'=>10002, ????????????'vip'=>50, ????????????'nickname'?=>?'elva', ????????????'email'=>'elva@ezhi.net', ????????????'qq'=>NULL, ????????????'gold'=>14320, ????????????'powerplay'=>?array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8), ????????????'gems'=>?array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), ????????????'ctime'=>1376523234, ????????????'lastLogin'=>1377123144, ????????????'level'=>112, ????????????'exp'=>167588, ????????), ????????10003?=>?array( ????????????'uid'?=>?10003, ????????????'vip'?=>?5, ????????????'nickname'?=>?'Lily', ????????????'email'?=>?'Lily@ezhi.net', ????????????'qq'?=>?NULL, ????????????'gold'?=>?1541, ????????????'powerplay'=>?array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8), ????????????'gems'?=>?array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7), ????????????'ctime'?=>?1376523234, ????????????'lastLogin'=>?1377123144, ????????????'level'?=>?10, ????????????'exp'?=>?1758, ????????), ????); ???? ????$uidArr?=?array(10001,10002,10003); ????if?(!in_array($uid,?$uidArr,?true))?{ ????????$output?=?array('data'?=>?NULL,?'info'=>'The?user?does?not?exist!',?'code'?=>?-402); ????????exit(json_encode($output)); ????} ????//查詢數據庫 ????$userInfo?=?$mysql[$uid]; ???? ????//輸出數據 ????$output?=?array( ????????'data'?=>?array( ????????????'userInfo'?=>?$userInfo, ????????????'isLogin'?=>?true,//是否首次登陸 ????????????'unread'?=>?4,//未讀消息數量 ????????????'untask'?=>?3,//未完成任務 ????????),? ????????'info'?=>?'Here?is?the?message?which,?commonly?used?in?popup?window',?//消息提示，客戶端常會用此作為給彈窗信息。 ????????'code'?=>?200,?//成功與失敗的代碼，一般都是正數或者負數 ????); ????exit(json_encode($output)); }?elseif?($a?==?'get_games_result')?{ ????//... ????die('您正在調?get_games_result?接口!'); }?elseif?($a?==?'upload_avatars')?{ ????//.... ????die('您正在調?upload_avatars?接口!'); } ``` 點擊測試（對于客戶端而言，也是直接調用這樣的地址）： <http://www.ezhi.net/api/test/index.php> [http://www.ezhi.net/api/test/index.php?a=get\_users](http://www.ezhi.net/api/test/index.php?a=get_users) [http://www.ezhi.net/api/test/index.php?a=get\_users&uid=10001](http://www.ezhi.net/api/test/index.php?a=get_users&uid=10001) [http://www.ezhi.net/api/test/index.php?a=get\_users&uid=10002](http://www.ezhi.net/api/test/index.php?a=get_users&uid=10002) [http://www.ezhi.net/api/test/index.php?a=get\_users&uid=10003](http://www.ezhi.net/api/test/index.php?a=get_users&uid=10003) #### 三、實際項目中，我們在開發 API 應該注意的幾個事項（僅供參考）： 1、單文件實現多接口的形式有很多種，例如：if..elseif.. 或 switch 或 動態方法 (也就是TP的這種訪問函數體的形式) 2、對于數據的輸出最好用json，json具有相當強大的跨平臺性，市場上各大主流編程語言都支持json解析，json正在逐步取代xml，成為網絡數據的通用格式 3、接口安全，一定要增加接口驗證。例如，客戶端和服務端針對不同接口統一做好加密方式，服務端在對于每次接口需要都要進行驗證。以保證防止接口被惡意刷新或黑客惡意調用，尤其是大型商業應用。 4、對于線上的 API 必須保證所有接口正常且關閉所有的錯誤信息 => error\_reporting(0)，在輸出JSON 時，不能有任何其它輸出，否則，客戶端將解析數據失敗，直接 Crash！ 5、開發 API 和 WEB 有一定的區別，如果是 WEB 的話，可能代碼出錯了，不會導致特別嚴重的錯誤，也許只是導致數據寫入和查詢失敗，也許導致 WEB 的某個部分錯位或亂碼。但如果是 API，直接 Crash！ 6、做接口開發，不建議使用框架開發，原因概括起來有兩點（其實我有點冒風險的，本人也是 TPer 一枚，畢竟這是TP的官網）： 1）客戶端一般對服務端的響應速度有極高要求，因此，使用最原生態的 PHP 完成接口開發，是最高效的，假如用到了框架，還需要加載各種不需要多余的文件，就好比夏天穿了件冬天的衣服。試想，你在玩手機的時候，使用一個應用隨便一個操作，等半天才有動靜，你受的了嗎？ 2）就是上面第4點提到的，框架對于WEB開發，是件很幸福的事，但對于 API 而言，你實在不敢想象它會給你出什么岔子！最后你將痛苦不堪~~因為很多框架都是為 WEB 誕生的（我也很期待有一天能看到專門為開發 API 而生的框架或者擴展） 這個也有人糾結，接口效率與穩定性，還得看編碼的人，有的人可能寫的還不如框架跑的快，也有人覺得用框架沒什么問題，這里只是建議，關鍵看自己的實際情況，同時建議代碼上線前壓測一下 說到這，不得不說扯一下，騰訊微博淘寶等開放平臺。其實那些開放平臺，所謂的開放，就是給你提供一個這樣的接口，你根據他們提供的技術文檔，按他們制定的格式和要求，調它們提供的接口文件（一般都是返回JSON或者xml），你就可以獲取到他們的相關信息，例如：QQ用戶基本信息、淘寶店鋪、商品消息等等。然后在根據這些消息，在你的應用里完成交互。 其實，ajax 也是調用 API 的一種體現形式，你覺得呢？ 呵呵~~