質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.64%

コンストラクタの振る舞い範囲について

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 206

syachiku

score 102

前提・実現したいこと

1.画面からアップロードされたCSVファイルを読み取り、各データをBeanのフィールドに格納する。
2.生成したBean内の各フィールドのバリデーションチェックを行う。(空白チェックや桁数チェック等)
3.バリデーションチェックの結果を画面に表示する。(下記イメージ)

項目1 項目2 項目3 ・・・
値1 値2 <br> 桁数が超過しています。 値3 ・・・

4.エラーとなった項目が無ければ結果確認後、DBに登録する。

発生している問題

上記1,2の実装方法について、2点質問です。
・両方ともBeanのコンストラクタ内で行ってもいいものか(アンチパターンかどうか)。
・各項目に対応するエラーメッセージを保持するフィールドもこのBeanに含めていいものか。(もっといいデザインパターンがないか)

該当のソースコード

以上2点そのまま実装した場合こんな感じの実装になります。

public class CsvDataBean {
    private boolean isValid;
    private String column1;
    private String column1ErrorMessage;
    private String column2;
    private String column2ErrorMessage;
            省略

    public CsvDataBean (String[] csvColumns) {
        this.isValid = true;
        try {
            this.column1 = csvColumns[0];
            this.column2 = csvColumns[1];
                省略

        } catch (IndexOutOfBoundsException e) {
            this.isValid = false;
        }

        try {
            this.validate();
        } catch (Exception e) {
            this.isValid = false;
        }
    }

    private void validate(){
        if(this.column1 == null) {
            this.column1ErrorMessag = "値1が空白です。"
            this.isValid = false;
        }
             省略
    }
}

補足情報(FW/ツールのバージョンなど)

Spring Boot 2
Thymeleaf 3

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • dameo

    2019/11/19 14:15

    流れとしては↓な感じになるのでしょうか?

    ①CSVのパース→文字列データをNフィールドxMレコードとして取得
    →CSVフォーマットがおかしい場合エラー(読み込みがコレ以上出来ないので単独エラー)

    ②①の各レコードからフィールドデータを検証する
    →単一データとして既定の値範囲やフォーマットなどが不当ならエラー(これは読み続けられるので複数エラーとして原因・場所と伴に記録)
     ※DBデータとして規定される場合はDB(DAO)参照も可

    ③レコードデータとして、各フィールドデータ間の整合性を検証する(必要なら。④や⑤で実施しても可)
    →不整合なフィールドデータがあればエラー(これは読み続けられるので複数エラーとして原因・場所と伴に記録)
     ※DBデータとして規定される場合はDB(DAO)参照も可

    ④全レコードデータ内の整合性を検証する(必要なら。⑤で実施しても可)
    →不整合なデータのうち、不要なもの、もしくは全体をエラー(複数エラーとして原因・場所と伴に記録)
     ※DBデータとして規定される場合はDB(DAO)参照も可

    ⑤全レコードデータが既存のDB(DAO)データと整合が取れているか検証し(、妥当なもののみDBに登録)
    →不整合なデータのうち、不要なもの、もしくは全体をエラー(複数エラーとして原因・場所と伴に記録)

    ※検証がその場でできない場合は、さらに後段の処理で検証する

    パターンとかこれだけの情報で判断することは難しいと思います。
    あと低評価するなら理由をコメントに入れないとフェアじゃないと思いますよ。

    キャンセル

  • syachiku

    2019/11/19 14:34

    DBに格納する際はinsertかupdateでしか行わないのでレコード間の整合性チェックは考えていませんでした。
    ただ、区分値のようなフィールドがあり、これはDBのマスタに存在する値を登録する必要があるのでDB参照が必要だと気付きました。
    流れとしてはほぼほぼその通りのイメージだと思います。
    ちなみに低評価を押したのは私ではありません!

    キャンセル

  • dameo

    2019/11/19 14:40

    いやいや質問者さんだとは思ってませんよ。ビックリさせてしまってごめんなさい。
    回答の方ありがとうございます。
    ただ知見が足りないのもあって回答は出来ないです。重ねてすみません。

    キャンセル

回答 2

checkベストアンサー

0

単なるデータのコンテナとしてCsvDataBeanを定義し、個々のCSVファイルの仕様は外出しにした形のバリデーターにすべくインターフェースを定義、何らかのデザインパターンで、ファイルの種類に応じたバリデーターの実装を取得できるようにすれば、さまざまな種類のCSVファイルを扱うユーティリティ化ができそうですね。
私ならそういう方向性で検討して、今回どこまでが必要なのかを考慮の上やりすぎない程度に作り込むかな、と思いました。

つまりコンストラクターでは妥当性チェックは実施しない考えです。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/11/20 11:34

    現時点で何種類かのCSVファイルを扱うことが想定されているため、ユーティリティ化はよさそうですね。(具体的な実装のイメージができていないのですが)
    そうした場合、各フィールドのエラー情報を保持するBeanを別で保持する方がいいのでしょうか。
    もしくは単なるデータコンテナというのはエラー情報のフィールドも含めてのことを指していますか。
    理解力が乏しくて申し訳ありませんが、ご教示お願い致します。

    キャンセル

  • 2019/11/20 15:01 編集

    エラー情報は、バリデーターが返す検査結果オブジェクトが保持するのが良いように思います。

    List<CsvDataBean> csvRecords = 何らかの方法で CSV ファイルからオブジェクト化する;
    CsvValidator validator = 何らかの方法で目的のバリデータを得る;
    List<CsvViolation> errors = validator.validate(csvRecords);

    のように処理できれば良いのかなと思います。
    ここで CsvViolation は、何行目のどの項目でどのようなエラーがあったかを保持するクラスのオブジェクトという感じですか。

    キャンセル

-1

・両方ともBeanのコンストラクタ内で行ってもいいものか(アンチパターンかどうか)。

コンストラクタに処理を書きすぎるのは一般的にアンチパターンだと思うけど、CSVデータがそのクラスのオブジェクトをシリアル化したモノであり、インスタンス生成のために必要な処理であるならOKだと思う。
(ファクトリ使っても良さそうではあるけど)

例えば、ビットマップ画像を表すクラスのインスタンスがファイルの内容を読み込んで初期化されるのは違和感はないのと同じ。

・各項目に対応するエラーメッセージを保持するフィールドもこのBeanに含めていいものか。(もっといいデザインパターンがないか) 

例外を発生させるのが普通だと思う。
エラーをフィールドや戻り値で取得したいのであれば、外部のファクトリに分けた方が良いんじゃないかなぁ。


追記

よく考えてみたら、

1.画面からアップロードされたCSVファイルを読み取り、各データをBeanのフィールドに格納する。

とあるので、バリデーションは必須なのか。
だったらファクトリは別に分けておいた方が良い気がしてきた。

入力ファイルの検証→検証済みのファイルからインスタンス生成
と明確に2ステップに分かれるので、テストの対象の粒度も小さくできるし理解もしやすいと思う。
(ファクトリじゃなくてバリデーションの機能だけもたせたバリデータを外に出しても良いかもしれんけど)

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.64%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる