【PHP8.x】attributesプロパティの使い方

Copy
1<?php
2
3/**
4 *  PHP 8 以降の attributes と annotations の比較サンプルコード
5 */
6
7// PHP 8 Attributes (リフレクションで使用)
8#[ExampleAttribute('Some value')]
9class MyClass {
10    #[ExampleAttribute('Another value')]
11    public $myProperty;
12
13    #[ExampleAttribute('Method value')]
14    public function myMethod() {
15        // 処理
16    }
17}
18
19// Attribute の定義
20#[Attribute(Attribute::TARGET_ALL)] // どこに適用できるかを指定
21class ExampleAttribute {
22    public string $value;
23
24    public function __construct(string $value) {
25        $this->value = $value;
26    }
27}
28
29
30// リフレクションを使って Attribute の情報を取得
31$reflectionClass = new ReflectionClass(MyClass::class);
32
33// クラスの Attribute を取得
34$attributes = $reflectionClass->getAttributes(ExampleAttribute::class);
35foreach ($attributes as $attribute) {
36    $instance = $attribute->newInstance();
37    echo "Class Attribute Value: " . $instance->value . PHP_EOL;
38}
39
40// プロパティの Attribute を取得
41$reflectionProperty = $reflectionClass->getProperty('myProperty');
42$attributes = $reflectionProperty->getAttributes(ExampleAttribute::class);
43foreach ($attributes as $attribute) {
44    $instance = $attribute->newInstance();
45    echo "Property Attribute Value: " . $instance->value . PHP_EOL;
46}
47
48
49// メソッドの Attribute を取得
50$reflectionMethod = $reflectionClass->getMethod('myMethod');
51$attributes = $reflectionMethod->getAttributes(ExampleAttribute::class);
52foreach ($attributes as $attribute) {
53    $instance = $attribute->newInstance();
54    echo "Method Attribute Value: " . $instance->value . PHP_EOL;
55}
56
57
58// PHP 7 以前の Annotations (DocBlock コメントで記述、ライブラリが必要)
59/**
60 * @AnnotationExample("Legacy value")
61 */
62class LegacyClass {
63    /**
64     * @AnnotationExample("Legacy property value")
65     */
66    public $legacyProperty;
67
68    /**
69     * @AnnotationExample("Legacy method value")
70     */
71    public function legacyMethod() {
72        // 処理
73    }
74}
75
76//  PHP 7以前のAnnotationsの例：
77//  Annotationsを使用するには、Doctrine Annotationsなどのライブラリが必要です。
78//  この例はDoctrine Annotationsを使用していることを前提としています。
79
80use Doctrine\Common\Annotations\AnnotationReader;
81
82$reader = new AnnotationReader();
83$legacyReflectionClass = new ReflectionClass(LegacyClass::class);
84
85// クラスの Annotation を取得
86$legacyClassAnnotation = $reader->getClassAnnotation($legacyReflectionClass, 'AnnotationExample');
87
88// Annotation は ExampleAttribute クラスのようなクラスとして定義されていません。
89// そのため、Reflection APIで簡単に扱うことができません。
90// ライブラリごとのAPIを使う必要があります。
91// この例では AnnotationExample アノテーションが存在すると仮定していますが、
92// 実際にはライブラリで定義されている必要があります。

このサンプルコードは、PHP 8で導入されたAttributes（属性）と、PHP 7以前で用いられていたAnnotations（注釈）の比較を示しています。

PHP 8のAttributesは、クラス、プロパティ、メソッドなどの宣言にメタデータを付加する機能です。#[ExampleAttribute('Some value')]のように記述し、リフレクションAPIを通じて実行時に情報を取得できます。#[Attribute(Attribute::TARGET_ALL)]は、この属性がどこに適用可能かを指定しています。ReflectionClass::getAttributes()メソッドを使用することで、指定した属性のインスタンスを取得し、その値を参照できます。

一方、PHP 7以前のAnnotationsは、DocBlockコメントに@AnnotationExample("Legacy value")のように記述します。Annotationsの利用には、Doctrine Annotationsなどのライブラリが必要です。リフレクションAPIだけでは直接扱うことが難しく、ライブラリ固有のAPIを使用する必要があります。

AttributesはPHP 8以降で標準機能として提供され、リフレクションAPIとの連携が容易であるため、Annotationsよりも扱いやすくなっています。Attributesを利用することで、コードの可読性や保守性を向上させることができます。このサンプルコードは、Attributesの定義方法、適用方法、そしてリフレクションによる情報取得方法を具体的に示しています。システムエンジニアを目指す方は、Attributesの仕組みを理解し、積極的に活用することで、より高度なプログラミングスキルを習得できるでしょう。