PHP編寫(xiě)RESTful接口
首先我們來(lái)認(rèn)識(shí)下RESTful
Restful是一種設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)，比如一個(gè)接口原本是這樣的： http://www.test.com/user/view/id/1
表示獲取id為1的用戶(hù)信息，如果使用Restful風(fēng)格，可以變成這樣：
可以很明顯的看出這樣做的好處：
1、更簡(jiǎn)潔的URL，對(duì)程序員友好
2、不暴露內(nèi)部代碼結(jié)構(gòu)，更安全
那么，如何實(shí)現(xiàn)這個(gè)接口呢？首先，我們需要接收到/user/1部分。
$path = $_SERVER['PATH_INFO'];
$arr = explode('/',$path);
print_r($arr);
得到下面的結(jié)果：
Array ( [0] => [1] => User [2] => 1 )
獲取到了參數(shù)，下面的操作就很簡(jiǎn)單了：
if($arr[1] == 'user'){
$model = new UserModel();
$id = $arr[2]; //讀取用戶(hù)信息
$user_info = $model->find($id);
echo json_encode($user_info);
}
這樣，我們就實(shí)現(xiàn)了一個(gè)Restful風(fēng)格的API。
下面，我們?cè)倏慈绾螌?shí)現(xiàn)讀取用戶(hù)列表的接口，傳統(tǒng)方式： http://www.test.com/user/list
使用Restful風(fēng)格，可以更加簡(jiǎn)潔：
和讀取用戶(hù)信息的區(qū)別是，user后面沒(méi)有id，所以我們可以在讀取部分的基礎(chǔ)上做一下修改：
if($arr[1] == 'user'){
$model = new UserModel();
$id = $arr[2]; if($id){ //讀取用戶(hù)信息
$user_info = $model->find($id);
echo json_encode($user_info);
}else{ //讀取用戶(hù)列表
$user_list = $model->select();
echo json_encode($user_list); } }
這樣就實(shí)現(xiàn)了讀取用戶(hù)列表的接口。
下面再看如何實(shí)現(xiàn)增加用戶(hù)的接口，傳統(tǒng)方式：
Restful風(fēng)格：
http://www.test.com/user
和讀取用戶(hù)列表的接口是一樣的，怎么區(qū)分呢？其實(shí)很簡(jiǎn)單，讀取是GET請(qǐng)求，而增加是POST請(qǐng)求，用戶(hù)信息都存在POST參數(shù)中，所以可以對(duì)代碼進(jìn)行下面的修改：
if($arr[1] == 'user'){
$model = new UserModel();
$id = $arr[2];
if($id){ //讀取用戶(hù)信息
$user_info = $model->find($id);
echo json_encode($user_info);
}else{
if(IS_POST){ //增加用戶(hù)
$res = $model->add($_POST);
if($res){ echo 'success';
}else{ echo 'fail'; }
}else{ //讀取用戶(hù)列表
$user_list = $model->select();
echo json_encode($user_list); } } }
同樣的接口，可以依據(jù)HTTP請(qǐng)求方式來(lái)執(zhí)行不同的邏輯。
這就是實(shí)現(xiàn)Restful風(fēng)格API的核心思路，依次類(lèi)推，我們可以實(shí)現(xiàn)編輯用戶(hù)接口和刪除用戶(hù)接口：
http://www.test.com/user/1
只要使用不同的請(qǐng)求方式，就能區(qū)分開(kāi)了。我們可以用PUT請(qǐng)求來(lái)執(zhí)行編輯操作，用DELETE請(qǐng)求來(lái)執(zhí)行刪除操作。
具體代碼就不寫(xiě)了，有興趣的朋友可以自己嘗試實(shí)現(xiàn)以下。
在Thinkphp框架中也提供了對(duì)Restful風(fēng)格的支持，原理也是類(lèi)似的。
總結(jié)一下，Restful風(fēng)格就是，使用簡(jiǎn)單的URL和HTTP請(qǐng)求方式來(lái)實(shí)現(xiàn)接口。
PHPRS github
這是一個(gè)輕量級(jí)框架，專(zhuān)為快速開(kāi)發(fā)RESTful接口而設(shè)計(jì)。如果你和我一樣，厭倦了使用傳統(tǒng)的MVC框架編寫(xiě)微服務(wù)或者前后端分離的API接口，受不了為了一個(gè)簡(jiǎn)單接口而做的很多多余的coding（和CTRL-C/CTRL-V），那么，你肯定會(huì)喜歡這個(gè)框架！
先舉個(gè)栗子
寫(xiě)個(gè)HelloWorld.php，放到框架指定的目錄下（默認(rèn)是和index.php同級(jí)的apis/目錄）
/**
* @path("/hw")
*/
class HelloWorld
{
/**
* @route({"GET","/"})
*/
public function doSomething() {
return "Hello World!";
}
}
你將看到：Hello World!就是這么簡(jiǎn)單，不需要額外配置，不需要繼承也不需要組合。
發(fā)生了什么
回過(guò)頭看HelloWorld.php，特殊的地方在于注釋?zhuān)ˊpath，@route），沒(méi)錯(cuò)，框架通過(guò)注釋獲取路由信息和綁定輸入輸出。但不要擔(dān)心性能，注釋只會(huì)在類(lèi)文件修改后解析一次。更多的@注釋后面會(huì)說(shuō)明。
再看個(gè)更具體的例子
這是一個(gè)登錄接口的例子
/**
* 用戶(hù)權(quán)限驗(yàn)證
* @path("/tokens/")
*/
class Tokens
{
/**
* 登錄
* 通過(guò)用戶(hù)名密碼授權(quán)
* @route({"POST","/accounts/"})
* @param({"account", "$._POST.account"}) 賬號(hào)
* @param({"password", "$._POST.password"}) 密碼
*
* @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用戶(hù)名或密碼無(wú)效
*
* @return({"body"})
* 返回token，同cookie中的token相同,
* {"token":"xxx", "uid" = "xxx"}
*
* @return({"cookie","token","$token","+365 days","/"}) 通過(guò)cookie返回token
* @return({"cookie","uid","$uid","+365 days","/"}) 通過(guò)cookie返回uid
*/
public function createTokenByAccounts($account, $password, &$token,&$uid){
//驗(yàn)證用戶(hù)
$uid = $this->users->verifyPassword($account, $password);
Verify::isTrue($uid, new InvalidPassword($account));
$token = ...;
return ['token'=>$token, 'uid'=>$uid];
}
/**
* @property({"default":"@Users"}) 依賴(lài)的屬性，由框架注入
* @var Users
*/
public $users;
}
還能做什么
- 依賴(lài)管理（依賴(lài)注入），
- 自動(dòng)輸出接口文檔（不是doxgen式的類(lèi)、方法文檔，而是描述http接口的文檔）
- 接口緩存
- hook
配合ezsql訪(fǎng)問(wèn)數(shù)據(jù)庫(kù)
ezsql是一款簡(jiǎn)單的面向?qū)ο蟮膕ql構(gòu)建工具，提供簡(jiǎn)單的基本sql操作。
接口
/** @path(/myclass) */
class MyClass{
/**
* @route({"GET","/do"})
* @param({"arg0","$._GET.arg0"})
*/
public doSomething($arg0){
return Sql::select('xxx')->from('table_xxx')->where( 'xxx = ?', $arg0)->get($this->db);
}
/**
* 依賴(lài)注入PDO實(shí)例
* @property
* @var PDO
*/
public $db;
}
配置文件
{
{
"MyClass":{
"properties":{
"db":"@db1"
}
},
},
"db1":{
"singleton":true,
"class":"PDO",
"pass_by_construct":true,
"properties":{
"dsn":"mysql:host=127.0.0.1;dbname=xxx",
"username":"xxxx",
"passwd":"xxxx"
}
},
}
相關(guān)文章
php使用goto實(shí)現(xiàn)自動(dòng)重啟swoole、reactphp、workerman服務(wù)的代碼
這篇文章主要介紹了php使用goto實(shí)現(xiàn)自動(dòng)重啟swoole、reactphp、workerman服務(wù)的方法，本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-04-04
這篇文章主要介紹了PHP 數(shù)組黑名單/白名單，本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-06-06
PHP的Yii框架中使用數(shù)據(jù)庫(kù)的配置和SQL操作實(shí)例教程
這篇文章主要介紹了PHP的Yii框架中使用數(shù)據(jù)庫(kù)的配置和SQL操作實(shí)例教程,Yii支持綁定多種數(shù)據(jù)庫(kù),文中主要對(duì)各種查詢(xún)語(yǔ)句在Yii中的使用給出了例子,需要的朋友可以參考下2016-03-03
laravel框架模板之公共模板、繼承、包含實(shí)現(xiàn)方法分析
這篇文章主要介紹了laravel框架模板之公共模板、繼承、包含實(shí)現(xiàn)方法,結(jié)合實(shí)例形式分析了Laravel框架中公共模板的建立、模板包含、模板繼承等相關(guān)操作技巧,需要的朋友可以參考下2019-08-08
php中用加號(hào)與用array_merge合并數(shù)組的區(qū)別深入分析
本篇文章是對(duì)php中用加號(hào)與用array_merge合并數(shù)組的區(qū)別進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-06-06
php實(shí)現(xiàn)批量下載百度云盤(pán)文件例子分享
本文使用百度開(kāi)放云的PHP SDK實(shí)現(xiàn)批量下載百度云盤(pán)的文件,需要的朋友可以參考下。2014-04-04
基于Swoole實(shí)現(xiàn)PHP與websocket聊天室
本文利用Swoole來(lái)實(shí)現(xiàn)PHP+websocket的聊天室，過(guò)程介紹的很詳細(xì)，對(duì)聊天室的開(kāi)發(fā)很有幫助，有需要的可以參考學(xué)習(xí)。2016-08-08
PHP父類(lèi)調(diào)用子類(lèi)方法的代碼例子
這篇文章主要介紹了PHP父類(lèi)調(diào)用子類(lèi)方法的代碼例子,需要的朋友可以參考下2014-04-04
php并發(fā)加鎖問(wèn)題分析與設(shè)計(jì)代碼實(shí)例講解
這篇文章主要介紹了php并發(fā)加鎖問(wèn)題分析與設(shè)計(jì)代碼實(shí)例講解，有感興趣的同學(xué)可以跟著研究學(xué)習(xí)下2021-02-02
thinkPHP5使用laypage分頁(yè)插件實(shí)現(xiàn)列表分頁(yè)功能
這篇文章主要為大家詳細(xì)介紹了thinkPHP5使用laypage分頁(yè)插件實(shí)現(xiàn)列表分頁(yè)功能，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-11-11