Annotation 注解 - 《easyswoole 文档 - 帮助手册 - 教程》

Annotation
安装
实现原理
例子
默认注解解析工具
IDE支持

Annotation

Easyswoole提供了一个轻量级的注解解析工具。

安装

composer require easyswoole/annotation

实现原理

约定
- 每个注解行为@字符开头，格式为 @METHOD(ARGS)
执行流程如下：
- 利用php反射得到注释信息
- 用explode用PHP_EOL分割每行
- 解析每行的数据，若存在对应的METHOD AnnotationTagInterface ，则把解析得到的ARGS传递给 AnnotationTagInterface 中的 assetValue 方法，用户可以在该方法中对解析得到的值进行自定义解析。
- 若为严格模式，如果解析不到正确的数值，则报错。

例子

<?php
use EasySwoole\Annotation\Annotation;
use EasySwoole\Annotation\AbstractAnnotationTag;
/*
 * 定义param渲染方法
 */
class param extends AbstractAnnotationTag
{
    public function tagName(): string
    {
        return 'param';
    }
    public function assetValue(?string $raw)
    {
        $list = explode(',',$raw);
        foreach ($list as $item){
            parse_str($item,$ret);
            foreach ($ret as $key => $value){
                $this->$key = trim($value," \t\n\r\0\x0B\"\'");
            }
        }
    }
}
/*
 * 定义timeout渲染方法
 */
class timeout extends AbstractAnnotationTag
{
    public $timeout;
    public function tagName(): string
    {
        return 'timeout';
    }
    public function assetValue(?string $raw)
    {
        $this->timeout = floatval($raw);
    }
    public function aliasMap(): array
    {
        return [
            static::class,
            "timeout_alias"
        ];
    }
}
class A
{
    protected $a;
    /**
     * @param(name=a,type=string,value=2)
     * @param(name=b)
     * @timeout_Alias(0.5)
     * @fuck(easyswoole)
     * 这是我的其他说明啊啊啊啊啊
     */
    function test()
    {
    }
}
/**
 * 实例化渲染器,并注册要解析的渲染方法
 */
$annotation = new Annotation();
$ref = new \ReflectionClass(A::class);
//不注册fuck 解析
$annotation->addParserTag(new param());
$annotation->addParserTag(new timeout());
$list = $annotation->getClassMethodAnnotation($ref->getMethod('test'));
foreach ($list['param'] as $item){
    var_dump((array)$item);
}
foreach ($list['timeout'] as $item){
    var_dump((array)$item);
}

::: warning
注释每行前3个字符若存在@,说明该行为需要解析注释行，默认为非严格模式，未注册的tag信息不会解析，严格模式下，若无法解析则会抛出异常。 :::

默认注解解析工具

Easyswoole 自带的字符串解析工具为 EasySwoole\Annotation\ValueParser,支持格式如下单元测试代码所示：

namespace EasySwoole\Annotation\Tests;
use EasySwoole\Annotation\ValueParser;
use PHPUnit\Framework\TestCase;
class ValueParserTest extends TestCase
{
    function testNormal()
    {
        $str = "int=1";
        $this->assertEquals([
            'int'=>"1"
        ],ValueParser::parser($str));
        $str = "int=1,int2=2";
        $this->assertEquals([
            'int'=>"1",
            'int2'=>"2"
        ],ValueParser::parser($str));
        $str = "int=1,int2='2'";
        $this->assertEquals([
            'int'=>"1",
            'int2'=>"2"
        ],ValueParser::parser($str));
    }
    function testArray()
    {
        $str = "array={1,2,3}";
        $this->assertEquals([
            'array'=>['1','2','3']
        ],ValueParser::parser($str));
        $str = "array={'1','2','3'}";
        $this->assertEquals([
            'array'=>['1','2','3']
        ],ValueParser::parser($str));
        $str = "array={'1','2 , 3'}";
        $this->assertEquals([
            'array'=>['1','2 , 3']
        ],ValueParser::parser($str));
        $str = 'array={"1","2","3"}';
        $this->assertEquals([
            'array'=>['1','2','3']
        ],ValueParser::parser($str));
        $str = "array={1,2,3} ,array2={4,5,6}";
        $this->assertEquals([
            'array'=>['1','2','3'],
            'array2'=>['4','5','6']
        ],ValueParser::parser($str));
    }
    function testEval()
    {
        $str = 'time="eval(time() + 30)"';
        $this->assertEquals([
            'time'=>time() + 30,
        ],ValueParser::parser($str));
        $str = 'time="eval(time() + 30)" , time2="eval(time() + 31)';
        $this->assertEquals([
            'time'=>time() + 30,
            'time2'=>time() + 31
        ],ValueParser::parser($str));
        $str = 'list="eval([1,2,3,4])"';
        $this->assertEquals([
            'list'=>[1,2,3,4]
        ],ValueParser::parser($str));
    }
    function testArrayAndEval()
    {
        $str = 'array="{"1","2",eval(time() + 30)}"';
        $this->assertEquals([
            'array'=>['1','2',time() + 30]
        ],ValueParser::parser($str));
        $str = 'array={"1","2",eval(time() + 30)},str="222"';
        $this->assertEquals([
            'array'=>['1','2',time() + 30],
            "str"=>'222'
        ],ValueParser::parser($str));
        $str = "array={1,2,3},time=eval(time())";
        $this->assertEquals([
            'array'=>['1','2','3'],
            'time'=>time()
        ],ValueParser::parser($str));
    }
    function testStrMulti()
    {
        $str = 'mix="first|{1,2,3}|eval(time() + 3)"';
        $this->assertEquals([
            'mix'=>['first',['1','2','3'],time() + 3]
        ],ValueParser::parser($str));
    }
}

IDE支持

需要为PHPStorm安装”PHP Annotation”插件以提供注解自动提示能力，插件可以在PHPStorm中直接搜索安装，也可以前往Github下载安装

::: warning https://github.com/Haehnchen/idea-php-annotation-plugin :::

然后自己编写一个下面这样的注解提示类，重点在于使用@Annotation类注释，标记这是一个注解提示类，PHPStorm索引到该文件，就可以对类名和类的成员进行注解提示


<?php
namespace EasySwoole\Validate;
/**
 * 注解标注文件
 * @Annotation
 * 需要向上方这样使用Annotation标记这是一个注解提示类
 */
final class ValidateRule
{
    /**
     * 括号内会提示这些字段
     * @var string
     */
    protected $name;
    /**
     * 括号内会提示这些字段
     * @var string
     */
    protected $column;
    /**
     * 括号内会提示这些字段
     * @var string
     */
    protected $alias;
}

即可实现下面aaa方法的自动注解提示

<?php
use EasySwoole\Validate as Validate;
class a
{
    /**
     * @Validate\ValidateRule(column="name",alias="账号名称")
     */
    function aaa(){
    }
}