php8註解詳解

時間  2020-12-01
標籤 php shell app 函數 this spa code 繼承 get string 欄目 PHP 简体版
原文   原文鏈接

註解語法

#[Route]
#[Route()]
#[Route("/path", ["get"])]
#[Route(path: "/path", methods: ["get"])]

其實語法跟實例化類很是類似，只是少了個 new 關鍵詞而已。php

要注意的是, 註解名不能是變量，只能是常量或常量表達式shell

//實例化類
$route = new Route(path: "/path", methods: ["get"]);

(path: "/path", methods: ["get"])是 php8 的新語法，在傳參的時候能夠指定參數名，不按照形參的順序傳參。app

註解類做用範圍

在定義註解類時，你可使用內置註解類 #[Attribute] 定義註解類的做用範圍，也能夠省略，由 PHP 動態地根據使用場景自動定義範圍。函數

註解做用範圍列表：this

  • Attribute::TARGET_CLASS
  • Attribute::TARGET_FUNCTION
  • Attribute::TARGET_METHOD
  • Attribute::TARGET_PROPERTY
  • Attribute::TARGET_CLASS_CONSTANT
  • Attribute::TARGET_PARAMETER
  • Attribute::TARGET_ALL
  • Attribute::IS_REPEATABLE
在使用時, #[Attribute] 等同於 #[Attribute(Attribute::TARGET_ALL)]，爲了方便，通常使用前者。

1~7都很好理解，分別對應類、函數、類方法、類屬性、類常量、參數、全部，前6項可使用 | 或運算符隨意組合，好比Attribute::TARGET_CLASS | Attribute::TARGET_FUNCTION。(Attribute::TARGET_ALL包含前6項，但並不包含 Attribute::IS_REPEATABLE)。spa

Attribute::IS_REPEATABLE 設置該註解是否能夠重複，好比:code

class IndexController
{
    #[Route('/index')]
    #[Route('/index_alias')]
    public function index()
    {
        echo "hello!world" . PHP_EOL;
    }
}

若是沒有設置 Attribute::IS_REPEATABLE，Route不容許使用兩次。繼承

上述提到的，若是沒有指定做用範圍，會由 PHP 動態地肯定範圍，如何理解？舉例：get

<?php

class Deprecated
{

}

class NewLogger
{
    public function newLogAction(): void
    {
        //do something
    }

    #[Deprecated('oldLogAction已廢棄，請使用newLogAction代替')]
    public function oldLogAction(): void 
    {

    }
}

#[Deprecated('OldLogger已廢棄，請使用NewLogger代替')]
class OldLogger
{

}

上述的自定義註解類 Deprecated 並無使用內置註解類 #[Attribute] 定義做用範圍，所以當它修飾類 OldLogger 時，它的做用範圍被動態地定義爲 TARGET_CLASS。當它修飾方法 oldLogAction 時，它的做用範圍被動態地定義爲 TARGET_METHOD。一句話歸納，就是修飾哪，它的做用範圍就在哪string

須要注意的是, 在設置了做用範圍以後，在編譯階段，除了內置註解類 #[Attribute]，自定義的註解類是不會自動檢查做用範圍的。除非你使用反射類 ReflectionAttribute 的 newInstance 方法。

舉例：

<?php

#[Attribute]
function foo()
{

}

這裏會報錯 Fatal error: Attribute "Attribute" cannot target function (allowed targets: class)，由於內置註解類的做用範圍是 TARGET_CLASS，只能用於修飾類而不能是函數，由於內置註解類的做用範圍僅僅是 TARGET_CLASS，因此也不能重複修飾。

而自定義的註解類，在編譯時是不會檢查做用範圍的。

<?php 

#[Attribute(Attribute::TARGET_CLASS)]
class A1
{

}

#[A1] 
function foo() {}

這樣是不會報錯的。那定義做用範圍有什麼意義呢？看一個綜合實例。

<?php 

#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)]
class Route
{
    protected $handler;

    public function __construct(
        public string $path = '',
        public array $methods = []
    ) {}

    public function setHandler($handler): self
    {
        $this->handler = $handler;
        return $this;
    }

    public function run()
    {
        call_user_func([new $this->handler->class, $this->handler->name]);
    }
}

class IndexController
{
    #[Route(path: "/index_alias", methods: ["get"])]
    #[Route(path: "/index", methods: ["get"])]
    public function index(): void
    {
        echo "hello!world" . PHP_EOL;
    }

    #[Route("/test")]
    public function test(): void 
    {
        echo "test" . PHP_EOL;
    }
}

class CLIRouter
{
    protected static array $routes = [];

    public static function setRoutes(array $routes): void
    {
        self::$routes = $routes;
    }

    public static function match($path)
    {
        foreach (self::$routes as $route) {
            if ($route->path == $path) {
                return $route;
            }
        }

        die('404' . PHP_EOL);
    }
}

$controller = new ReflectionClass(IndexController::class);
$methods = $controller->getMethods(ReflectionMethod::IS_PUBLIC);

$routes = [];
foreach ($methods as $method) {
    $attributes = $method->getAttributes(Route::class);

    foreach ($attributes as $attribute) {
        $routes[] = $attribute->newInstance()->setHandler($method);
    }
}

CLIRouter::setRoutes($routes);
CLIRouter::match($argv[1])->run();
php test.php /index
php test.php /index_alias
php test.php /test

在使用 newInstance 時，定義的做用範圍纔會生效，檢測註解類定義的做用範圍和實際修飾的範圍是否一致，其它場景並不檢測。

註解命名空間

<?php

namespace {
    function dump_attributes($attributes) {
        $arr = [];
        foreach ($attributes as $attribute) {
            $arr[] = ['name' => $attribute->getName(), 'args' => $attribute->getArguments()];
        }
        var_dump($arr);
    }
}

namespace Doctrine\ORM\Mapping {
    class Entity {
    }
}

namespace Doctrine\ORM\Attributes {
    class Table {
    }
}

namespace Foo {
    use Doctrine\ORM\Mapping\Entity;
    use Doctrine\ORM\Mapping as ORM;
    use Doctrine\ORM\Attributes;

    #[Entity("imported class")]
    #[ORM\Entity("imported namespace")]
    #[\Doctrine\ORM\Mapping\Entity("absolute from namespace")]
    #[\Entity("import absolute from global")]
    #[Attributes\Table()]
    function foo() {
    }
}

namespace {
    class Entity {}

    dump_attributes((new ReflectionFunction('Foo\foo'))->getAttributes());
}

//輸出：

array(5) {
  [0]=>
  array(2) {
    ["name"]=>
    string(27) "Doctrine\ORM\Mapping\Entity"
    ["args"]=>
    array(1) {
      [0]=>
      string(14) "imported class"
    }
  }
  [1]=>
  array(2) {
    ["name"]=>
    string(27) "Doctrine\ORM\Mapping\Entity"
    ["args"]=>
    array(1) {
      [0]=>
      string(18) "imported namespace"
    }
  }
  [2]=>
  array(2) {
    ["name"]=>
    string(27) "Doctrine\ORM\Mapping\Entity"
    ["args"]=>
    array(1) {
      [0]=>
      string(23) "absolute from namespace"
    }
  }
  [3]=>
  array(2) {
    ["name"]=>
    string(6) "Entity"
    ["args"]=>
    array(1) {
      [0]=>
      string(27) "import absolute from global"
    }
  }
  [4]=>
  array(2) {
    ["name"]=>
    string(29) "Doctrine\ORM\Attributes\Table"
    ["args"]=>
    array(0) {
    }
  }
}

跟普通類的命名空間一致。

其它要注意的一些問題

  • 不能在註解類參數列表中使用 unpack 語法。
<?php

class IndexController
{
    #[Route(...["/index", ["get"]])]
    public function index()
    {

    }
}

雖然在詞法解析階段是經過的，可是在編譯階段會拋出錯誤。

  • 在使用註解時能夠換行
<?php 

class IndexController
{
    #[Route(
        "/index",
        ["get"]
    )]
    public function index()
    {

    }
}
  • 註解能夠成組使用
<?php

class IndexController
{
    #[Route(
        "/index",
        ["get"]
    ), Other, Another]
    public function index()
    {

    }
}
  • 註解的繼承

註解是能夠繼承的，也能夠覆蓋。

<?php

class C1
{
    #[A1]
    public function foo() { }
}

class C2 extends C1
{
    public function foo() { }
}

class C3 extends C1
{
    #[A1]
    public function bar() { }
}

$ref = new \ReflectionClass(C1::class);
print_r(array_map(fn ($a) => $a->getName(), $ref->getMethod('foo')->getAttributes()));

$ref = new \ReflectionClass(C2::class);
print_r(array_map(fn ($a) => $a->getName(), $ref->getMethod('foo')->getAttributes()));

$ref = new \ReflectionClass(C3::class);
print_r(array_map(fn ($a) => $a->getName(), $ref->getMethod('foo')->getAttributes()));

C3 繼承了 C1 的 foo 方法，也繼承了 foo 的註解。而 C2 覆蓋了 C1 的 foo 方法，所以註解也就不存在了。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程