示例淺談PHP與手機APP開發，即API接口開發

時間 2019-11-30

標籤示例淺談 php 手機 app 開發 api 接口欄目 PHP 简体版

原文原文鏈接

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）

二、爲何選擇 PHP 做爲開發服務端的首選？
答：跨平臺（能夠運行在UNIX、LINUX、WINDOWS、Mac OS下）、低消耗（PHP消耗至關少的系統資源）、運行效率高（相對而言）、MySQL的完美搭檔，自己是免費開源的，......

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

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

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

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

<?php
/**
* 比較標準的接口輸出函數
* @param string $info 消息
* @param integer $code 接口錯誤碼，很關鍵的參數
* @param array $data 附加數據
* $param string $location 重定向
* @return array
*/
function var_json($info = '', $code = 10000, $data = array(), $location = '') {
$out['code'] = $code ?: 0;
$out['info'] = $info ?: ($out['code'] ? 'error' : 'success');
$out['data'] = $data ?: array();
$out['location'] = $location;
header('Content-Type: application/json; charset=utf-8');
echo json_encode($out, JSON_HEX_TAG);
exit(0);
}
$a = empty($_GET['a']) ? '' : $_GET['a'];
$qq = empty($_GET['qq']) ? 0 : intval($_GET['qq']);
//假設這是數據源，如MySQL
$data = array();
$data[979136] = array('qq'=>979136, 'vip'=>5,'level'=>128, 'reg_time'=>1376523234, 'qb'=>300);
$data[979137] = array('qq'=>979137, 'vip'=>8,'level'=>101, 'reg_time'=>1377123144, 'qb'=>300);
preg_match('/^[a-zA-Z]+$/', $a) || var_json('非法調用');
isset($data[$qq]) || var_json('用戶不存在', 100001);
switch ($a) {
//獲取用戶基本信息
case 'info':
//你的更多業務邏輯 ...
var_json('success', 0, $data[$qq]);
break;
//獲取動態消息
case 'message':
var_json('您正在調用動態消息接口', 0);
break;
//獲取好友列表
case 'friends':
var_json('你正在調用好友列表接口', 0);
break;
default:
var_json('非法調用');
}

複製代碼

把它部署到服務器以後，任何語言均可以經過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：html

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

json具備很強的跨平臺性，幾乎每種語言都有解析json的函數，下面是一個PHP做爲客戶端調用的示例：thinkphp

<?php
header('Content-type:text/html;charset=utf-8');
$url = "http://demo.979137.com/api/test/user.php";
$arg = array(
'a' => 'info',
'qq' => '979137',
);
$query_string = http_build_query($arg);
$ch = curl_init($url.'?'.$query_string);
curl_setopt($ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_USERAGENT , 'QQ_Mobile_V5.5');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 60 );
curl_setopt($ch, CURLOPT_TIMEOUT , 60);
curl_setopt($ch, CURLOPT_RETURNTRANSFER , true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
$httpcode = curl_getinfo($ch , CURLINFO_HTTP_CODE);
curl_close($ch);
if ($response === false) {
var_dump(curl_error($ch));
} elseif ($httpcode != 200) {
var_dump($httpcode, '接口請求失敗');
} else {
$ret = json_decode($response, true);
var_dump($ret);
}

複製代碼

頁面輸出結果：編程

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) ""
}

實際業務中，就是拿到了接口返回的數據以後，結合自身的業務爲用戶提供服務！

3、實際項目中，咱們在開發 API 時應該注意的幾個點（僅供參考）

一、單文件實現多接口的形式有不少種，例如：if..elseif.. 或 switch 或不少框架裏用到的統一入口經過調用類函數的形式實現
二、數據輸出建議使用json，json具備很強的跨平臺性，大多編程語言都支持json解析，json正在逐步取代xml，成爲網絡數據的通用格式
三、爲了保證接口安全，必定要加入鑑權體系
四、對於線上的API，務必關閉全部錯誤顯示，能夠把錯誤寫到日誌裏，PHP中，能夠經過 error_reporting(0) 屏蔽全部錯誤
這樣作的目的，一方面是保護接口安全，防止輸出不應打印的錯誤信息
另外一方面是保證輸出的是正確的數據格式，如json，假如不是標準的json格式，客戶端在解析時就會出錯，由此影響客戶端的正常運轉
PS：咱們平時在使用手機APP時，手機會閃退，多半是這個緣由，即接口調用異常
五、開發 API 和 WEB 有必定的區別，若是是 WEB 的話，若是程序寫的有問題，好比有個notice 或 warning 級別的錯誤，在 WEB 裏可能不會有什麼問題，也許就只是致使 WEB 的某個部分錯位或亂碼。但若是是 API，就會嚴重調用的客戶端了，若是是手機APP，那閃推啥的，是必然的，若是一樣也是Web調用，也可能會出現 Server Error 了
六、必定要重點考慮穩定性和響應速度，由於咱們在使用手機APP時，都不但願APP常常閃推、並且但願應用很流暢
七、不要隨便使用一些 PHP 開源框架，緣由歸納起來有兩點：
1）如6所述，客戶端通常對 API 響應速度有極高要求，目前PHP領域的開源框架很是多，根據筆者的瞭解，目前比較流行的框架，廣泛作的比較重，並且基本都是爲WEB而生，所以，框架多了不少 API 用不到的東西，框架在加載和執行冗餘文件時，實際是在消耗你的性能
2）如4和5所述，框架對於WEB開發，是件很幸福的事，但對於 API 而言，你實在不敢想象它會給你出什麼岔子，由於不少框架並無全面的考慮到 API 場景

關於這點，仍是有不少人糾結的，認爲用框架沒問題，這個怎麼說呢，關鍵還得看架構和編碼之人，有些人作的架構、寫的代碼，遠不如框架寫的穩定、跑得快的也比比皆是！
這裏只是建議，關鍵看本身的實際狀況，上線前測試全面纔是硬道理！

話說，牛逼的架構，通常都有本身的 API 框架！json

這裏給 ThinkPHP 打個廣告：
目前 ThinkPHP5 是 ThinkPHP 家族的一個顛覆性重構版本，Slogan：爲 API 而生。
本站數據接口版面提供的全部API，均採用 ThinkPHP5 框架開發，並部署在新浪雲平臺

再扯一下騰訊、微博、淘寶等這些個開放平臺吧，
它們所謂的開放，其實就是給開發者提供一系列的API，開發者根據他們提供的技術文檔，按規定的調用方法，調它們提供的接口，你就能夠獲取到他們的相關信息，
例如：QQ用戶基本信息、微博登陸、淘寶店鋪、商品消息等等。而後開發者再根據這些數據，在你的應用裏完成交互。
另外，咱們經常使用的 Ajax 其實也是 API 調用的一種體現形式後端