1 前言
Spring Batch
远程分区对于大量数据的处理非常擅长,它的实现有多种方式,如本地Jar包模式
、MQ模式
、Kubernetes模式
。这三种模式的如下:
(1)本地Jar包模式
:分区处理的worker
为一个Java进程
,从jar
包启动,通过jvm
参数和数据库传递参数;官方提供示例代码。
(2)MQ模式
:worker
是一个常驻进程,Manager
和Worker
通过消息队列来传递参数;网上有不少相关示例代码。
(3)Kubernetes模式
:worker
为K8s
中的Pod
,Manager
直接启动Pod
来处理;网上并没有找到任何示例代码。
本文将通过代码来讲解第一种模式(本地Jar包模式
),其它后续再介绍。
建议先看下面文章了解一下:
Spring Batch入门:Spring Batch入门教程篇
Spring Batch并行处理介绍:详解SpringBoot和SpringBatch 使用
2 代码讲解
本文代码中,Manager
和Worker
是放在一起的,在同一个项目里,也只会打一个jar
包而已;我们通过profile
来区别是manager
还是worker
,也就是通过Spring Profile
实现一份代码,两份逻辑。实际上也可以拆成两份代码,但放一起更方便测试,而且代码量不大,就没有必要了。
2.1 项目准备
2.1.1 数据库
首先我们需要准备一个数据库,因为Manager
和Worker
都需要同步状态到DB
上,不能直接使用嵌入式的内存数据库了,需要一个外部可共同访问的数据库。这里我使用的是H2 Database
,安装可参考:把H2数据库从jar包部署到Kubernetes,并解决Ingress不支持TCP的问题。
2.1.2 引入依赖
maven
引入依赖如下所示:
org.springframework.boot spring-boot-starter-batch org.springframework.cloud spring-cloud-starter-task com.h2database h2 runtime org.springframework.cloud spring-cloud-deployer-local 2.4.1 org.springframework.batch spring-batch-integration
spring-cloud-deployer-local
用于部署和启动worker
,非常关键;其它就是Spring Batch
和Task
相关的依赖;以及数据库连接。
2.1.3 主类入口
Springboot
的主类入口如下:
@EnableTask @SpringBootApplication @EnableBatchProcessing public class PkslowRemotePartitionJar { public static void main(String[] args) { SpringApplication.run(PkslowRemotePartitionJar.class, args); } }
在Springboot
的基础上,添加了Spring Batch
和Spring Cloud Task
的支持。
2.2 关键代码编写
前面的数据库搭建和其它代码没有太多可讲的,接下来就开始关键代码的编写。
2.2.1 分区管理Partitioner
Partitioner
是远程分区中的核心bean
,它定义了分成多少个区、怎么分区,要把什么变量传递给worker
。它会返回一组<分区名,执行上下文>的键值对,即返回Map
。把要传递给worker
的变量放在ExecutionContext
中去,支持多种类型的变量,如String
、int
、long
等。实际上,我们不建议通过ExecutionContext
来传递太多数据;可以传递一些标识或主键,然后worker
自己去拿数据即可。
具体代码如下:
private static final int GRID_SIZE = 4; @Bean public Partitioner partitioner() { return new Partitioner() { @Override public Mappartition(int gridSize) { Map partitions = new HashMap<>(gridSize); for (int i = 0; i < GRID_SIZE; i++) { ExecutionContext executionContext = new ExecutionContext(); executionContext.put("partitionNumber", i); partitions.put("partition" + i, executionContext); } return partitions; } }; }
上面分成4个区,程序会启动4个worker
来处理;给worker
传递的参数是partitionNumber
。
2.2.2 分区处理器PartitionHandler
PartitionHandler
也是核心的bean
,它决定了怎么去启动worker
,给它们传递什么jvm
参数(跟之前的ExecutionContext
传递不一样)。
@Bean public PartitionHandler partitionHandler(TaskLauncher taskLauncher, JobExplorer jobExplorer, TaskRepository taskRepository) throws Exception { Resource resource = this.resourceLoader.getResource(workerResource); DeployerPartitionHandler partitionHandler = new DeployerPartitionHandler(taskLauncher, jobExplorer, resource, "workerStep", taskRepository); ListcommandLineArgs = new ArrayList<>(3); commandLineArgs.add("--spring.profiles.active=worker"); commandLineArgs.add("--spring.cloud.task.initialize-enabled=false"); commandLineArgs.add("--spring.batch.initializer.enabled=false"); partitionHandler .setCommandLineArgsProvider(new PassThroughCommandLineArgsProvider(commandLineArgs)); partitionHandler .setEnvironmentVariablesProvider(new SimpleEnvironmentVariablesProvider(this.environment)); partitionHandler.setMaxWorkers(2); partitionHandler.setApplicationName("PkslowWorkerJob"); return partitionHandler; }
上面代码中:
resource
是worker
的jar
包地址,表示将启动该程序;
workerStep
是worker
将要执行的step
;
commandLineArgs
定义了启动worker
的jvm
参数,如--spring.profiles.active=worker
;
environment
是manager
的系统环境变量,可以传递给worker
,当然也可以选择不传递;
MaxWorkers
是最多能同时启动多少个worker
,类似于线程池大小;设置为2,表示最多同时有2个worker
来处理4个分区。
2.2.3 Manager和Worker的Batch定义
完成了分区相关的代码,剩下的就只是如何定义Manager
和Worker
的业务代码了。
Manager
作为管理者,不用太多业务逻辑,代码如下:
@Bean @Profile("!worker") public Job partitionedJob(PartitionHandler partitionHandler) throws Exception { Random random = new Random(); return this.jobBuilderFactory.get("partitionedJob" + random.nextInt()) .start(step1(partitionHandler)) .build(); } @Bean public Step step1(PartitionHandler partitionHandler) throws Exception { return this.stepBuilderFactory.get("step1") .partitioner(workerStep().getName(), partitioner()) .step(workerStep()) .partitionHandler(partitionHandler) .build(); }
Worker
主要作用是处理数据,是我们的业务代码,这里就演示一下如何获取Manager
传递过来的partitionNumber
:
@Bean public Step workerStep() { return this.stepBuilderFactory.get("workerStep") .tasklet(workerTasklet(null, null)) .build(); } @Bean @StepScope public Tasklet workerTasklet(final @Value("#{stepExecutionContext['partitionNumber']}") Integer partitionNumber) { return new Tasklet() { @Override public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception { Thread.sleep(6000); //增加延时,查看效果,通过jps:在jar情况下会新起java进程 System.out.println("This tasklet ran partition: " + partitionNumber); return RepeatStatus.FINISHED; } }; }
通过表达式@Value("#{stepExecutionContext['partitionNumber']}")
获取Manager
传递过来的变量;注意要加注解@StepScope
。
3 程序运行
因为我们分为Manager
和Worker
,但都是同一份代码,所以我们先打包一个jar
出来,不然manager
无法启动。配置数据库和Worker
的jar
包地址如下:
spring.datasource.url=jdbc:h2:tcp://localhost:9092/test spring.datasource.username=pkslow spring.datasource.password=pkslow spring.datasource.driver-class-name=org.h2.Driver pkslow.worker.resource=file://pkslow/target/remote-partitioning-jar-1.0-SNAPSHOT.jar
执行程序如下:
可以看到启动了4次Java
程序,还给出日志路径。
通过jps
命令查看,能看到一个Manager
进程,还有两个worker
进程:
4 复杂变量传递
前面讲了Manager
可以通过ExecutionContext
传递变量,如简单的String
、long
等。但其实它也是可以传递复杂的Java
对象的,但对应的类需要可序列化,如:
import java.io.Serializable; public class Person implements Serializable { private Integer age; private String name; private String webSite; //getter and setter }
Manager
传递:
executionContext.put("person", new Person(0, "pkslow", "www.pkslow.com"));
Worker
接收:
@Value("#{stepExecutionContext['person']}") Person person
5 总结
本文介绍了Spring Batch
远程分区的本地Jar包模式
,只能在一台机器上运行,所以也是无法真正发挥出远程分区的作用。但它对我们后续理解更复杂的模式是有很大帮助的;同时,我们也可以使用本地模式进行开发测试,毕竟它只需要一个数据库就行了,依赖很少。