Attributeを極める

Attributeを極める

増補版

Mastering Attributes

pixiv Inc.
USAMI Kenta

2022-03-25

お前誰よ

• うさみけんた (@tadsan) / Zonu.EXE / にゃんだーすわん
• ピクシブ株式会社 pixiv事業本部 エンジニア
  • 最近はピクシブ百科事典(dic.pixiv.net)を開発しています
• Emacs Lisper, PHPer
  • Emacs PHP Modeを開発しています (2017年-)
• プログラミング言語にちょっとこだわりのある素人

ゴランノスポンサー

先におことわり：
20分ではピクシブ百科事典の
事例紹介までたどりつけませんでした
(話はするけどあっさりめ)

さて

PHPのアップデートサイクル

• PHPは年に一回バージョンアップされている
  • https://www.php.net/supported-versions.php
  • 最新バージョンは2022年12月リリースの8.2.x系
• いわゆるセマンティックバージョニングではない
  • 8.2.0… MAJOR.MINOR.RELASEの3レベル構成
  • 影響の大きなBC BreakはMAJOR

PHP8.0で
変わったこと

すべての機能を
使えていますか？

その中でも存在感が
ありながら
｢何に使うの｣度が高い

ア ト リ ビ ュ ー ト

Attributes

実はPHPerKaigiでは

毎年なにかと
言及されている

アトリビュートってなんだ？

• 日本語での定訳としては「属性」
• もっとも知られているであろう用語としてはHTMLタグ
• あるもの(要素)の性質を表す情報のこと
• MDNではHTMLの属性について次のように説明している
  • 「属性は要素を拡張し、動作を変更したりメタデータを提供したりします。」
    Attribute (属性) - MDN Web Docs 用語集 より

<a href="?foo">

<a href="?foo">

属性名

<a href="?foo">

属性名 属性値

<a href="?foo">

属性名 属性 属性値

<a href="?foo">

要素名

<a href="?foo">

要素名 (開始)タグ

<a href="?foo">
text
</a>

<a>要素

今回はHTMLは 本題ではないので
ここまで

ソースコードにも
付加的な情報を
付与したい！

付加的な情報…
われわれは知っている

Docコメント

/**
* @param positive-int $id
*/
function Pnd(int $id): Book
{

コードに書きたい付加情報とは何か

人間だけわかれば

• 人間に意図を伝えるためのドキュメント(コメント)

ヨシ

人間もわかって
機械可読

• 静的解析ツールが情報を読み取ってコードを検査するための情報
• 実行時に可読で
  フレームワークなどが情報を読み取って振る舞いを制御する

効率高いとうれしい

• プログラミング処理系(PHP)に特別な処理をさせるための指定

構文の一部である
必要がある

コードに書きたい付加情報とは何か

人間だけわかれば

• 人間に意図を伝えるためのドキュメント(コメント)

ヨシ

人間もわかって
機械可読

• 従来Docコメントが賄っていた領域
  静的解析ツールが情報を読み取ってコードを検査するための情報
• 実行時に可読で
  フレームワークなどが情報を読み取って振る舞いを制御する

効率高いとうれしい

• プログラミング処理系(PHP)に特別な処理をさせるための指定

構文の一部である
必要がある

DocCommentは自由帳

• 事実上、なんでも書ける
• なにを書いても怒られないが、@hogeのような形式が一般的
• phpDocumenterスタイルの「タグ」
  • @param int $foo (スペース区切り)
• Doctrineスタイルの「アノテーション」
  • @Annotation("arg", 1, 2, 3)

なぜDocコメント…

改めてDocコメント

実行時に読める不思議なコメント

• 関数やクラスなどの直前に /** ... */ のような形式でコメントを書くと、
  リ フ レ ク シ ョ ン
  ReXectionという機能を使って読み取れる
  • Re:ection::getComment() で文字列で取得できる
• 実行時とかにいい感じに情報を読み取って処理をしてやるとメタプログラミ
  ングが実現できる

メタ？

さっきも出てきた

アトリビュートってなんだ？

• 日本語での定訳としては「属性」
• もっとも知られているであろう用語としてはHTMLタグ
• あるもの(要素)の性質を表す情報のこと
• MDNではHTMLの属性について次のように説明している
  • 「属性は要素を拡張し、動作を変更したりメタデータを提供したりします。」
    Attribute (属性) - MDN Web Docs 用語集 より

Wikipedia曰く

https://ja.wikipedia.org/wiki/メタ
2022-12-14T19:41:26版より

https://ja.wikipedia.org/wiki/メタ
2022-12-14T19:41:26版より

つまり？

メタデータ
データについてのデータ

例：
写真 に対する
(画像データ)
｢撮影場所｣や｢日時｣などの
情報

例：
楽曲 に対する
(音声データ)
｢演奏者｣や｢ジャンル｣など
の情報

メタプログラミング プログラムについての
プログラミング

メタプログラミングってつまり何

• プログラムそのものを対象にするプログラミング
  • クラスや関数などを動的に呼び出したり
  • ある処理をしたいとき、コードに直接的に書かなくても実現したりできる
  • 明示的に定義してなくてもなんか動いてたりするやつ
• フレームワークのようなコードは大なり小なりメタプロ的な要素がある
• ブラックマジック
  理窟がよくわからんけど動いてたりするのはこれ (魔法とか黒魔術とか…)

メタプロするなら コードから情報を
読み取れるとうれしい

(それが全てではない)

ということで

基本的な定義方法

use Attribute;

#[Attribute(
Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE
)]
class MyAttr {

基本的な使いかた

use MyAttr;

#[MyAttr('foo', 'bar', 'buz')]
class Book
{

名前付きの呼び出しも可能

use MyAttr;

#[MyAttr(a: 'foo', b: 'bar', c: 'buz')]
class Book
{

Attributeはどこに書けるの？

• 現在Re:ectionから読み取れるのは6箇所

宣伝

• クラス
• 関数
• メソッド
• プロパティ
• パラメータ (仮引数)

これでみなさまは
Attributeを定義でき
るようになりました

ね、簡単でしょ？

Docコメントと
何が違うの？

比べてみよう

実行時に読める不思議なコメント

• 関数やクラスなどの直前に /** ... */ のような形式でコメントを書くと、
  リ フ レ ク シ ョ ン
  ReXectionという機能を使って読み取れる
  • Re:ection::getComment() で文字列で取得できる
• 実行時とかにいい感じに情報を読み取って処理をしてやるとメタプログラミ
  ングが実現できる

実行時に読める不思議なXXXX

• 関数やクラスなどの直前に #[Attr()] のような形式のコードを書くと、
  リ フ レ ク シ ョ ン
  ReXectionという機能を使って読み取れる
  • Re:ection::getAttributes() でRe:ectionAttributeを取得できる
• 実行時とかにいい感じに情報を読み取って処理をしてやるとメタプログラミ
  ングが実現できる

Q. 何が違うの？

A. 違うよ､全然違うよ

実際に見てみましょう

ReflectionAttribute

• getAttributes() メソッドでとれるクラス
  • $ref = new Re:ectionClass(Target::class);
  • $ref->getArguments() で値だけ取れる
  • $ref->newInstance() でアトリビュートをインスタンス化できる

何が変わったのか

• 明示的にRe:ectionしないと何も起こらないのはDocコメントと同じ
  • Attributeを書くだけなら、ただのコメントと同じ
• 引数の区切りがとても簡単
  • Docコメントでは自前で構文解析しないといけない
• 静的解析ツールが自然にサポートしてくれている
  • Docコメントでは変な記述をしても気付きにくい

これでAttributeの
機能は全部です！

完全マスター

🎉

機能はめっちゃ
シンプル

あとはどういう
｢想い｣を載せるか

創意工夫が大事

とはいえ定石はある

DI vs Attribute

• 山岡さんの2021年の発表で紹介された事例
• 依存性注入したいデータを明示するために使う

DB vs Attribute

• おかしょいさんの2022年の発表で紹介された事例
• データベースとPHPのクラスのプロパティを紐付けるために使う

バリデーション vs Attribute

• 2022年11月に私が書いた記事
• アトリビュートは自然に発火しないので明示的に呼び出す必要がある

PHPUnit vs Docコメント

• PHPUnitはこれまでDocコメントによってテストの実行を制御できた
  • @dataProvider, @testWith … パラメタライズドテスト
  • @runInSeparateProcess, @runTestsInSeparateProcess
    … プロセスを隔離して実行
  • @covers … カバレッジターゲットの制御
  • @group … テストグループの宣言
• Doctrine式のAnnotationではなくスペース区切りが多かった

PHPUnit 10 vs Attribute

• PHPUnit 10でAttributeに移行、11で非推奨化、12で削除予定
• 超大量の移行リスト… sebastianbergmann/phpunit#4502
• その他の変更は02氏の
  発表を参照のこと

明示 vs 黙示

「こっそりやる」vs「堂々とやる」

• PHPにはマクロやプリプロセッサがないので、明示的が基本ではある
• しかし、クラスローダーを悪用してソースコードを書き換えてしまう荒技も
  • Go! AOPなどのAOPフレームワークはクラスローダーでフックする

PHPの後方互換性 vs Attribute

• PHPでは継承するときに型宣言を厳密に合わせないといけない
• PHP 8ではPHPの組み込みクラスにも型宣言が追加された
• そうするとPHP 7/8両対応のライブラリで非常に困る
• #[ReturnTypeWillChange] と書くと局所的に無視できるようになった
  • 問題の先送りができてうれしい！

ひっそり佇むAttribute

• そこにあるだけでは何も起こさないというのは重要な性質
• # はPHPのコメント行なので、PHP 7以下のコードに書いても問題ない
• ということは… PHP 7以下でもパフォーマンスを気にしなければ
  Attributeを使える
  • spiral/attributes というライブラリがある
  • 開発用途やデプロイスクリプトなどで使う分には問題にならない

doctrine/annotations

• Docコメントのアノテーションを読み取るライブラリ
• Attributeとだいたい同じ使い方できるが仕様が微妙に異なる
  • デフォルトでは引数は __construct(array $values) として
    一個の配列にまとめて渡されてしまう
  • クラスに @Annotation @namedArgumentConstructor と書くと
    Attributeと同様に個別のパラメータで受け取れるようになる

spiral/attributesの互換性

• PHP 7で利用できるAttributeを読み取るライブラリ
  • AnnotationとAttributeを相互運用できる
    • doctorine/annotationsのラッパーとしてPHPDocも読める
  • Annotationとの相互運用のためか、デフォルトでは引数がまとめて
    __construct(array $values) に渡されてしまう
    • クラスに #[Spiral Attributes NamedArgumentConstructor]と

\ \

書くと通常のAttributeと同じ仕様で使える

ピクシブ百科事典 vs Attribute

• コントローラにルーティング情報が書ける
• これは実行時に読まず、スクリプトでファイルに書き出す方式

キミだけの最高の
ユースケースを
見付けだせ