CSVファイルをクラスとして定義する場合のクラス分割

Question

楽天市場やYahoo!ショッピングではCSVファイルを使った商品の登録ができます。

この商品登録用のCSVファイルを読み書き（ドメインのデータへのコンバート）するシステムをPHPを使って作成しているのですが、CSVファイルをオブジェクトとして取り扱うにはどのようにすればいいのか悩んでいます。

これらネットショップの商品CSVファイルは項目数も多く、設定できる値が制限されていたり値の書式が決まっているなど取り扱いが大変です。

また、ショッピングモール側の仕様変更が度々あり、項目が増えたり廃止されたり入力ルールが変更されるなどメンテナンスが必須です。

現状はCSVファイルを配列で管理しているのですがメンテナンスしやすくするためにクラスとして定義してみようと考えてみました。

・CSV全体のクラス
・CSVファイル1行分のクラス
・CSVファイルの各項目のクラス

項目1つ1つをクラスとして定義して、各項目の入力ルールを定義しようというアイデアですがこれだと100項目あれば100個のクラスになってしまいます。

こういうクラス設計をやったことがないので加減が分からないのですが、100個でも200個でもあるだけ作っていくものなのでしょうか？

それともある程度意味のあるまとまりでまとめておく方がいいでしょうか？

皆様のご意見を教えていただければ幸いです。

Answer 1

がると申します。

全体の仕様やビジネスが見え切れていないので言及しにくい部分も色々とあるのですが。
「CSV全体のクラス」については、SplFileObjectが、PHP的には標準でもあり、使いやすいのではないか、と思います。
書式としては

$f_obj = new \SplFileObject(ファイル名);
$f_obj->setFlags(\SplFileObject::READ_CSV);
foreach ($f_obj as $key => $row) {
    // $keyに行番号、$rowに1行分のデータ
}

といった感じです。

あとはこのCSVをどのように使うか、によっても色々と変わるかなぁ、と思うのですが。
自分であれば、見ている範囲であれば
・「項目が増えたり廃止されたり」は、configあたりで「ｎカラム目はこのデータ」とかいった対応表を作る(例えば「0カラム目はitem_id」「1カラム目はitem_name」とか)
・上述の「$row」のデータを「1行分のデータを扱うクラス」に食わせて、1インスタンスを取得する

$item_obj = new item($row);

・validateなどは「1行分のデータを扱うクラス」の中で実装する
→簡単な「必須」とか「文字であること／数値であること」「文字長のmix-min」などは簡単にかけるようにしておくと楽
→もうちょっと入り組んだもの(書式チェックとか)は「1項目ごと」に書いちゃうほうが楽

自分なら、validate関連は、itemクラスの中で

public function validate()
{
    // 呼び出したい「個々のvalidate」のメソッド名の配列
    $validate_methods['validate_hoge', 'validate_foo', 'validate_bar'];
    // 個々に呼び出し
    $err = [];
    foreach($validate_methods as $vm) {
        $err = $this->$vm($err);
    }
    //
    if ([] !== $err) {
        // なにかエラーがあったぽい。エラーの詳細は$errの配列の中になんか情報がある事を想定
        return false;
    }
    // 問題がなかったぽい
    return true;
}

/**
 */
protected function validate_hoge($err)
{
    // 項目hogeに関するvalidate
}

// 以下略

なんていう書き方をイメージしますかね。ざっくりとは。

あとはまぁ「修正が楽にできる」ように、なので、色々な考え方があると思うので。
色々と試してみて「楽だなぁ、と思った」方法で進めてみると、よいように思われます。

上述、ざっくりとしか書いていないので。
「興味があるからもうちょっと詳しく！！」とかありましたら、コメントなどいただければ、時間があるときに、ですが、返信などできるかと思います。

Comments

[msx2]

がるさん、ご回答ありがとうございます
PHP入門の頃には記事とかとても勉強させてもらいました。

このCSV処理ですが初級エンジニアの私では手におえない難易度なのですが、そうも言ってられず質問させていただいた次第でございます。

システムの全体像をもっと明らかにできれば回答も得られやすいのは承知なのですが、なかなか詳細に書くこともできず申し訳ありません。

少しだけ書かせていただくと
弊社には商品データベースがあり、これは汎用的なものです。
このデータベースを元に楽天用やYahoo用の商品CSVを作りたくて
弊社の商品データベースを楽天・YahooのCSVファイルに変換する必要があります。
また逆に楽天やYahooからダウンロードしたCSVファイルを弊社の商品データに変換して取り込む処理もあります。

つまりこのCSVクラスはコンバーターとして弊社の商品DBと楽天・Yahooの商品データの間に入って使うことを想定しています。

コンバートの処理をどうするのか、弊社DB→楽天・Yahooへの変換とその逆の変換をそれぞれどんなクラスにするのか？？などなど課題は山積みなのですが、そもそもCSVファイルをどうクラス化すると仕様変更がやりやすくなるのか、この部分に絞って質問したかったのですが、まったく言葉足らずでした。

もちろんCSVクラス1つでどうにかなる問題ではなく、いろいろな役割のクラスを作って、それらが今回質問したかったCSVクラスと連携しながら処理を進めていくのだろうなとイメージしています。

何かお気づきの点などありましたらまたコメントいただけるとヒントになるかもしれません。

よろしくお願いします。

[退会済みユーザー]

Perlだけど、楽天の在庫情報をYahoo!用に加工するのを作ってたりする。
楽天側はitem.csvとselect.csv、Yahoo!側はdata.csvですな。出力はquantity.csv。
そのときは、特にクラスとか作らず商品管理番号と項目選択肢横軸縦軸を連結したものをキーにした連想配列を作って在庫数を持ち、在庫用CSVを生成するってのをやってました。（4～5年は使ってます。）
Yahoo!の商品マスターが無理やり1:n関係のデータを織り込んでCSVに含めているので、エグいなぁと思いながらスクリプトを作ってました。
クラスの勉強がてら書き直してみようかな、忙しくなったら棚上げするかもしれないけども。

[msx2]

いつもコメントありがとうございます。
Yahoo!の商品マスターのデータの持ち方は面白いですよね。
でも1レコードにサブコードが全部収まっているのは処理しやすくて個人的には好きです、区切り文字が半角スペースなのはどうにかして欲しいところですが、、

クラス化したらまたどこかで公開してくださいね～