php接口规范

1. php---APP接口02

JSON&XML

XML: 是一种标记语言，设计的宗旨是传输数据

JSON： 轻量级的数据交换格式

APP接口主要是用JSON输出格式

APP接口输出格式三要素：

1. code:：错误码

2. msg：错误码对应的描述

3. data：接口返回的数据

谁有权限调用APP接口，客户端需要带着凭证来调用APP接口

JWT的原理：

服务端认证之后，生成一个JSON对象，返回给用户。后续客户端所有请求都会带上这个JSON对象。服务端依靠这个JSON对象来认定用户身份。

组成: Header, Payload, Signature

1. Header

说一下我是什么

header通常包含了两部分：类型和加密算法

{

    "alg": "HS256",

    "typ": "JWT"

}

header需要经过Base64Url编码后作为IWT的第一部分。

2. Payload

payload包含了claim, 三种类型reserved, public, private

reserved这些claim是JWT预先定义的，不强制使用，常用的有：

1). iss: 签发者

2). exp: 过期的时间戳

3). sub: 面向的用户

4). aud: 接收方

5). iat: 签发时间

{

    "sub":  "1234567890",

    "name":  "John Doe",

    "admin": true

}

payload需要经过Base64Url编码后作为JWT的第二部分。

3. Signature

创建签名使用编码后的header和payload以及一个密匙，使用header中指定的签名算法进行签名

HMACSHA256(

base64UrlEncode(header) + "." +

base64UrlEncode(payload),

secret

)

签名是在服务端进行的，客户端并不知道，所以是安全的。

2. 怎么在PHP中定义和使用接口interface

1、接口的定义：
接口：一种成员属性为抽象的特殊抽象类，在程序中同为规范的作用
2、其实他们的作用很简单，当有很多人一起开发一个项目时，可能都会去调用别人写的一些类，那你就会问，我怎么知道他的某个功能的实现方法是怎么命名的呢，这 个时候PHP接口类interface就起到作用了，当我们定义了一个接口类时，它里面的方式是下面的子类必须实现的，比如 :
interface Shop
{
public function buy($gid);
public function sell($gid);
public function view($gid);
}
我声明一个shop接口类，定义了三个方法：买(buy),卖(sell),看(view),那么继承此类的所有子类都必须实现这3个方法少一个都 不行，如果子类没有实现这些话，就无法运行。实际上接口类说白了，就是一个类的模板，一个类的规定，如果你属于这类，你就必须遵循我的规定，少一个都不 行，但是具体你怎么去做，我不管，那是你的事，如：
class BaseShop implements Shop { public function buy($gid) { echo('你购买了ID为 :'.$gid.'的商品'); } public function sell($gid) { echo('你卖了ID为 :'.$gid.'的商品'); } public function view($gid) { echo('你查看了ID为 :'.$gid.'的商品'); } }
结论 ： PHP接口类interface就是一个类的领导者，指明方向，子类必须完成它指定方法。这样不同的开发者就不要去了解别人怎么命名相应的方法。
3、php中使用接口(interface)实现多重继承:
我们都知道PHP中的类(class)是单继承的，那是不是就没有办法实现多重继承了呢?答案是否定的.我们可以通过其它特殊的方式实现类的多重 继承，比如使用接口(interface)实现，只要把类的特征抽象为接口，并通过实现接口的方式让对象有多重身份，通过这样就可以模拟多重继承了。
下面是一个用接口(interface)实现多重继承的例子，源代码如下：
<?php
interface UserInterface{ //定义User的接口
function getname();
}
interface TeacherInterface{ //teacher相关接口
function getLengthOfService();
}
class User implements UserInterface { //实现UserInterface接口
private $name = "tom";
public function getName(){
return $this->name;
}
}
class Teacher implements TeacherInterface { //实现TeacherInterface接口
private $lengthOfService = 5; // 工龄
public function getLengthOfService(){
return $this->lengthOfService;
}
}
// 继承自User类,同时实现了TeacherInterface接口.
class GraateStudent extends User implements TeacherInterface {
private $teacher ;
public function __construct(){
$this->teacher = new Teacher();
}
public function getLengthOfService(){
return $this->teacher->getLengthOfService();
}
}
class Act{
//注意这里的类型提示改成了接口类型
public static function getUserName(UserInterface $_user){
echo "Name is " . $_user->getName() ."<br>";
}
//这里的类型提示改成了TeacherInterface类型.
public static function getLengthOfService(TeacherInterface $_teacher){
echo "Age is " .$_teacher->getLengthOfService() ."<br>";
}
}
$graateStudent = new GraateStudent();
Act::getUserName($graateStudent);
Act::getLengthOfService($graateStudent);
//结果正如我们所要的,实现了有多重身份的一个对象.
?>
示例运行结果如下：
Name is tom
Age is 5
4、接口类和抽象类的区别
抽象类 :1.类中至少有一个抽象方法
2.前面加abstract
接口: 1.成员属性为常量const
2.前面不用加abstract
3.类中全部为抽象方法,接口抽象方法为public
5、接口类和抽象类 共同点:
1.本身不能被实例化，必须继承或者引用
2.继承和引用后，抽象方法必须重载才能实例化
关键字 interface.引用关键字 implements

3. 如何利用Thinkphp框架开发移动端接口详解

方案一：给原生APP提供api接口

使用TP框架时 放在common文件夹下文件名就叫function.php

<?php
/**
*Createdbyzhangkx
*Email:[email protected]
*Date:2015/8/1
*Time:23:15
*/

/******api开发辅助函数*******/

/**
*@paramnull$msg返回正确的提示信息
*@paramflagsuccessCURD操作成功
*@paramarray$data具体返回信息
*Functiondescript:返回带参数，标志信息，提示信息的json数组
*
*/
functionreturnApiSuccess($msg=null,$data=array()){
$result=array(
'flag'=>'Success',
'msg'=>$msg,
'data'=>$data
);
printjson_encode($result);
}

/**
*@paramnull$msg返回具体错误的提示信息
*@paramflagsuccessCURD操作失败
*Functiondescript:返回标志信息‘Error'，和提示信息的json数组
*/
functionreturnApiError($msg=null){
$result=array(
'flag'=>'Error',
'msg'=>$msg,
);
printjson_encode($result);
}

/**
*@paramnull$msg返回具体错误的提示信息
*@paramflagsuccessCURD操作失败
*Functiondescript:返回标志信息‘Error'，和提示信息，当前系统繁忙，请稍后重试；
*/
functionreturnApiErrorExample(){
$result=array(
'flag'=>'Error',
'msg'=>'当前系统繁忙，请稍后重试！',
);
printjson_encode($result);
}

/**
*@paramnull$data
*@returnarray|mixed|null
*Functiondescript:过滤post提交的参数；
*
*/

functioncheckDataPost($data=null){
if(!empty($data)){
$data=explode(',',$data);
foreach($dataas$k=>$v){
if((!isset($_POST[$k]))||(empty($_POST[$k]))){
if($_POST[$k]!==0&&$_POST[$k]!=='0'){
returnApiError($k.'值为空！');
}
}
}
unset($data);
$data=I('post.');
unset($data['_URL_'],$data['token']);
return$data;
}
}

/**
*@paramnull$data
*@returnarray|mixed|null
*Functiondescript:过滤get提交的参数；
*
*/
functioncheckDataGet($data=null){
if(!empty($data)){
$data=explode(',',$data);
foreach($dataas$k=>$v){
if((!isset($_GET[$k]))||(empty($_GET[$k]))){
if($_GET[$k]!==0&&$_GET[$k]!=='0'){
returnApiError($k.'值为空！');
}
}
}
unset($data);
$data=I('get.');
unset($data['_URL_'],$data['token']);
return$data;
}
}


查询单个果品详细信息
/**
*发布模块
*
*获取信息单个果品详细信息
*
*/
(){
//检查是否通过post方法得到数据
checkdataPost('id');
$where['id']=$_POST['id'];
$field[]='id,fruit_name,high_price,low_price,address,size,weight,fruit_pic,remark';
$releaseInfo=$this->release_obj->findRelease($where,$field);
$releaseInfo['remark']=mb_substr($releaseInfo['remark'],0,49,'utf-8').'...';
//多张图地址按逗号截取字符串，截取后如果存在空数组则需要过滤掉
$releaseInfo['fruit_pic']=array_filter(explode(',',$releaseInfo['fruit_pic']));
$fruit_pic=$releaseInfo['fruit_pic'];unset($releaseInfo['fruit_pic']);
//为图片添加存储路径
foreach($fruit_picas$k=>$v){
$releaseInfo['fruit_pic'][]='http://'.$_SERVER['HTTP_HOST'].'/Uploads/Release/'.$v;
}
if($releaseInfo){
returnApiSuccess('',$releaseInfo);
}else{
returnApiError('什么也没查到(+_+)！');
}
}


findRelease()方法的model
/**
*查询一条数据
*/
publicfunctionfindRelease($where,$field){
if($where['status']==''||empty($where['status'])){
$where['status']=array('neq','9');
}
$result=$this->where($where)->field($field)->find();
return$result;
}


app端接收到的数据（解码json之后）
{
"flag":"success",
"message":"",
"responseList":{
"id":"2",
"fruit_name":"苹果",
"high_price":"8.0",
"low_price":"5.0",
"address":"天津小白楼水果市场",
"size":"2.0",
"weight":"2.0",
"remark":"急需...",
"fruit_pic":[
"http://fruit.txunda.com/Uploads/Release/201508/55599e7514815.png",
"http://fruit.txunda.com/Uploads/Release/201508/554f2dc45b526.jpg"
]
}
}


app端接收到的数据（原生json串）
代码如下:

{"flag":"success","message":"","responseList":{"id":"2","fruit_name":"u82f9u679c","high_price":"8.0","low_price":"5.0","address":"","size":"2.0","weight":"2.0","remark":"u6025u9700...","fruit_pic":["http://fruit.txunda.com/Uploads/Release/201508/55599e7514815.png","http://fruit.txunda.com/Uploads/Release/201508/554f2dc45b526.jpg"]}}

方案二：另外我们还可以通过ThinkPHP实现移动端访问自动切换主题模板，这样也可以做到移动端访问

ThinkPHP的模板主题机制，如果只是在PC，只要需修改 DEFAULT_THEME （新版模板主题默认是空，表示不启用模板主题功能）配置项就可以方便的实现多模板主题切换。

但对于移动端与PC端，也许你会设计完全不同的主题风格，且针对不同的来路提供不同的渲染方式，其中一种比较流行的方法是“响应式设计”，但就本人经历而言，要实现完全的“响应式设计”并不是那么容易，且解决兼容问题也是个难题，假设是大型站点，比如：淘宝、网络、拍拍这些，响应式设计肯定是满足不了需求的，而是需要针对手机访问用户提供单独的手机网站。

ThinkPHP 完全能够实现，而且非常的简单。与TPM的智能模版切换引擎相同，只要对来路进行判断处理就行了。

一、将 ismobile() 加入到｛项目/Common/common.php｝

functionismobile(){
//如果有HTTP_X_WAP_PROFILE则一定是移动设备
if(isset($_SERVER['HTTP_X_WAP_PROFILE']))
returntrue;

//此条摘自TPM智能切换模板引擎，适合TPM开发
if(isset($_SERVER['HTTP_CLIENT'])&&'PhoneClient'==$_SERVER['HTTP_CLIENT'])
returntrue;
//如果via信息含有wap则一定是移动设备,部分服务商会屏蔽该信息
if(isset($_SERVER['HTTP_VIA']))
//找不到为flase,否则为true
returnstristr($_SERVER['HTTP_VIA'],'wap')?true:false;
//判断手机发送的客户端标志,兼容性有待提高
if(isset($_SERVER['HTTP_USER_AGENT'])){
$clientkeywords=array(
'nokia','sony','ericsson','mot','samsung','htc','sgh','lg','sharp','sie-','philips','panasonic','alcatel','lenovo','iphone','ipod','blackberry','meizu','android','netfront','symbian','ucweb','windowsce','palm','operamini','operamobi','openwave','nexusone','cldc','midp','wap','mobile'
);
//从HTTP_USER_AGENT中查找手机浏览器的关键字
if(preg_match("/(".implode('|',$clientkeywords).")/i",strtolower($_SERVER['HTTP_USER_AGENT']))){
returntrue;
}
}
//协议法，因为有可能不准确，放到最后判断
if(isset($_SERVER['HTTP_ACCEPT'])){
//如果只支持wml并且不支持html那一定是移动设备
//如果支持wml和html但是wml在html之前则是移动设备
if((strpos($_SERVER['HTTP_ACCEPT'],'vnd.wap.wml')!==false)&&(strpos($_SERVER['HTTP_ACCEPT'],'text/html')===false||(strpos($_SERVER['HTTP_ACCEPT'],'vnd.wap.wml')<strpos($_SERVER['HTTP_ACCEPT'],'text/html')))){
returntrue;
}
}
returnfalse;
}

二、在｛项目/Lib/｝创建一个 CommonAction.php，假设你的项目已公共控制器，则无需创建，直接加在里面就行了。

{
Publicfunction_initialize(){
//移动设备浏览，则切换模板
if(ismobile()){
//设置默认默认主题为Mobile
C('DEFAULT_THEME','Mobile');
}
//............你的更多代码.......
}
}

4. PHP 的API接口

使用PHP写api接口是经常做的，PHP写好接口后，前台就可以通过链接获取接口提供的数据，而返回的数据一般分为两种情况，xml和json,在这个过程中，服务器并不知道，请求的来源是什么，有可能是别人非法调用我们的接口，获取数据，因此就要使用安全验证

原理

从图中可以看得很清楚，前台想要调用接口，需要使用几个参数生成签名。

时间戳：当前时间

随机数：随机生成的随机数

口令：前后台开发时，一个双方都知道的标识，相当于暗号

算法规则：商定好的运算规则，上面三个参数可以利用算法规则生成一个签名。前台生成一个签名，当需要访问接口的时候，把时间戳，随机数，签名通过URL传递到后台。后台拿到时间戳，随机数后，通过一样的算法规则计算出签名，然后和传递过来的签名进行对比，一样的话，返回数据。

算法规则

在前后台交互中，算法规则是非常重要的，前后台都要通过算法规则计算出签名，至于规则怎么制定，看你怎么高兴怎么来。

我这个算法规则是

• 时间戳，随机数，口令按照首字母大小写顺序排序

• 然后拼接成字符串

• 进行sha1加密

• 再进行MD5加密

• 转换成大写。

5. php 写接口一般遵循什么规范,或者标准。

interface面向对象编程的一个重要思想接口是一个类的抽象 在接口中只定义方法却不是先方法interface Ibook {function ready();function weite();} 累如果要实现接口就必须 写出接口中所有的方法class myBook implements Ibook{function ready(){echo "ready()";}function write(){echo "write()";}}接口在代码中起规范代码作用但是php中对接口的支持没有java C#等完全面向对象语言的强大