Групова обработка на Java EE 7

1. Въведение

Представете си, че трябва да изпълняваме ръчно задачи като обработка на фишове за изплащане, изчисляване на лихви и генериране на сметки. Ще стане доста скучен, склонен към грешки и безкраен списък с ръчни задачи!

В този урок ще разгледаме Java Batch Processing (JSR 352), част от платформата на Джакарта EE, и страхотна спецификация за автоматизиране на задачи като тези. Той предлага на разработчиците на приложения модел за разработване на стабилни системи за групова обработка, така че те да могат да се съсредоточат върху бизнес логиката.

2. Зависимости на Maven

Тъй като JSR 352 е само спецификация, ще трябва да включим неговия API и изпълнение, като jberet :

 javax.batch javax.batch-api 1.0.1   org.jberet jberet-core 1.0.2.Final   org.jberet jberet-support 1.0.2.Final   org.jberet jberet-se 1.0.2.Final 

Ще добавим и база данни в паметта, за да можем да разгледаме някои по-реалистични сценарии.

3. Основни понятия

JSR 352 въвежда няколко концепции, които можем да разгледаме по този начин:

Нека първо дефинираме всяко парче:

  • Започвайки отляво, имаме JobOperator . Той управлява всички аспекти на обработката на заданието, като стартиране, спиране и рестартиране
  • След това имаме Работата . Работата е логично събиране на стъпки; той капсулира цял партиден процес
  • Заданието ще съдържа между 1 и n Стъпка . Всяка стъпка е независима, последователна единица на работа. Една стъпка се състои от четене на вход, обработка на този вход и запис на изход
  • И последно, но не на последно място, имаме JobRepository, който съхранява текущата информация за заданията. Помага за проследяване на работните места, тяхното състояние и резултатите от завършването им

Стъпките имат малко повече подробности от това, така че нека да разгледаме това по-нататък. Първо ще разгледаме стъпките на Chunk и след това Batchlet s.

4. Създаване на парче

Както беше посочено по-рано, парче е вид стъпка . Често ще използваме парче, за да изразим операция, която се извършва отново и отново, да речем над набор от елементи. Това е нещо като междинни операции от Java Streams.

Когато описваме парче, трябва да изразим откъде да вземем предметите, как да ги обработим и къде да ги изпратим след това.

4.1. Четене на предмети

За да четем елементи, ще трябва да приложим ItemReader.

В този случай ще създадем четец, който просто ще издава числата от 1 до 10:

@Named public class SimpleChunkItemReader extends AbstractItemReader { private Integer[] tokens; private Integer count; @Inject JobContext jobContext; @Override public Integer readItem() throws Exception { if (count >= tokens.length) { return null; } jobContext.setTransientUserData(count); return tokens[count++]; } @Override public void open(Serializable checkpoint) throws Exception { tokens = new Integer[] { 1,2,3,4,5,6,7,8,9,10 }; count = 0; } }

Сега просто четем от вътрешното състояние на класа тук. Но, разбира се, readItem може да изтегли от база данни , от файловата система или друг външен източник.

Имайте предвид, че запазваме част от това вътрешно състояние, като използваме JobContext # setTransientUserData (), което ще ви бъде полезно по-късно.

Освен това обърнете внимание на параметъра на контролната точка . Ще вземем и това отново.

4.2. Обработка на елементи

Разбира се, причината, поради която се късаме, е, че искаме да извършим някаква операция върху нашите артикули!

Всеки път, когато връщаме null от обработващ елемент, изпускаме този елемент от партидата.

И така, нека кажем тук, че искаме да запазим само четните числа. Можем да използваме ItemProcessor, който отхвърля странните, като връща null :

@Named public class SimpleChunkItemProcessor implements ItemProcessor { @Override public Integer processItem(Object t) { Integer item = (Integer) t; return item % 2 == 0 ? item : null; } }

processItem ще бъде извикан веднъж за всеки елемент, който излъчва нашият ItemReader .

4.3. Писане на предмети

И накрая, заданието ще извика ItemWriter, за да можем да напишем нашите трансформирани елементи:

@Named public class SimpleChunkWriter extends AbstractItemWriter { List processed = new ArrayList(); @Override public void writeItems(List items) throws Exception { items.stream().map(Integer.class::cast).forEach(processed::add); } } 

Колко време са артикулите ? След малко ще определим размера на парче, което ще определи размера на списъка, който се изпраща до writeItems .

4.4. Определяне на парче в работа

Сега събрахме всичко това в XML файл, използвайки JSL или Job Specification Language. Имайте предвид, че ще изброим нашия четец, процесор, разделител, както и размер на разфасовките:

Размерът на парчетата е колко често напредъкът в парчето се ангажира с хранилището на задания , което е важно за гарантиране на завършването, ако част от системата се провали.

Ще трябва да поставим този файл в META-INF / batch-jobs for. jar файлове и в WEB-INF / класове / META-INF / batch-jobs за .war файлове .

Дадохме на работата си идентификатора “simpleChunk”, така че нека опитаме това в единичен тест.

Сега заданията се изпълняват асинхронно, което ги прави трудни за тестване. В извадката не забравяйте да проверите нашия BatchTestHelper, който анкетира и чака, докато работата приключи:

@Test public void givenChunk_thenBatch_completesWithSuccess() throws Exception { JobOperator jobOperator = BatchRuntime.getJobOperator(); Long executionId = jobOperator.start("simpleChunk", new Properties()); JobExecution jobExecution = jobOperator.getJobExecution(executionId); jobExecution = BatchTestHelper.keepTestAlive(jobExecution); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); } 

Така че това са парчетата. Сега, нека да разгледаме партидите.

5. Създаване на Batchlet

Не всичко се вписва добре в итеративен модел. Например, може да имаме задача, която просто трябва да извикаме веднъж, да изпълним до завършване и да върнем състояние на изход.

Договорът за партида е съвсем прост:

@Named public class SimpleBatchLet extends AbstractBatchlet { @Override public String process() throws Exception { return BatchStatus.COMPLETED.toString(); } }

Както е JSL:

И можем да го тестваме, като използваме същия подход като преди:

@Test public void givenBatchlet_thenBatch_completeWithSuccess() throws Exception { JobOperator jobOperator = BatchRuntime.getJobOperator(); Long executionId = jobOperator.start("simpleBatchLet", new Properties()); JobExecution jobExecution = jobOperator.getJobExecution(executionId); jobExecution = BatchTestHelper.keepTestAlive(jobExecution); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

И така, разгледахме няколко различни начина за прилагане на стъпки.

Сега нека разгледаме механизмите за маркиране и гарантиране на напредъка.

6. Персонализирана контролна точка

Failures are bound to happen in the middle of a job. Should we just start over the whole thing, or can we somehow start where we left off?

As the name suggests, checkpoints help us to periodically set a bookmark in case of failure.

By default, the end of chunk processing is a natural checkpoint.

However, we can customize it with our own CheckpointAlgorithm:

@Named public class CustomCheckPoint extends AbstractCheckpointAlgorithm { @Inject JobContext jobContext; @Override public boolean isReadyToCheckpoint() throws Exception { int counterRead = (Integer) jobContext.getTransientUserData(); return counterRead % 5 == 0; } }

Remember the count that we placed in transient data earlier? Here, we can pull it out with JobContext#getTransientUserDatato state that we want to commit on every 5th number processed.

Without this, a commit would happen at the end of each chunk, or in our case, every 3rd number.

And then, we match that up with the checkout-algorithm directive in our XML underneath our chunk:

Let's test the code, again noting that some of the boilerplate steps are hidden away in BatchTestHelper:

@Test public void givenChunk_whenCustomCheckPoint_thenCommitCountIsThree() throws Exception { // ... start job and wait for completion jobOperator.getStepExecutions(executionId) .stream() .map(BatchTestHelper::getCommitCount) .forEach(count -> assertEquals(3L, count.longValue())); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

So, we might be expecting a commit count of 2 since we have ten items and configured the commits to be every 5th item. But, the framework does one more final read commit at the end to ensure everything has been processed, which is what brings us up to 3.

Next, let's look at how to handle errors.

7. Exception Handling

By default, the job operator will mark our job as FAILED in case of an exception.

Let's change our item reader to make sure that it fails:

@Override public Integer readItem() throws Exception { if (tokens.hasMoreTokens()) { String tempTokenize = tokens.nextToken(); throw new RuntimeException(); } return null; }

And then test:

@Test public void whenChunkError_thenBatch_CompletesWithFailed() throws Exception { // ... start job and wait for completion assertEquals(jobExecution.getBatchStatus(), BatchStatus.FAILED); }

But, we can override this default behavior in a number of ways:

  • skip-limit specifies the number of exceptions this step will ignore before failing
  • retry-limit specifies the number of times the job operator should retry the step before failing
  • skippable-exception-class specifies a set of exceptions that chunk processing will ignore

So, we can edit our job so that it ignores RuntimeException, as well as a few others, just for illustration:

And now our code will pass:

@Test public void givenChunkError_thenErrorSkipped_CompletesWithSuccess() throws Exception { // ... start job and wait for completion jobOperator.getStepExecutions(executionId).stream() .map(BatchTestHelper::getProcessSkipCount) .forEach(skipCount -> assertEquals(1L, skipCount.longValue())); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

8. Executing Multiple Steps

We mentioned earlier that a job can have any number of steps, so let's see that now.

8.1. Firing the Next Step

By default, each step is the last step in the job.

In order to execute the next step within a batch job, we'll have to explicitly specify by using the next attribute within the step definition:

If we forget this attribute, then the next step in sequence will not get executed.

And we can see what this looks like in the API:

@Test public void givenTwoSteps_thenBatch_CompleteWithSuccess() throws Exception { // ... start job and wait for completion assertEquals(2 , jobOperator.getStepExecutions(executionId).size()); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

8.2. Flows

A sequence of steps can also be encapsulated into a flow. When the flow is finished, it is the entire flow that transitions to the execution element. Also, elements inside the flow can't transition to elements outside the flow.

We can, say, execute two steps inside a flow, and then have that flow transition to an isolated step:

And we can still see each step execution independently:

@Test public void givenFlow_thenBatch_CompleteWithSuccess() throws Exception { // ... start job and wait for completion assertEquals(3, jobOperator.getStepExecutions(executionId).size()); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

8.3. Decisions

We also have if/else support in the form of decisions. Decisions provide a customized way of determining a sequence among steps, flows, and splits.

Like steps, it works on transition elements such as next which can direct or terminate job execution.

Let's see how the job can be configured:

Any decision element needs to be configured with a class that implements Decider. Its job is to return a decision as a String.

Each next inside decision is like a case in a switch statement.

8.4. Splits

Splits are handy since they allow us to execute flows concurrently:

Of course, this means that the order isn't guaranteed.

Let's confirm that they still all get run. The flow steps will be performed in an arbitrary order, but the isolated step will always be last:

@Test public void givenSplit_thenBatch_CompletesWithSuccess() throws Exception { // ... start job and wait for completion List stepExecutions = jobOperator.getStepExecutions(executionId); assertEquals(3, stepExecutions.size()); assertEquals("splitJobSequenceStep3", stepExecutions.get(2).getStepName()); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

9. Partitioning a Job

We can also consume the batch properties within our Java code which have been defined in our job.

They can be scoped at three levels – the job, the step, and the batch-artifact.

Let's see some examples of how they consumed.

When we want to consume the properties at job level:

@Inject JobContext jobContext; ... jobProperties = jobContext.getProperties(); ...

This can be consumed at a step level as well:

@Inject StepContext stepContext; ... stepProperties = stepContext.getProperties(); ...

When we want to consume the properties at batch-artifact level:

@Inject @BatchProperty(name = "name") private String nameString;

This comes in handy with partitions.

See, with splits, we can run flows concurrently. But we can also partition a step into n sets of items or set separate inputs, allowing us another way to split up the work across multiple threads.

To comprehend the segment of work each partition should do, we can combine properties with partitions:

10. Stop and Restart

Now, that's it for defining jobs. Now let's talk for a minute about managing them.

We've already seen in our unit tests that we can get an instance of JobOperator from BatchRuntime:

JobOperator jobOperator = BatchRuntime.getJobOperator();

And then, we can start the job:

Long executionId = jobOperator.start("simpleBatchlet", new Properties());

However, we can also stop the job:

jobOperator.stop(executionId);

And lastly, we can restart the job:

executionId = jobOperator.restart(executionId, new Properties());

Let's see how we can stop a running job:

@Test public void givenBatchLetStarted_whenStopped_thenBatchStopped() throws Exception { JobOperator jobOperator = BatchRuntime.getJobOperator(); Long executionId = jobOperator.start("simpleBatchLet", new Properties()); JobExecution jobExecution = jobOperator.getJobExecution(executionId); jobOperator.stop(executionId); jobExecution = BatchTestHelper.keepTestStopped(jobExecution); assertEquals(jobExecution.getBatchStatus(), BatchStatus.STOPPED); }

And if a batch is STOPPED, then we can restart it:

@Test public void givenBatchLetStopped_whenRestarted_thenBatchCompletesSuccess() { // ... start and stop the job assertEquals(jobExecution.getBatchStatus(), BatchStatus.STOPPED); executionId = jobOperator.restart(jobExecution.getExecutionId(), new Properties()); jobExecution = BatchTestHelper.keepTestAlive(jobOperator.getJobExecution(executionId)); assertEquals(jobExecution.getBatchStatus(), BatchStatus.COMPLETED); }

11. Fetching Jobs

When a batch job is submitted then the batch runtime creates an instance of JobExecution to track it.

To obtain the JobExecution for an execution id, we can use the JobOperator#getJobExecution(executionId) method.

And, StepExecution provides helpful information for tracking a step's execution.

To obtain the StepExecution for an execution id, we can use the JobOperator#getStepExecutions(executionId) method.

And from that, we can get several metrics about the step via StepExecution#getMetrics:

@Test public void givenChunk_whenJobStarts_thenStepsHaveMetrics() throws Exception { // ... start job and wait for completion assertTrue(jobOperator.getJobNames().contains("simpleChunk")); assertTrue(jobOperator.getParameters(executionId).isEmpty()); StepExecution stepExecution = jobOperator.getStepExecutions(executionId).get(0); Map metricTest = BatchTestHelper.getMetricsMap(stepExecution.getMetrics()); assertEquals(10L, metricTest.get(Metric.MetricType.READ_COUNT).longValue()); assertEquals(5L, metricTest.get(Metric.MetricType.FILTER_COUNT).longValue()); assertEquals(4L, metricTest.get(Metric.MetricType.COMMIT_COUNT).longValue()); assertEquals(5L, metricTest.get(Metric.MetricType.WRITE_COUNT).longValue()); // ... and many more! }

12. Disadvantages

JSR 352 is powerful, though it is lacking in a number of areas:

  • Изглежда липсват читатели и писатели, които могат да обработват други формати като JSON
  • Няма поддръжка на генерични лекарства
  • Разделянето поддържа само една стъпка
  • API не предлага нищо за поддържане на планиране (въпреки че J2EE има отделен модул за планиране)
  • Поради асинхронния си характер тестването може да бъде предизвикателство
  • API е доста подробен

13. Заключение

В тази статия разгледахме JSR 352 и научихме за парчета, партиди, разделения, потоци и много други. И все пак ние едва надраскахме повърхността.

Както винаги демо кодът може да бъде намерен в GitHub.