时间:2021-07-01 10:21:17 帮助过:17人阅读
在php为app开发接口中需要注意以下几点:
1、数据传输建议使用json,json具有很强的跨平台性,大多编程语言都支持json解析,json正在逐步取代xml,成为网络数据的通用格式。
2、为了保证接口安全,一定要加入鉴权体系,确保请求php接口的是合法来源。另外对于传输的数据也可以使用加密技术,本书第20章有讲述关于api接口签名和信息加密的内容。
3、对于线上的API,尽量使用error_reporting(0)关闭错误提示,或者把错误提示写入到日志中,方便日后排查。这样做的目的,一方面可以保护接口安全,防止输出不该打印的错误信息,另一方面是保证输出的是正确的数据格式,防止输出错误信息被客户端错误解析而出现的接口调用异常。
4、开发 API 和 WEB 有一定的区别,如果接口返回的格式不规范,被客户端拿到解析,可能会导致客户端闪退崩溃等情况的出现,所以在接口上线之前一定要充分的测试。
5、尽可能保证php写出的代码的性能,手机应用比web应用对响应速度的要求更高,因为用户手机性能的巨大差异,手机应用在从服务端取到数据后要进行数据重组页面渲染等会比web应用消耗更多的时间。
客户端和服务端之间选定json作为数据传输格式,之后便要约定json中各字段的含义,一般在json数据中定义至少三个字段,分别为返回状态码,返回状态描述和数据内容。比如一个定义返回用户信息的的json数据如下:
{“code":0,"msg":"success","data":{"name":"chenxiaolong","age":"22","gender":"male"}}
其中code值为0表示客户端此次请求接口成功,msg字段说明此次请求的状态,与返回状态码code对应,data中是客户端想要取到的具体内容,里面包含服务端返回的用户信息。在data字段开发者可根据不同的接口需要定义不同的字段格式。
此接口的简单代码示例如下:
function getUserInfo() { $uid = $_REQUEST[‘uid']; $user = new User(); if($data = $user->findByUid($uid) != false) { $this->output($data); } else { $this->output('',1,'invalid uid'); } }
客户端通过调用getUserInfo接口并传入用户的uid参数,php接收该参数到mysql数据库用户表里根据此uid查询用户相关信息,其中User是一个封装的用户表模型,它提供根据用户uid查询用户信息的findByUid方法,如果查询到用户信息就输出用户信息,否则返回错误信息给到客户端,此处返回的错误状态码定义为1,表示不合法的uid,即在用户表里没有查询到该uid对应的数据记录。
接口用到了一个公用output方法,此方法是输出json数据的具体实现,示例代码如下:
function output(,$data='',$code=0,$msg='success') { $out = array('code'=$code,'msg'=>$msg,'data'=>$data); echo json_encode($out); }
注意向客户端返回数据时使用的是echo输出而不是return。
以上就是php在app开发中的应用详解的详细内容,更多请关注Gxl网其它相关文章!