Java tutorial
/* * Copyright 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 * * http://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.cloud.task.batch.handler; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.Properties; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.batch.core.ExitStatus; import org.springframework.batch.core.Job; import org.springframework.batch.core.JobExecution; import org.springframework.batch.core.JobExecutionException; import org.springframework.batch.core.JobParameters; import org.springframework.batch.core.JobParametersBuilder; import org.springframework.batch.core.JobParametersInvalidException; import org.springframework.batch.core.configuration.JobRegistry; import org.springframework.batch.core.converter.DefaultJobParametersConverter; import org.springframework.batch.core.converter.JobParametersConverter; import org.springframework.batch.core.explore.JobExplorer; import org.springframework.batch.core.launch.JobLauncher; import org.springframework.batch.core.launch.JobParametersNotFoundException; import org.springframework.batch.core.launch.NoSuchJobException; import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException; import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException; import org.springframework.batch.core.repository.JobRestartException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.autoconfigure.batch.JobExecutionEvent; import org.springframework.cloud.task.listener.TaskException; import org.springframework.context.ApplicationEventPublisher; import org.springframework.context.ApplicationEventPublisherAware; import org.springframework.core.Ordered; import org.springframework.util.PatternMatchUtils; import org.springframework.util.StringUtils; /** * {@link CommandLineRunner} to {@link JobLauncher launch} Spring Batch jobs. Runs all * jobs in the surrounding context by default and throw an exception upon the * first job that returns an {@link ExitStatus} of FAILED. * Can also be used to launch a specific job by providing a jobName. The * TaskJobLaunchercommandLineRunner takes the place of the * {@link org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner} * when it is in use. * * @author Glenn Renfro * @since 2.0.0 */ public class TaskJobLauncherCommandLineRunner implements CommandLineRunner, Ordered, ApplicationEventPublisherAware { /** * The default order for the command line runner. */ public static final int DEFAULT_ORDER = 0; private static final Log logger = LogFactory.getLog(TaskJobLauncherCommandLineRunner.class); private JobParametersConverter converter = new DefaultJobParametersConverter(); private JobLauncher jobLauncher; private JobRegistry jobRegistry; private JobExplorer jobExplorer; private String jobNames; private Collection<Job> jobs = Collections.emptySet(); private int order = DEFAULT_ORDER; private ApplicationEventPublisher publisher; public TaskJobLauncherCommandLineRunner(JobLauncher jobLauncher, JobExplorer jobExplorer) { this.jobLauncher = jobLauncher; this.jobExplorer = jobExplorer; } public void setOrder(int order) { this.order = order; } @Override public int getOrder() { return this.order; } @Override public void setApplicationEventPublisher(ApplicationEventPublisher publisher) { this.publisher = publisher; } public void setJobRegistry(JobRegistry jobRegistry) { this.jobRegistry = jobRegistry; } public void setJobNames(String jobNames) { this.jobNames = jobNames; } public void setJobParametersConverter(JobParametersConverter converter) { this.converter = converter; } public void setJobs(Collection<Job> jobs) { this.jobs = jobs; } @Override public void run(String... args) throws JobExecutionException { logger.info("Running default command line with: " + Arrays.asList(args)); launchJobFromProperties(StringUtils.splitArrayElementsIntoProperties(args, "=")); } protected void launchJobFromProperties(Properties properties) throws JobExecutionException { JobParameters jobParameters = this.converter.getJobParameters(properties); executeLocalJobs(jobParameters); executeRegisteredJobs(jobParameters); } private void executeRegisteredJobs(JobParameters jobParameters) throws JobExecutionException { if (this.jobRegistry != null && StringUtils.hasText(this.jobNames)) { String[] jobsToRun = this.jobNames.split(","); for (String jobName : jobsToRun) { try { Job job = this.jobRegistry.getJob(jobName); if (this.jobs.contains(job)) { continue; } execute(job, jobParameters); } catch (NoSuchJobException ex) { logger.debug("No job found in registry for job name: " + jobName); } } } } protected void execute(Job job, JobParameters jobParameters) throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException, JobParametersInvalidException, JobParametersNotFoundException { JobParameters nextParameters = new JobParametersBuilder(jobParameters, this.jobExplorer) .getNextJobParameters(job).toJobParameters(); JobExecution execution = this.jobLauncher.run(job, nextParameters); if (this.publisher != null) { this.publisher.publishEvent(new JobExecutionEvent(execution)); } if (execution.getExitStatus().getExitCode().equals(ExitStatus.FAILED.getExitCode())) { String message = String.format( "Job %s failed during " + "execution for jobId %s with jobExecutionId of %s", execution.getJobInstance().getJobName(), execution.getJobId(), execution.getId()); logger.error(message); throw new TaskException(message); } } private void executeLocalJobs(JobParameters jobParameters) throws JobExecutionException { for (Job job : this.jobs) { if (StringUtils.hasText(this.jobNames)) { String[] jobsToRun = this.jobNames.split(","); if (!PatternMatchUtils.simpleMatch(jobsToRun, job.getName())) { logger.debug("Skipped job: " + job.getName()); continue; } } execute(job, jobParameters); } } }