Perlにおける動的なモジュールロードのメリットとデメリット

Perlにおける動的なモジュールロードのメリットとデメリット YAPC::Nagoya::Tiny @_ybrliiu

自己紹介 • id: mp0liiu / @_ybrliiu • 所属 : 株式会社モバイルファクトリー
• 新卒2年目(23歳) • Perl歴約7年 • 最近はソフトウェアアーキテクチャとか型に関心があります ◦ https://github.com/ybrliiu/p5-Types-TypedCodeRef

Perlの好きなところ • TMTOWTDI • 特にオブジェクト指向の実現方法がいろいろあるところ ◦ Any reference base class,
Inside-out class, いろんなクラスビルダー, etc... • 最近Perlコアにオブジェクト指向の構文を入れようという提案がでていたりしていてテンションが上っています

よろしくお願いいたします！！！

なぜこの発表をしようと思ったのか • これまで趣味 + お仕事で動的なモジュールロードを行うコードをカジュアルに書いてきました • そのようなコードを運用していると、後から辛くなってくることが多かったので、なぜそうなっているのかを整理し、どうすれば改善できるのかを考えました
• http://mp0liiu.hatenablog.com/entry/2019/02/28/111424

次のようなコードがありました • とあるソーシャルゲームのコード • アイテムを使用すると、アイテムの種類に応じて効果が発動する • アイテムのデータはDBで管理されている

エンジニアA 「いちいちアイテム効果クラスを1つ1つuseしてアイテムの種類と対応させるコードを書くのめんどくさいなー」エンジニアA 「せや！アイテムデータの種類を見て正規表現でいい感じのアイテムクラス名を作ってそれをロードするようにするんや！」エンジニアA 「よし！簡潔に書けていいな！」

数カ月後・・・

新しい効果をもつアイテムを追加することになりました

エンジニアB 「新しいアイテムのデータも追加したしアイテムの効果も実装するか」エンジニアB 「とりあえず他のアイテムのクラスを真似て作ろう」エンジニアB 「クラス名はなんてすればいいんだ？ grepしてもアイテム効果クラスが使われている場所が見つからないぞ?」

今回の発表で伝えたいこと • 動的なモジュールロードは柔軟性がありすぎるので下手な使い方をすると保守性が下がってしまう ◦ 静的なモジュールロードを行う方法でできないか検討しよう ◦ 動的なモジュールロードをする方が合理的なら保守性が下がらないように工夫しよう

今日話すこと • 静的なモジュールロードと動的なモジュールロードについて • 動的なモジュールロードのメリット • 動的なモジュールロードのデメリット • 保守性を下げないようにするには

静的なモジュールロード • コンパイルフェーズで行うモジュールロードのこと • 通常は use でロード • ロードするタイミングやロードするモジュールに制約がかかる ◦
少なくともランタイムが開始する前にどんなモジュールがロードされるかが定まるようになっていないけない

動的なモジュールロード • ランタイムで行うモジュールロードのこと • ロードするタイミングやモジュールを好きなように決められる • 言語組み込みの機能で行うのなら require でのモジュールロード ◦
ロードするモジュールを動的に決めたいなら eval “require ...” • 通常は Module::Load, Class::Load などといったモジュールローダーを利用してロード

動的なモジュールロード • use する場合と挙動が違うところがあるので注意 ◦ import は自動的に呼ばれない ◦ CHECK, INITブロックに書かれたコードが実行されない

動的なモジュールロードを行うことによるメリットあるいはどのようなときに動的なモジュールロードを行いたくなるのか

コード量が少なくなる

for, while 文などでまとめてロードすればコード量が減る

Module::Find を利用すると、ある名前空間の下に属するモジュールをすべて読み込むことができる

Catalyst 風のモジュールローダーを利用する • useしなくてもモジュールを使える、use忘れがなくなる • パッケージ名を短く書ける

プラガブルなモジュールを簡単に作れる

モジュールに新たなメソッドを追加したりやモンキーパッチを当てれるようにしたい場合 (Tengのようなケース)

与えられたものを読み取って何かするようなモジュールに、ルールを追加していける構造にしたい (Perl::Critic のようなケース)

動的にディスパッチできる • 利用するモジュールを動的にディスパッチできる • プログラムの外部で管理されていたり、外部から受け付ける入力に応じて処理を分岐させたい場合に非常に便利 ◦ 項目が多いマスタデータの種類に応じて ◦ HTTPリクエストの内容に応じて

動的にディスパッチできる

起動 / ロードにかかる時間の短縮 • モジュールをロードするタイミングをモジュール内のコードを実行する直前にまで遅らせることで、アプリケーションの起動やモジュールのロードにかかる時間を短くすることができる ◦ 当然その分実行時に短くした分の時間がかかる •
高速化を意識しているCPANモジュールや巨大なアプリケーションでよく見かける ◦ Moo, Type::Tiny, Class::Accessor::Lite, etc...

依存関係を動的に解決できる • 依存関係を動的に解決できる ◦ 条件に応じて依存モジュールを変更できる ◦ モジュールが相互に依存しても警告が発生しない • モジュールロードに失敗した場合の処理が書ける

動的なモジュールロードを行うことによるデメリット開発体験にどのような悪影響がでるのか

可読性が下がる • 動的にロードするモジュール名を組み立てていると発生する問題 • 特に動的にモジュールロードされていることを知らない人がコードを読むと、どこで何のモジュールが使われているのかがわかりにくい ◦ 特に正規表現でモジュール名を作ったりしていると非常に厳しい

可読性が下がる • 本質的には greppability の話 ◦ 調べたいコードが検索しにくい状態になってしまう ◦ 動的にシンボルを組み立てているとコードが検索しにくくて機械も人間も辛い思いをする
◦ 静的解析を利用したツールの恩恵を授かれない恐れも

良くない設計の原因になる • どこでモジュールがロードがされるかわかりにくくなるので、注意しないと混沌とした依存関係や構造ができあがる • モジュールの先頭で依存しているモジュールがまとめて use されている方が依存関係はわかりやすい •
依存関係が循環しているモジュールがあっても警告がでない

実際にロードされるまで動くかわからない • 依存しているモジュールがエラーなどで動かなくなっていても、実際にコードが動くまでわからない • しっかりテストが書かれていたり、 Test::UseAllModules::all_use_ok みたいなテストが用意されているならそんなに問題にはならない •
またリッチな機能をもつエディタなら Syntax Error とかにも気づきやすい

つまり、むやみに動的なモジュールロードを行うと保守性が下がる

静的にモジュールロードする場合、柔軟性がない分保守性が下がるような書き方をしにくい

なるべく静的にモジュールロードしたい

動的なモジュールロードを行うほうが合理的なときは、なるべく保守性が下がらないようにしたい

どうするか

コード量を減らしたいとき

パッケージ名が長すぎるモジュールローダーの代わりに定数や aliased でパッケージ名のエイリアスを作る

use 忘れを防ぎたい • 現状代替案は知りません・・・ • いい方法を知っている方がいれば教えて下さい！ • 理想を言えば他の言語みたいにエディタやIDEの機能でパッケージを利用していたら自動でuseできるようになってほしい •
うたがわさんが便利そうなプラグインを作られていました ◦ 開発体験良くなりそうですね

まとめてロードしたい • 普通にuseする方法では不可能 • そもそもたくさんのモジュールをロードしたいケースは頻繁にあるのか? ◦ 拡張性を重視する構造でなければ、責務が大きくなりすぎている可能性がある ◦
その場合はモジュールを分割すべき

まとめてロードしたい • 拡張性を重視していたり、useを延々と書き続けるのが現実的ではない場合は動的にロードすべき • ただし保守性が低下しないように工夫する ◦ まとめすぎない (Module::Find::useall()) ◦
動的にパッケージ名を組み立てない ◦ Test::UseAllModules などを利用してコンパイルフェーズでエラーが起きないかをテストするようにする

プラグイン機構を実装したい時 • 手間がかかるが、プラグインオブジェクトを外でuseして作って渡すこともできる • フレームワークだったりプラガブルにしたい場合は動的にロードするのもよい • プロダクトのコード、特にビジネスロジックなどではプラガブルな構造を用意するのはやり過ぎなケースが多い
◦ 基本的に保守性を重視して静的にロードする

モジュールに新たなメソッドを追加したりやモンキーパッチを当てれるようにしたい場合 (Tengのようなケース)

動的にディスパッチしたい時 • 利用しうるモジュールは全て事前にロードしておき、外部からの値に応じて利用するモジュールを分けるような対応表を書くことで対応できる ◦ 数が多いなら対応表を自動生成する仕組みをつくるという手も • 工数、拡張性と保守性のトレードオフになるので状況に応じて判断 •
利用するパッケージ名を難しい正規表現とかで作っている場合は読みにくくなるので対応表をちゃんと書くべき

動的にディスパッチしたい時

起動 / ロードにかかる時間の短縮 • 起動やロードにかかる時間を短縮したい場合は動的にロードするしかない • 保守性との引き換えになることを念頭に置いた上で、なるべく保守性がおちないように工夫する ◦
良くない設計になってしまわないように注意を払う ◦ 動的にパッケージ名を組み立てない ◦ Test::UseAllModules などを利用してテストする

依存関係を動的に解決したい • 条件が実行する前に決まるなら if プラグマを利用したり、importや BEGIN句の中で頑張って静的にロードさせるようにすることができる • 依存関係が循環しているような場合は結合度が高く、設計としてよくない状態になっているので設計を修正する

まとめ

まとめ • 動的なモジュールロードは下手な使い方をすると保守性が下がってしまう ◦ 静的なモジュールロードを行う方法でできないか検討しよう ◦ 動的なモジュールロードをする方が合理的なら保守性が下がらないように工夫しよう

ご清聴ありがとうございました

Perlにおける動的なモジュールロードのメリットとデメリット

Perlにおける動的なモジュールロードのメリットとデメリット

More Decks by ybrliiu

Other Decks in Technology

Featured

Transcript