7.4.1. データバインド¶

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

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

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

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

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

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

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

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

詳細は以下を参照。

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

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

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

詳細なフォーマットの指定方法は以下を参照。

• CSVファイルのフォーマットを指定する
• 固定長ファイルのフォーマットを指定する

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

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

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

Java Beansクラスへのアノテーション定義方法の詳細は以下を参照。

• CSVファイルをJava Beansクラスにバインドする場合のフォーマット指定方法
• 固定長ファイルを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.4.1.3.2. Java Beansオブジェクトの内容をデータファイルに書き込む¶

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

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

Java Beansクラスへのアノテーション定義方法の詳細は以下を参照。

• CSVファイルをJava Beansクラスにバインドする場合のフォーマット指定方法
• 固定長ファイルをJava Beansクラスにバインドする場合のフォーマット指定方法

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

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

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

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

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

DataBindConfig への設定方法の詳細は以下を参照。

• CSVファイルをMapクラスにバインドする場合のフォーマット指定方法
• 固定長ファイルをMapクラスにバインドする場合のフォーマット指定方法

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

// DataBindConfigオブジェクトを生成
DataBindConfig config = CsvDataBindConfig.DEFAULT.withHeaderTitles("年齢", "名前")
                                                 .withProperties("age", "name");
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.4.1.3.4. Mapオブジェクトの内容をデータファイルに書き込む¶

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

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

DataBindConfig への設定方法の詳細は以下を参照。

• CSVファイルをMapクラスにバインドする場合のフォーマット指定方法
• 固定長ファイルをMapクラスにバインドする場合のフォーマット指定方法

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

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

7.4.1.3.5. ファイルのデータの論理行番号を取得する¶

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

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

実装例を以下に示す。

private Long lineNumber;

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

7.4.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.4.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.4.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.4.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,
        emptyToNull = true)
public class Person {
    private Integer age;
    private String name;

    // getter、setterは省略。
}

補足

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

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

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

また、フォーマットを指定する際は、 CsvDataBindConfig#withProperties で設定したプロパティ名がMapオブジェクトのキーとして使用される。 なお、CSVにヘッダ行が存在する場合は、プロパティ名の設定を省略することでヘッダタイトルをキーとして使用できる。

以下に実装例を示す。

ポイント

• ヘッダタイトル、プロパティ名はCSVの項目順と一致するように定義すること

// ヘッダタイトル、プロパティ名はCSVの項目順と一致するように定義する
DataBindConfig config = CsvDataBindConfig.DEFAULT.withHeaderTitles("年齢", "名前")
                                                 .withProperties("age", "name");
ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, outputStream, config);

7.4.1.3.10. 固定長ファイルのフォーマットを指定する¶

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

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

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

• FixedLength
• Field

また、固定長ファイルの各フィールドに対し、パディングやトリム等を変換するコンバータを指定できる。 標準で指定できるコンバータについては、 nablarch.common.databind.fixedlength.converter パッケージ配下を参照。

以下に実装例を示す。

@FixedLength(length = 19, charset = "MS932", lineSeparator = "\r\n")
public class Person {

    @Field(offset = 1, length = 3)
    @Lpad
    private Integer age;

    @Field(offset = 4, length = 16)
    @Rpad
    private String name;

    // getter、setterは省略
}

もし、以下の様に未使用領域が存在するフォーマットの場合、 固定長ファイルへの書き込み時に FixedLength#fillChar に設定した文字で自動的にパディングされる。(デフォルトは半角スペース)

@FixedLength(length = 24, charset = "MS932", lineSeparator = "\r\n", fillChar = '0')
public class Person {

    @Field(offset = 1, length = 3)
    @Lpad
    private Integer age;

    @Field(offset = 9, length = 16)
    @Rpad
    private String name;

    // getter、setterは省略
}

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

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

FixedLengthDataBindConfig は、 FixedLengthDataBindConfigBuilder を使用して生成できる。

以下に実装例を示す。

final DataBindConfig config = FixedLengthDataBindConfigBuilder
        .newBuilder()
        .length(19)
        .charset(Charset.forName("MS932"))
        .lineSeparator("\r\n")
        .singleLayout()
        .field("age", 1, 3, new Lpad.Converter('0'))
        .field("name", 4, 16, new Rpad.RpadConverter(' '))
        .build();

final ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, outputStream, config);

7.4.1.3.11. 固定長ファイルに複数のフォーマットを指定する¶

複数のフォーマットを持つ固定長ファイルのフォーマット指定についても、 Java Beansクラスにバインドする場合とMapクラスにバインドする場合で2種類の指定方法がある。

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

フォーマットごとにJavaBeansクラスを定義して、それらのJava Beansクラスをプロパティとして持つ MultiLayout の継承クラスを作成することで、 複数フォーマットの固定長ファイルに対応できる。

以下にフォーマット指定の実装例を示す。

ポイント

• フォーマットごとにJava Beansクラスを定義する。
• 上記のフォーマットを定義したJava Beansクラスをプロパティとして持つ、 MultiLayout の継承クラスを定義する。
• MultiLayout の継承クラスに FixedLength アノテーションを設定し、 multiLayout 属性に true を設定する。
• MultiLayout#getRecordIdentifier メソッドをオーバーライドして、 対象のデータがどのフォーマットに紐づくかを識別する RecordIdentifier の実装クラスを返却する。

@FixedLength(length = 20, charset = "MS932", lineSeparator = "\r\n", multiLayout = true)
public class Person extends MultiLayout {

    @Record
    private Header header;

    @Record
    private Data data;

    @Override
    public RecordIdentifier getRecordIdentifier() {
        return new RecordIdentifier() {
            @Override
            public RecordName identifyRecordName(byte[] record) {
                return record[0] == 0x31 ? RecordType.HEADER : RecordType.DATA;
            }
        };
    }

    // getter、setterは省略
}

public class Header {

    @Field(offset = 1, length = 1)
    private Long id;

    @Rpad
    @Field(offset = 2, length = 19)
    private String field;

    // getter、setterは省略
}

public class Data {

    @Field(offset = 1, length = 1)
    private Long id;

    @Lpad
    @Field(offset = 2, length = 3)
    private Long age;

    @Rpad
    @Field(offset = 5, length = 16)
    private String name;

    // getter、setterは省略
}

enum RecordType implements MultiLayoutConfig.RecordName {
    HEADER {
        @Override
        public String getRecordName() {
            return "header";
        }
    },
    DATA {
        @Override
        public String getRecordName() {
            return "data";
        }
    }
}

次に、指定されたフォーマットをもとに固定長データの読み込み・書き込みを行う実装例を示す。

// 読み込む場合の実装例
try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, inputStream)) {
    final Person person = mapper.read();
    if (RecordType.HEADER == person.getRecordName()) {
        final Header header = person.getHeader();

        // 後続の処理は省略
    }
}

// 書き込む場合の実装例
try (ObjectMapper<Person> mapper = ObjectMapperFactory.create(Person.class, outputStream)) {
    final Person person = new Person();
    person.setHeader(new Header("1", "test"));
    mapper.write(person);
}

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

固定長ファイルをMapクラスにバインドする場合のフォーマット指定方法 と同様の手順でフォーマットを指定できる。

以下にフォーマット指定の実装例を示す。

ポイント

• multiLayout メソッドを呼び出し、マルチレイアウト用のDataBindConfigを生成する。
• recordIdentifier メソッドには、対象のデータがどのフォーマットに紐づくかを識別する RecordIdentifier の実装クラスを指定する。

final DataBindConfig config = FixedLengthDataBindConfigBuilder
        .newBuilder()
        .length(20)
        .charset(Charset.forName("MS932"))
        .lineSeparator("\r\n")
        .multiLayout()
        .record("header")
        .field("id", 1, 1, new DefaultConverter())
        .field("field", 2, 19, new Rpad.RpadConverter(' '))
        .record("data")
        .field("id", 1, 1, new DefaultConverter())
        .field("age", 2, 3, new Lpad.LpadConverter('0'))
        .field("name", 5, 16, new Rpad.RpadConverter(' '))
        .recordIdentifier(new RecordIdentifier() {
            @Override
            public RecordName identifyRecordName(byte[] record) {
                return record[0] == 0x31 ? RecordType.HEADER : RecordType.DATA;
            }
        })
        .build();

次に、指定されたフォーマットをもとに固定長データの読み込み・書き込みを行う実装例を示す。

// 読み込む場合の実装例
try (ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, inputStream, config)) {
    final Map<String, ?> map = mapper.read();
    if (RecordType.HEADER == map.get("recordName")) {
        final Map<String, ?> header = map.get("header");

        // 後続の処理は省略
    }
}

// 書き込む場合の実装例
try (ObjectMapper<Map> mapper = ObjectMapperFactory.create(Map.class, outputStream, config)) {
    final Map<String, ?> header = new HashMap<>();
    header.put("id", "1");
    header.put("field", "test");

    final Map<String, ?> map = new HashMap<>();
    map.put("recordName", RecordType.HEADER);
    map.put("header", header);

    mapper.write(map);
}

7.4.1.3.12. 出力するデータの表示形式をフォーマットする¶

データを出力する際に、 フォーマッタ を使用することで日付や数値などのデータの表示形式をフォーマットできる。

詳細は フォーマッタ を参照すること。

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

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

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

ポイント

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

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