7.5.1. データバインド¶

7.5.1.1.1. データをJava Beansオブジェクトとして扱うことができる¶

データファイルのデータをJava Beansオブジェクトとして扱うことができる。

Java Beansオブジェクトへの変換時、Java Beansクラスに定義されたプロパティの型に BeanUtil を使用して自動的に型変換を行う。 型変換に失敗した場合は例外が発生し、Java Beansオブジェクトは生成されない。

データをJava Beansオブジェクトとして扱う方法の詳細は以下を参照。

• データをJava Beansオブジェクトとして読み込む
• Java Beansオブジェクトの内容をデータファイルに書き込む

7.5.1.1.2. データをMapオブジェクトとして扱うことができる¶

データファイルのデータをMapオブジェクトとして扱うことができる。

Mapオブジェクトへの変換時、値は全てString型で格納される。

詳細は以下を参照。

• データをMapオブジェクトとして読み込む
• Mapオブジェクトの内容をデータファイルに書き込む

7.5.1.1.3. データファイルのフォーマットをアノテーションで指定することができる¶

データファイルのフォーマットは設定ファイルに記述するのではなく、 アノテーションや DataBindConfig を使用して定義することができる。

詳細なフォーマットの指定方法は、 CSVファイルのフォーマットを指定する を参照。

7.5.1.3.1. データをJava Beansオブジェクトとして読み込む¶

データファイルを先頭から1データずつ読み込み、Java Beansオブジェクトとして取得することができる。

データの読み込みは、 ObjectMapperFactory#create で生成した ObjectMapper を使用して行い、 ObjectMapper の生成時に指定した、 Java Beansクラスに定義されたアノテーションをもとにデータを読み込む。

Java Beansクラスへのアノテーション定義方法の詳細は、 CSVファイルをJava Beansクラスにバインドする場合のフォーマット指定方法 を参照。

全データを読み込む場合の実装例を以下に示す。

try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, inputStream)) {
    Person person;
    while ((person = mapper.read()) != null) {
        // Java Beansオブジェクトごとの処理を記述(Java Beansオブジェクトへの変換処理など)
    }
} catch (InvalidDataFormatException e) {
    // 読み込んだデータのフォーマットが不正な場合の処理を記述
}

7.5.1.3.2. Java Beansオブジェクトの内容をデータファイルに書き込む¶

Java Beansオブジェクトの内容をデータファイルに1データずつ書き込むことができる。

データファイルへの書き込みは、 ObjectMapperFactory#create で生成した ObjectMapper を使用して行い、 ObjectMapper の生成時に指定した、 Java Beansクラスに定義されたアノテーションをもとにデータを書き込む。

Java Beansクラスへのアノテーション定義方法の詳細は、 CSVファイルをJava Beansクラスにバインドする場合のフォーマット指定方法 を参照。

リスト内の全てのJava Beansオブジェクトをデータファイルに書き込む場合の実装例を以下に示す。

try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, outputStream)) {
    for (Person person : personList) {
        mapper.write(person);
    }
}

7.5.1.3.3. データをMapオブジェクトとして読み込む¶

データファイルを先頭から1データずつ読み込み、Mapオブジェクトとして取得することができる。

データの読み込みは、 ObjectMapperFactory#create で生成した ObjectMapper を使用して行い、 ObjectMapper の生成時に指定した、 DataBindConfig の設定値をもとにデータを読み込む。

DataBindConfig への設定方法の詳細は、 CSVファイルをMapクラスにバインドする場合のフォーマット指定方法 を参照。

データファイルの全データを読み込む場合の実装例を以下に示す。

// DataBindConfigオブジェクトを生成
DataBindConfig config = CsvDataBindConfig.DEFAULT.withHeaderTitles("年齢", "名前");
try (ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, inputStream, config)) {
    Person person;
    while ((person = mapper.read()) != null) {
        // Java Beansオブジェクトごとの処理を記述(Java Beansオブジェクトへの変換処理など)
    }
} catch (InvalidDataFormatException e) {
    // 読み込んだデータのフォーマットが不正な場合の処理を記述
}

7.5.1.3.4. Mapオブジェクトの内容をデータファイルに書き込む¶

Mapオブジェクトの内容をデータファイルに1データずつ書き込むことができる。

データファイルへの書き込みは、 ObjectMapperFactory#create で生成した ObjectMapper を使用して行い、 ObjectMapper の生成時に指定した、 DataBindConfig の設定値をもとにデータを書き込む。

DataBindConfig への設定方法の詳細は、 CSVファイルをMapクラスにバインドする場合のフォーマット指定方法 を参照。

リスト内の全てのMapオブジェクトをデータファイルに書き込む場合の実装例を以下に示す。

// DataBindConfigオブジェクトを生成
DataBindConfig config = CsvDataBindConfig.DEFAULT.withHeaderTitles("年齢", "名前");
try (ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, outputStream, config)) {
    for (Map<String, Object> person : personList) {
        mapper.write(person);
    }
}

7.5.1.3.5. データの論理行番号を取得する¶

データファイルのデータをJava Beansオブジェクトとして取得する際、Java Beansクラスにプロパティを定義して LineNumber を使用することで、データの論理行番号も一緒に取得することができる。

例えば、入力値チェック時にバリデーションエラーが発生したデータの行番号をログに出力したい場合などに使用する。

実装例を以下に示す。

private Long lineNumber;

@LineNumber
public Long getLineNumber() {
    return lineNumber;
}

7.5.1.3.6. データの入力値をチェックする¶

データをJava Beansオブジェクトとして読み込むことができるため、 Bean Validation による入力値チェックを行うことができる。

実装例を以下に示す。

try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, inputStream)) {
    Person person;
    while ((person = mapper.read()) != null) {
        // 入力値チェックを実行
        ValidatorUtil.validate(person);

        // 後続の処理は省略
    }
} catch (InvalidDataFormatException e) {
    // データファイルのフォーマット不正時の処理を記述
}

7.5.1.3.7. ファイルダウンロードで使用する¶

ウェブアプリケーションで、Java Beansオブジェクトの内容をデータファイルとしてダウンロードするための実装例を以下に示す。

ポイント

• データをメモリ上に展開すると大量データのダウンロード時などにメモリを圧迫する恐れがあるため、一時ファイルに出力する。
• データファイルへの書き込みについては、 Java Beansオブジェクトの内容をデータファイルに書き込む を参照。
• FileResponse オブジェクト生成時にデータファイルを指定する。
• リクエスト処理の終了時に自動的にファイルを削除する場合は、 FileResponse のコンストラクタの第二引数に true を指定する。
• レスポンスに Content-Type 及び Content-Disposition を設定する。

public HttpResponse download(HttpRequest request, ExecutionContext context) {

    // 業務処理

    final Path path = Files.createTempFile(null, null);
    try (ObjectMapper<Person> mapper =
            ObjectMapperFactory.create(Person.class, Files.newOutputStream(path))) {
        for (Person person : persons) {
            mapper.write(BeanUtil.createAndCopy(PersonDto.class, person));
        }
    }

    // ファイルをボディに設定する。
    FileResponse response = new FileResponse(path.toFile(), true);

    // Content-Typeヘッダ、Content-Dispositionヘッダを設定する
    response.setContentType("text/csv; charset=Shift_JIS");
    response.setContentDisposition("person.csv");

    return response;
}

7.5.1.3.8. アップロードファイルのデータを読み込む¶

ウェブアプリケーションで、画面からアップロードされたデータファイルをJava Beansオブジェクトとして読み込むための実装例を以下に示す。

ポイント

• PartInfo#getInputStream を使用して、アップロードファイルのストリームを取得する。
• 不正なデータが入力されている可能性があるため、Bean Validation を使用して入力チェックを行う。

List<PartInfo> partInfoList = request.getPart("uploadFile");
if (partInfoList.isEmpty()) {
    // アップロードファイルが見つからない場合の処理を記述
}

PartInfo partInfo = partInfoList.get(0);
try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, partInfo.getInputStream())) {
    Person person;
    while ((person = mapper.read()) != null) {
        // 入力値チェックを実行
        ValidatorUtil.validate(person);

        // 後続の処理は省略
    }
} catch (InvalidDataFormatException e) {
    // データファイルのフォーマット不正時の処理を記述
}

7.5.1.3.9. CSVファイルのフォーマットを指定する¶

CSVファイルのフォーマット指定は、Java Beansクラスにバインドする場合とMapクラスにバインドする場合で2種類の指定方法がある。

Java Beansクラスにバインドする場合

以下のアノテーションを使用してフォーマットを指定する。

• Csv
• CsvFormat

CSVファイルのフォーマットは予め用意したフォーマットセットの中から選択することができる。 フォーマットセットについては CSVファイルのフォーマットとして指定できるフォーマットセット を参照。

以下に実装例を示す。

@Csv(type = Csv.CsvType.DEFAULT, properties = {"age", "name"}, headers = {"年齢", "氏名"})
public class Person {
    private Integer age;
    private String name;

    // getter、setterは省略。
}

また、CSVファイルのフォーマットが、予め用意したフォーマットセットのいずれにも当てはまらない場合は、 CsvFormat を使用して個別にフォーマットを指定することができる。

以下に実装例を示す。

// type属性にCUSTOMを指定する。
@Csv(type = Csv.CsvType.CUSTOM, properties = {"age", "name"})
@CsvFormat(
        fieldSeparator = '\t',
        lineSeparator = "\r\n",
        quote = '\'',
        ignoreEmptyLine = false,
        requiredHeader = false,
        charset = "UTF-8",
        quoteMode = CsvDataBindConfig.QuoteMode.ALL)
public class Person {
    private Integer age;
    private String name;

    // getter、setterは省略。
}

ちなみに

Java Beansクラスにバインドする場合、フォーマット指定はアノテーションで行うため、 ObjectMapper の生成時に DataBindConfig を使用したフォーマットの指定はできない。

Mapクラスにバインドする場合

ObjectMapper の生成時に CsvDataBindConfig を使用して個別にフォーマットを指定する。

また、フォーマットを指定する際は、Mapオブジェクトのキーとして使用するため、 CsvDataBindConfig#withHeaderTitles でCSVファイルのヘッダフィールド名を設定する必要がある。

以下に実装例を示す。

DataBindConfig config = CsvDataBindConfig.DEFAULT.withHeaderTitles("年齢", "名前");
ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, outputStream, config);

7.5.1.4.1. Java Beansクラスにバインドできるファイル形式を追加する¶

Java Beansクラスにバインドできるファイル形式を追加するには、以下の手順が必要となる。

1. 指定した形式のファイルとJava Beansクラスをバインドさせるため、 ObjectMapper の実装クラスを作成する。
2. ObjectMapperFactory を継承したクラスを作成し、 先ほど作成した ObjectMapper の実装クラスを生成する処理を追加する。
3. ObjectMapperFactory の継承クラスをコンポーネント設定ファイルに設定する。 以下にコンポーネント設定ファイルへの設定例を示す。

ポイント

• コンポーネント名は、 objectMapperFactory とすること。

<component name="objectMapperFactory" class="sample.SampleObjectMapperFactory" />