示例淺談PHP與手機APP開發，即API介面開發

速貸100發表於2017-03-07
PHPAPPAPI

API（Application Programming Interface，應用程式介面）架構，已經成為目前網際網路產品開發中常見的軟體架構模式，並且誕生很多專門API服務的公司，如：聚合資料（https://www.juhe.cn/）、百度APIStore（http://apistore.baidu.com/）

作為最流行的服務端語言PHP（PHP: Hypertext Preprocessor），在開發API方面，是很簡單且極具優勢的
這篇文章寫給不太瞭解PHP開發API介面的開發者

一、先簡單回答兩個問題

1、PHP 可以開發客戶端嗎？
答：正確的回答是，不適合，因為PHP是服務端指令碼語言，負責 B/S或C/S 架構的S部分，即：Server端的開發。
（別去糾結 GTK、WinBinder）

2、為什麼選擇 PHP 作為開發服務端的首選？
答：跨平臺（可以執行在UNIX、LINUX、WINDOWS、Mac OS下）、低消耗（PHP消耗相當少的系統資源）、執行效率高（相對而言）、MySQL的完美搭檔，本身是免費開源的，……

二、如何使用 PHP 開發 API 呢？

有興趣細研究的，可以先看看百科介紹：http://baike.baidu.com/item/api/10154
百科寫的比較泛，嫌文字多？好吧，那就不看了，先了解下 API 是什麼鬼
1、API 比開發 WEB 更簡潔，但可能邏輯更復雜，API 只返回結果，也就是隻完成資料輸出，不呈現頁面，
2、WEB 開發，更多的是 GET 和 POST 請求，API 還有 PUT、DELETE 請求
3、和 WEB 開發一樣，首先需要一些相關的引數，這些引數，都會由客戶端傳過來，也許是 GET 也許是 POST，這個需要開發團隊相互之間約定好，或者制定統一規範
4、有了引數，根據應用需求，完成資料處理，例如：獲取使用者資訊、發朋友圈、發訊息、一局遊戲結束資料提交等等
5、資料邏輯處理完之後，返回客戶端所需要用到的相關資料，例如：使用者資訊陣列、朋友圈列表、訊息狀態、遊戲結果資料等等，那資料是怎麼返給客戶端呢？常見有XML、JSON，設定相應的header並把要返回的資料直接列印出來即可
6、客戶端獲取到你返回的資料後，在客戶端本地和使用者進行互動

所以我們大概知道，API 其實不存在Web領域的 MVC 架構模式，若要分層的，API 也只有 M 和 C 兩層，當然，後端可能會有更加複雜的架構！

通過下面一個HTTP協議的API例項來理解PHP怎麼開發API：

  1. <?php
  2. /**
  3. * 比較標準的介面輸出函式
  4. * @param string  $info 訊息
  5. * @param integer $code 介面錯誤碼，很關鍵的引數
  6. * @param array   $data 附加資料
  7. * $param string  $location 重定向
  8. * @return array
  9. */
  10. function var_json($info = “, $code = 10000, $data = array(), $location = “) {
  11.     $out[`code`] = $code ?: 0;
  12.     $out[`info`] = $info ?: ($out[`code`] ? `error` : `success`);
  13.     $out[`data`] = $data ?: array();
  14.     $out[`location`] = $location;
  15.     header(`Content-Type: application/json; charset=utf-8`);
  16.     echo json_encode($out, JSON_HEX_TAG);
  17.     exit(0);
  18. }
  20. $a = empty($_GET[`a`]) ? “ : $_GET[`a`];
  21. $qq = empty($_GET[`qq`]) ? 0 : intval($_GET[`qq`]);
  23. //假設這是資料來源，如MySQL
  24. $data = array();
  25. $data[979136] = array(`qq`=>979136, `vip`=>5,`level`=>128, `reg_time`=>1376523234, `qb`=>300);
  26. $data[979137] = array(`qq`=>979137, `vip`=>8,`level`=>101, `reg_time`=>1377123144, `qb`=>300);
  28. preg_match(`/^[a-zA-Z]+$/`, $a) || var_json(`非法呼叫`);
  29. isset($data[$qq]) || var_json(`使用者不存在`, 100001);
  31. switch ($a) {
  32.     //獲取使用者基本資訊
  33.     case `info`: 
  34.         //你的更多業務邏輯 …
  35.         var_json(`success`, 0, $data[$qq]);
  36.         break;
  37.     //獲取動態訊息
  38.     case `message`:
  39.         var_json(`您正在呼叫動態訊息介面`, 0);
  40.         break;
  41.     //獲取好友列表
  42.     case `friends`:
  43.         var_json(`你正在呼叫好友列表介面`, 0);
  44.         break;
  45.     default:
  46.         var_json(`非法呼叫`);
  47. }

複製程式碼

把它部署到伺服器之後，任何語言都可以通過HTTP協議呼叫諸如下面的URL介面：
http://demo.979137.com/api/test/user.php
http://demo.979137.com/api/test/user.php?a=info&qq=979137&ticket=test
http://demo.979137.com/api/test/user.php?a=info&qq=979138&ticket=test
http://demo.979137.com/api/test/user.php?a=friends&qq=979137&ticket=test
http://demo.979137.com/api/test/user.php?a=fuck&qq=979137&ticket=test
介面輸出示例，返回的是一串json：

{
        “code”: 0,
        “info”: “success”,
        “data”: {
                “qq”: 979137,
                “vip”: 8,
                “level”: 101,
                “reg_time”: 1377123144,
                “qb”: 300
        },
        “location”: “”
}


json具有很強的跨平臺性，幾乎每種語言都有解析json的函式，下面是一個PHP作為客戶端呼叫的示例：

  1. <?php
  2. header(`Content-type:text/html;charset=utf-8`);
  3. $url = “http://demo.979137.com/api/test/user.php”;
  4. $arg = array(
  5.     `a`  => `info`,
  6.     `qq` => `979137`,
  7. );
  8. $query_string = http_build_query($arg);
  9. $ch = curl_init($url.`?`.$query_string);
  10. curl_setopt($ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1);
  11. curl_setopt($ch, CURLOPT_USERAGENT , `QQ_Mobile_V5.5`);
  12. curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 60 );
  13. curl_setopt($ch, CURLOPT_TIMEOUT , 60);
  14. curl_setopt($ch, CURLOPT_RETURNTRANSFER , true);
  15. curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
  16. $response = curl_exec($ch);
  17. $httpcode = curl_getinfo($ch , CURLINFO_HTTP_CODE);
  18. curl_close($ch);
  19. if ($response === false) {
  20.     var_dump(curl_error($ch));
  21. } elseif ($httpcode != 200) {
  22.     var_dump($httpcode, `介面請求失敗`);
  23. } else {
  24.     $ret = json_decode($response, true);
  25.     var_dump($ret);
  26. }

複製程式碼

頁面輸出結果：

array(4) {
    [“code”]=>int(0)
    [“info”]=>string(7) “success”
    [“data”]=>
    array(5) {
        [“qq”]=>int(979137)
        [“vip”]=>int(8)
        [“level”]=>int(101)
        [“reg_time”]=>int(1377123144)
        [“qb”]=>int(300)
    }
    [“location”]=>string(0) “”
}


實際業務中，就是拿到了介面返回的資料之後，結合自身的業務為使用者提供服務！

三、實際專案中，我們在開發 API 時應該注意的幾個點（僅供參考）

1、單檔案實現多介面的形式有很多種，例如：if..elseif.. 或 switch 或 很多框架裡用到的統一入口通過呼叫類函式的形式實現
2、資料輸出建議使用json，json具有很強的跨平臺性，大多程式語言都支援json解析，json正在逐步取代xml，成為網路資料的通用格式
3、為了保證介面安全，一定要加入鑑權體系
4、對於線上的API，務必關閉所有錯誤顯示，可以把錯誤寫到日誌裡，PHP中，可以通過 error_reporting(0) 遮蔽所有錯誤
這樣做的目的，一方面是保護介面安全，防止輸出不該列印的錯誤資訊
另一方面是保證輸出的是正確的資料格式，如json，假如不是標準的json格式，客戶端在解析時就會出錯，由此影響客戶端的正常運轉
PS：我們平時在使用手機APP時，手機會閃退，多半是這個原因，即介面呼叫異常
5、開發 API 和 WEB 有一定的區別，如果是 WEB 的話，如果程式寫的有問題，比如有個notice 或 warning 級別的錯誤，在 WEB 裡可能不會有什麼問題，也許就只是導致 WEB 的某個部分錯位或亂碼。但如果是 API，就會嚴重呼叫的客戶端了，如果是手機APP，那閃推啥的，是必然的，如果同樣也是Web呼叫，也可能會出現  Server Error 了
6、一定要重點考慮穩定性和響應速度，因為我們在使用手機APP時，都不希望APP經常閃推、而且希望應用很流暢
7、不要隨便使用一些 PHP 開源框架，原因概括起來有兩點：
    1）如6所述，客戶端一般對 API 響應速度有極高要求，目前PHP領域的開源框架非常多，根據筆者的瞭解，目前比較流行的框架，普遍做的比較重，而且基本都是為WEB而生，因此，框架多了很多 API 用不到的東西，框架在載入和執行冗餘檔案時，實際是在消耗你的效能
    2）如4和5所述，框架對於WEB開發，是件很幸福的事，但對於 API 而言，你實在不敢想象它會給你出什麼岔子，因為很多框架並沒有全面的考慮到 API 場景

    關於這點，還是有很多人糾結的，認為用框架沒問題，這個怎麼說呢，關鍵還得看架構和編碼之人，有些人做的架構、寫的程式碼，遠不如框架寫的穩定、跑得快的也比比皆是！
    這裡只是建議，關鍵看自己的實際情況，上線前測試全面才是硬道理！

話說，牛逼的架構，一般都有自己的 API 框架！

這裡給 ThinkPHP 打個廣告：
目前 ThinkPHP5 是 ThinkPHP 家族的一個顛覆性重構版本，Slogan：為 API 而生。
本站資料介面版面提供的所有API，均採用 ThinkPHP5 框架開發，並部署在新浪雲平臺


再扯一下騰訊、微博、淘寶等這些個開放平臺吧，
它們所謂的開放，其實就是給開發者提供一系列的API，開發者根據他們提供的技術文件，按規定的呼叫方法，調它們提供的介面，你就可以獲取到他們的相關資訊，
例如：QQ使用者基本資訊、微博登入、淘寶店鋪、商品訊息等等。然後開發者再根據這些資料，在你的應用裡完成互動。
另外，我們常用的 Ajax 其實也是 API 呼叫的一種體現形式


相關文章