DEVELOPERS BLOGデベロッパーズブログ

  1. HOME > 
  2. 加藤 正人 > 
  3. タイトル

 CsvLoaderBhavior - CSV データを CakePHP で扱うための一手法

2015/02/14

CsvLoaderBhavior - CSV データを CakePHP で扱うための一手法

 

しばしば CSV データをデータベース (テーブル) として処理したいことがある。(電力会社から公開される電力使用量データや総務省から公開される全国市区町村一覧等々。)

CsvSource データソースを利用する方法もあるが、こちらは find 時の絞り込み条件指定等は対応していないようで全件読み込み以外の処理には難があるようだし、他のテーブルとのアソシエーションにも難がありそうだし、ロードした後継続的にテーブルとして使用する場合は自分で CSV のフィールドを調べてテーブルを作成し、内容をコピーするようコードを書かなければならない。

それならば、モデルを最初にアクセスする際に CSV ファイルの構造からテーブルを作成しそこに読み込んでしまい、それ以降は通常のデータベーステーブルとしてアクセスする方法があればよいのではないだろうか。

この方法であれば Behavior として実現できそうだし、他のテーブルとのアソシエーションも容易なので試してみた。

コンセプト

使用に先立ち、CSV データを既存またはその時点で作成したテーブルにロードしてしまえば CRUD 部分は通常のデータベースとしてアクセスするだけなので、ビヘイビアの初期化部分 (setup() メソッド) で対応する。

書き込み先テーブルを生成する場合は、その構造 (スキーマ) をユーザが指定することもできるが、可能な限り自動生成できるようにする。

ビヘイビア名を CsvLoader とすると、以下のような感じになる。

使用する際には、Model 定義で以下のようにする。

実装

上記を実現するためのビヘイビアの setup()  コールバックメソッドの構造は以下のようにできる。

  1. ビヘイビアの生成オプションと既定値オプションをマージする
  2. CSV ファイルをオープンする
  3. テーブルを構築するためのスキーマデータをオプションに従って生成する
  4. データベースにテーブルを作成する
  5. CSV ファイルからレコードを読み込みテーブルに書き込む
  6. EOF に達したらファイルをクローズする

これをコード化したものがこちら。(抜粋)

細かい内部メソッドや省略されている要素にについては次回解説の予定。

この記事は加藤 正人さんが書いています!

加藤 正人

氏名
加藤 正人
役職
多分SE
血液型
秘密
出没
美味しいもののあるところ
特色
タヒチ大好き。ちょいメタボ。