SFDC apex バッチ基礎および様々な応用 | カネ | ライフ

こんにちは、管理人の@Salesforce.Zです。
一括処理をバッチにすると、ガバナ制限を回避できるし、大量処理も可能。
うまく設計できたら、いいですね。

Contents

1 Apex Batchの構成
2 Database.Batchable インターフェースの実装
3 終わりに
- 3.1 整理
- 3.2 リファレンス

Apex Batchの構成

バッチのインターフェースを実装するには、３つの必要な次の 3 つのメソッドが含まれています。

Start Method
Execute Method
Finish Method

それぞれの構文があります。バッチの実行流れは下記の感じです。

Startメソッドで、処理したいデータを取得 →バッチサイズで、分割→分割分ごとにExecuteメソッドにデータチャンクを渡す
＃１で分割したチャンクごとにExecuteメソッドで処理する
すべてのチャンクをExecuteメソッドで処理完了後にFinishメソッドが動作（送信など）

Startメソッド構文

global (Database.QueryLocator | Iterable<sObject>) start(Database.BatchableContext bc) {}

1	global (Database.QueryLocator \| Iterable<sObject>) start(Database.BatchableContext bc) {}

Executeメソッド構文

global void execute(Database.BatchableContext BC, list<sObject>){}

1	global void execute(Database.BatchableContext BC, list<sObject>){}

Finishメソッド構文

global void finish(Database.BatchableContext BC){}

1	global void finish(Database.BatchableContext BC){}

バッチクラス例

global with sharing class YourBatch implements Database.Batchable<sObject> {
    /**
     * Startメソッド（一回のみ実行）
     */
    global Database.QueryLocator start(Database.BatchableContext BC) {
        // 対象データをクエリする（例：対象データが1,000件、バッチサイズが200、executeメソッドが５回動作）
    }

    /**
     * Executeメソッド（分割回数実行）
     */
    global void execute(Database.BatchableContext BC, List<sObject> scope) {
        // 対象データを更新、作成、削除など
    }

    /**
     * Finishメソッド（一回のみ実行）
     */
    global void finish(Database.BatchableContext BC) {
        // メール送信や、失敗エラー、成功エラーなどのロジック
    }
}

global with sharing class YourBatch implements Database.Batchable<sObject> {

/**

* Startメソッド（一回のみ実行）

global Database.QueryLocator start(Database.BatchableContext BC) {

// 対象データをクエリする（例：対象データが1,000件、バッチサイズが200、executeメソッドが５回動作）

}

/**

* Executeメソッド（分割回数実行）

global void execute(Database.BatchableContext BC, List<sObject> scope) {

// 対象データを更新、作成、削除など

}

/**

* Finishメソッド（一回のみ実行）

global void finish(Database.BatchableContext BC) {

// メール送信や、失敗エラー、成功エラーなどのロジック

}

Database.Batchable インターフェースの実装

Database.QueryLocator と Iterable の比較

シンプルに対象レコードをクエリで、取得できる場合、Database.QueryLocatorでStartメソッドを用意して充分です。
複雑な場合、IterableでStartメソッドを用意する。
つまり、普段、 Database.QueryLocator でしてください。満足できない場合
Iterable を考えましょう。

＃	ポイント	QueryLocator	Iterable
1	返されるレコード数制限	5,000万まで	50,000まで
2	バッチサイズ	2,000まで	無限
3	処理複雑さ	シンプルの場合	複雑な場合
		条件付きのクエリとか	集計関数を使うとか

Database.QueryLocator Start メソッドの場合

global with sharing class YourBatch implements Database.Batchable<sObject> {
    /**
     * Startメソッド（一回のみ実行）
     */
    global Database.QueryLocator start(Database.BatchableContext BC) {
        // 対象データをクエリする（例：対象データが1,000件、バッチサイズが200、executeメソッドが５回動作）
    }

    /**
     * Executeメソッド（分割回数実行）
     */
    global void execute(Database.BatchableContext BC, List<sObject> scope) {
        // 対象データを更新、作成、削除など
    }

    /**
     * Finishメソッド（一回のみ実行）
     */
    global void finish(Database.BatchableContext BC) {
        // メール送信や、失敗エラー、成功エラーなどのロジック
    }
}

global with sharing class YourBatch implements Database.Batchable<sObject> {

/**

* Startメソッド（一回のみ実行）

global Database.QueryLocator start(Database.BatchableContext BC) {

// 対象データをクエリする（例：対象データが1,000件、バッチサイズが200、executeメソッドが５回動作）

}

/**

* Executeメソッド（分割回数実行）

global void execute(Database.BatchableContext BC, List<sObject> scope) {

// 対象データを更新、作成、削除など

}

/**

* Finishメソッド（一回のみ実行）

global void finish(Database.BatchableContext BC) {

// メール送信や、失敗エラー、成功エラーなどのロジック

}

Iterable Startメソッドの場合

CustomIterable クラス

global class CustomIterable implements Iterator<Account>{ 
   List<Account> accs {get; set;} 
   Integer i {get; set;}
   //　CustomIterableインスタンスの場合、このクエリ結果になる
   public CustomIterable(){ 
       accs = [SELECT id, name, numberofEmployees FROM Account WHERE name = 'false']; 
       i = 0; 
   }   
   global boolean hasNext(){ 
       if(i >= accs.size()) 
           return false; 
       else 
           return true; 
   }    
   global Account next(){ 
       if(i == 8){ i++; return null;} 
       i=i+1; 
       return accs[i-1]; 
   } 
}

global class CustomIterable implements Iterator<Account>{

List<Account> accs {get; set;}

Integer i {get; set;}

//　CustomIterableインスタンスの場合、このクエリ結果になる

public CustomIterable(){

accs = [SELECT id, name, numberofEmployees FROM Account WHERE name = 'false'];

i = 0;

}

global boolean hasNext(){

if(i >= accs.size())

return false;

else

return true;

}

global Account next(){

if(i == 8){ i++; return null;}

i=i+1;

return accs[i-1];

}

CustomIterable クラスを返す Iterable Startメソッドバッチクラス

global class YourBatchClass implements Database.batchable<Account>{
   // Iterable型のStartメソッド：CustomIterable クラスの返りはAccoutなので、Iterable<Account>にするわけ
   global Iterable<Account> start(Database.batchableContext info){ 
       return new CustomIterable(); 
   }     
   global void execute(Database.batchableContext info, List<Account> scope){ 
       List<Account> accsToUpdate = new List<Account>(); 
       for(Account a : scope){ 
           a.name = 'true'; 
           a.numberOfEmployees = 69; 
           accsToUpdate.add(a); 
       } 
       update accsToUpdate; 
   }     
   global void finish(Database.batchableContext info){     
   } 
}

global class YourBatchClass implements Database.batchable<Account>{

// Iterable型のStartメソッド：CustomIterable クラスの返りはAccoutなので、Iterable<Account>にするわけ

global Iterable<Account> start(Database.batchableContext info){

return new CustomIterable();

}

global void execute(Database.batchableContext info, List<Account> scope){

List<Account> accsToUpdate = new List<Account>();

for(Account a : scope){

a.name = 'true';

a.numberOfEmployees = 69;

accsToUpdate.add(a);

}

update accsToUpdate;

}

global void finish(Database.batchableContext info){

}

集計関数をバッチ内で使用する Iterable Startメソッドバッチクラス例１

バッチクラスで、そのまま集計関数をクリエしたら、下記のエラーになります。

Aggregate query does not support queryMore(), use LIMIT to restrict the results to a single batch

しかも、Iterable Startメソッドで、複雑なバッチを構築可能です。
ほとんどの場合、 Iterable Startメソッドを構築する前提となることが
イテレータ（ Iterator ）インターフェースとイテラブル（ Iterable ）インターフェースが必要になってくる

カスタムイテレータを用意した上で、カスタムイテラブルでカスタムイテレータをコールするように準備する、　

具体的なアルゴリズムは下記になります。

カスタムイテレータ（Iterator）インターフェースを実装するクラスを用意する
カスタムイテラブル（ Iterable ）インターフェースを実装するクラスを用意する
カスタムバッチインターフェースを実装するクラスを用意する

イテレータ（Iterator）とイテラブル（Iterable）およびバッチを用意してから
コール順は下記になります

バッチで、イテラブル（Iterable）をコール
イテラブル（Iterable）で、イテレータ（Iterator）をコールする
イテレータ（Iterator）で、クエリを行う

IteratorとIterableを用いて、集計関数をバッチ内で使用する応用コード例

/**
  *Iteratorインターフェースを実装するクラス
 */
public class AggreIterator Implements Iterator<AggregateResult>{
    public AggregateResult[] results {get;set;}
    public Integer index {get;set;}

    public AggreIterator(String query){
        this.index = 0;
        results = Database.query(query);
    }

    public boolean hasNext(){
        return results !=null && !results.isEmpty() && index < 
        results.size();
    }

    public AggregateResult next(){
        return results[index++];
    }
}

/**

*Iteratorインターフェースを実装するクラス

public class AggreIterator Implements Iterator<AggregateResult>{

public AggregateResult[] results {get;set;}

public Integer index {get;set;}

public AggreIterator(String query){

this.index = 0;

results = Database.query(query);

}

public boolean hasNext(){

return results !=null && !results.isEmpty() && index <

results.size();

}

public AggregateResult next(){

return results[index++];

}

/**
  *Iterabaleインターフェースを実装するクラス
  *@使用方法：カスタムイテレータクラス（AggreIterator）をコールする
 */
public class AggreIterable implements Iterable<AggregateResult>{
    private String query;

    public AggreIterable(String soql){
    	this.query = soql;
  	}

    public Iterator<AggregateResult> Iterator(){
        return new AggreIterator(this.query);
    }
}

/**

*Iterabaleインターフェースを実装するクラス

*@使用方法：カスタムイテレータクラス（AggreIterator）をコールする

public class AggreIterable implements Iterable<AggregateResult>{

private String query;

public AggreIterable(String soql){

this.query = soql;

}

public Iterator<AggregateResult> Iterator(){

return new AggreIterator(this.query);

}

/**
  *バッチクラスで、カスタムイテラブルクラス（AggreIterable）をコール
 */
global class SampleAggregateBatch implements Database.Batchable<AggregateResult> {
  // バッチ開始：Iterable Startメソッド
  global Iterable<AggregateResult> start(Database.BatchableContext bc){
    String query = YourDao.getDataByYourContidons();
    return new AggreIterable(query);
  } 
  // The batch job executes and operates on one batch of records
  global void execute(Database.BatchableContext bc, List<sObject> scope){ 
    for(sObject sObj : scope) {
      AggregateResult ar = (AggregateResult)sObj;
      System.debug('>>>> COUNT : ' + ar.get('cnt'));
    }
  }
  // The batch job finishes
  global void finish(Database.BatchableContext bc){ }
}

/**

*バッチクラスで、カスタムイテラブルクラス（AggreIterable）をコール

global class SampleAggregateBatch implements Database.Batchable<AggregateResult> {

// バッチ開始：Iterable Startメソッド

global Iterable<AggregateResult> start(Database.BatchableContext bc){

String query = YourDao.getDataByYourContidons();

return new AggreIterable(query);

}

// The batch job executes and operates on one batch of records

global void execute(Database.BatchableContext bc, List<sObject> scope){

for(sObject sObj : scope) {

AggregateResult ar = (AggregateResult)sObj;

System.debug('>>>> COUNT : ' + ar.get('cnt'));

}

// The batch job finishes

global void finish(Database.BatchableContext bc){ }

}

/**
  *Data Access Object：DAOクラス
 */
public with sharing class YourDao{
    /*
     * クエリしたい内容
     */
    public static String getDataByYourContidons(){
        String query = 'SELECT COUNT(Id) cnt';
        query += ' ,    AccountId';
        query += ' FROM Contact GROUP BY AccountId';
        return query;
    }
}

/**

*Data Access Object：DAOクラス

public with sharing class YourDao{

* クエリしたい内容

public static String getDataByYourContidons(){

String query = 'SELECT COUNT(Id) cnt';

query += ' , AccountId';

query += ' FROM Contact GROUP BY AccountId';

return query;

}

ちょい解釈

Iterable Startメソッドは複雑な処理をするバッチを構築する場合に使うものなので、
イテレータとイテラブルの対象が集計関数じゃなくても良い、
クラスやなにかのコレクションのものでもよいです。
しっかり、イテレータとイテラブルを理解すれば、後は、バッチの開発の自由度がもっと高くなります。ぜひ活用できるようにしてください。

終わりに

整理

バッチクラスはインターフェースである「Database.Batchable」を実装する
バッチクラスはStart()、Execute()、Finish()３つメソッドを含めます。
Start()メソッドは処理したい対象（データ、何かのコレクション）を一括集めます。
Start()メソッドのreturnはDatabase.QueryLocator オブジェクまたは　ジョブに渡すレコードやオブジェクトが含まれる Iterable オブジェクト
Database.QueryLocator Startメソッドの場合、最大5,000万件レコードを集めて、処理可能。 Database.executeBatch(b, BATCH_SIZE)のバッチサイズはデフォルトは200件、最大は2,000件まで指定可能、2,000より大きい値で指定しても、2,000になる
Iterable Startメソッドの場合、最大50,000件レコードを集めて、処理可能。 Database.executeBatch(b, BATCH_SIZE)のバッチサイズは無限だがほかの制限が適用される
ExecuteメソッドはStartメソッドで集めたすべてのデータを分割したchunkごとに実行される、returnはAsyncApexObjectのID
Finishメソッドは分割したすべてのchunkが実行完了後に実行される
Database.BatchableContextはバッチジョブを追跡用
ジョブトランザクション全体でインスタンスメンバー変数またはデータを共有する場合は、クラス定義で Database.Stateful を使用し、対応可能だが使用しない場合、各トランザクションの開始時にすべてのメンバー変数が初期状態にリセットされてしまう

Apex 一括処理 バッチの使用およびテストクラス