swoft微服务实战十二：注解

一、注解概念:

1. 注解是一种和注释平行的概念.

①. 注释:
   a. 提供对可执行代码的说明
   b. 便于开发人员阅读,不影响代码的执行.
②. 注解:
   a. 提供对代码的声明和配置的作用
   b. 为可执行代码提供机器可用的额外信息,在特定的环境下会影响程序的执行.

2. 注解定义:

附加在数据/代码上的元数据(metadata),框架可以基于这些元信息为代码提供各种额外功能.

3. Doctrine注解引擎:

目前PHP没有对注解的官方实现,主流PHP框架都是借用T_DOC_COMMENT型注释块(/*型注释/)中的@Tag,定义自己的注解机制.

①. Doctrine的注解方案是基于T_DOC_COMMENT型注释的.
②. Doctrine使用反射获取代码的T_DOC_COMMENT型注释,并将注释中的特定类型@Tag映射到对应注解类.
③. 为此,Swoft首先要为每一个框架自定义的注解定义注解类.    ???
④. Swoft采用了Doctrine的注解引擎.
⑤. 注解(Annotations)是Swoft中AOP、IoC容器的基础.

二、swoft注解:

1. 注解定义:

@Breaker注解的注解类定义如下:

// Swoft\Sg\Bean\Annotation\Breaker.php
namespace Swoft\Sg\Bean\Annotation;
/**
 * the annotation of breaker
 * @Annotation //声明这是一个注解类
 * @Target("CLASS")  //声明这个注解只可用在class级别的注释中
 */
class Breaker
{
    /**
     * the name of breaker
     * @var string   // @var是PHPDoc标准的常用的tag,定义了属性的类型Doctrine会根据该类型额外对注解参数进行检查
     */
    private $name = "";
    /**
     * 若注解类提供构造器,Doctrine会调用,一般会在此处对注解类对象的private属性进行赋值
     * Breaker constructor.
     * @param array $values // Doctrine注解使用处的参数数组
     */
    public function __construct(array $values)
    {
        if (isset($values['value'])) {
            $this->name = $values['value'];
        }
        if (isset($values['name'])) {
            $this->name = $values['name'];
        }
    }
    // 按需写的getter setter code....
}