Spring Batch 之 JobParameters (十)

继续前面关于Spring Batch系列的文章，本文主要介绍与JobParameters相关的一些知识。

一、JobParameters

顾名思义，所谓JobParameters，就是Job运行时的参数。它在bath中有两个作用：一是标示不同的jobInstance，二是作为job中用到的信息，以参数的形式传给job。

如何使用JobParameters呢？它主要是在启动的job的时候，与job联系起来的。看一下框架提供的启动job的接口JobLauncher的源代码，就会发现其run方法需要两个参数，一个是Job，也就是需要启动的job，另一个就是JobParameters。可以通过如下方式使用：

jobLauncher.run(job, new JobParametersBuilder()

.addString("para1", "value1")

.addString("para2","value2")

.toJobParameters()

);

如代码所示，参数para1和para2就可以传给Job了，在Job中如果需要使用参数信息，可以使用Spring注入的方式传给不同的使用对象。

<bean:bean id="itemReader" class="com.wanggc.springbatch.BatchItemReader" scope="step">
      <bean:property name="filePath" value="#{jobParameters['inputFilePath']}" />
</bean:bean>

注意需要设置Bean的scope属性为step，这是SpringBatch的一个后绑定技术，就是在生成Step的时候，才去创建bean，因为这个时候jobparameter才传过来。如果加载配置信息的时候就创建bean，这个时候jobparameter的值还没有产生，会抛出异常。

二、JobParametersValidator

SpringBatch框架支持JobParameters的简单验证，并提供了JobParametersValidator接口和validate方法，用于在job启动之前对参数信息验证和检查。如果需要对参数进行验证，就可以实现此接口，并在validate方法中定制验证规则，当验证失败的时候，会抛出JobParametersInvalidException异常。当然，SpringBatch框架也提供了一个默认的验证类DefaultJobParametersValidator，但此类验证功能有限，主要用于必须项和非必须项的验证。通过如下配置可以实现此验证功能。

<job id="batchJob">            
    ......        
    <validator ref="jobParametersValidator" />        
</job>            
<bean:bean id="jobParametersValidator"            
    class="org.springframework.batch.core.job.DefaultJobParametersValidator">        
    <bean:property name="requiredKeys">        
        <bean:set>    
            <bean:value>para1</bean:value>
            <bean:value>para2</bean:value>
            <bean:value>para3</bean:value>
        </bean:set>    
    </bean:property>        
    <bean:property name="optionalKeys">        
        <bean:set>    
            <bean:value>para4</bean:value>
        </bean:set>    
    </bean:property>        
</bean:bean>

DefaultJobParametersValidator类提供两个重要属性：requiredKeys和optionalKeys，前者为JobParameters中必须包含的项，但对参数的实际值不做check(不做空的check)，只要包含此项的key就可以了；后者为可选项，有没有此项都可以。但如果JobParameters中含有两者以外的项，也会抛出JobParametersInvalidException异常。

三、JobParametersIncrementer

JobParametersIncrementer主要用于JobOperator接口的startNextInstance等方法启动job的情况下。同一个Job在batch启动后被多次调用的场合，startNextInstance方法将会非常有用，因为它将使用JobParametersIncrementer与Job绑定，创建一个新实例。因为JobParametersIncrementer有一个getNext方法，可以在此方法中为parameters添加一个自增的值，以区分不同的Job实例，当然，这个值在job的其他的地方并不会用到，仅仅是为了标示不同JobInstance。当然SpringBatch框架也为我们提供了一个JobParametersIncrementer的实现类RunIdIncrementer 。使用方法如下:

<job id="batchJob" incrementer="sampleIncrementer">        
    ......    
    <validator ref="jobParametersValidator" />    
</job>        
<bean:bean id="sampleIncrementer"        
        class="org.springframework.batch.core.launch.support.RunIdIncrementer"/>

RunIdIncrementer的getNext方法实现如下：

public JobParameters getNext(JobParameters parameters) {            
        if (parameters == null) {    
            parameters = new JobParameters();
        }    
        long id = parameters.getLong(key, 0L) + 1;    
        return new JobParametersBuilder(parameters).addLong(key, id).toJobParameters();    
    }