Awesome
PHP Accessor
生成类访问器（Getter & Setter）
快速入门
安装
composer require free2one/php-accessor
项目composer.json 文件中配置以下信息
{
"scripts":{
"php-accessor": "@php vendor/bin/php-accessor generate"
}
}
将相应的注释添加到需要生成访问器的类中:
<?php
namespace App;
use PhpAccessor\Attribute\Data;
#[Data]
class Entity
{
private int $id;
private string $name;
}
运行命令生成代理类
composer run-script php-accessor CLASS_PATH
注解说明
#[Data]
用于PHP Accessor识别是否需要生成访问器。
配置项
namingConvention: 访问器命名约定,支持以下类别
NamingConvention::UPPER_CAMEL_CASE: 大驼峰NamingConvention::LOWER_CAMEL_CAS: 小驼峰NamingConvention::NONE: 首字母大写,系统默认配置
accessorType: 需要生成的访问器类型
AccessorType::GETTER: 仅生成getterAccessorType::SETTER: 仅生成setterAccessorType::BOTH: 生成getter及setter，系统默认配置
prefixConvention: 访问器前缀约定，支持以下类别
PrefixConvention::GET_SET(系统默认配置)- Getter: 使用
get - Setter: 使用
set
- Getter: 使用
PrefixConvention::BOOLEAN_IS- Getter: 当属性为布尔类型时,使用
is,否则使用get - Setter: 使用
set
- Getter: 当属性为布尔类型时,使用
示例
<?php
namespace App;
use PhpAccessor\Attribute\Data;
use PhpAccessor\Attribute\Map\NamingConvention;
#[Data(namingConvention: NamingConvention::UPPER_CAMEL_CASE, accessorType: AccessorType::GETTER)]
class Entity
{
private int $id;
private string $name;
}
#[Overlook]
设置后该类字段将不生成访问器。
示例
<?php
namespace App;
use PhpAccessor\Attribute\Data;
use PhpAccessor\Attribute\Overlook;
#[Data]
class Entity
{
private int $id;
#[Overlook]
private string $ignore;
}
#[DefaultNull]
设置后调用相应的Getter方法时，若属性未进行初始化，将返回null。
示例
<?php
namespace App;
use PhpAccessor\Attribute\Data;
use PhpAccessor\Attribute\DefaultNull;
#[Data]
class Entity
{
private int $id;
#[DefaultNull]
private string $defaultNull;
}
$entity = new Entity();
var_dump($entity->getDefaultNull()); // output: NULL
要点说明
如何使用生成的代理类
如果你的项目使用的是Hyperf框架，则可直接引入<a href="https://github.com/kkguan/hyperf-php-accessor">Hyperf PHP Accessor</a>包。其他情况下，请参考以下示例。
待生成访问器的类Entity
<?php
namespace App;
use PhpAccessor\Attribute\Data;
use PhpAccessor\Attribute\Overlook;
#[Data()]
class Entity
{
#[Overlook]
private string $ignore;
private int $id;
}
执行文件示例
<?php
require_once "vendor/autoload.php";
use App\Entity;
use Composer\Autoload\ClassLoader;
use PhpAccessor\Console\Application;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Finder\Finder;
$scanDir = ['PROJECT_ROOT_PATH/app']; //需要扫描的项目目录
$proxyDir = 'PROJECT_ROOT_PATH/.php-accessor'; //代理类存放目录
//生成代理类
$input = new ArrayInput([
'command' => 'generate',
'path' => $scanDir,
'--dir' => $proxyDir,
'--gen-meta' => 'yes', //发布线上时，可设置为no
'--gen-proxy' => 'yes',
]);
$app = new Application();
$app->setAutoExit(false);
$app->run($input);
//利用composer注册自动加载
$finder = new Finder();
$finder->files()->name('*.php')->in($proxyDir);
$classLoader = new ClassLoader();
$classMap = [];
foreach ($finder->getIterator() as $value) {
$classname = str_replace('@', '\\', $value->getBasename('.' . $value->getExtension()));
$classname = substr($classname, 1);
$classMap[$classname] = $value->getRealPath();
}
$classLoader->addClassMap($classMap);
$classLoader->register(true);
//Entity已被替换为代理类😸
$entity = new Entity();
$entity->setId(222);
var_dump($entity);