之前發布了一篇關于我的
行車服務
appiOS
端代碼簡析的文章:文章地址。 此篇是對這個項目后端PHP
代碼的簡析。
iOS端代碼地址: iOS代碼,PHP代碼。如果你覺得有幫助,希望能夠點個Star
,感謝~
筆者對于PHP
學習也剛開始不久,所以此篇不敢妄言指導,只是把這個項目后端代碼的結構、實現講述一遍,希望大家多多指教。
適合想要自己嘗試使用PHP
搭建一個API
項目的同學閱讀。
項目結構
-
封裝好的公共文件
-
helper/
- 這個部分包括
MySQL
交互、JSON
包裝函數、`返回結果函數。
-
-
各個接口實現文件
-
interface/
- 這個部分是各個接口的實現文件,由路由文件按需調用。
-
-
入口文件,接口路由
-
receiver.php
- 這個部分是整個項目的路由文件,接收請求,然后分發給各個接口實現文件。
-
代碼實現
-
公共文件
helper/
:-
common.php
:
-
returnData ($msg, $code, $data)
:
適用于獲取數據類型的接口,它帶有data
參數。
返回結果示例:
{ "msg": "ok", "code": "1", "data": { "count": "3", "points_list": [{ "id": "19", "poi_name": "sss", "poi_address": "sss", "uid": "fuck", "points": "30" }, { "id": "25", "poi_name": "洗車裝飾服務", "poi_address": "北三環西路76號附近", "uid": "B0FFHF5BKD", "points": "30" }] }
-
}
- `returnMsg ($msg, $code)`: 適用于僅返回狀態的接口。 返回結果示例:
{
"msg": "添加成功",
"code": "1"
}
```
-
jsonHelper.php
:-
arrayRecursive(&$array, $function, $apply_to_keys_also = false)
函數作用是對數組中的元素遞歸地進行傳入的$function
操作。 -
JSON($array)
函數用于將數組包裝為JSON
格式。
-
-
sqlHelper.php
:這個文件中對所使用數據庫名稱、賬戶信息等進行設置,大家可以按照自己的信息自行在此配置。
-
路由文件
receiver.php
:- 這個文件是整個項目的調用入口,具體接口調用時的
url
示例即為:服務器IP地址/DriverEpoch-Server/receiver.php
。 - 本文件解析參數中的
if
參數,然后分發到對應的接口文件。 - 例如,
if=Login
,即為調用登錄接口,分發到登錄接口的實現文件:
case "Login": require "interface/Login.php"; break;
- 這個文件是整個項目的調用入口,具體接口調用時的
-
各個接口實現文件
interface/
:這部分我對于兩個類型各選取一個接口來講述一下。
-
返回狀態類型:
AddPlace
:- 這個接口用來為用戶添加歷史足跡。
- 參數列表:
- user_id: 用戶id
- latitude:緯度
- longitude:經度
- place_name:地點名稱
- place_address:地點地址
- 很簡單,解析到
POST
方式傳入的各個參數之后,構建一條mysql
語句,作用是向對應的表插入一條數據:$sql = "INSERT INTO historyPlaces (user_id, latitude, longitude, place_name, place_address) VALUES ('$user_id', '$latitude', '$longitude', '$place_name', '$place_address')";
- 執行之后,若
mysql
表示執行成功,則返回JSON
格式的成功信息。否則返回失敗信息,此處就要使用前文提到的封裝好的工具函數。
-
返回狀態+數據類型:
GetPlaces
:- 這個接口用于獲取用戶的所有歷史足跡。
- 參數列表:
- user_id:用戶id
- 這種類型的接口比剛剛的稍微復雜一些。拿到參數后,構建一條查詢語句,查詢用戶的所有歷史遺跡:
$sql = "SELECT add_time,place_name,place_address FROM historyPlaces WHERE user_id = '$user_id' ORDER BY add_time";
- 取到結果后,若結果條數為0,則返回結果條數為0的信息。否則,將
mysql
返回結果的每一行都包裝成為數組的一個元素,然后將數組包裝為JSON
,返回給客戶端。
$places_list = null; $i = 0; $num = mysqli_num_rows($sqlResult); while($row = mysqli_fetch_array($sqlResult)) { $places_list[$i]['add_time'] = $row['add_time']; $places_list[$i]['place_name'] = $row['place_name']; $places_list[$i]['place_address'] = $row['place_address']; $i++; if ($i >= $num){ break; } } $data['count'] = $i; $data['places_list'] = $places_list; returnData("ok", 1, $data);
-
其他接口的實現文件大同小異,有一些具體的點大家可以和我繼續交流。
寫在最后:
PHP
的語法非常簡單,我個人覺得不太需要刻意去看語法,有其他語言基礎的同學看幾份代碼就可以上手寫,勇于嘗試,加油!- 我后續會再寫一篇關于自己部署
LAMP
架構的PHP
項目的教程,希望能和前文形成一個自己DIY全端項目的教程。
項目已開源,如果覺得有用,希望點一下star
感謝
halo