这个帖子写给不太了解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、客户端获取到你返回的数据后,在客户端本地和用户进行交互

临时写的一个简单 api 例子:

  1.  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'=>'979137@qq.com',
    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'=>'elva@ezhi.net',
    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' => 'lily@ezhi.net',
    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 }

     

 

点击测试(对于客户端而言,也是直接调用这样的地址):

三、实际项目中,我们在开发 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 的一种体现形式

 

推荐阅读:

一:比rbac更好的权限认证方式(auth类认证)

二:php获得毫秒数

三:php 获取文件下的所有文件。php 获取文件下的所有子文件。php 递归获取文件下的所有文件。封装好的方法

四:2019年php程序员面试经验实战附答案