mirror of
https://gitee.com/hyperf/hyperf.git
synced 2024-12-02 19:58:22 +08:00
52094d0fad
- Added demo for query builder. - Added meilisearch client into awesome components. Co-authored-by: codelin <494020937@qq.com> Co-authored-by: Alone88 <im@alone88.cn> Co-authored-by: 李铭昕 <715557344@qq.com>
456 lines
13 KiB
Markdown
456 lines
13 KiB
Markdown
# 注解
|
||
|
||
注解是 Hyperf 非常强大的一项功能，可以通过注解的形式减少很多的配置，以及实现很多非常方便的功能。
|
||
|
||
## 概念
|
||
|
||
### 什么是注解什么是注释？
|
||
|
||
在解释注解之前我们需要先定义一下 `注解` 与 `注释` 的区别：
|
||
- 注释：给程序员看，帮助理解代码，对代码起到解释、说明的作用。
|
||
- 注解：给应用程序看，用于元数据的定义，单独使用时没有任何作用，需配合应用程序对其元数据进行利用才有作用。
|
||
|
||
### 注释型注解解析如何实现？
|
||
|
||
Hyperf 使用了 [doctrine/annotations](https://github.com/doctrine/annotations) 包来对代码内的注解进行解析，注解必须写在下面示例的标准注释块才能被正确解析，其它格式均不能被正确解析。
|
||
注释块示例：
|
||
```php
|
||
/**
|
||
* @AnnotationClass()
|
||
*/
|
||
```
|
||
在标准注释块内通过书写 `@AnnotationClass()` 这样的语法即表明对当前注释块所在位置的对象(类、类方法、类属性)进行了注解的定义， `AnnotationClass` 对应的是一个 `注解类` 的类名，可写全类的命名空间，亦可只写类名，但需要在当前类 `use` 该注解类以确保能够根据命名空间找到正确的注解类。
|
||
|
||
### 注解是如何发挥作用的？
|
||
|
||
我们有说到注解只是元数据的定义，需配合应用程序才能发挥作用，在 Hyperf 里，注解内的数据会被收集到 `Hyperf\Di\Annotation\AnnotationCollector` 类供应用程序使用，当然根据您的实际情况，也可以收集到您自定义的类去，随后在这些注解本身希望发挥作用的地方对已收集的注解元数据进行读取和利用，以达到期望的功能实现。
|
||
|
||
### 忽略某些注解
|
||
|
||
在一些情况下我们可能希望忽略某些 注解，比如我们在接入一些自动生成文档的工具时，有不少工具都是通过注解的形式去定义文档的相关结构内容的，而这些注解可能并不符合 Hyperf 的使用方式，我们可以通过在 `config/autoload/annotations.php` 内将相关注解设置为忽略。
|
||
|
||
```php
|
||
return [
|
||
'scan' => [
|
||
// ignore_annotations 数组内的注解都会被注解扫描器忽略
|
||
'ignore_annotations' => [
|
||
'mixin',
|
||
],
|
||
],
|
||
];
|
||
```
|
||
|
||
## 使用注解
|
||
|
||
注解一共有 3 种应用对象，分别是 `类`、`类方法` 和 `类属性`。
|
||
|
||
### 使用类注解
|
||
|
||
类注解定义是在 `class` 关键词上方的注释块内，比如常用的 `@Controller` 和 `@AutoController` 就是类注解的使用典范，下面的代码示例则为一个正确使用类注解的示例，表明 `@ClassAnnotation` 注解应用于 `Foo` 类。
|
||
|
||
- PHP 版本低于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
/**
|
||
* @ClassAnnotation
|
||
*/
|
||
class Foo {}
|
||
```
|
||
|
||
- PHP 版本大于等于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
#[ClassAnnotation]
|
||
class Foo {}
|
||
```
|
||
|
||
### 使用类方法注解
|
||
|
||
类方法注解定义是在方法上方的注释块内，比如常用的 `@RequestMapping` 就是类方法注解的使用典范，下面的代码示例则为一个正确使用类方法注解的示例，表明 `@MethodAnnotation` 注解应用于 `Foo::bar()` 方法。
|
||
|
||
- PHP 版本低于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
class Foo
|
||
{
|
||
/**
|
||
* @MethodAnnotation()
|
||
*/
|
||
public function bar()
|
||
{
|
||
// some code
|
||
}
|
||
}
|
||
```
|
||
|
||
- PHP 版本大于等于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
class Foo
|
||
{
|
||
#[MethodAnnotation]
|
||
public function bar()
|
||
{
|
||
// some code
|
||
}
|
||
}
|
||
```
|
||
|
||
### 使用类属性注解
|
||
|
||
类属性注解定义是在属性上方的注释块内，比如常用的 `@Value` 和 `@Inject` 就是类属性注解的使用典范，下面的代码示例则为一个正确使用类属性注解的示例，表明 `@PropertyAnnotation` 注解应用于 `Foo` 类的 `$bar` 属性。
|
||
|
||
- PHP 版本低于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
class Foo
|
||
{
|
||
/**
|
||
* @PropertyAnnotation()
|
||
*/
|
||
private $bar;
|
||
}
|
||
```
|
||
|
||
- PHP 版本大于等于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
class Foo
|
||
{
|
||
#[PropertyAnnotation]
|
||
private $bar;
|
||
}
|
||
```
|
||
|
||
### 注释型注解参数传递
|
||
|
||
- 传递主要的单个参数 `@DemoAnnotation("value")`
|
||
- 传递字符串参数 `@DemoAnnotation(key1="value1", key2="value2")`
|
||
- 传递数组参数 `@DemoAnnotation(key={"value1", "value2"})`
|
||
|
||
## 自定义注解
|
||
|
||
### 创建一个注解类
|
||
|
||
在任意地方创建注解类，如下代码示例：
|
||
|
||
- PHP 版本低于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
namespace App\Annotation;
|
||
|
||
use Hyperf\Di\Annotation\AbstractAnnotation;
|
||
|
||
/**
|
||
* @Annotation
|
||
* @Target({"METHOD","PROPERTY"})
|
||
*/
|
||
class Bar extends AbstractAnnotation
|
||
{
|
||
// some code
|
||
}
|
||
|
||
/**
|
||
* @Annotation
|
||
* @Target("CLASS")
|
||
*/
|
||
class Foo extends AbstractAnnotation
|
||
{
|
||
// some code
|
||
}
|
||
```
|
||
|
||
> 注意注解类的 `@Annotation` 和 `@Target` 注解为全局注解，无需 `use`
|
||
|
||
其中 `@Target` 有如下参数：
|
||
- `METHOD` 注解允许定义在类方法上
|
||
- `PROPERTY` 注解允许定义在类属性上
|
||
- `CLASS` 注解允许定义在类上
|
||
- `ALL` 注解允许定义在任何地方
|
||
|
||
- PHP 版本大于等于 8.0 时
|
||
|
||
```php
|
||
<?php
|
||
namespace App\Annotation;
|
||
|
||
use Hyperf\Di\Annotation\AbstractAnnotation;
|
||
|
||
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
|
||
class Bar extends AbstractAnnotation
|
||
{
|
||
// some code
|
||
}
|
||
|
||
#[Attribute(Attribute::TARGET_CLASS)]
|
||
class Foo extends AbstractAnnotation
|
||
{
|
||
// some code
|
||
}
|
||
```
|
||
|
||
我们注意一下在上面的示例代码中，注解类都继承了 `Hyperf\Di\Annotation\AbstractAnnotation` 抽象类，对于注解类来说，这个不是必须的，但对于 Hyperf 的注解类来说，继承 `Hyperf\Di\Annotation\AnnotationInterface` 接口类是必须的，那么抽象类在这里的作用是提供极简的定义方式，该抽象类已经为您实现了`注解参数自动分配到类属性`、`根据注解使用位置自动按照规则收集到 AnnotationCollector` 这样非常便捷的功能。
|
||
|
||
### 自定义注解收集器
|
||
|
||
注解的收集时具体的执行流程也是在注解类内实现的，相关的方法由 `Hyperf\Di\Annotation\AnnotationInterface` 约束着，该接口类要求了下面 3 个方法的实现，您可以根据自己的需求实现对应的逻辑：
|
||
|
||
- `public function collectClass(string $className): void;` 当注解定义在类时被扫描时会触发该方法
|
||
- `public function collectMethod(string $className, ?string $target): void;` 当注解定义在类方法时被扫描时会触发该方法
|
||
- `public function collectProperty(string $className, ?string $target): void` 当注解定义在类属性时被扫描时会触发该方法
|
||
|
||
因为框架实现了注解收集器缓存功能，所以需要您将自定义收集器配置到 `annotations.scan.collectors` 中，这样框架才能自动缓存收集好的注解，在下次启动时进行复用。
|
||
如果没有配置对应的收集器，就会导致自定义注解只有在首次启动 `server` 时生效，而再次启动时不会生效。
|
||
|
||
```php
|
||
<?php
|
||
|
||
return [
|
||
// 注意在 config/autoload 文件下的配置文件则无 annotations 这一层
|
||
'annotations' => [
|
||
'scan' => [
|
||
'collectors' => [
|
||
CustomCollector::class,
|
||
],
|
||
],
|
||
],
|
||
];
|
||
|
||
```
|
||
|
||
### 原生注解(Attributes)
|
||
|
||
众所周知，在 PHP 8 增加了 `原生注解(Attributes)` 的特性，Hyperf 2.2 版本开始也支持了原生注解的写法，文档内的所有注解都可做对应的转换，如下：
|
||
|
||
#### PHPDoc 注解
|
||
|
||
```php
|
||
/**
|
||
* @ClassAnnotation()
|
||
*/
|
||
class Foo {}
|
||
```
|
||
|
||
#### PHP 原生注解
|
||
|
||
```php
|
||
#[ClassAnnotation()]
|
||
class Foo {}
|
||
```
|
||
|
||
### 利用注解数据
|
||
|
||
在没有自定义注解收集方法时，默认会将注解的元数据统一收集在 `Hyperf\Di\Annotation\AnnotationCollector` 类内，通过该类的静态方法可以方便的获取对应的元数据用于逻辑判断或实现。
|
||
|
||
### ClassMap 功能
|
||
|
||
框架提供了 `class_map` 配置，可以方便用户直接替换需要加载的类。
|
||
|
||
比如以下我们实现一个可以自动复制协程上下文的功能：
|
||
|
||
首先，我们实现一个用于复制上下文的 `Coroutine` 类。其中 `create()` 方法，可以将父类的上下文复制到子类当中。
|
||
|
||
为了避免命名冲突，约定使用 `class_map` 做为文件夹名，后跟要替换的命名空间的文件夹及文件。
|
||
|
||
如： `class_map/Hyperf/Utils/Coroutine.php`
|
||
|
||
```php
|
||
<?php
|
||
|
||
declare(strict_types=1);
|
||
/**
|
||
* This file is part of Hyperf.
|
||
*
|
||
* @link https://www.hyperf.io
|
||
* @document https://doc.hyperf.io
|
||
* @contact group@hyperf.io
|
||
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE
|
||
*/
|
||
namespace App\Kernel\Context;
|
||
|
||
use Hyperf\Contract\StdoutLoggerInterface;
|
||
use Hyperf\ExceptionHandler\Formatter\FormatterInterface;
|
||
use Hyperf\Utils;
|
||
use Psr\Container\ContainerInterface;
|
||
use Psr\Http\Message\ServerRequestInterface;
|
||
use Swoole\Coroutine as SwooleCoroutine;
|
||
|
||
class Coroutine
|
||
{
|
||
/**
|
||
* @var ContainerInterface
|
||
*/
|
||
protected $container;
|
||
|
||
/**
|
||
* @var StdoutLoggerInterface
|
||
*/
|
||
protected $logger;
|
||
|
||
/**
|
||
* @var null|FormatterInterface
|
||
*/
|
||
protected $formatter;
|
||
|
||
public function __construct(ContainerInterface $container)
|
||
{
|
||
$this->container = $container;
|
||
$this->logger = $container->get(StdoutLoggerInterface::class);
|
||
if ($container->has(FormatterInterface::class)) {
|
||
$this->formatter = $container->get(FormatterInterface::class);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @return int Returns the coroutine ID of the coroutine just created.
|
||
* Returns -1 when coroutine create failed.
|
||
*/
|
||
public function create(callable $callable): int
|
||
{
|
||
$id = Utils\Coroutine::id();
|
||
$result = SwooleCoroutine::create(function () use ($callable, $id) {
|
||
try {
|
||
// 按需复制，禁止复制 Socket，不然会导致 Socket 跨协程调用从而报错。
|
||
Utils\Context::copy($id, [
|
||
ServerRequestInterface::class,
|
||
]);
|
||
call($callable);
|
||
} catch (Throwable $throwable) {
|
||
if ($this->formatter) {
|
||
$this->logger->warning($this->formatter->format($throwable));
|
||
} else {
|
||
$this->logger->warning((string) $throwable);
|
||
}
|
||
}
|
||
});
|
||
return is_int($result) ? $result : -1;
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
然后，我们实现一个跟 `Hyperf\Utils\Coroutine` 一模一样的对象。其中 `create()` 方法替换成我们上述实现的方法。
|
||
|
||
`class_map/Hyperf/Utils/Coroutine.php`
|
||
|
||
```php
|
||
<?php
|
||
|
||
declare(strict_types=1);
|
||
/**
|
||
* This file is part of Hyperf.
|
||
*
|
||
* @link https://www.hyperf.io
|
||
* @document https://doc.hyperf.io
|
||
* @contact group@hyperf.io
|
||
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE
|
||
*/
|
||
namespace Hyperf\Utils;
|
||
|
||
use App\Kernel\Context\Coroutine as Co;
|
||
use Swoole\Coroutine as SwooleCoroutine;
|
||
use Hyperf\Utils\ApplicationContext;
|
||
|
||
/**
|
||
* @method static void defer(callable $callable)
|
||
*/
|
||
class Coroutine
|
||
{
|
||
public static function __callStatic($name, $arguments)
|
||
{
|
||
if (! method_exists(SwooleCoroutine::class, $name)) {
|
||
throw new \BadMethodCallException(sprintf('Call to undefined method %s.', $name));
|
||
}
|
||
return SwooleCoroutine::$name(...$arguments);
|
||
}
|
||
|
||
/**
|
||
* Returns the current coroutine ID.
|
||
* Returns -1 when running in non-coroutine context.
|
||
*/
|
||
public static function id(): int
|
||
{
|
||
return SwooleCoroutine::getCid();
|
||
}
|
||
|
||
/**
|
||
* Returns the parent coroutine ID.
|
||
* Returns -1 when running in the top level coroutine.
|
||
* Returns null when running in non-coroutine context.
|
||
*
|
||
* @see https://github.com/swoole/swoole-src/pull/2669/files#diff-3bdf726b0ac53be7e274b60d59e6ec80R940
|
||
*/
|
||
public static function parentId(?int $coroutineId = null): ?int
|
||
{
|
||
if ($coroutineId) {
|
||
$cid = SwooleCoroutine::getPcid($coroutineId);
|
||
} else {
|
||
$cid = SwooleCoroutine::getPcid();
|
||
}
|
||
if ($cid === false) {
|
||
return null;
|
||
}
|
||
|
||
return $cid;
|
||
}
|
||
|
||
/**
|
||
* @return int Returns the coroutine ID of the coroutine just created.
|
||
* Returns -1 when coroutine create failed.
|
||
*/
|
||
public static function create(callable $callable): int
|
||
{
|
||
return ApplicationContext::getContainer()->get(Co::class)->create($callable);
|
||
}
|
||
|
||
public static function inCoroutine(): bool
|
||
{
|
||
return Coroutine::id() > 0;
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
然后配置一下 `class_map`，如下：
|
||
|
||
```php
|
||
<?php
|
||
|
||
declare(strict_types=1);
|
||
|
||
use Hyperf\Utils\Coroutine;
|
||
|
||
return [
|
||
'scan' => [
|
||
'paths' => [
|
||
BASE_PATH . '/app',
|
||
],
|
||
'ignore_annotations' => [
|
||
'mixin',
|
||
],
|
||
'class_map' => [
|
||
// 需要映射的类名 => 类所在的文件地址
|
||
Coroutine::class => BASE_PATH . '/class_map/Hyperf/Utils/Coroutine.php',
|
||
],
|
||
],
|
||
];
|
||
|
||
```
|
||
|
||
这样 `co()` 和 `parallel()` 等方法，就可以自动拿到父协程，上下文中的数据，比如 `Request`。
|
||
|
||
## IDE 注解插件
|
||
|
||
因为 `PHP8.0` 以下并不是原生支持 `注解`，所以 `IDE` 不会默认增加注解支持。但我们可以添加第三方插件，来让 `IDE` 支持 `注解`。
|
||
|
||
### PhpStorm
|
||
|
||
我们到 `Plugins` 中搜索 `PHP Annotations`，就可以找到对应的组件 [PHP Annotations](https://github.com/Haehnchen/idea-php-annotation-plugin)。然后安装组件，重启 `PhpStorm`，就可以愉快的使用注解功能了，主要提供了为注解类增加自动跳转和代码提醒支持，使用注解时自动引用注解对应的命名空间等非常便捷有用的功能。
|