SpringBatch 监听器之Job监听器(JobExecutionListener)和Step监听器(StepExecutionListener)(五)

最新推荐文章于 2023-06-16 12:40:10 发布
最新推荐文章于 2023-06-16 12:40:10 发布
阅读量8.9k 收藏 10
点赞数 5
CC 4.0 BY-SA版权
分类专栏： SpringBatch学习之路 springboot系列文章 java技能提升
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/TreeShu321/article/details/100746226
本文介绍了如何在SpringBatch中使用Job监听器JobExecutionListener和Step监听器StepExecutionListener。通过两种实现方式，包括注解和接口实现，详细讲解了它们在job和step执行前后进行数据处理的场景。此外，提供了相关监听器的使用示例，以帮助优化代码逻辑。

文章目录

前言：例我们在执行job时候，可能需要在job执行之前预先对一些数据做处理，或者在job执行之后需要做一些处理。这时候我们就可以使用到监听器来帮做我们处理，SpringBatch已经帮我们预先留好接口了。

代码已上传GitHub上面地址：https://github.com/FadeHub/spring-boot-learn/tree/master/spring-boot-springbatch

在spring batch中主要以以下七种监听器为主：

  • Step监听器 ：监听step的执行开始和结束；
  • Job监听器 ：监听job的执行开始和结束；
  • SkipListener监听器 ：在读、处理、写的过程中，监听跳过的异常；
  • ChunkListener监听器 ：监听的chunk的执行开始和结束，或者监听chunk出错
  • ItemReadListener监听器：监听 读之前、读之后、读的时候发生错误
  • ItemProcessListener监听器：监听 处理之前、处理之后、处理的时候发生错误
  • ItemWriteListener监听器：监听 写之前、写之后、写的时候发生错误

SpringBatch其它文章直通车：

了解本专栏 订阅专栏 解锁全文 超级会员免费看
一篇文章教你学会使用SpringBatch 监听器Listener
境里婆娑
07-12 5306
文章目录 写在前面： 我是「境里婆娑」。我还是从前那个少年，没有一丝丝改变，时间只不过是考验，种在心中信念丝毫未减，眼前这个少年，还是最初那张脸，面前再多艰险不退却。 写博客的目的就是分享给大家一起学习交流，如果您对 Java感兴趣，可以关注我，我们一起学习。 前言：为什么要写这篇文章，由于长时间都是在使用连接数据库第三方框架Mybatis等，不使用JDBC操作，导致很多基础知识都朦朦胧胧似懂非懂，今天抽空把这部分内容认真复习了下，顺便写篇文章加深印象。本文以MySql为例。 ...
SpringBatch 监听器之Chunk监听器(ChunkListener)和Skip监听器(SkipListener)(六)
境里婆娑
09-12 3492
文章目录一、Chunk监听器(ChunkListener)二、Skip监听器(SkipListener) 前言：这一章我们接着上一章继续介绍SpringBatch其它监听器ChunkListener和SkipListener。 一、Chunk监听器(ChunkListener) ChunkListener监听器顾名思义，就是SpringBatch一个chunk之前或者之后需要做的事情。 例如：...
监听器Listener
u010502101的博客
03-25 942
在spring batch中主要以以下四种监听器为主： Step监听器 ：监听step的执行开始和结束； Job监听器 ：监听job的执行开始和结束； SkipListener监听器 ：在读、处理、写的过程中，监听跳过的异常； ChunkListener监听器 ：监听的chunk的执行开始和结束，或者监听chunk出错。 一、Step监听器 首先创建一个step监听器，实现StepExe...
Spring Batch 之 ItemProcessor 和 StepListener
vincent
03-17 8000
ItemProcessor 在开发过程中，我们经常需要读取数据后，经过一系列业务逻辑的操作，进而写入数据到指定持久化过程。Spring Batch为我们提供了ItemProcessor接口进行数据处理。 我们可以构建CompositeItemProcessor 的Bean，存储多个Processor，再与Step绑定； @Autowired priva...
SpringBatch Step StepExecution
架构之路
01-23 5423
Step表示作业中的一个完整步骤，一个Job可以由一个或者多个Step组成。Step包含一个实际运行的批处理任务中的所有必须的信息.一个Job可以拥有一到多个Step；一个Step可以有一到多个Step Execution(当一个Step执行失败，下次重新执行该任务的时候，会为该Step重新生成一个StepExecution)；一个JobExecution可以有一到多个StepExecution(当
Spring batch系列文章（三）—— 决策器和监听器
不与三的毛竹
09-22 1923
只能靠写博客来鞭策自己学习了决策器什么是决策器？决策器实现监听器什么是监听器？监听器的实现 系列文章第三篇，学习一下 spring batch 的两个重要的组件，决策器（Decider）和监听器（Listener） 。 第一篇文章的传送门：Spring batch系列文章（一）——介绍和入门 第二篇的文章传送门：Spring batch系列文章（二）——核心api 决策器 什么是决策器？ 简而言之，决策器就是在step执行完成后，根据执行的结果动态进行决策，能够根据不同的结果执行不同的接下来的step，这
Spring Batch 步骤对象-步骤监听器
langfeiyes的博客
02-02 1163
本篇再来讲解spring batch中步骤监听器，看这个步骤监听器与作业监听器有何异同？
Job作业
qq_26326471的博客
05-08 243
日落是太阳给天空的文温柔
Spring Boot 整合——Spring batch的监听器
大风的博客
12-27 2100
关于版本 依赖 版本 springboot 2.4.0 spring batch 2.4.0 代码地址 因为每个例子涉及代码较多，且包含测试用例，如果都贴到文章中内容过多，所以只贴出了部分代码。全部的代码在这里： https://gitee.com/daifyutils/springboot-samples。 此篇文章所属模块为：base-batch-2.4.0 目录地址 目录 测试目录 内容 dai.samples.batch.allowstart dai.sa
SpringBatch JobExecution
架构之路
01-23 5744
Job Execution 表示Job执行的句柄，一次Job执行可能成功也可能失败。只有Job Execution执行成功之后，对应的Job Instance才能被完成。Job Execution对应的数据库表是：BATCH_JOB_EXECUTION,对应的java类是:org.springframework.batch.core.JobExecution。表结构：JobExecution关键属性
SpringBatch(8):利用StepExecutionListener传递Job参数
不积跬步，无以至千里
09-13 1618
Step在执行时，需要一些参数，如何给Step传递参数？
SpringBatch从入门到实战(五)：执行上下文和单步骤重启
人不风流枉少年
06-16 1462
JobContext 绑定 JobExecution 执行对象，为Job作业执行提供执行环境(上下文)。
JobListener 通常不是一个标准的Java接口，但在某些上下文（如Java EE、Spring Batch、Quartz Scheduler等）
BLOG域名:programb.blog.youkuaiyun.com
04-24 369
在Spring Batch中，例如，有一个名为 JobExecutionListener 的接口，它允许你监听Spring Batch作业的执行事件。如果你正在使用某个特定的框架或库（如Spring Batch、Quartz Scheduler等），并且你看到了 JobListener 接口，我建议你查阅该框架或库的官方文档以获取关于这个接口的更多详细信息。您是对的，JobListener 通常不是一个标准的Java接口，而是在某些框架和库中定义的，用于监听作业（Job）的生命周期事件。
Spring Batch 作业对象-作业监听器
langfeiyes的博客
12-15 1043
本篇就来了解一下Spirng Batch 作业监听器，看能玩出啥花样。
SpringBatch(7):监听器
不积跬步，无以至千里
09-13 918
监听器，用于监听作业的执行过程。
Spring batch 的监听机制
justlpf的专栏
03-17 1284
由于实现接口的方式，需要把所有的接口内的方法都需要实现一遍，不太灵活，所以使用注解的方法建立监听器，会比较容易，即我们想使用哪一个监听器的监听方法，就在我们的逻辑方法上面，加上该监听器方法对应的注解即可。由于 Spring batch 的监听器有许多种，但创建方法都十分相似，所以这里只以 StepExecutionListener 为例子，来建立 Step 粒度的监听器。我们甚至可以只使用一个 Class 文件，把多种不同粒度的注解写入，这样就可以一个 class 监听器包含了多种监听器的多个监听方法。
Spring Batch_Intercepting Step Execution
weixin_33890526的博客
11-19 289
2019独角兽企业重金招聘Python工程师标准>>> ...
Spring Batch 框架学习（五）：split并发执行Step
qq_45003757的博客
12-05 1552
我们可以创建多个step和多个flow来看下split是怎么并发执行的，我们需要新建一个类来进行测试 @Configuration @EnableBatchProcessing public class SplitDemo { @Autowired private JobBuilderFactory jobBuilderFactory; @Autowired private StepBuilderFactory stepBuilderFactory; //创建ste
Spring Batch四种模式
qq_36526036的博客
03-22 4565
1、Spring Batch的四种模式 根据官网解读，Spring Batch有以下四种模式： Multi-threaded Step Parallel Step Remote Chunking of Step Partitioning Step 1.1、Multi-threaded Step 多线程Step,根据官网给出的例子，它的定义如下： @Bean public TaskExecuto...
Spring batch writer监听器
最新发布
07-25
<think>我们正在讨论如何编写Spring Batch Writer监听器。根据引用[1]和[2]的内容，我们知道Spring Batch提供了多种监听器，包括Chunk监听器和Skip监听器。但是，用户特别询问了Writer监听器的实现。实际上，Spring Batch并没有直接提供名为"Writer监听器"的接口，但我们可以通过以下方式实现对Writer操作的监听： ### 1. 使用`ItemWriteListener`接口 这是最直接的方式，它提供了三个方法： - `beforeWrite()`: 在Writer执行前调用 - `afterWrite()`: 在Writer成功执行后调用 - `onWriteError()`: 在Writer执行出错时调用 #### 实现示例： ```java import org.springframework.batch.core.ItemWriteListener; import java.util.List; @Component @StepScope public class CustomWriteListener implements ItemWriteListener<YourData> { @Override public void beforeWrite(List<? extends YourData> items) { System.out.println("准备写入 " + items.size() + " 条数据"); } @Override public void afterWrite(List<? extends YourData> items) { System.out.println("成功写入 " + items.size() + " 条数据"); } @Override public void onWriteError(Exception exception, List<? extends YourData> items) { System.err.println("写入失败: " + items.size() + " 条数据，错误信息：" + exception.getMessage()); } } ``` ### 2. 在Step中注册监听器 ```java @Bean public Step myStep(StepBuilderFactory steps, ItemReader<YourData> reader, ItemWriter<YourData> writer, CustomWriteListener writeListener) { return steps.get("myStep") .<YourData, YourData>chunk(100) .reader(reader) .writer(writer) .listener(writeListener) // 注册监听器 .build(); } ``` ### 3. 使用注解方式（更简洁） 如果不希望实现完整接口，可以使用Spring Batch提供的注解： ```java import org.springframework.batch.core.annotation.BeforeWrite; import org.springframework.batch.core.annotation.AfterWrite; import org.springframework.batch.core.annotation.OnWriteError; @Component @StepScope public class AnnotatedWriteListener { @BeforeWrite public void beforeWrite(List<? extends YourData> items) { System.out.println("[注解]准备写入: " + items); } @AfterWrite public void afterWrite(List<? extends YourData> items) { System.out.println("[注解]写入完成: " + items); } @OnWriteError public void onWriteError(Exception exception, List<? extends YourData> items) { System.err.println("[注解]写入错误: " + items + " - " + exception.getMessage()); } } ``` ### 关键点说明： 1. **作用范围**： - `@StepScope`确保每次Step执行都会创建新的监听器实例 - 可访问JobExecutionContext中的属性（通过`@Value("#{stepExecutionContext[...]}")`） 2. **应用场景**： - 日志记录：跟踪写入过程 - 错误处理：自定义写入失败处理逻辑 - 性能监控：记录写入耗时（在before/after中计算时间差） 3. **与Chunk监听器的区别**： - Chunk监听器（如引用[1]）作用于整个chunk周期（读+处理+写） - ItemWriteListener仅针对写入操作 > **注意**：当同时使用多个监听器时，执行顺序为： > 1. `ChunkListener.beforeChunk()` > 2. `ItemReadListener.beforeRead()` > 3. 读取/处理 > 4. `ItemWriteListener.beforeWrite()` > 5. 写入操作 > 6. `ItemWriteListener.afterWrite()` > 7. `ChunkListener.afterChunk()` ### 实际应用：写入前后添加头尾 ```java @Override public void beforeWrite(List<? extends YourData> items) { if (isFirstWrite()) { // 自定义判断逻辑 writer.writeHeader(); // 调用写入器输出文件头 } } @Override public void afterWrite(List<? extends YourData> items) { if (isLastChunk()) { // 自定义判断逻辑 writer.writeFooter(); // 输出文件尾 } } ``` §§相关问题§§ 1. 如何在Spring Batch中监听读取(Reader)操作？ 2. 如何实现Spring Batch的全局作业监听器(JobListener)？ 3. ItemWriteListener和ChunkListener的使用场景有什么区别？ 4. 在监听器中如何访问Spring Batch的上下文信息？ 5. 如何为同一个Step配置多个不同类型的监听器？</think>在 Spring Batch 中，可以通过实现 **`ItemWriteListener` 接口** 或使用 **`@BeforeWrite`、`@AfterWrite`、`@OnWriteError` 注解** 来创建 Writer 监听器。以下是具体实现方法： --- ### 方法一：实现 ItemWriteListener 接口（推荐） ```java import org.springframework.batch.core.ItemWriteListener; import org.springframework.stereotype.Component; import java.util.List; @Component @StepScope public class CustomWriteListener implements ItemWriteListener<YourDataType> { // Writer执行前触发 @Override public void beforeWrite(List<? extends YourDataType> items) { System.out.println("准备写入 " + items.size() + " 条数据"); // 可添加预处理逻辑 } // Writer成功执行后触发 @Override public void afterWrite(List<? extends YourDataType> items) { System.out.println("成功写入 " + items.size() + " 条数据"); // 可添加后处理逻辑（如日志记录） } // Writer执行出错时触发 @Override public void onWriteError(Exception exception, List<? extends YourDataType> items) { System.err.println("写入失败: " + items.size() + " 条数据，错误信息：" + exception.getMessage()); // 可添加错误处理逻辑 } } ``` --- ### 方法二：使用注解方式（更简洁） ```java import org.springframework.batch.core.annotation.*; import org.springframework.stereotype.Component; import java.util.List; @Component @StepScope public class AnnotatedWriteListener { @BeforeWrite public void beforeWrite(List<? extends YourDataType> items) { System.out.println("[注解]准备写入: " + items.size() + " 条数据"); } @AfterWrite public void afterWrite(List<? extends YourDataType> items) { System.out.println("[注解]成功写入: " + items.size() + " 条数据"); } @OnWriteError public void onWriteError(Exception exception, List<? extends YourDataType> items) { System.err.println("[注解]写入错误: " + items.size() + " 条数据"); } } ``` --- ### 在 Step 中注册监听器 ```java @Bean public Step myStep(StepBuilderFactory steps, ItemReader<YourDataType> reader, ItemWriter<YourDataType> writer, CustomWriteListener writeListener) { // 注入监听器 return steps.get("myStep") .<YourDataType, YourDataType>chunk(100) .reader(reader) .writer(writer) .listener(writeListener) // 注册监听器 .build(); } ``` --- ### 关键特性说明 1. **监听时机**： - `beforeWrite()`：Writer执行前触发（可访问待写入数据） - `afterWrite()`：Writer成功执行后触发（可访问已写入数据） - `onWriteError()`：Writer执行失败时触发（可访问异常和问题数据）[^1] 2. **作用域控制**： - `@StepScope` 确保每次Step执行都创建新的监听器实例 - 可访问Job参数：`@Value("#{jobParameters['param']}")` 3. **典型应用场景**： ```java @AfterWrite public void logWriteMetrics(List<? extends YourDataType> items) { metricsService.recordWriteCount(items.size()); // 记录写入指标 } @OnWriteError public void handleWriteFailure(Exception ex, List<?> items) { errorReporter.reportFailedItems(items, ex); // 报告失败数据 } ``` 4. **与Chunk监听器的区别**： - `ItemWriteListener` 只监听Writer操作 - `ChunkListener` 监听整个chunk周期（读+处理+写）[^1][^2] > **最佳实践**：对于纯Writer操作监听，优先选择 `ItemWriteListener`；若需监控整个chunk生命周期（包含读/处理/写），则使用 `ChunkListener`[^1]。 --- ### 常见问题解决方案 **问题：如何获取写入的文件路径？** ```java @BeforeWrite public void beforeWrite(ChunkContext chunkContext) { StepContext stepContext = chunkContext.getStepContext(); String filePath = stepContext.getJobParameters().getString("outputPath"); System.out.println("写入文件: " + filePath); } ``` **问题：如何跳过特定数据的写入？** 在 `beforeWrite` 中过滤数据： ```java @Override public void beforeWrite(List<? extends YourDataType> items) { items.removeIf(item -> item.shouldSkip()); // 动态过滤数据 } ```
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

境里婆娑

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值