스프링 배치가 제공하는 기본 ItemReader 상속해서 사용하기

🤔 배경

프로젝트 배치 모듈 개발 컨벤션을 정하는 과정에서 처음에 Job 설정 파일에 관련된 모든 Bean(Job, Step, ItemReader, 등)을 넣자고 했을 때 "그러면 Chunk 기반 Step을 구성 중에 ItemReader와 ItemWriter 중 하나는 스프링에서 제공하는 기본적인 클래스를 사용하고, 하나는 기능이 복잡해서 별도로 만든다고 하면 어떻게 하는 게 좋을까?" 라는 질문이 나왔다.

 

예를 들면, ItemReader는 구현이 단순해서 FlatFileItemReader를 사용하고, Writer는 복잡해서 별도 클래스에 ItemWriter를 구현한다는 의미이다.

 

해당 질문을 듣고 나는 "ItemReader는 설정 파일에 Bean으로 등록하고, Writer는 별도 클래스로 빼는 게 맞는 걸까?" 이런 의문이 들면서 "만약, 스프링에서 제공하는 기본 배치 클래스를 Bean으로 등록하지 않고 상속해서 구현하려면 어떻게 해야 할까?"라는 고민을 하게 되었다.

 

    @Bean
    @StepScope
    public FlatFileItemReader<FileItem> blackShibaItemReader(@Value("#{jobParameter[filePath]}") String filePath) {
        DefaultLineMapper<FileItem> lineMapper = new DefaultLineMapper<>();
        DelimitedLineTokenizer tokenizer = new DelimitedLineTokenizer();

        tokenizer.setNames("id","name","address");
        lineMapper.setLineTokenizer(tokenizer);
        lineMapper.setFieldSetMapper(fieldSet -> {
            int id = fieldSet.readInt("id");
            String name = fieldSet.readString("name");
            String address = fieldSet.readString("address");

            return new FileItem(id,name,address);
        });

        return new FlatFileItemReaderBuilder<FileItem>()
                .name("blackShibaItemReader")
                .encoding("UTF-8")
                .resource(new ClassPathResource(filePath))
                .linesToSkip(1)
                .lineMapper(lineMapper)
                .build();
    }

 

위 코드처럼 Bean으로 등록하는 FlatFileItemReader를 별도 클래스로 상속받아서 구현하려면 어떻게 해야 할까?

그리고 이런 경우에 JobParameter는 어떻게 주입해 줄 수 있을까?

 

@Component
@StepScope
public class BlackShibaItemReader extends FlatFileItemReader<FileItem> {

    public BlackShibaItemReader(@Value("#{jobParameter[filePath]}") String filePath) {
        super();

        DefaultLineMapper<FileItem> lineMapper = new DefaultLineMapper<>();
        DelimitedLineTokenizer tokenizer = new DelimitedLineTokenizer();

        tokenizer.setNames("id","name","address");
        lineMapper.setLineTokenizer(tokenizer);
        lineMapper.setFieldSetMapper(fieldSet -> {
            int id = fieldSet.readInt("id");
            String name = fieldSet.readString("name");
            String address = fieldSet.readString("address");

            return new FileItem(id,name,address);
        });

        setName("blackShibaItemReader");
        setEncoding("UTF-8");
        setResource(new ClassPathResource(filePath));
        setLinesToSkip(1);
        setLineMapper(lineMapper);
    }
}

 

스프링 배치가 기본으로 제공하는 클래스에서는 setter를 통해서 주입이 가능하도록 기능을 지원하고 있다.

따라서 생성자 단에서 동일한 기능을 setter를 통해 설정하면 된다.

 

만약 JobParameter 등을 주입받는 경우 @StepScope 어노테이션을 클래스 단에 설정해야 한다.