add to hatena

hatena.comment

add to del.icio.us

add to livedoor.clip

add to Yahoo!Bookmark

(0) Total: 0

DAY4: リファクタリング

おさらい

さて、askeet1.2チュートリアルも4日目です。本家のチュートリアルに沿ってきていますので今日もそうしましょう。
本家では今日はりファクタリングのチュートリアルとなっていますが、まとめると以下のような内容です。

* 回答の一覧を表示
* アクション、テンプレートの編集
* テストデータをバッチで投入
* モデルの修正
* ルーティングの設定

かなりのボリュームです。さぁ、がんばりましょう。

質問への回答一覧を表示する

3日目でQuestionのCRUDをコマンドから作りました。そこで、以下のようなURLで指定された質問IDの内容を表示できるようにしてみましょう。

http://symfony.centos5.localhost/askeet/frontend_dev.php/question/show/id/2

すでにアクションは自動生成されていますので、再作成されたアクションファイル(./app/frontend/module/question/actions/actions.class.php)

PHP:

public function executeShow($request)
{
$this->question = $this->getQuestionById($request->getParameter('id'));
$this->forward404Unless($this->question);
}

ref: 本家チュートリアル4日目

本家のチュートリアルと異なる点があります。
まず１つはデータの取得方法の呼び出し方が異なります。これはPropelとDoctrineでの記述の違いがあるからです。
ただし、処理していることは同じです。データベースから指定したIDの質問内容を取得しているだけです。

Doctrineのドキュメントは有志の方々により日本語で公開されています。かなりの量になりますが、一通り目をとおしておくことをオススメします。

ref: http://www.doctrine-project.org/documentation

もう１つの違いはメソッドの引数に$requestが存在することです。
いままでは$request = $this->getRequest() とする必要がありましたが、アクションはパラメータをモデル等への受け渡しがメインの処理のため
常に引数として渡されるようになったのです。明確になったというところでしょうか。

またこのメソッドの中の$request->getParameter('id')という表現がでてきます。
これはURLにスラッシュ区切りでkeyとvalueを含めることで、スマートなURLを表現していて、上記URLでは `?id=2`というクエリストリングと同意です。

このような表現はsymfonyでは必ずでてきますので覚えておきましょう。

また、どのようなパラメータが利用できるのか全てを見たい場合は、デバッグツールバーで確認するか、

PHP:

$request->getParameterHolder()->getAll();

で全てのリクエストパラメータを確認することができます。覚えておくとデバッグのとき役に立つので覚えておくと便利です。

もう一つforward404unlessメソッドが利用されています。これはunless(ifの反対「〜でなければ」と置き換えると解りやすいです)の場合に404ページを表示させるif構文と画面遷移の両方をまとめたようなメソッドです。
今回では「$this->questionが存在しなければ404ページを表示する」というメソッドということです。

showSuccess.phpテンプレートを修正

次にテンプレートを修正します。まずここで覚えておくルールはアクションで$this->XXXでアサインしたメンバ変数はテンプレートで$XXXで利用できるというルールがあるということです。
なので、今回のテンプレートでは$questionが利用できるということになります。

また、呼び出されるテンプレートは特に指定しなければ「アクション名Success.php」となります。
Successというのは「正常に処理されました」という意味だとでも思っておいてください。

他にもErrorや好きな名前をつけることができるのですが、symfony1.2からはSuccessを使うことがほとんどだと思います。

では、さっそくテンプレートを本家と同じく以下の内奥で置き換えてみましょう

PHP:

<?php use_helper('Date') ?>
<div class="interested_block">
<div class="interested_mark" id="mark_<?php echo $question->getId() ?>">
<?php echo count($question->getInterest()) ?>
</div>
</div>
<h2><?php echo $question->getTitle() ?></h2>
<div class="question_body">
<?php echo $question->getBody() ?>
</div>
<div id="answers">
<?php foreach ($question->getAnswer() as $answer): ?>
<div class="answer">
posted by <?php echo $answer->getUser()->getFirstName().' '.$answer->getUser()->getLastName() ?>
on <?php echo format_date($answer->getCreatedAt(), 'p') ?>
<div>
<?php echo $answer->getBody() ?>
</div>
</div>
<?php endforeach; ?>
</div>

３日目のときと同じで、Doctrineを使っているため、リレーション先の取得方法が$question->getInterest()、$question->getAnser()と単数系になっていることにさえ注意すれば大丈夫です。
あとは、回答データがないので、回答のサンプルデータをymlで作成し投入します。

CSS:

Answer:
a1_q1:
Question: q1
User: francois
body: |
You can try to read her poetry. Chicks love that kind of things.
a2_q1:
Question: q1
User: fabien
body: |
Don't bring her to a donuts shop. Ever. Girls don't like to be
seen eating with their fingers - although it's nice.
a3_q2:
Question: q2
User: fabien
body: |
The answer is in the question: buy her a step, so she can
get some exercise and be grateful for the weight she will
lose.
a4_q3:
Question: q3
User: fabien
body: |
Build it with symfony - and people will love it.

本家サンプルとの違いは外部キーを参照しているカラム名にモデル名(Question, User)を指定することです。これは３日目と同じですね。
そして、タスクコマンドで再取り込みを行いたいのですがここで問題があります。

それは、doctrine:data-loadタスクはテーブルのデータを削除しようとすることです。しかもリレーションの定義を考慮せず削除しようとするため
場合によっては削除時にエラーで処理が中断してしまいます。

そのため、前日にように単純にdoctrine:data-loadを使用してもデータを読み込めません。残念な結果です。

タスクはとても便利なのですが、このように意図した通りに動かない場合も多々ありますので、今回のように削除できないことが原因と解っているのであれば、
drop tableするSQLを別途用意し、あらかじめ読み込ませるほうが早かったりします。

というわけで、今回は以下のようなSQLを用意しました。

./data/sql/drop.sql

SQL:

DROP TABLE IF EXISTS ask_interest;
DROP TABLE IF EXISTS ask_relevancy;
DROP TABLE IF EXISTS ask_answer;
DROP TABLE IF EXISTS ask_question;
DROP TABLE IF EXISTS ask_user;

これを最初に読み込み、以前作成したテーブル作成用のクエリを実行してからdata-loadを実行します。

また、テーブルをdropしたあとはcreateが必要になりますが、ここでテーブルをリストアする方法についてもう１パターンから行ってみます。
２日目で、create.sqlというファイルをphpMyAdminから作成し、そこからテーブルを作成しました。
今回もテーブル構造に変更はないので、そのまま読み込ませても問題ありません。

しかし、すでにモデルのためのスキーマも用意できていますし、スキーマファイルに基づいたテーブルを作成したい場合もあります。
その場合はdoctrine:build-sqlで既存モデルからテーブルのcreate文を作成してくれますのでそれを利用します。
今回はこのパターンでテーブルをリストアしてみます。

* テーブルを削除する

$ mysql -uyourname -p askeet < ./data/sql/drop.sql
Enter password:

* モデルからテーブルのCreate文を作成する

$ ./symfony doctrine:build-sql
>> doctrine generating sql for models

* 作成したSQLを読み込む

$ mysql -uyourname -p askeet < ./data/sql/schema.sql
Enter password:

* テストデータを再投入

$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

すると、ここでエラーが発生します。

$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

Invalid fixture element "User" under "a1_q1"

すいません。phpMyAdminでテーブル定義したときにask_answerテーブルのuse_idに対してリレーションを作成するのを忘れていました。
そのためリレーションが判断できずに不明のカラムとして処理されエラーとなってしまいます。

対処方法として、以下の２パターンがあります。
テーブルを直接修正するか、それともスキーマファイルを修正する方法です。

今回はモデル名と実際のテーブル名がprefixをつけているため異なります。
つまり、テーブルを直接修正し、スキーマファイルを再作成した後に、さらにスキーマファイルにも修正が必要になります。
これはちょっと面倒ですよね。

なので、ここではスキーマファイルを修正し、そのスキーマファイルからテーブルの再作成、モデルの再作成を行います。

* スキーマファイルの修正
./config/doctrine/schema.yml

CSS:

relations:
Question:
local: question_id
foreign: id
type: one
User:
local: user_id
foreign: id
type: one

User:部分を追加します。後は、モデルとSQLを再作成し、
さきほどと同じ処理をおこないます。

* モデルの再作成

$ ./symfony doctrine:build-model
>> doctrine generating model classes

* テーブルのCreate文の作成

$ ./symfony doctrine:build-sql
>> doctrine generating sql for models

* 再度実行

$ mysql -uyourname -p askeet < ./data/sql/drop.sql
Enter password:
$ ./symfony doctrine:build-sql
>> doctrine generating sql for models
$ mysql -uyourname -p askeet < ./data/sql/schema.sql
Enter password:
$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

最後にモデルに修正を加えたのでキャッシュをクリアしておきます。

$ ./symfony cc

あとはもう一度画面をみてみます。

http://symfony.centos5.localhost/askeet/frontend_dev.php/question/show/id/1

投入した回答データが表示されていればOKです。

モデルの修正　その1

ではようやく、本日の課題であるリファクタリングを行っていきます。
PHP5ではオブジェクトそのものをechoした場合にマジックメソッドとして__toString()が呼ばれます。
それを上手に利用すればすっきりしたコードになります。

まずはUserモデルクラスに対して以下のようにメソッドを追加します。

* lib/model/doctrine/User.class.php

PHP:

public function __toString()
{
return sprintf("%s %s", $this->getFirstName(), $this->getLastName());
}

そして、テンプレート側の呼び出し方をオブジェクトをechoするようにします。

app/frontend/modules/question/templates/showSuccess.php

PHP:

posted by <?php echo $answer->getUser() ?>

すっきりしましたね！

同じ事を繰り返さない(DRY)

異なる画面でも表示する内容が同じ場合というのはよくあることです。そのような場合にテンプレートを部品化し、
それを読み込むようにすれば共通化できますよね。これがD.R.y(Don't Repeat Yourself)です。

symfonyでは部品化の方法としてパーシャル(partial)、コンポーネント(component)があります。
これらの違いは単純なテンプレート(partial)か、ロジックが含むちょっとややこしいテンプレート(component)です。

ここでは、パーシャルを用いてinterestモデルを利用しているところがshow,list両方で利用されているので共通化しておきます。

まず、パーシャルテンプレートを用意します。部品化されたテンプレートはアンダーバーで始まるファイル名にします。
ここでは_interested_user.phpとします。
* ./apps/frontend/modules/question/templates/_interested_user.php

PHP:

<div class="interested_mark" id="mark_<?php echo $question->getId() ?>">
<?php echo count($question->getInterest()) ?>
</div>

そして、このテンプレートを呼び出すように呼び出しもとのテンプレートを修正します。

* ./app/frontend/module/question/templates/showSuccess.php

PHP:

<div class="interested_block">
<?php include_partial('_interested_user', array('question' => $question)) ?>
</div>

* ./app/frontend/module/question/templates/indexSuccess.php

PHP:

<?php use_helper('Text') ?>
<?php foreach($questionList as $question): ?>
<div class="interested_block">
<?php echo include_partial('interested_user', array('question' => $question)) ?>
</div>
<h2><?php echo link_to($question->getTitle(), 'question/show?id='.$question->getId()) ?></h2>
<div class="question_body">
<?php echo truncate_text($question->getBody(), 200) ?>
</div>
<?php endforeach ?>

モデルの修正その2

interestをcountしている箇所があったのを覚えていますか？
あれはリレーションで定義した外部テーブルのデータがオブジェクトとして取得したものをカウントしているのですが、
コストを考えると、既にカウントしたデータをinterested_usersカラムに入れておくほうが良いですよね。

というわけで、本家と同じ処理をおこないます。

interested_usersカラムを追加する

ask_questionテーブルに追加します。
型はintegerでデフォルトは0です。

./config/doctrine/schema.yml

CSS:

interested_users:
type: integer(4)
unsigned: 1
default: 0

今日のはじめに定義忘れで再構築したので手順の説明は省きます。

$ ./symfony doctrine:build-model
$ mysql -uyourname -p askeet < ./data/sql/drop.sql
Enter password:
$ ./symfony doctrine:build-sql
>> doctrine generating sql for models
$ mysql -uyourname -p askeet < ./data/sql/schema.sql
Enter password:
$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

次に、Interestモデルにカウントアップするための処理を追加します。
本家とちがいこのチュートリアルはDoctrineのため異なります。

Propelよりも簡単で以下のようにするだけです。

./lib/model/doctrine/Interest.class.php

PHP:

public function preSave($event)
{
$question = $this->getQuestion();
$question->interested_users++;
$question->save();
}

もともとsaveメソッドが走る前にフックできるようにpreSaveメソッドが用意されているのでこれを利用してカウントアップを行っています。
あとは、パーシャルテンプレートを修正するだけです。

./app/frontend/modules/question/templates/_interested_user.php

PHP:

<?php echo $question->getInterestedUsers() ?>

また、本家ではトランザクション処理についても書かれていますが、ここではDoctrineの場合の例だけをのせておきます。実装はしていません。

PHP:

$con = Doctrine_Manager::connection();
try {
$conn->beginTransaction();
// 処理
$conn->commit();
} catch(Doctrine_Exception $e) {
$conn->rollback();
}

次に、回答テーブルに関連性(Relevancy)のupとdownをカウントするカラムを追加します。
型はintegererでデフォルトは0です

./config/doctrine/schema.yml

CSS:

Answer:
....
relevancy_up:
type: integer(4)
default: 0
relevancy_down:
type: integer(4)
default: 0

そして、モデルとテーブルを再生成します。

$ ./symfony doctrine:build-model
$ ./symfony doctrine:build-sql
$ mysql -uyourname -p askeet < ./data/sql/drop.sql
Enter password:
$ mysql -uyourname -p askeet < ./data/sql/schema.sql
Enter password:
$ ./symfony doctrine:data-load --dir="data/fixtures/test"
>> doctrine loading data fixtures from "Array"

これらのカウント処理をRelevancyモデルに実装します。
今度はトランザクションも入れてみます。

本家とほぼ同じで、異なる部分はDoctrineで処理するための違いです。

./lib/model/doctrine/Relevancy.class.php

PHP:

public function preSave($event)
{
$con = Doctrine_Manager::connection();
try {
$con->beginTransaction();
$answer = $this->getAnswer();
if ($this->getScore() == 1) {
$answer->relevancy_up++;
} else {
$answer->relevancy_down++;
}
$answer->save();
$con->commit();
} catch (Doctrine_Exception $e) {
$con->rollback();
}
}

./lib/model/doctrine/Answer.class.php

PHP:

public function getRelevancyUpPercent()
{
$total = $this->getRelevancyUp() + $this->getRelevancyDown();
return $total ? sprintf('%.0f', $this->getRelevancyUp() * 100 / $total) : 0;
}
public function getRelevancyDownPercent()
{
$total = $this->getRelevancyUp() + $this->getRelevancyDown();
return $total ? sprintf('%.0f', $this->getRelevancyDown() * 100 / $total) : 0;
}

./app/frontend/modules/question/templates/showSuccess.php

PHP:

<div id="answers">
<?php foreach ($question->getAnswer() as $answer): ?>
<div class="answer">
<?php echo $answer->getRelevancyUpPercent() ?>% UP <?php echo $answer->getRelevancyDownPercent() ?> % DOWN
posted by <?php echo $answer->getUser() ?>
on <?php echo format_date($answer->getCreatedAt(), 'p') ?>
<div>
<?php echo $answer->getBody() ?>
</div>
</div>
<?php endforeach; ?>
</div>

あとはテストデータを作って再度投入します。
./data/fixtures/test/005.relevancy.yml

CSS:

Relevancy:
rel1:
Answer: a1_q1
User: fabien
score: 1
rel2:
Answer: a1_q1
User: francois
score: -1

これで、テストデータを入れ終わった後に画面でみてみます。

ルーティング

本家ではこのあとにタイトルの一部を使ってルーティングを変更する処理を行っています。
これはIDよりタイトルがURLに含まれているほうがSEO的に良いなどの理由からなのですがここではルーティングの変更を行わずにそのままいきます。

また明日？

さすがにこれだけの量になると大変ですね。時間があるときに少しずつ実際に触りながら行うことをオススメします。

ここまでのソースは以下のリポジトリからチェックアウトすることができます。
http://svn.1ms.jp/public/symfony/askeet12/tags/release_day_4

関連するその他の記事

10 月 27, 2008 · Filed Under askeet 1.2

Comments

Leave a Reply