https://github.com/xmlking/grails3-spring-batch
Grails 3 Spring Batch Plugin
https://github.com/xmlking/grails3-spring-batch
Last synced: 3 months ago
JSON representation
Grails 3 Spring Batch Plugin
- Host: GitHub
- URL: https://github.com/xmlking/grails3-spring-batch
- Owner: xmlking
- Created: 2015-02-01T11:30:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-02-18T04:06:12.000Z (almost 11 years ago)
- Last Synced: 2025-03-25T06:28:12.001Z (10 months ago)
- Language: Groovy
- Size: 176 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Grails Spring Batch Plugin
====================
This plugin adds the Spring Batch framework to a __Grails 3__ project.
It's intent is to minimize/eliminate the need for verbose XML files to configure Spring Batch jobs.
### Note: Under development.
## Sample App
[grails3 spring batch sample app using this plugin](https://github.com/xmlking/grails3-spring-batch-sample)
## Getting Started
To install the plugin, add the following entry to your `build.groovy` file in the dependencies sections:
```groovy
compile "org.grails.plugins:spring-batch:3.0.0.BUILD-SNAPSHOT"
```
Add `copyBatchConfig` task to your `build.groovy` file at the end:
```groovy
task copyBatchConfig {
copy {
from("${project.projectDir}/grails-app/batch") {
include '**/*BatchConfig.groovy'
}
into "${buildDir}/resources/main/batch"
}
}
```
Add Spring Batch Config to your `grails-app/conf/application.yml` file at the end:
```yml
---
grails:
springBatch:
loadTables: true
database: "h2"
environments:
production:
grails:
springBatch:
database = "mysql" #TODO set prod database type...
```
Once the plugin is installed, you can define your Spring Batch job configuration in a Groovy script file in your application's `grails-app/batch` directory.
The script's filename must end with BatchConfig (i.e. `SimpleJobBatchConfig.groovy`).
Define your Spring Batch job using the Grails BeanBuilder syntax (just like in the `resources.groovy` file).
To launch a job from your application do the following:
1. Inject the Spring Batch Job Launcher and the job you defined in your configuration file into the controller or service (or lookup it up from the `grailsApplication.mainContext`)
2. Call the `jobLauncher.run()` method with a reference to your job and a `JobParameters` object. Spring Batch will take care of the rest
`grails-app/batch/SimpleJobBatchConfig.groovy`
```groovy
beans {
batch.job(id: 'simpleJob') {
batch.step(id: 'logStart') {
batch.tasklet(ref: 'printStartMessage')
}
}
printStartMessage(PrintStartMessageTasklet) { bean ->
bean.autowire = "byName"
}
}
```
`src/main/groovy/springbatchsample/PrintMessageTasklet.groovy`
```groovy
import org.springframework.batch.core.step.tasklet.Tasklet
import org.springframework.batch.repeat.RepeatStatus
import org.springframework.batch.core.StepContribution
import org.springframework.batch.core.scope.context.ChunkContext
class PrintMessageTasklet implements Tasklet {
String mesg
RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) {
println mesg
return RepeatStatus.FINISHED
}
}
```
`grails-app/controllers/springbatchsample/FooController.groovy`
```groovy
import org.springframework.batch.core.JobParameters
import org.springframework.batch.core.JobParametersBuilder
class FooController {
def jobLauncher
def simpleJob
def launch() {
JobParameters jobParameters = new JobParametersBuilder().addDate("now",
new Date()).addString("comment", "Unit Test").toJobParameters();
jobLauncher.run(simpleJob, jobParameters)
respond ""
}
}
```