Glassfish jBatch

2023-12-092023
93.7% (342.3/365)
December
26.9% (8.3/31)
Week 49
76.3% (5.3/7)
Day 09 Sat
34.7% (8.3/24)

訪問者

total: 13394
today: 6
yesterday: 5
now: 4

↑

更新

MenuBar

Java Batch とは ?
Java Batch の起動方法
Job
Chunk
Batchlet
実行結果
Glassfish で、JOB の状態を管理する
アプリケーションから JOB の状態を管理する

Java Batch とは ? †

Java EE 7 (Glassfish 4) から導入された、バッチジョブのフレームワーク。JavaSE でも動くよ
- IBM Tivoli や Fujitsu Operation Manager のように、スケジューリングやジョブ間の依存関係の管理を行うためのものではない
- jBatch は、単一のジョブを実装するためのフレームワーク。汎用部品を組み合わせてジョブを作る。ジョブ内の状態管理。リトライ管理 (1000件目から再実行とか)。
JSR352 https://jcp.org/en/jsr/detail?id=352
Spring Batch のまねっこ http://docs.spring.io/spring-batch/
構成
- Job は Step から構成される
- Step の実装方法には、Chunk と Batchlet がある
- Chunk は Reader、Processor、Writer から構成される
  - Reader : データの読み取り
  - Processor : データの処理
  - Writer : データの書き込み
- Batchlet は単体のプログラム
- Step は Flow でひとまとまりにできる → Glassfish jBatch JSLで書けること整理
- Step, Flow は、Split で並列実行できる → Glassfish jBatch JSLで書けること整理
- Decision で条件分岐を定義できる → Glassfish jBatch JSLで書けること整理
Instance と Execution
- Job が起動されると Job Instance と Job Execution が生まれる
- Instance : Job の管理情報。DB (Derby) に格納される
- Execution : Job を実行する Object
- Job が中断されると Instance は残るが、Execution は死ぬ。Job 再開時には、別の Execution が生まれて Instance の状態から処理を引き継ぐ。

↑

Java Batch の起動方法 †

JobOperator job = BatchRuntime.getJobOperator();
long id = job.start("sample-job", null);

job.start(xml, properties)

xml	META-INF/batch-jobs/ 以下にある JOB 定義 XML ファイル名
properties	実行時のパラメータ (cf.Glassfish jBatch Parameter)

返り値は Job Execution 番号

package com.mycompany.jbatchexam;

import java.io.IOException;
import java.io.PrintWriter;
import javax.batch.operations.JobOperator;
import javax.batch.runtime.BatchRuntime;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(name = "BatchEntry", urlPatterns = {"/BatchEntry"})
public class BatchEntry extends HttpServlet {

    protected void processRequest(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        try (PrintWriter out = response.getWriter()) {
            out.println("<!DOCTYPE html>");
            out.println("<html>");
            out.println("<head>");
            out.println("<title>Servlet BatchEntry</title>");
            out.println("</head>");
            out.println("<body>");
            out.println("<h1>Servlet BatchEntry at " + request.getContextPath() + "</h1>");

            JobOperator job = BatchRuntime.getJobOperator();

            System.out.println("Batch Start");
            long id = job.start("sample-job", null);
            System.out.println("Batch Queued " +id);
            out.println("Task Queued. No." + id);
            
            out.println("</body>");
            out.println("</html>");
        }
    }

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        processRequest(request, response);
    }

    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        processRequest(request, response);
    }

    @Override
    public String getServletInfo() {
        return "Short description";
    }
}

↑

Job †

META-INF/batch-jobs/ 内の XML ファイルで定義する。JSL(Job Specification Language)

<?xml version="1.0" encoding="UTF-8"?>
<job id="sample-job"
     xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
     version="1.0">

    <step id="sample-chunk" next="sample-batchlet">
        <chunk item-count="5">
            <reader    ref="MyItemReader"/>
            <processor ref="MyItemProcessor"/>
            <writer    ref="MyItemWriter"/>
        </chunk>
    </step>

    <step id="sample-batchlet">
        <batchlet ref="MyBatchlet"/>
    </step>
</job>

Job は XML に定義されれる
- id属性は xml のファイル名と同じ
Job は Step から構成される
- Step の属性に、Step の呼び出し順を定義する
- Step の実装方法には、Chunk と Batchlet がある
Chunk は Reader、Processor、Writer から構成される
- Reader : データの読み取り
- Processor : データの処理
- Writer : データの書き込み
- 実行クラスは CDI で管理されている名前 ( or クラス名フルパス)
- item-count 属性は、Writer を何回に一回呼ぶかの指定。デフォルト値は 10
  - item-count = 05 :
```
(RP RP RP RP RP W)
(RP RP RP RP RP W)
(RP RP W)
```
  - item-count = 10 :
```
(RP RP RP RP RP RP RP RP RP RP W)
(RP RP W)
```
Batchlet は単体のプログラム
- 実行クラスは CDI で管理されている名前 ( or クラス名フルパス)

↑

Chunk †

MyItermReader? (データの読み込み)

package com.mycompany.jbatchexam;

import java.io.Serializable;
import javax.batch.api.chunk.ItemReader;
import javax.enterprise.context.Dependent;
import javax.inject.Named;

@Dependent
@Named("MyItemReader")
public class MyItemReader implements ItemReader {

    private int counter;

    @Override
    public void open(Serializable checkpoint) throws Exception {
        System.out.println("MyItermReader#open");
        counter = 0;
    }

    @Override
    public void close() throws Exception {
        System.out.println("MyItermReader#close");
    }

    @Override
    public Object readItem() throws Exception {
        counter += 1;
        if (counter > 13) {
            return null;
        }
        
        System.out.println("MyItermReader#readItem " + (counter));
        return counter;
    }

    @Override
    public Serializable checkpointInfo() throws Exception {
        System.out.println("MyItermReader#checkpointInfo");
        return null;
    }
}

Step では、ひとつの Object が使われる
readItem() の返り値が、MyItermProcessor?#processItem(item) の引数になる
readItem() で null を返すと処理終了
cehckpoint についてはいずれまた → Glassfish jBatch Checkpoint

MyItermProcessor? (データの処理)

package com.mycompany.jbatchexam;

import javax.batch.api.chunk.ItemProcessor;
import javax.enterprise.context.Dependent;
import javax.inject.Named;

@Dependent
@Named("MyItemProcessor")
public class MyItemProcessor implements ItemProcessor {

    @Override
    public Object processItem(Object item) throws Exception {
        System.out.println("MyItemProcessor#processItem " + item);
        return "P" + item;
    }

}

processItem(item) の item は、MyItemReader?#readItem() の返り値
processItem(item) の返り値が、MyItemWriter?#writeItem(List<Object> item) の引数になる (XML の item-cont で指定した分だけまとめられる)

MyItermWriter? (データの書き込み)

package com.mycompany.jbatchexam;

import java.io.Serializable;
import java.util.List;
import javax.batch.api.chunk.ItemWriter;
import javax.batch.runtime.context.JobContext;
import javax.enterprise.context.Dependent;
import javax.inject.Inject;
import javax.inject.Named;

@Dependent
@Named("MyItemWriter")
public class MyItemWriter implements ItemWriter {
    
    @Inject
    private JobContext jobCtx;

    @Override
    public void open(Serializable checkpoint) throws Exception {
        System.out.println("MyItemWriter#open");
    }

    @Override
    public void close() throws Exception {
        System.out.println("MyItemWriter#close");
        jobCtx.setTransientUserData("***** The treasure map is here ! ****");
    }

    @Override
    public void writeItems(List<Object> items) throws Exception {
        System.out.println("MyItemWriter#writeItems " + items);
    }

    @Override
    public Serializable checkpointInfo() throws Exception {
        System.out.println("MyItemWriter#checkpointInfo");
        return null;
    }    
}

writeItem(List<Object> items) の items は、MyItemProcessor?#processItem() の返り値を item-conunt 個分まとめたもの
Step 間でデータをやりとりしたい場合には JobContext? のユーザデータ領域を使う
JobContext? は Injection すること (自前でインスタンス化してもなんにも起きないよ)

↑

Batchlet †

MyBatchlet? (データ転送などの処理を実装する)

package com.mycompany.jbatchexam;

import javax.batch.api.Batchlet;
import javax.batch.runtime.context.JobContext;
import javax.enterprise.context.Dependent;
import javax.inject.Inject;
import javax.inject.Named;

@Dependent
@Named("MyBatchlet")
public class MyBatchlet implements Batchlet {
    @Inject
    private JobContext jobCtx;

    @Override
    public String process() throws Exception {
        System.out.println("MyBatchlet#process");
        System.out.println(jobCtx.getTransientUserData());
        return null;
    }

    @Override
    public void stop() throws Exception {
        System.out.println("MyBatchlet#stop");
    }
}

Step 間でデータをやりとりしたい場合には JobContext? のユーザデータ領域を使う
JobContext? は Injection すること (自前でインスタンス化してもなんにも起きないよ)

↑

実行結果 †

情報:   Batch Start
情報:   Batch Queued 11
情報:   MyItermReader#open
情報:   MyItemWriter#open
情報:   MyItermReader#readItem 1
情報:   MyItemProcessor#processItem 1
情報:   MyItermReader#readItem 2
情報:   MyItemProcessor#processItem 2
情報:   MyItermReader#readItem 3
情報:   MyItemProcessor#processItem 3
情報:   MyItermReader#readItem 4
情報:   MyItemProcessor#processItem 4
情報:   MyItermReader#readItem 5
情報:   MyItemProcessor#processItem 5
情報:   MyItemWriter#writeItems [P1, P2, P3, P4, P5]
情報:   MyItermReader#checkpointInfo
情報:   MyItemWriter#checkpointInfo
情報:   MyItermReader#readItem 6
情報:   MyItemProcessor#processItem 6
情報:   MyItermReader#readItem 7
情報:   MyItemProcessor#processItem 7
情報:   MyItermReader#readItem 8
情報:   MyItemProcessor#processItem 8
情報:   MyItermReader#readItem 9
情報:   MyItemProcessor#processItem 9
情報:   MyItermReader#readItem 10
情報:   MyItemProcessor#processItem 10
情報:   MyItemWriter#writeItems [P6, P7, P8, P9, P10]
情報:   MyItermReader#checkpointInfo
情報:   MyItemWriter#checkpointInfo
情報:   MyItermReader#readItem 11
情報:   MyItemProcessor#processItem 11
情報:   MyItermReader#readItem 12
情報:   MyItemProcessor#processItem 12
情報:   MyItermReader#readItem 13
情報:   MyItemProcessor#processItem 13
情報:   MyItemWriter#writeItems [P11, P12, P13]
情報:   MyItermReader#checkpointInfo
情報:   MyItemWriter#checkpointInfo
情報:   MyItermReader#close
情報:   MyItemWriter#close
情報:   MyBatchlet#process
情報:   ***** The treasure map is here ! ****