2. 程式人生 > >php開發App介面

php開發App介面

阿新 • • 發佈：2019-01-05

APP介面簡介：

什麼是app介面？app介面就是用服務端程式如php寫好的指令碼，以供app客戶端請求而獲得資料的一個東西。比如一個視訊app的首頁，肯定有一些視訊列表，那麼當你開啟這個app時，這個封裝在app裡的這個首頁其實會去請求一個遠端php檔案如：http://www.example.com/index.php 去獲得需要展示在首頁的視訊列表資料。前段工程師拿到這些資料，就會按照特定的設計，將這些內容展示出來了。

　　介面要實現的目的就是這樣。一個app內部通常需要訪問多個php介面來獲得不同的資料。下面具體講一講介面實現的流程以及實現介面需要的一些核心的技術。

思路流程：

 

如何通訊：


客戶端傳送http請求 伺服器返回資料。

 

封裝通訊介面方法：

2-1 JSON方式封裝通訊介面 (14:39)

先上程式碼：

response.class.php

<?php

/**
 *description 用於返回指定資料格式的類
 *@param $code [int] 返回的狀態碼
 *@param $message [string] 返回的狀態資訊
 *@param $data [array] 需要返回的資料
 *
 */

class Response{
    public function json($code,$message,$data){
        $result = array(
                "code" => $code,
                "message" => $message,
                "data" => $data
            );
        return json_encode($result);
    }
}


response.class.php是一個最簡單的返回json格式資料的類,在下面的課程中我們會進一步對其進行完善。

下面貼出介面檔案程式碼：

returndata.php

<?php
require "response.class.php";    //引入返回資訊類

//準備返回資料
$code = 200;
$message = "資訊請求成功";
$data = array(
        "name" => "ruanwnewu",
        "sex"  => "1",
        "age"  => "28",
        "exp" => array(
                "2012" => "北京瑞泰新",
                "2013" => "兄弟連",
                "2014" => "木螞蟻科技"
            )
    );

//例項化response類
$response = new Response;

//返回資料
echo $response -> json($code,$message,$data);


請求returndata.php介面返回的資料如下圖所示：

這樣就完成了一個最基本的，封裝好的json資料通訊介面。

2-2 PHP生成XML資料 (12:02)

生成XML格式資料一般有三種方法：

  • 拼接字串
  • domDocument
  • simpleXML

在這裡我只講解第一種方法生成XML資料的方法。上程式碼：

producexml.php

<?php
header('Content-Type:text/xml');
$xml = '<?xml version="1.0" encoding="utf-8" ?>';
$xml .= '<res>';
$xml .= '<code>404</code>'."\r\n";
$xml .= '<message>資料返回成功</message>'."\r\n";
$xml .= '<data>'."\r\n";
$xml .= '<name>軟文無</name>'."\r\n";
$xml .= '<sex>1</sex>'."\r\n";
$xml .= '<age>28</age>'."\r\n";
$xml .= '</data>';
$xml .= '</res>';
echo $xml;


2-3 XML方式封裝通訊介面 (17:50)

上程式碼：

<?php

/**
 *description 用於返回指定資料格式的類
 *@param $code [int] 返回的狀態碼
 *@param $message [string] 返回的狀態資訊
 *@param $data [array] 需要返回的資料
 */

class Response{
    public function json($code,$message,$data){
        $result = array(
                "code" => $code,
                "message" => $message,
                "data" => $data
            );
        return json_encode($result);
    }
    
    public function xml($code,$message,$data){
        $result = array(
                "code" => $code,
                "message" => $message,
                "data" => $data
            );
        header('Content-Type:text/xml');
        $xml = "<?xml version='1.0' encoding='UTF-8'?>\n";
        $xml .= "<root>";
        $xml .= self::encodeXml($result);
        $xml .= "</root>";
        return $xml;
    }
    
    /**
     *將資料解析為XML字串
     */
    
    public static function encodeXml($data){
        $attr = $xml = "";
        foreach($data as $key => $value){
                if(is_numeric($key)){
                    $attr = " id='{$key}'";
                    $key = "item";
                }
                $xml .= "<{$key}{$attr}>";
                $xml .= is_array($value)?self::encodeXml($value):$value;
                $xml .= "</$key>";
        }
        return $xml;
    }
    
}

同樣用returndata.php呼叫該介面：

<?php
require "response.class.php";    //引入返回資訊類

//準備返回資料
$code = 200;
$message = "資訊請求成功";
$data = array(
        "name" => "ruanwnewu",
        "sex"  => "1",
        "age"  => "28",
        "exp" => array(
                "2012" => "北京瑞泰新",
                "2013" => "兄弟連",
                "2014" => "木螞蟻科技"
            )
    );

//例項化response類
$response = new Response;

//返回資料
echo $response -> xml($code,$message,$data);


得到如下圖所示的XML檔案結果

2-4 綜合方式封裝通訊資料方法 (11:15)

將兩種封裝方法綜合起來，並能夠根據請求的引數來返回指定格式的資料,上程式碼：

完善後的response類

<?php

/**
 *description 用於返回指定資料格式的類
 *@param $code [int] 返回的狀態碼
 *@param $message [string] 返回的狀態資訊
 *@param $data [array] 需要返回的資料
 */

class Response{
    public function show($code,$message,$data,$type="json"){
        if($type == "json"){
            $this->json($code,$message,$data);
        }else{
            $this->xml($code,$message,$data);
        }
    }
    public function json($code,$message,$data){
        $result = array(
                "code" => $code,
                "message" => $message,
                "data" => $data
            );
        return json_encode($result);
    }
    
    public function xml($code,$message,$data){
        $result = array(
                "code" => $code,
                "message" => $message,
                "data" => $data
            );
        header('Content-Type:text/xml');
        $xml = "<?xml version='1.0' encoding='UTF-8'?>\n";
        $xml .= "<root>";
        $xml .= self::encodeXml($result);
        $xml .= "</root>";
        return $xml;
    }
    
    /**
     *將資料解析為XML字串
     */
    
    public static function encodeXml($data){
        $attr = $xml = "";
        foreach($data as $key => $value){
                if(is_numeric($key)){
                    $attr = " id='{$key}'";
                    $key = "item";
                }
                $xml .= "<{$key}{$attr}>";
                $xml .= is_array($value)?self::encodeXml($value):$value;
                $xml .= "</$key>";
        }
        return $xml;
    }
    
}


總結：

1、對於資料的輸出最好用json，json具有相當強大的跨平臺性，市場上各大主流程式語言都支援json解析，json正在逐步取代xml，成為網路資料的通用格式
2、介面安全，一定要增加介面驗證。例如，客戶端和服務端針對不同介面統一做好加密方式，服務端在對於每次介面需要都要進行驗證。以保證防止介面被惡意重新整理或黑客惡意呼叫，尤其是大型商業應用。
3、對於線上的 API 必須保證所有介面正常且關閉所有的錯誤資訊 => error_reporting(0)，在輸出JSON 時，不能有任何其它輸出，否則，客戶端將解析資料失敗，直接 Crash！
4、開發 API 和 WEB 有一定的區別，如果是 WEB 的話，可能程式碼出錯了，不會導致特別嚴重的錯誤，也許只是導致資料寫入和查詢失敗，也許導致 WEB 的某個部分錯位或亂碼。但如果是 API，直接 Crash！

相關推薦

PHP開發APP介面之封裝通訊介面

PHP開發APP介面之封裝通訊介面 按json方式輸出通訊資料 /** * 按json方式輸出通訊資料 * @param integer $code 狀態碼 * @param string $message 提示資訊 * @p

PHP 開發 APP 介面--XML篇

1.PHP 生成 XML 資料 ① 拼接字串 ② 使用系統類（DomDocument，XMLWriter，SimpleXML） 例1 使用 PHP 系統類中的 DomDocument 類： <?php $dom = new DomDocument('1.0','utf-8'); $elem

PHP 開發 APP 介面 --JSON、XML結合篇

要求： 1.在一個類中封裝多種資料通訊方法(JSON,XML)，並且只通過一個入口選擇需要的資料通訊格式 2.客戶端開發工程師可以自行選擇資料傳輸格式(GET 方式) response.php <?php class Response{ const JSON =

PHP 開發 APP 介面--靜態快取篇

儲存靜態快取即把快取寫入檔案。 /** *按綜合方式輸出通訊資料 *@param string $k 檔名 *@param string $v 快取資料 *@param string $path 路徑 *@return string */ file.php <?p

PHP 開發 APP 介面 --Redis篇

Redis 可以定期將資料備份到磁碟中（持久化），同時不僅僅支援簡單的key/value 型別的資料，同時還提供list，set，hash等資料結構的儲存；Memcache 只是簡單的key/value 快取。   ① 開啟 redis 服務： [[email&

PHP 開發 APP 介面 學習筆記與總結--讀取資料庫方式

方案一：讀取資料庫方式 從資料庫讀取資訊→封裝→生成介面資料 應用場景： 資料時效性比較高的系統   方案二：讀取快取方式 從資料庫獲取資訊（第一次設定快取或快取失效時）→封裝（第一次設定快取或快取失效時）→返回資料          

PHP 開發 APP 介面--讀取快取方式

以靜態快取為例。 list.php: 1 <?php 2 require_once 'response.php'; 3 require_once 'db.php'; 4 require_once 'file.php'; 5 6 $page = isset($_GET['pag

PHP開發APP介面 記錄

用於 把資料返給APP介面使用 ，返回 方式有 xml，json，array class Response { /** * 綜合方式輸出資料 * @param integer $code 狀態碼 * @param string $message 提示資訊 * @param a

php開發App介面

APP介面簡介： 什麼是app介面？app介面就是用服務端程式如php寫好的指令碼，以供app客戶端請求而獲得資料的一個東西。比如一個視訊app的首頁，肯定有一些視訊列表，那麼當你開啟這個app時，這個封裝在app裡的這個首頁其實會去請求一個遠端php檔案如：http:/

php開發app介面1

APP是如何通訊  類似於 B/S架構(瀏覽器/伺服器)  1、介面地址看不到  2、返回的型別不一樣 xml於json 區別 1、可讀性  xml資料強 2、生成資料方面  json強 3、速度方面     json app介面做的那些事情？ 1、檢測是否更新... ..

PHP開發APP介面注意事項

一、雙方統一介面開發文件 為了提升開發效率及溝通方便，需要建立規範的開發文件。 一般保護介面的功能或頁面、介面地址、介面引數、介面返回值等說明。 參考文件格式： 二、注意以下 分版本

PHP開發APP介面全過程（一）

1、學習要點： 伺服器端 –> 資料庫|快取 –>呼叫介面 –>客戶端 2、APP介面介紹：（PHP開發APP介面） PHP面向物件的介面：抽象類，interface定義 ==>interface.php

php 開發APP介面

APP模擬器：Start BlueStacks； 第一、APP介面簡介 1.1、客戶端app通訊 這種通訊模式類似於BS架構系統相似，但是有區別： （1）：客戶端請求地址是不可見的，是封裝在APP中的； （2）：BS架構返回的是HTML格式資料，而APP返回的是XML和J

慕課 php 開發APP介面（三）

#檔案： 存key value 值 $value 不為空，則存，為空 則讀，為 null 則刪除 class File{ private $_dir; const EXT = '.txt'; public function __construct

PHP 開發APP 介面

介面是什麼： 介面泛指實體把自己提供給外界的一種抽象化物（可以為另一實體），用以由內部操作分離出外部溝通方法，使其能被修改內部而不影響外界其他實體與其互動的方式。 人類與電腦等資訊機器或人類與程式之間的介面稱為使用者介面。電腦等資訊機器硬體元件間的介面叫硬體介面。電腦等資訊機器軟體元件間的

[APP介面] -- PHP開發APP介面（一）

原文連結: http://www.cnblogs.com/xp796/p/5347374.html php以json或者xml 形式返回給app。明白這點就很好說了，就是把資料包裝成json或者xml，返回給APP 定義抽象APP基類： <?php /**

PHP開發app介面（1）

這是學習用php開發app介面的一些隨筆。 用interface關鍵字定義，示例： interface video(){ public function getVideos(); public function getCount();//這都是虛擬的方法 } 介面的實現：

PHP 開發 APP 接口--XML篇

odi write ttr UNC -- elf jpg php 結束 1.PHP 生成 XML 數據 ① 拼接字符串 ② 使用系統類（DomDocument，XMLWriter，SimpleXML） 例1 使用 PHP 系統類中的 DomDocument 類： <

PHP開發api介面安全驗證

php的api介面 在實際工作中，使用PHP寫api介面是經常做的，PHP寫好介面後，前臺就可以通過連結獲取介面提供的資料，而返回的資料一般分為兩種情況，xml和json,在這個過程中，伺服器並不知道，請求的來源是什麼，有可能是別人非法呼叫我們的介面，獲取資料，因此就要使用安

PHP開發api介面安全驗證方法一

前臺想要呼叫介面，需要使用幾個引數生成簽名。時間戳：當前時間隨機數：隨機生成的隨機數 簽名：特定方法生成的sign簽名 演算法規則在前後臺互動中，演算法規則是非常重要的，前後臺都要通過演算法規則計算出簽名，至於規則怎麼制定，看你怎麼高興怎麼來。我這個演算法規則是時間戳，隨機數，口令按照首字母大小寫順序排序