Spring Boot批处理作业运行时传入参数的实现方案咨询

我来帮你梳理下正确的实现方式，避开那些搜索时常见的坑，同时满足组织规范要求：

一、直接通过Spring Boot Jar传递参数（基础方式） #

先明确最基础的正确用法，虽然你需要用脚本或CommandLineJobRunner，但这个是底层逻辑：
运行Spring Boot可执行Jar时，直接在--后追加参数，这些参数会被Spring Batch的Job接收：

java -jar your-batch-app.jar --inputFile=data.csv --outputFile=result.csv

在Job配置类里，你可以通过@Value注解直接注入参数，或者通过JobParameters获取：

@Bean
public FlatFileItemReader<User> reader(@Value("${inputFile}") String inputFile) {
    // 在这里使用inputFile参数配置读取器
}

二、使用CommandLineJobRunner的正确姿势 #

很多人踩坑是没搞对版本差异或参数格式，以下是通用的正确用法：

1. 命令格式（针对Fat Jar） #

如果你的应用是Spring Boot构建的可执行Jar，调用CommandLineJobRunner的正确命令是：

java -cp your-batch-app.jar org.springframework.batch.core.launch.support.CommandLineJobRunner com.yourpackage.JobConfiguration yourJobName inputFile=data.csv outputFile=result.csv

逐一解释下各部分：

• org.springframework.batch.core.launch.support.CommandLineJobRunner：官方提供的Job启动器类
• com.yourpackage.JobConfiguration：你的Job配置类全限定名（就是带@Configuration和@EnableBatchProcessing的那个类）
• yourJobName：你定义的Job的Bean名称（比如@Bean方法名，或者JobBuilder里指定的名称）
• 后面的key=value：传递给Job的参数，不需要加--，这些参数会被封装到JobParameters中

2. 关键注意事项 #

• 版本兼容：Spring Boot 2.x及以上版本用法和1.x一致，只要依赖里包含spring-boot-starter-batch就没问题
• 禁用自动启动：如果你的应用默认会自动启动所有Job（Spring Boot自动配置行为），可以在application.properties里加：spring.batch.job.enabled=false，这样只有通过CommandLineJobRunner调用时才会启动指定Job，避免冲突
• 获取参数：在Step里可以通过StepExecution获取Job参数：

@Bean
public ItemWriter<User> writer() {
    return items -> {
        StepExecution stepExecution = StepSynchronizationManager.getContext().getStepExecution();
        String outputFile = stepExecution.getJobParameters().getString("outputFile");
        // 用outputFile处理输出逻辑
    };
}

三、Shell脚本封装（符合组织规范） #

为了符合组织规范，你可以写一个Shell脚本封装调用逻辑，增加参数校验、日志记录等，示例如下：

#!/bin/bash

# 脚本配置项，根据实际情况修改
APP_JAR="/opt/apps/your-batch-app.jar"
JOB_CONFIG_CLASS="com.yourcompany.batch.JobConfig"
JOB_NAME="importUserJob"
LOG_DIR="/var/log/batch-jobs"
LOG_FILE="$LOG_DIR/import-user-$(date +%Y%m%d).log"

# 创建日志目录
mkdir -p $LOG_DIR

# 参数校验
if [ $# -ne 2 ]; then
    echo "用法错误：$0 <输入文件路径> <输出文件路径>"
    exit 1
fi

INPUT_FILE=$1
OUTPUT_FILE=$2

# 启动Job并记录日志
echo "[$(date +'%Y-%m-%d %H:%M:%S')] 开始执行批处理作业" >> $LOG_FILE
java -cp $APP_JAR org.springframework.batch.core.launch.support.CommandLineJobRunner $JOB_CONFIG_CLASS $JOB_NAME inputFile=$INPUT_FILE outputFile=$OUTPUT_FILE >> $LOG_FILE 2>&1

# 检查执行结果
if [ $? -eq 0 ]; then
    echo "[$(date +'%Y-%m-%d %H:%M:%S')] 批处理作业执行成功" >> $LOG_FILE
    exit 0
else
    echo "[$(date +'%Y-%m-%d %H:%M:%S')] 批处理作业执行失败" >> $LOG_FILE
    exit 1
fi

使用方式：

# 给脚本加执行权限
chmod +x run-import-job.sh
# 运行脚本
./run-import-job.sh /data/input.csv /data/output.csv

这个脚本可以根据组织规范扩展，比如加入环境变量配置、权限控制、失败告警等。

四、常见错误规避 #

• 类路径错误：如果出现ClassNotFoundException，检查Job配置类的全限定名是否正确，或者Jar包路径是否有误
• Job名称错误：确保yourJobName和配置类中Job Bean的名称完全一致（包括大小写）
• 参数格式错误：用CommandLineJobRunner时，参数不要加--，否则会被当成JVM参数，而非Job参数
• 自动启动冲突：必须设置spring.batch.job.enabled=false，否则应用启动时会自动执行所有Job，导致不符合预期的执行

内容的提问来源于stack exchange，提问作者CardsFan