Javaマルチステップ検証方法 - リファクタリング

Question

以前のものに依存する複数の検証を行う方法があります。これは純粋にフォーム/フロントエンドのないRESTサービスです。例えば

public Json processPayment(User user, Amount amount, CardData cardData) { 
    Json result = new Json(); 

    Json userResult = validateUser(user); 
    if (userResult.isNotValid()) 
     result.put("errorCode", userResult.get("errorCode"); 
     result.put("message", userResult.get("message"); 
     return result; 
    } 

    Merchant merchant = getMerchant(user); 
    Json merchantResult = validateMerchant(user); 
    if (merchantResult.isNotValid()) 
     result.put("errorCode", merchantResult.get("errorCode"); 
     result.put("message", merchantResult.get("message"); 
     return result; 
    } 

    Json limitsResult = validateLimits(user, merchant, amount); 
    if (limitsResult.isNotValid()) 
     result.put("errorCode", limitsResult.get("errorCode"); 
     result.put("message", limitsResult.get("message"); 
     return result; 
    } 

    // Like above there are few more steps. 
    . 
    . 
    . 

    // All validations are fine process transaction. 
    Json transactionResult = processTransaction(user, merchant, amount, cardData); 
    if (transactionResult.isNotValid()) 
     result.put("errorCode", transactionResult.get("errorCode"); 
     result.put("message", transactionResult.get("message"); 
    } else { 
     result.put("message", "Transaction Successful"); 
     result.put("referenceNumber, transactionResult.get("rrn"); 
    } 

    return result; 
} 

結果が無効な場合は、エラーメッセージとともにすぐに戻る必要があります。それ以外の場合は、次の手順に進みます。

複数のステップがあるため、この方法は非常に大きくなり、単体テストを行うことはほとんど不可能になりました。

このメソッドを小さなものに分割したいと考えています。私は既に各ステップのすべてのビジネスロジックを別々のメソッドに移しましたが、依然としてこの大きなメソッドにはフローが残ります。

ソナーリントCCは47ですが、大きな心配です。

これを処理するには適切な方法が何であるかお勧めします。

ありがとうございます。

Answer 1

これはあなたのための解決策となりうる小さな例です。

主な考え方は、各検証ステップが1つの共通のコンテキストを共有することです。このコンテキストは、検証プロセスのあらゆる情報を保持します。

次に、バリデータのキューがあります。それぞれ1つの検証ステップを表します。バリデーターは（商人オブジェクトの追加のような）コンテキストを変更し、検証メソッドを呼び出し、必要に応じてコンテキストの結果を変更します。

検証プロセス自体は、キューを反復して、失敗したバリデータを探します。

このコードを実行してください。多分それは役立ちます：

import java.util.*; 

interface PaymentValidatorInterface { 
    public boolean validate(PaymentValidationContext context); 
} 

class PaymentValidationContext { 
    String result = ""; 
    String user; 
    int cardData; 
    String merchant; 

    public PaymentValidationContext(String user, int cardData) { 
     this.user = user; 
     this.cardData = cardData; 
    } 
} 

class PaymentValidator { 
    public static boolean validateUser(PaymentValidationContext context) { 
     if (context.user == null) { 
      context.result += "User is wrong\n"; 
      return false; 
     } 
     return true; 
    } 

    public static boolean validateMerchant(PaymentValidationContext context) { 
     context.merchant = context.user + "#" + context.cardData; 
     if (context.merchant.length() <= 3) { 
      context.result += "Marchant is wrong\n"; 
      return false; 
     } 
     return true; 
    } 

    public static boolean finishValidation(PaymentValidationContext context) { 
     context.result += "Everything is fine.\n"; 
     return true; 
    } 
} 

public class Processor { 
    private final static Queue<PaymentValidatorInterface> validators = new LinkedList<>(); 
    static { 
     validators.add(PaymentValidator::validateUser); 
     validators.add(PaymentValidator::validateMerchant); 
     validators.add(PaymentValidator::finishValidation); 
    } 

    public String processPayment(String user, int cardData) { 
     PaymentValidationContext context = new PaymentValidationContext(user, cardData); 
     validators.stream().anyMatch(validator -> !validator.validate(context)); 
     return context.result; 
    } 

    // For testing ------- 
    public static void main(String[] args) { 
     Processor p = new Processor(); 
     System.out.print(p.processPayment("Foobar", 1337)); // ok 
     System.out.print(p.processPayment(null, 1337));  // fails 
     System.out.print(p.processPayment("", 1));    // fails 
    } 
} 

Answer 2

doValidation()と書くことができます。

private doValidation(Json validationResult, Json result) { 
    if (validationResult.isNotValid()) 
     result.put("errorCode", validationResult.get("errorCode"); 
     result.put("message", validationResult.get("message"); 
     return false;//validation failed 
    } 
    return true;//validation passed 
} 

このメソッドをprocessPayment()メソッドから呼び出す。

public Json processPayment(User user, Amount amount, CardData cardData) { 
    Json result = new Json(); 

    if(!doAllValidations(user,amount,cardData, result)) 
     return result; 

    // All validations are fine process transaction. 
    Json transactionResult = processTransaction(user, merchant, amount, cardData); 
    if (transactionResult.isNotValid()) 
     result.put("errorCode", transactionResult.get("errorCode"); 
     result.put("message", transactionResult.get("message"); 
    } else { 
     result.put("message", "Transaction Successful"); 
     result.put("referenceNumber, transactionResult.get("rrn"); 
    } 

    return result; 
} 

最後に、必要に応じてすべての検証を他の方法に移行することができます。

public bool doAllValidations(User user, Amount amount, CardData cardData, result) { 
     Json userResult = validateUser(user); 
     if (!doValidation(userResult, result)) 
      return result; 


     Merchant merchant = getMerchant(user); 
     Json merchantResult = validateMerchant(user); 
     if (!doValidation(merchantResult, result)) 
      return result; 

     Json limitsResult = validateLimits(user, merchant, amount); 
     if (!doValidation(limitsResult, result)) 
      return result; 
     .... 
}