FlatFileItemReder setCommentsの使い方

Question

実現したいこと

フレームワークはSpringを使用しています。
FlatFileItemReder setCommentsの使い方をご存知の方いらっしゃいましたら教えていただきたいです。
String配列を渡せばいいのはjavaリファレンスを読んで分かりましたが、使用例が検索しても出てきません。

発生している問題・分からないこと

※ちなみにやりたいことは、読み込んだファイルの行の先頭文字が特定の文字だった場合、その行を読み込まない、ということをやりたいです。

該当のソースコード

特になし

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

使用例は出てきませんでした。

補足

特になし

Comments

[jimbe]

揚げ足取るつもりは無いですが・・・
FlatFileItemReader では無いですか？

Answer 1

FlatFileItemReder setCommentsの使い方をご存知の方いらっしゃいましたら教えていただきたいです。
String配列を渡せばいいのはjavaリファレンスを読んで分かりましたが、使用例が検索しても出てきません。

確かに、Spring Batch関連のサンプルコードは少ないようです。まぁ、もともとFlatFileItemReader クラスやそのsetComments メソッドの使い方を知っている人は少ないでしょうし、知っていても本質問を閲覧しているとは限りませんから、そんな場合は実際に書いて試してみるのが一番の近道です。

FlatFileItemReaderクラスは知りませんでしたが、興味がわいたので試してみました。まず簡単に、FlatFileItemReader.setCommentsメソッドについては、例えばこんな風に使います。

	FlatFileItemReader<Hoge> reader = new FlatFileItemReader<>();

	// コメント行とみなす行頭の文字列群をセット
	reader.setComments(new String[] { "#", ";", "//" });

Spring Batchのテスト用コードを書いて実際に試してみます。まず、ID, 名前, 年齢がCSV形式で保存されているデータファイルdata.csvを用意します。1行目はヘッダーで、"#", ";", "//" が行頭にあったらそれはコメント行とします。

• src/main/resources/data.csv

id,name,age
1,James,15
2,Mary,20
# comment1
; comment2
3,Michael,25
// comment3
4,Patricia,30

data.csvの各行の項目がマップされるPersonクラスです。greetメソッドで挨拶用の文字列を出力します。

• src/main/java/com/example/test4/Person.java

package com.example.test4;

public class Person {
	private int id;
	private String name;
	private int age;
	private int lineNumber; // 行番号

	public int getId() {
		return this.id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return this.name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return this.age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public int getLineNumber() {
		return this.lineNumber;
	}

	public void setLineNumber(int lineNumber) {
		this.lineNumber = lineNumber;
	}

	@Override
	public String toString() {
		String result = String.format("id=%d, name=%s, age=%d", id, name, age);
		return result;
	}

	public String greet() {
		String result = String.format("Hello! My name is %s. %d years old. (id=%d, lineNumber=%d)", name, age, id,
				lineNumber);
		return result;
	}
}

で、LineMapper をimplementsしたPersonLineMapperクラスです。

• src/main/java/com/example/test4/PersonLineMapper.java

package com.example.test4;

import org.springframework.batch.item.file.LineMapper;

public class PersonLineMapper implements LineMapper<Person> {
	@Override
	public Person mapLine(String line, int lineNumber) {
		String[] fields = line.split(",");
		Person person = new Person();
		person.setId(Integer.parseInt(fields[0]));
		person.setName(fields[1]);
		person.setAge(Integer.parseInt(fields[2]));
		person.setLineNumber(lineNumber);
		return person;
	}
}

BatchConfigです。

• src/main/java/com/example/test4/BatchConfig.java

package com.example.test4;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.step.builder.StepBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.batch.item.file.FlatFileItemReader;

@Configuration
public class BatchConfig {

	@Bean
	public FlatFileItemReader<Person> reader() {
		FlatFileItemReader<Person> reader = new FlatFileItemReader<>();
		reader.setResource(new ClassPathResource("data.csv"));
		// 1行目のヘッダーをスキップ
		reader.setLinesToSkip(1);

		// コメント行とみなす行頭の文字列群をセット
		reader.setComments(new String[] { "#", ";", "//" });
		reader.setLineMapper(new PersonLineMapper());
		return reader;
	}

	@Bean
	public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
		return new StepBuilder("step1", jobRepository).<Person, Person>chunk(10, transactionManager).reader(reader())
				.writer(items -> items.forEach((item) -> {
					System.out.println(">>> " + item.greet());
				})).build();
	}

	@Bean
	public Job job(JobRepository jobRepository, Step step1) {
		return new JobBuilder("job", jobRepository).start(step1).build();
	}
}

これを実行すると、writerによりターミナル上で以下のような出力を得られます。

...略
>>> Hello! My name is James. 15 years old. (id=1, lineNumber=2)
>>> Hello! My name is Mary. 20 years old. (id=2, lineNumber=3)
>>> Hello! My name is Michael. 25 years old. (id=3, lineNumber=6)
>>> Hello! My name is Patricia. 30 years old. (id=4, lineNumber=8)
...略

CSVファイルのコメント行はスキップされ、各々のレコードがオブジェクトにマップされてPerson.greetメソッドで出力されているのが分かります。FlatFileItemReader.setCommentsメソッド、便利ですね。

最後にバージョン情報も簡単に載せておきます。

• Eclipse IDE: 2025-06 (4.36.0)
• Spring Boot: 3.5.5
• Java: 11

Comments

[hanahanahana]

詳細に回答してくださり、ありがとうございました！
ベストアンサーに選ばせていただきました。

[dodox86]

お役に立てたようでよかったです。

> ベストアンサーに選ばせていただきました。
えっと、ご質問が解決済みになっていないようです。こちらもお願いします。
[質問を解決済みにしたい] https://teratail.com/help#resolve-question