Yii2でブログシステムを作ってみた

Tunnelでインターンをしている松永です。
今回はこの『RoomClip開発者ブログ』を開発した話をします。

Yii2フレームワーク

タイトルにもある通り、このブログはYii2というフレームワークを用いて一から実装されています。ちなみにRoomClipの開発に使用されているのはCodeIgniterです。

Yii2はPHPのMVCフレームワークのひとつで、高速であることやセキュアであることを売りにしているようです(他のフレームワークがそうでないかというと、そんなこともないと思いますが)。 実際に使ってみると、キャッシュを簡単に使用できたりCodeceptionでのテストをサポートしていたりと非常に開発をしやすい印象を受けました。サービスの規模に応じての拡張が容易であることも魅力的でした。

このYii2にはGiiというコード生成を行うためのExtensionがあり、これを用いるとDBテーブルに紐付いたモデルクラスやCRUDコードなどをGUIを通して生成することができます。また、テーブル構造の変更を考慮してクエリなどは生成したモデルクラスを継承したクラスに記述をしています。

Yii2についてのより詳細な説明はこちらを参照してください。

開発

既存のコードに変更を加えたり機能を追加することはありましたが、ほぼ何もない状態からWebアプリケーションの開発を行うのは僕にとって初めての経験でした。 知識が足りないことも多く、細かなソフトウェア設計には頭を悩まされましたが、他のエンジニアに助けてもらいつつ実装を進めていきました。

コーディング規約は基本的にYii2のコードに合わせるように定めました。Giiでコードを生成するとDBのカラム名と生成される変数名が同じになるため、カラム名もキャメルケースで統一しています。

モデルクラス内のクエリ文はできるだけcreateCommandを使用して書きたいという思いがあったのですが、そのままだと目的のクラスのオブジェクトではなく連想配列として値が返ってきてしまいます。また、数値を期待していてもクエリを通すと文字列として返ってくるため型のチェックと変換を行いたいです。

そこで、以下のようなtraitを作成し、モデルクラスに与えることでこの2つの問題を解決しました。

このコードではreadObjectで連想配列をクラスで包み、モデルクラスのValidatorを利用して型の変換を行っています。このValidatorはGiiでのコード生成時にテーブル構造から読み込まれるものなので、別途型情報を付与する必要はほぼありません。

実際に使用する際は以下のようにしています。

高速化

ある程度の形が出来上がったら、高速化をする段階に入りました。

ここではレスポンスタイムの確認にNew Relicを使用し、PHPの関数ごとにどれくらいの時間がかかっているかを見ます。どのようなクエリを何回叩いているかなども表示してくれるので、キャッシュの仕方を決めるのに非常に役に立ちました。

Yii2には、FileCache / Redis / Memcachedなどを扱うためのクラスがあらかじめ用意されており、Configで切り替えることが可能です。このConfigはすべてのアクセスの受け皿となるEntry Script内でyii\web\Applicationオブジェクトの作成時に渡されるので、このオブジェクトを通していつでもキャッシュにアクセスすることができます。この技術ブログではRedisを使用しました。

テスト

RoomClipの開発でテストを走らせることはしていなかったので、この機会にテストのコードを書くことにも挑戦をしました。テストにはCodeceptionというテストフレームワークを使用しており、これはYii2がサポートしているため簡単に導入することができました。また、Fakerというツールを使用してFixtureのためのテストケースを生成しています。
現在はcronで定時にユニットテストを走らせてSlackにログファイルをアップロードするようになっています。コミット時にフックさせられると良いかもしれません。

もちろんテストをすることでバグを発見する手助けになるわけですが、テストコードを書くこと自体も思ったより負担になりそうです。実際に運用をする際には、どれだけ手軽にテストができるかが重要になりそうですね。

完成

ざっくりではありますが、このようにして技術ブログが完成しました。
ブログシステムを一から作れることは自分にとって良い経験でしたし、メインのサービスとは切り離されているので新しいことをやるのにはとても都合の良い場でした。
これからエンジニア・デザイナー・セールス含め、多くの記事が追加されていくと思いますので、興味を持っていただけたらと思います。

今後も『RoomClip開発者ブログ』をよろしくお願いします。