リソースとテーブルのギャップを飛び越える

2010年10月20日(水)
川尻 剛

論理モデルで実現する

テーブル・ビューを使う方法は、シンプルである一方で、Migrationを使用するために修正が大変になります。モデルの属性は、後に何度も修正することになるので、コード上で変更できる方が良いでしょう。

そこで、次は、モデル側でクエリーを構築し、テーブル・ビューのようなクラスを実現してみます。以降では、このようなモデルを論理モデルと呼び、実テーブルに対応する物理モデルと区別します。

論理モデルを表現する方法の1つは、Rails 3.0で導入されたActiveModelを使用することです。ActiveModelは、validationなどの機能をモジュール化したものです。任意のクラスに、ActiveRecordの機能を持たせることができます。

ActiveModelは、検索条件など、ユーザー入力の抽象化などには、非常に役立ちます。しかし、今回定義したいモデルは、実テーブルに直結するものなので、SQLの型を指定したいところです。そこで、ActiveRecordを継承して、属性とともにSQLの型を指定できるようにする方向でやってみます。この継承クラスの実装例を、次に示します。

01<!--//--><![CDATA[// ><!--
02 
03module LogicalRecord
04  class Base < ActiveRecord::Base
05    self.abstract_class = true
06    def self.column(name, sql_type=nil, default=nil, null=true)
07      columns << ActiveRecord::ConnectionAdapters::Column.new(
08        name.to_s, default, sql_type.to_s, null
09      )
10    end
11    def self.columns; @columns ||= [] ;end
12    def save(validate = true); validates ? valid? : true ;end
13  end
14end
15 
16//--><!

上記のクラスでは、abstract_classにtrueを指定することによって、テーブルとマッピングされないようにしています。また、Columnクラスを使用することによって、SQLの型を指定できるようにしてあります。本クラスを継承して定義した論理モデルは、次のようになります。

01<!--//--><![CDATA[// ><!--
02 
03module Shop
04  class TableView::Sale < ActiveRecord::Base
05    column :id, :integer
06    column :item_id, :integer
07    column :unit, :integer
08    column :address, :string
09    column :delivered_on, :date
10 
11    validates_presence_of :item_id, :unit, :address
12    belongs_to :item, :class_name => 'Shop::Physical::Item'
13 
14    FIND_FIRST_QUERY = <<-SQL
15        SELECT
16          st.id AS id
17          , st.item_id
18          , st.unit
19          , sp.address
20          , sp.delivered_on
21        FROM
22          shop_stocks AS st
23          , shop_shipments AS sp
24        WHERE
25          st.id = sp.stock_id
26          AND st.id = ?
27        ;
28    SQL
29 
30    def self.find(id)
31      self.find_by_sql([FIND_FIRST_QUERY, id]).first
32    end
33 
34    def save
35       #テーブル・ビューと同じなので省略
36    end
37  end
38end
39 
40//--><!

SELECT文で指定した列と、columnメソッドで指定した列を、一致させるのがポイントです。列さえ同じであれば、UNIONなどを活用した複雑なクエリーでも対応付けられます。また、列の定義がテーブルに関連していないので、次のようにモックを作成することで、テーブル定義のタイミングを遅らせることができます。

1<!--//--><![CDATA[// ><!--
2 
3    def self.find(id)
4        self.new(:item_id => 1, :unit => 100 ....)
5    end
6 
7//--><!

著者がよく行うのは、「まずはモックを使用して"保存できないアプリケーション"を軽く作成した上でユーザーに操作してもらい、仕様がある程度固まってからテーブルを設計する」という方法です。これによって、デモのタイミングを前倒しにできます。さらに、以前であれば山のようにできてしまっていたMigrationを、少なく抑えることができます。

上記で定義したSaleモデルを、コンソールから触ってみましょう。

01<!--//--><![CDATA[// ><!--
02 
03>   Shop::Logical::Sale.find(1)
04 => #<Shop::Logical::Sale id: 1, item_id: 1, unit: 2, address: "Tokyo", delivered_on: nil>
05> Shop::Logical::Sale.find(1).item
06 => #<Shop::Physical::Item id: 1, name: "apple", price: 100>
07 
08> sale = Shop::Logical::Sale.new
09> sale.save
10 => false
11> sale.errors
12 => #<OrderedHash {:item_id=>["can't be blank"], :unit=>["can't be blank"], ...
13> Shop::Logical::Sale.new(:item_id => 1, :unit=>1, :address=>'Sapporo').save
14 => #<Shop::Logical::Sale id: 4, item_id: 1, unit: 1, address: "Sapporo", delivered_on: nil>
15 
16//--><!

validationが機能しているのに加え、関連なども正常に取れているのが分かります。

ARelで修正する

先述した論理モデルの例では、参照のクエリーを文字列で表現していました。この場合、参照件数が1件や複数といったわずかな違いであっても、同じような文字列をそれぞれ個別に用意する必要があります。

幸い、Rails 3.0からは、クエリーを抽象化したARelと呼ぶライブラリが導入されています。本ライブラリを活用し、既存のクエリーを再利用できるように修正してみます。

ARelでは、次のように、テーブルに対応するオブジェクトを作成して、whereなどのメソッドを組み合わせてクエリーを構築します。

01<!--//--><![CDATA[// ><!--
02 
03> shipments = Table(:shop_shipments)
04> shipments.to_sql
05 => "SELECT     `shop_shipments`.`id`, `shop_shipments`.`stock_id`, `shop_shipments`.`address`, `shop_shipments`.`delivered_on` FROM  `shop_shipments`"
06 
07> shipments = shipments.where(shipments[:address].eq 'Tokyo')
08> shipments.to_sql
09 => "SELECT     `shop_shipments`.`id`, `shop_shipments`.`stock_id`, `shop_shipments`.`address`, `shop_shipments`.`delivered_on` FROM  shop_shipments`  WHERE     `shop_shipments`.`address` = 'Tokyo'"
10 
11//--><!

一度作成したら、後付けで条件を追加していけるのがポイントです。JOINするクエリーをあらかじめ作成しておけば、細かな条件を付加して再利用できます。このような方針で参照メソッドを修正した例を、次に示します。

01<!--//--><![CDATA[// ><!--
02 
03module Shop
04  class Logical::Sale < LogicalRecord::Base
05     # 省略
06    class << self
07      def base_query
08        @base_query ||= begin
09          st = Table(:shop_stocks, :as => 'st')
10          sp = Table(:shop_shipments, :as => 'sp')
11          sale = st.join(sp).on(st[:id].eq(sp[:stock_id]))
12          sale = sale.project(
13            st[:id].as('id'),
14            st[:item_id].as('item_id'),
15            st[:unit].as('unit'),
16            sp[:address].as('address'),
17            sp[:delivered_on].as('delivered_on')
18          )
19        end
20      end
21 
22      def find(id)
23        find_by_sql(base_query.where(base_query[:id].eq id).to_sql).first
24      end
25 
26      def all
27        find_by_sql(base_query.to_sql)
28      end
29    end
30    ....
31 
32//--><!

コンソールから試してみましょう。

01<!--//--><![CDATA[// ><!--
02 
03> Shop::Logical::Sale.base_query.to_sql
04 => "SELECT     `st`.`id` AS 'id', `st`.`item_id` AS 'item_id', `st`.`unit` AS 'unit', `sp`.`address` AS 'address', `sp`.`delivered_on` AS 'delivered_on' FROM       `shop_stocks` `st`  INNER JOIN `shop_shipments` `sp` ON `st`.`id` = `sp`.`stock_id`"
05> Shop::Logical::Sale.find(1)
06 => #<Shop::Logical::Sale id: 1, item_id: 1, unit: 2, address: "Tokyo", delivered_on: nil>
07> Shop::Logical::Sale.all
08 => [#<Shop::Logical::Sale id: 1, item_id: 1, unit: 2, address: "Tokyo", delivered_on: nil>, #<Shop::Logical::Sale id: 2, item_id: 2, unit: 3, address: "Sapporo", delivered_on: nil>]
09 
10//--><!

ARelで表現したクエリーが、正常に動作しているのが分かります。

おわりに

今回は、ActiveRecordを活用した中間層の実現方法として、ビューに対応するクラスを置く方法を中心に説明しました。

注意してほしいのは、やり過ぎは厳禁ということです。気がついたら「画面ごとにビューを実現したクラスを定義してしまって、ActiveRecordの特徴である再利用性が生かされていない」とうことにならないように、気をつけてください。基本的には、まずはActiveRecordの関連などを活用し、どうしてもうまくマッチしない時に、今回の話を思い出すと良いでしょう。

次回は、最終回です。NoSQL関連のトピックを解説します。ご期待ください。

株式会社日立ソリューションズ

技術開発本部 Rubyセンタ所属
1977年生まれ。入社後、自社フレームワークの開発を経てRIAの調査などに関わる。
最近は「お客様とチームがより幸せなるマネジメント」を目標としてプロジェクトマネジメントを勉強中。著書に「Java開発者のためのAjax実践開発入門」(共著)など。

連載バックナンバー

Think ITメルマガ会員登録受付中

Think ITでは、技術情報が詰まったメールマガジン「Think IT Weekly」の配信サービスを提供しています。メルマガ会員登録を済ませれば、メルマガだけでなく、さまざまな限定特典を入手できるようになります。

Think ITメルマガ会員のサービス内容を見る

他にもこの記事が読まれています