這個帖子寫給不太了解PHP與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、客戶端獲取到你回傳的資料后,在客戶端本地和用戶進行互動
phper在進階的時候總會遇到一些問題和瓶頸,業務代碼寫多了沒有方向感,不知道該從那里入手去提升,對此我整理了一些資料,包括但不限于:分布式架構、高可擴展、高性能、高并發、服務器性能調優、TP6,laravel,YII2,Redis,Swoole、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階干貨需要的可以免費分享給大家,需要的請點擊(→)我的官方群
臨時寫的一個簡單 API 例子:
-
1 <?php 2 $output = array(); 3 $a = @$_GET['a'] ? $_GET['a'] : ''; 4 $uid = @$_GET['uid'] ? $_GET['uid'] : 0; 5 if (empty($a)) { 6 $output = array('data'=>NULL, 'info'=>'坑爹啊!', 'code'=>-201); 7 exit(json_encode($output)); 8 } 9 //走介面 10 if ($a == 'get_users') { 11 //檢查用戶 12 if ($uid == 0) { 13 $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401); 14 exit(json_encode($output)); 15 } 16 //假設 $mysql 是資料庫 17 $mysql = array( 18 10001 => array( 19 'uid'=>10001, 20 'vip'=>5, 21 'nickname' => 'Shine X', 22 'email'=>'[email protected]', 23 'qq'=>979137, 24 'gold'=>1500, 25 'powerplay'=> array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8), 26 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), 27 'ctime'=>1376523234, 28 'lastLogin'=>1377123144, 29 'level'=>19, 30 'exp'=>16758, 31 ), 32 10002 => array( 33 'uid'=>10002, 34 'vip'=>50, 35 'nickname' => 'elva', 36 'email'=>'[email protected]', 37 'qq'=>NULL, 38 'gold'=>14320, 39 'powerplay'=> array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8), 40 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), 41 'ctime'=>1376523234, 42 'lastLogin'=>1377123144, 43 'level'=>112, 44 'exp'=>167588, 45 ), 46 10003 => array( 47 'uid' => 10003, 48 'vip' => 5, 49 'nickname' => 'Lily', 50 'email' => '[email protected]', 51 'qq' => NULL, 52 'gold' => 1541, 53 'powerplay'=> array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8), 54 'gems' => array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7), 55 'ctime' => 1376523234, 56 'lastLogin'=> 1377123144, 57 'level' => 10, 58 'exp' => 1758, 59 ), 60 ); 61 62 $uidArr = array(10001,10002,10003); 63 if (in_array($uid, $uidArr, true)) { 64 $output = array('data' => NULL, 'info'=>'The user does not exist!', 'code' => -402); 65 exit(json_encode($output)); 66 } 67 //查詢資料庫 68 $userInfo = $mysql[$uid]; 69 70 //輸出資料 71 $output = array( 72 'data' => array( 73 'userInfo' => $userInfo, 74 'isLogin' => true,//是否首次登陸 75 'unread' => 4,//未讀訊息數量 76 'untask' => 3,//未完成任務 77 ), 78 'info' => 'Here is the message which, commonly used in popup window', //訊息提示,客戶端常會用此作為給彈窗資訊, 79 'code' => 200, //成功與失敗的代碼,一般都是正數或者負數 80 ); 81 exit(json_encode($output)); 82 } elseif ($a == 'get_games_result') { 83 //... 84 die('您正在調 get_games_result 介面!'); 85 } elseif ($a == 'upload_avatars') { 86 //.... 87 die('您正在調 upload_avatars 介面!'); 88 }
點擊測驗(對于客戶端而言,也是直接呼叫這樣的地址):
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&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=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 的一種體現形式
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/131464.html
標籤:PHP
