2015 年 9 月 – 知识点滴

极简的Api处理

2015年9月18日 by admin·已关闭评论

根据请求的api获取class, 即需要一个Api class loader, api格式如 xxx.xxx.xx

/**
     * @param $api
     * @param string $oldApi
     * @return Base
     * @throws Exception
     */
    function getClass($api, $oldApi = ''){
        if(isset(self::$classCaches[$api])){
            return self::$classCaches[$api];
        }

        if(!$oldApi){
            $oldApi = $api;
        }

        if(isset($this->apiMap[$api])){
            return new $this->apiMap[$api];
        }

        $path = explode('.', $api);
        $className = array_pop($path);
        $apiClass = $this->nsPrefix . ($path ? (implode('\\', $path)) . "\\" : '') . ucfirst($className);
        if(!class_exists($apiClass)){
            if($path){
                return $this->getClass(implode('.', $path), $oldApi);
            }else{
                throw new Exception("Invalid api({$api})", Exception::API);
            }
        }

        if($api != $oldApi)
            $action = str_replace($api . '.', '', $oldApi);
        else {
            $action = '';
        }

        /** @var Base $class */
        $class = new $apiClass();
        $class->setAction($action);
        self::$classCaches[$api] = $class;
        return $class;
    }

/**

* @param $api

* @param string $oldApi

* @return Base

* @throws Exception

function getClass($api, $oldApi = ''){

if(isset(self::$classCaches[$api])){

return self::$classCaches[$api];

}

if(!$oldApi){

$oldApi = $api;

}

if(isset($this->apiMap[$api])){

return new $this->apiMap[$api];

}

$path = explode('.', $api);

$className = array_pop($path);

$apiClass = $this->nsPrefix . ($path ? (implode('\\', $path)) . "\\" : '') . ucfirst($className);

if(!class_exists($apiClass)){

if($path){

return $this->getClass(implode('.', $path), $oldApi);

}else{

throw new Exception("Invalid api({$api})", Exception::API);

}

if($api != $oldApi)

$action = str_replace($api . '.', '', $oldApi);

else {

$action = '';

}

/** @var Base $class */

$class = new $apiClass();

$class->setAction($action);

self::$classCaches[$api] = $class;

return $class;

}

需要一个api 的基类，根据请求参数返回结果

    public function handle($args, $request = []){
        if($this->action){
            $method = str_replace('.', '_', $this->action);
            if($this->action != 'handle' && method_exists($this, $method)){
                return call_user_func(array($this, $method), $args);
            }

            if(method_exists($this, 'getModel')){
                $model = $this->getModel();
                if(method_exists($model, $method)){
                    return call_user_func_array(array($model, $method), $args);
                }
            }

        } else if(method_exists($this, 'execute')){
            return call_user_func(array($this, 'execute'), $args);
        }

        throw new Exception("Method not found");
    }

public function handle($args, $request = []){

if($this->action){

$method = str_replace('.', '_', $this->action);

if($this->action != 'handle' && method_exists($this, $method)){

return call_user_func(array($this, $method), $args);

}

if(method_exists($this, 'getModel')){

$model = $this->getModel();

if(method_exists($model, $method)){

return call_user_func_array(array($model, $method), $args);

}

} else if(method_exists($this, 'execute')){

return call_user_func(array($this, 'execute'), $args);

}

throw new Exception("Method not found");

}

弄个js客户端

    apiUrl : 'http://api.' + location.host + '/index.php?q=%action%&callback=?',
    api : function(api, args){
        if(!args){
            args = {};
        }
        var deferred = $.Deferred();
        var url = this.apiUrl.replace(/%action%/, api);
        $.getJSON(url, args, function(response){
                if(jc001.papi.is_succ(response)){
                    deferred.resolve(response.data);
                } else {
                    deferred.reject(response);
                }
            }
        );
        return deferred;
    }

apiUrl : 'http://api.' + location.host + '/index.php?q=%action%&callback=?',

api : function(api, args){

if(!args){

args = {};

}

var deferred = $.Deferred();

var url = this.apiUrl.replace(/%action%/, api);

$.getJSON(url, args, function(response){

if(jc001.papi.is_succ(response)){

deferred.resolve(response.data);

} else {

deferred.reject(response);

}

);

return deferred;

}

    papi.api('comm.region.name', 2747).done(function(rs){
        console.log(rs);
    }).fail(function(rs){
        console.log(rs);
    });

papi.api('comm.region.name', 2747).done(function(rs){

console.log(rs);

}).fail(function(rs){

console.log(rs);

});

接口文档及web接口测试

加一个接口日志及统计收工

反射获取文档

2015年9月18日 by admin·已关闭评论

有需要web在线查看对象文档需求，简单测试可行

function test1(){
    $class = new ReflectionClass('TestObject');

    //$properties = $class->getProperties();
    $methods = $class->getMethods(ReflectionMethod::IS_PUBLIC);
    foreach($methods as $method){
        $doc = $method->getDocComment();
        echo "\t" . $doc;
        echo "\n";

        $params = $method->getParameters();
        echo implode(' ', Reflection::getModifierNames($method->getModifiers()));
        echo ' ', $method->getName() . '(';
        foreach($params as $param){
            echo $param->getName();
            if($param->isDefaultValueAvailable()){
                $value = $param->getDefaultValue();
                echo "=", $value;
            }
        }
        echo ")";
        echo "\n";
    }
}

function test1(){

$class = new ReflectionClass('TestObject');

//$properties = $class->getProperties();

$methods = $class->getMethods(ReflectionMethod::IS_PUBLIC);

foreach($methods as $method){

$doc = $method->getDocComment();

echo "\t" . $doc;

echo "\n";

$params = $method->getParameters();

echo implode(' ', Reflection::getModifierNames($method->getModifiers()));

echo ' ', $method->getName() . '(';

foreach($params as $param){

echo $param->getName();

if($param->isDefaultValueAvailable()){

$value = $param->getDefaultValue();

echo "=", $value;

}

echo ")";

echo "\n";

}

注解的解析

2015年9月18日 by admin·已关闭评论

Phalcon的注解(Phalcon\Annotations\*)

Class Phalcon\Annotations\Annotation
Class Phalcon\Annotations\Collection Annotation集合
Class Phalcon\Annotations\Exception
Class Phalcon\Annotations\Reader 读取类的注解，以数组形式分类返回, 可用于创建 Reflection
Class Phalcon\Annotations\Reflection

Reflection
注解反射对象，获取类方法，属性，类等的注释

常用方法, 返回 Collection, 可遍历的对象集合(Annotation)

  public getClassAnnotations ();
  public getMethodsAnnotations ();

1 2	public getClassAnnotations (); public getMethodsAnnotations ();

Reflection的使用参考：

use Phalcon\Annotations\Adapter\Memory as MemoryAdapter;
use Phalcon\Annotations\Reader;
use Phalcon\Annotations\Reflection as PhalconReflection;

function test2($useCache = 1){
    if($useCache == 1) {
        $reader = new MemoryAdapter();
        $reflection = $reader->get('TestObject');
    } else {
        // Parse the annotations in a class
        $reader = new Reader();
        $parsing = $reader->parse('TestObject');
        // Create the reflection
        $reflection = new PhalconReflection($parsing);
    }

    // Get the annotations in the class docblock
    $classAnnotations = $reflection->getClassAnnotations();
    var_dump($classAnnotations);

    $methodAnnotations = $reflection->getMethodsAnnotations();
    var_dump($methodAnnotations);
}

use Phalcon\Annotations\Adapter\Memory as MemoryAdapter;

use Phalcon\Annotations\Reader;

use Phalcon\Annotations\Reflection as PhalconReflection;

function test2($useCache = 1){

if($useCache == 1) {

$reader = new MemoryAdapter();

$reflection = $reader->get('TestObject');

} else {

// Parse the annotations in a class

$reader = new Reader();

$parsing = $reader->parse('TestObject');

// Create the reflection

$reflection = new PhalconReflection($parsing);

}

// Get the annotations in the class docblock

$classAnnotations = $reflection->getClassAnnotations();

var_dump($classAnnotations);

$methodAnnotations = $reflection->getMethodsAnnotations();

var_dump($methodAnnotations);

}

Annotation 注解类
获取单个注解的名称、参数表达式等

注解示例

<?php

/**
 * Simple Annotation
 *
 * @SomeAnnotation
 */

/**
 * Annotation with parameters
 *
 * @SomeAnnotation("hello", "world", 1, 2, 3, false, true)
 */

/**
 * Annotation with named parameters
 *
 * @SomeAnnotation(first="hello", second="world", third=1)
 * @SomeAnnotation(first: "hello", second: "world", third: 1)
 */

/**
 * Passing an array
 *
 * @SomeAnnotation([1, 2, 3, 4])
 * @SomeAnnotation({1, 2, 3, 4})
 */

/**
 * Passing a hash as parameter
 *
 * @SomeAnnotation({first=1, second=2, third=3})
 * @SomeAnnotation({'first'=1, 'second'=2, 'third'=3})
 * @SomeAnnotation({'first': 1, 'second': 2, 'third': 3})
 * @SomeAnnotation(['first': 1, 'second': 2, 'third': 3])
 */

/**
 * Nested arrays/hashes
 *
 * @SomeAnnotation({"name"="SomeName", "other"={
 *     "foo1": "bar1", "foo2": "bar2", {1, 2, 3},
 * }})
 */

/**
 * Nested Annotations
 *
 * @SomeAnnotation(first=@AnotherAnnotation(1, 2, 3))
 */

<?php

/**

* Simple Annotation

* @SomeAnnotation

/**

* Annotation with parameters

* @SomeAnnotation("hello", "world", 1, 2, 3, false, true)

/**

* Annotation with named parameters

* @SomeAnnotation(first="hello", second="world", third=1)

* @SomeAnnotation(first: "hello", second: "world", third: 1)

/**

* Passing an array

* @SomeAnnotation([1, 2, 3, 4])

* @SomeAnnotation({1, 2, 3, 4})

/**

* Passing a hash as parameter

* @SomeAnnotation({first=1, second=2, third=3})

* @SomeAnnotation({'first'=1, 'second'=2, 'third'=3})

* @SomeAnnotation({'first': 1, 'second': 2, 'third': 3})

* @SomeAnnotation(['first': 1, 'second': 2, 'third': 3])

/**

* Nested arrays/hashes

* @SomeAnnotation({"name"="SomeName", "other"={

* "foo1": "bar1", "foo2": "bar2", {1, 2, 3},

* }})

/**

* Nested Annotations

* @SomeAnnotation(first=@AnotherAnnotation(1, 2, 3))

PHP相关工具参考：

doctrine/annotations
https://github.com/doctrine/annotations

PHP反射相关接口参考：

http://php.net/manual/zh/book.reflection.php

知识点滴

专注于php应用开发

月度归档： 2015 年 9 月

极简的Api处理

反射获取文档

注解的解析

Phalcon的注解(Phalcon\Annotations\*)

PHP相关工具参考：

PHP反射相关接口参考：