Spring Batch (9) JobParametersValidator

지난 시간에는 JobLauncher에 대해 살펴보았습니다.

 

JobLauncher는 실제 Spring Batch Job을 실행하는 역할을 하며, Job & JobParameters를 인자로 받아 배치 작업을 수행한 후 JobExecution을 반환합니다. 

 

Spring Batch에서는 BatchAutoConfiguration 클래스 내의 JobLauncherApplicationRunner 클래스가 Job을 실행하게 됩니다.

 

 

 

📌 JobParametersValidator

기본 개념

• Job 실행 시 필수적인 파라미터를 검증하는 역할입니다.
• 기본적으로 DefaultJobParametersValidator 구현체를 지원하며, JobParametersValidator 인터페이스를 직접 구현하여 파라미터를 검증할 수도 있습니다.

 

 

 

📌 예제 코드 1. JobParametersValidator 인터페이스 직접 구현

첫 번째로 JobParametersValidator 인터페이스를 직접 구현하여 설정하는 방법에 대해 살펴보겠습니다.

import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersInvalidException;
import org.springframework.batch.core.JobParametersValidator;

public class CustomJobParametersValidator implements JobParametersValidator {

    @Override
    public void validate(JobParameters jobParameters) throws JobParametersInvalidException {

        if (jobParameters.getString("name") == null) {
            throw new JobParametersInvalidException("name parameter is not found.");
        }
    }
}

위 예제는 JobParameters에 key가 name인 파라미터가 존재하지 않으면 예외가 발생하는 코드입니다.

 

 

실제 적용은 아래와 같이 Job에서 validator() 메서드를 통해 위에서 생성한 CustomJobParametersValidator 인스턴스를 생성하면 됩니다.

JobBuilderHelper

@RequiredArgsConstructor
@Configuration
public class ValidatorConfiguration {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job parametersValidatorJob() {
        return this.jobBuilderFactory.get("parametersValidatorJob")
                .validator(new CustomJobParametersValidator()) // Validator 설정
                .start(parametersValidatorStep1())
                .next(parametersValidatorStep2())
                .next(parametersValidatorStep3())
                .build();
    }
    
    ... 
}

 

 

Spring Batch에서 JobParameters에 대한 검증은 총 2번이 이루어집니다.

1. JobLauncher 인터페이스의 구현체인 SimpleJobLauncher에서 JobParameters 검증
2. Job 인터페이스의 구현체인 AbstractJob 추상 클래스에서 JobParameters 검증

1. SimpleJobLauncher.run()

 

2. AbstractJob.execute()

 

 

 

AbstractJob

커스텀 Validator를 설정하고 실행해보면 위와 같이 AbstractJob 추상 클래스에서 setter를 통해 validator를 설정합니다.

 

SimpleJobLauncher

그 후 첫 번째 검증인 SimpleJobLauncher 클래스에서 validate() 메서드를 통해 검증합니다.

다음으로 AbstractJob 추상 클래스의 validate() 메서드에서도 검증이 되어야하나, 위 예시는 예외를 발생하여 이후 로직은 진행이 되지 않습니다.

 

 

예제 코드에서는 파라미터에 requestDate라는 key를 설정했기 때문에 name에 해당하는 key는 존재하지 않아 null로 나오고, 커스텀 Validator 클래스에서 설정한 메시지를 출력하며 예외가 발생합니다.

 

 

 

만약 위처럼 JobParameters에 key를 name으로 설정하여 다시 실행해보면 검증에 통과하여 정상적으로 실행이 됩니다.

 

 

두 번째 검증인 AbstractJob 추상 클래스에서도 정상적으로 validate() 메서드를 통과하여 Batch Job이 실행됩니다.

 

 

 

📌 예제 코드 2. DefaultJobParametersValidator 구현체 사용

다음으로 Spring Batch에서 기본적으로 제공하는 JobParametersValidator 인터페이스의 기본 구현체인 DefaultJobParametersValidator 클래스에 대해 살펴보겠습니다.

 

 

/*
 * Copyright 2012-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.batch.core.job;
 
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
 
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersInvalidException;
import org.springframework.batch.core.JobParametersValidator;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
 
/**
 * Default implementation of {@link JobParametersValidator}.
 *
 * @author Dave Syer
 * @author Mahmoud Ben Hassine
 *
 */
public class DefaultJobParametersValidator implements JobParametersValidator, InitializingBean {
 
    private Collection<String> requiredKeys;
 
    private Collection<String> optionalKeys;
 
    /**
     * Convenient default constructor for unconstrained validation.
     */
    public DefaultJobParametersValidator() {
        this(new String[0], new String[0]);
    }
 
    /**
     * Create a new validator with the required and optional job parameter keys
     * provided.
     *
     * @see DefaultJobParametersValidator#setOptionalKeys(String[])
     * @see DefaultJobParametersValidator#setRequiredKeys(String[])
     *
     * @param requiredKeys the required keys
     * @param optionalKeys the optional keys
     */
    public DefaultJobParametersValidator(String[] requiredKeys, String[] optionalKeys) {
        super();
        setRequiredKeys(requiredKeys);
        setOptionalKeys(optionalKeys);
    }
 
    /**
     * Check that there are no overlaps between required and optional keys.
     * @throws IllegalStateException if there is an overlap
     */
    @Override
    public void afterPropertiesSet() throws IllegalStateException {
        for (String key : requiredKeys) {
            Assert.state(!optionalKeys.contains(key), "Optional keys cannot be required: " + key);
        }
    }
 
    /**
     * Check the parameters meet the specification provided. If optional keys
     * are explicitly specified then all keys must be in that list, or in the
     * required list. Otherwise all keys that are specified as required must be
     * present.
     *
     * @see JobParametersValidator#validate(JobParameters)
     *
     * @throws JobParametersInvalidException if the parameters are not valid
     */
    @Override
    public void validate(@Nullable JobParameters parameters) throws JobParametersInvalidException {
 
        if (parameters == null) {
            throw new JobParametersInvalidException("The JobParameters can not be null");
        }
 
        Set<String> keys = parameters.getParameters().keySet();
 
        // If there are explicit optional keys then all keys must be in that
        // group, or in the required group.
        if (!optionalKeys.isEmpty()) {
 
            Collection<String> missingKeys = new HashSet<>();
            for (String key : keys) {
                if (!optionalKeys.contains(key) && !requiredKeys.contains(key)) {
                    missingKeys.add(key);
                }
            }
            if (!missingKeys.isEmpty()) {
                throw new JobParametersInvalidException(
                        "The JobParameters contains keys that are not explicitly optional or required: " + missingKeys);
            }
 
        }
 
        Collection<String> missingKeys = new HashSet<>();
        for (String key : requiredKeys) {
            if (!keys.contains(key)) {
                missingKeys.add(key);
            }
        }
        if (!missingKeys.isEmpty()) {
            throw new JobParametersInvalidException("The JobParameters do not contain required keys: " + missingKeys);
        }
 
    }
 
    /**
     * The keys that are required in the parameters. The default is empty,
     * meaning that all parameters are optional, unless optional keys are
     * explicitly specified.
     *
     * @param requiredKeys the required key values
     *
     * @see #setOptionalKeys(String[])
     */
    public final void setRequiredKeys(String[] requiredKeys) {
        this.requiredKeys = new HashSet<>(Arrays.asList(requiredKeys));
    }
 
    /**
     * The keys that are optional in the parameters. If any keys are explicitly
     * optional, then to be valid all other keys must be explicitly required.
     * The default is empty, meaning that all parameters that are not required
     * are optional.
     *
     * @param optionalKeys the optional key values
     *
     * @see #setRequiredKeys(String[])
     */
    public final void setOptionalKeys(String[] optionalKeys) {
        this.optionalKeys = new HashSet<>(Arrays.asList(optionalKeys));
    }
 
}
 

 

DefaultJobParametersValidator 클래스에는 requiredKeys, optionalKeys 두 개의 컬렉션 필드가 존재합니다.

 

변수명에서 알 수 있듯이 각각 필수 key, 옵셔널 key를 의미하는데요 requiredKeys는 단어 그대로 파라미터에 반드시 존재해야 하는 key를 의미하며 optionalKeys는 파라미터에 존재하지 않아도 상관이 없습니다.

 

@RequiredArgsConstructor
@Configuration
public class ValidatorConfiguration {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job parametersValidatorJob() {
        String[] requiredKeys = {"name", "date"};
        String[] optionalKeys = {"year"};

        return this.jobBuilderFactory.get("parametersValidatorJob")
                .validator(new DefaultJobParametersValidator(requiredKeys, optionalKeys))
                .start(parametersValidatorStep1())
                .next(parametersValidatorStep2())
                .next(parametersValidatorStep3())
                .build();
    }

위 코드에서 필수 키는 name, date 이므로 두 key가 JobParameters에 반드시 포함이 되어야 합니다.

• name, date = 필수
• year = 선택

 

만약 위처럼 파라미터에 필수 키인 date가 존재하지 않는다면, Job이 정상적으로 수행되지 않고 실패할 것이라고 예상할 수 있습니다.

 

 

DefaultJobParametersValidator 클래스의 validate() 메서드에서 첫 for문 내에서의 검증은 입력받은 JobParameters에 대해 검증하여 optionalKeys, requiredKeys 두 컬렉션에 모두 존재하지 않는다면 예외가 발생합니다.

 

 

그 후 두 번째 for문에서 requiredKeys에 해당하는 date 키가 파라미터에 존재하지 않기 때문에 misskingKeys에 존재하지 않는 key를 추가하고, 이후 if문에서 예외가 발생합니다.

required Keys에서 date 키가 존재하지 않기 때문에 예외가 발생합니다.

 

 

만약 requiredKeys에 해당하는 name, date를 모두 파라미터로 설정한다면 정상적으로 검증에 성공하여 Job이 실행이 됩니다.

 

 

 

 

참고 문서

• https://docs.spring.io/spring-batch/docs/current/reference/html/index-single.html
• https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B0%B0%EC%B9%98/dashboard