首页
/ 正文

PHP attributes() 函数（建议收藏）

更新时间: 2025-04-10 02:01:56

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;

《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前，星球内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习，欢迎点击围观

一、前言：PHP 属性的崛起与 attributes() 的诞生

在 PHP8.0 引入属性（Attributes）这一全新特性之前，开发者们通常使用注释或魔术方法来记录代码的元数据信息。例如，通过 @Route("/api/users") 这样的注释标记控制器方法的路由路径，或是通过 __get() 魔术方法实现动态属性访问。然而这些方法存在维护成本高、解析逻辑复杂等问题。

随着 PHP8.0 的发布，属性机制正式成为语言级特性，而 attributes() 函数作为配套工具，为开发者提供了一种标准化的元数据访问方式。它就像快递单上的电子标签扫描器，能够精准识别并提取类、方法、参数等代码元素上的属性信息。

本文将从基础概念到实战案例，循序渐进地解析 attributes() 函数的使用方法，帮助开发者掌握这一现代 PHP 开发的重要工具。

二、基础用法：属性的定义与访问

1. 属性的定义方式

属性通过 #[Attribute] 语法声明，可以附加到类、方法、参数等代码元素上。例如：

#[Attribute]
class Route {
    public function __construct(public string $path) {}
}

#[Route("/api/users")]
class UserController {
    #[Route("/create")]
    public function create() {}
}

这里我们定义了一个 Route 属性，用于标记类和方法的路由路径。注意所有属性必须通过 #[Attribute] 声明，否则无法被 attributes() 函数识别。

2. 使用 attributes() 获取属性

要获取特定代码元素上的属性，只需调用 attributes() 方法：

// 获取类级别的属性
$classAttributes = UserController::class->attributes();

// 获取方法级别的属性
$method = (new UserController())->create(...);
$methodAttributes = $method->attributes();

该函数返回一个 ArrayIterator 对象，可以通过 get() 方法获取特定属性的实例：

$routeAttr = $classAttributes->get(Route::class);
if ($routeAttr) {
    echo "类路由路径：" . $routeAttr->path;
}

三、参数详解：深入理解 attributes() 的功能选项

attributes() 函数支持两个可选参数，允许开发者精确控制属性的获取方式：

ArrayIterator attributes(
    bool $inherited = true,
    int $check_access = ReflectionAttribute::IS_INSTANCEOF
)

参数说明表

参数名	类型	默认值	作用描述
$inherited	boolean	true	是否包含父类继承的属性
$check_access	integer	ReflectionAttribute::IS_INSTANCEOF	控制如何验证属性类型是否匹配

参数使用场景分析

1. 控制继承属性的获取

class BaseController {
    #[Route("/base")]
    protected function index() {}
}

class ChildController extends BaseController {
    // ...
}

// 获取基类方法属性（需要设置 $inherited）
$baseMethodAttrs = BaseController::class->index()->attributes(true);

2. 精确验证属性类型

当需要确保属性类型完全匹配时，可以设置 $check_access 为 ReflectionAttribute::IS_EXACT：

// 只接受精确类型匹配
$exactAttrs = $method->attributes(Route::class, ReflectionAttribute::IS_EXACT);

四、高级应用：属性的动态特性与组合模式

1. 动态属性的构建

通过结合反射类，可以实现属性的动态构建和解析：

use ReflectionClass;

function resolveRoute(string $className): array {
    $reflection = new ReflectionClass($className);
    $classAttrs = $reflection->getAttributes(Route::class);
    
    return [
        'class_path' => $classAttrs[0]->newInstance()->path,
        'method_paths' => array_map(function($method) {
            return $method->getAttributes(Route::class)[0]->newInstance()->path;
        }, $reflection->getMethods())
    ];
}

2. 属性的组合使用

多个属性可以叠加使用，通过 ArrayIterator 的遍历实现组合逻辑：

#[Route("/api")]
#[Middleware("AuthMiddleware")]
class ApiController {}

$apiAttrs = ApiController::class->attributes();
foreach ($apiAttrs as $attr) {
    echo "属性类型：" . $attr->getName() . PHP_EOL;
}

五、实战案例：构建简易路由系统

案例需求

开发一个基于属性的路由匹配系统，要求：

支持类和方法级别的路由声明
自动解析路由参数
支持中间件配置

实现代码

// 路由属性定义
#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
class Route {
    public function __construct(public string $path) {}
}

// 路由解析器
class Router {
    public function dispatch(string $requestPath): void {
        $controller = $this->resolveController($requestPath);
        $method = $this->resolveMethod($controller, $requestPath);
        
        // 检查并执行中间件
        $this->executeMiddlewares($controller, $method);
        
        // 执行目标方法
        $method->invoke(new $controller);
    }
    
    private function resolveController(string $requestPath): string {
        // 省略控制器匹配逻辑
    }
    
    private function resolveMethod(string $controller, string $path): ReflectionMethod {
        // 省略方法匹配逻辑
    }
    
    private function executeMiddlewares($controller, $method): void {
        // 获取类和方法上的中间件属性
        $classAttrs = (new ReflectionClass($controller))->getAttributes(Middleware::class);
        $methodAttrs = $method->getAttributes(Middleware::class);
        
        foreach (array_merge($classAttrs, $methodAttrs) as $attr) {
            $middleware = $attr->newInstanceWithoutConstructor();
            $middleware->handle();
        }
    }
}

代码亮点解析

重复属性支持：通过 Attribute::IS_REPEATABLE 允许同一位置声明多个属性
反射组合查询：同时获取类与方法级别的中间件配置
动态实例化：使用 newInstanceWithoutConstructor 安全创建中间件实例

六、注意事项与常见问题

1. 属性继承的特殊处理

当使用 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_INHERITED)] 声明属性时，子类会自动继承父类属性。此时需注意：

class ParentController {
    #[Route("/parent")]
    protected function sharedAction() {}
}

class ChildController extends ParentController {
    // sharedAction 方法会继承父类的路由属性
}

2. 属性作用域的限制

属性只能附加到支持的代码元素上，例如不能直接附加到 if 语句或 foreach 循环等结构。尝试这样做会导致：

#[Route("/invalid")]
if ($condition) { // 此处属性无效，会触发 E_COMPILE_ERROR
    // ...
}

3. 与反射类的配合技巧

建议优先使用 ReflectionClass 和 ReflectionMethod 类来获取属性，因为它们提供了更完整的元数据访问接口：

$reflection = new ReflectionMethod(UserController::class, 'create');
$attributes = $reflection->getAttributes();

七、总结：PHP attributes() 函数的价值与未来

PHP attributes() 函数通过标准化的元数据访问机制，解决了传统注释解析的痛点，为现代 PHP 开发带来以下优势：

代码可维护性提升：属性定义与使用均通过类型安全的方式实现
框架集成友好：如 Laravel 已开始采用属性替代部分旧版语法
开发效率优化：通过组合属性可快速构建复杂配置系统

随着 PHP8.1 引入的 #[\Attribute] 简写语法和未来版本的持续优化，属性机制必将在 PHP 生态中扮演更重要的角色。建议开发者在构建新项目或重构现有代码时，积极采用这一现代特性，体验更优雅的元数据管理方式。

PHP attributes() 函数（建议收藏）

一、前言：PHP 属性的崛起与 attributes() 的诞生

二、基础用法：属性的定义与访问

1. 属性的定义方式

2. 使用 attributes() 获取属性

三、参数详解：深入理解 attributes() 的功能选项

参数说明表

参数使用场景分析

1. 控制继承属性的获取

2. 精确验证属性类型

四、高级应用：属性的动态特性与组合模式

1. 动态属性的构建

2. 属性的组合使用

五、实战案例：构建简易路由系统

案例需求

实现代码

代码亮点解析

六、注意事项与常见问题

1. 属性继承的特殊处理

2. 属性作用域的限制

3. 与反射类的配合技巧

七、总结：PHP attributes() 函数的价值与未来

最新发布

jQuery.each()方法（长文解析）

jQuery.extend()方法（长文解析）

jQuery.fn.extend()方法（千字长文）

jQuery.globalEval()方法（长文讲解）

jQuery.grep() 方法（长文讲解）

jQuery.inArray() 方法（长文讲解）

jQuery.isArray() 方法（手把手讲解）

jQuery.isEmptyObject() 方法（千字长文）

jQuery.isFunction() 方法（建议收藏）

jQuery.isNumeric() 方法（手把手讲解）