Download the PHP package maliboot/lombok without Composer

Lombok

简介

这是一个通过注解来减少重复代码的工具。 本插件参考了Java库-Lombok奇思妙想编写而成，与其一样，致力于解放开发者的双手☕️～。最后，本插件的名称也以lombok向其致敬。

功能

• Setter
• Getter
• 日志
• 工具类方法，如toArray、toCollection等
• 类委托
• 类属性委托
• 增强已有注解功能
• 自定义组合注解功能
• 自定义扩展lombok
• ....

依赖

• hyperf/di

安装

• PHP包安装（必须）：composer require maliboot/lombok
• PHPStorm插件支持（可选）：Hyperf Support，下载传送门

使用

1.1 #[Getter]基本使用，#[ToArray]、#[ToCollection]同理

1.1.1、在不使用lombok以前，我们实现一个Getter功能, 需要写如下代码：

使用lombok后，我们只需要添加一个Getter注解，皆可省掉以上方法：

1.2 #[Logger]基本使用

• #[Logger]注解集成了hyperf日志系统，会自动给类添加public \Psr\Log\LoggerInterface $logger属性。
• #[Logger(name:"CALL_CLASS_NAME", group: "default")]中给了默认参数。其中CALL_CLASS_NAME会被插件自动替换为当前类名称。如下示例

1.3 进阶用法

1.3.1、可用注解如下

1.3.2、注解增强

当我们的项目里已有DTO注解，想为此注解支持Getter功能时，可以如下操作

• 在原有注解上，继承\MaliBoot\Lombok\Contract\GetterAnnotationInterface

• 注册AOP（本组件的功能基于hyperf/di的AOP代理文件，所以必须生成代理文件）

• 完成以上两步骤，\App\Annotation\DTO此注解将自动拥有原\MaliBoot\Lombok\Annotation\Getter的功能

1.3.3、注解增强 - 自定义组合

当然，同时我们需要自定义一个（或者老项目里已有的一个类注解扩展支持）同时拥有Setter,Getter, Logger等多功能的注解，并且可以自定义组合这些功能时。那么同理，只需要在某注解上继续继承相应的注解接口皆可。可用的接口如下

1.3.4、自定义lombok注解

当然，我们也可以自己做一个lombok功能。比如，我们给./app/Foo.php扩展一个swap方法。

• 第1步，添加一个注解接口，用于生成代理代码与自定义组合的凭据

• 第2步，添加lombok注解，并继承\App\Contract\SwapAnnotationInterface接口。

  注意：此步骤非必须，如果已有现成的其它注解如\App\Annotation\Controller，可以直接在该注解内继承swap接口也可以

  \App\Annotation\Controller implements \App\Contract\SwapAnnotationInterface

• 第3步，lombok注解注册AOP

• 第4步，lombok代码模板

• 以上是扩展lombok的所有步骤，相关代码在lombok/sample内可见。那么下面可以直接使用了

注意事项

• 为了保证代码安全，当功能注解生成的代码与原代码冲突时，将放弃生成相应代码，以原代码为准。如Setter、toArray方法已存在，public $logger类属性已经存在等等