M

MLOG

日本語

イベントソーシングがいかに監査証跡の実装を革新し、比類ない追跡可能性、データ整合性、システム回復力をもたらすかを探ります。実践的な例と実装戦略をご紹介します。

イベントソーシング：堅牢で追跡可能なシステムのための監査証跡の実装

今日の複雑で相互接続されたデジタル環境において、堅牢で包括的な監査証跡の維持は極めて重要です。それは多くの場合、規制要件であるだけでなく、デバッグ、セキュリティ分析、およびシステムの進化を理解するためにも不可欠です。アプリケーションの状態へのすべての変更をイベントのシーケンスとしてキャプチャするアーキテクチャパターンであるイベントソーシングは、信頼性があり、監査可能で、拡張性のある監査証跡を実装するためのエレガントで強力なソリューションを提供します。

イベントソーシングとは？

従来のアプリケーションは通常、データベースにデータの現在の状態のみを保存します。このアプローチでは、過去の状態を再構築したり、現在の状態に至った一連のイベントを理解したりすることが困難です。対照的に、イベントソーシングは、アプリケーションの状態に対するすべての重要な変更を不変のイベントとしてキャプチャすることに焦点を当てています。これらのイベントは追記専用のイベントストアに保存され、システム内のすべてのアクションの完全で時系列の記録を形成します。

これを銀行口座の台帳のように考えてみてください。単に現在の残高を記録するのではなく、すべての預金、引き出し、送金が個別のイベントとして記録されます。これらのイベントをリプレイすることで、任意の時点の口座の状態を再構築できます。

監査証跡にイベントソーシングを使用する理由

イベントソーシングは、監査証跡を実装するためにいくつかの説得力のある利点を提供します。

監査証跡のためのイベントソーシングの実装：ステップバイステップガイド

以下に、監査証跡のためにイベントソーシングを実装するための実践的なガイドを示します。

1. 主要なイベントを特定する

最初のステップは、監査証跡にキャプチャしたい主要なイベントを特定することです。これらのイベントは、アプリケーションの状態に対する重要な変更を表すべきです。次のようなアクションを検討してください。

例: eコマースプラットフォームの場合、主要なイベントには「OrderCreated」（注文作成）、「PaymentReceived」（支払い受領）、「OrderShipped」（注文発送）、「ProductAddedToCart」（商品をカートに追加）、「UserProfileUpdated」（ユーザープロファイル更新）などが含まれる場合があります。

2. イベント構造を定義する

各イベントは、以下の情報を含む明確に定義された構造を持つ必要があります。

例: 「OrderCreated」イベントは次のような構造を持つ場合があります。

{
  \"eventType\": \"OrderCreated\",
  \"eventData\": {
    \"orderId\": \"12345\",
    \"customerId\": \"67890\",
    \"orderDate\": \"2023-10-27T10:00:00Z\",
    \"totalAmount\": 100.00,
    \"currency\": \"USD\",
    \"shippingAddress\": {
      \"street\": \"123 Main St\",
      \"city\": \"Anytown\",
      \"state\": \"CA\",
      \"zipCode\": \"91234\",
      \"country\": \"USA\"
    }
  },
  \"timestamp\": \"2023-10-27T10:00:00Z\",
  \"userId\": \"user123\",
  \"transactionId\": \"tx12345\",
  \"correlationId\": \"corr123\",
  \"metadata\": {
    \"ipAddress\": \"192.168.1.1\",
    \"browser\": \"Chrome\",
    \"location\": {
       \"latitude\": 34.0522,
       \"longitude\": -118.2437
    }
  }
}

3. イベントストアを選択する

イベントストアは、イベントを保存するための中央リポジトリです。イベントのシーケンスの書き込みと読み取りに最適化された追記専用のデータベースであるべきです。いくつかのオプションがあります。

イベントストアを選択する際には、次のような要素を考慮してください。

4. イベント発行を実装する

イベントが発生した場合、アプリケーションはそれをイベントストアに発行する必要があります。これには通常、次のステップが含まれます。

例 (架空のEventStoreServiceを使用):

public class OrderService {

  private final EventStoreService eventStoreService;

  public OrderService(EventStoreService eventStoreService) {
    this.eventStoreService = eventStoreService;
  }

  public void createOrder(Order order, String userId) {
    // ... business logic to create the order ...

    OrderCreatedEvent event = new OrderCreatedEvent(
        order.getOrderId(),
        order.getCustomerId(),
        order.getOrderDate(),
        order.getTotalAmount(),
        order.getCurrency(),
        order.getShippingAddress()
    );

    eventStoreService.appendEvent(\"order\", order.getOrderId(), event, userId);
  }
}

public class EventStoreService {

  public void appendEvent(String streamName, String entityId, Object event, String userId) {
    // Create an event object
    EventRecord eventRecord = new EventRecord(
        UUID.randomUUID(), // eventId
        streamName,  // streamName
        entityId,   // entityId
        event.getClass().getName(), // eventType
        toJson(event),  // eventData
        Instant.now().toString(), // timestamp
        userId  // userId
    );

    // Serialize the event
    String serializedEvent = toJson(eventRecord);

    // Append the event to the event store (implementation specific to the chosen event store)
    storeEventInDatabase(serializedEvent);

    // Publish the event to subscribers (optional)
    publishEventToMessageQueue(serializedEvent);
  }

  // Placeholder methods for database and message queue interaction
  private void storeEventInDatabase(String serializedEvent) {
    // Implementation to store the event in the database
    System.out.println(\"Storing event in database: \" + serializedEvent);
  }

  private void publishEventToMessageQueue(String serializedEvent) {
    // Implementation to publish the event to a message queue
    System.out.println(\"Publishing event to message queue: \" + serializedEvent);
  }

  private String toJson(Object obj) {
    // Implementation to serialize the event to JSON
    try {
      ObjectMapper mapper = new ObjectMapper();
      return mapper.writeValueAsString(obj);
    } catch (Exception e) {
      throw new RuntimeException(\"Error serializing event to JSON\", e);
    }
  }
}


class EventRecord {
  private final UUID eventId;
  private final String streamName;
  private final String entityId;
  private final String eventType;
  private final String eventData;
  private final String timestamp;
  private final String userId;

  public EventRecord(UUID eventId, String streamName, String entityId, String eventType, String eventData, String timestamp, String userId) {
    this.eventId = eventId;
    this.streamName = streamName;
    this.entityId = entityId;
    this.eventType = eventType;
    this.eventData = eventData;
    this.timestamp = timestamp;
    this.userId = userId;
  }

  // Getters

  @Override
  public String toString() {
    return \"EventRecord{\" +
        \"eventId=\" + eventId +
        \", streamName='\" + streamName + '\\'\' +
        \", entityId='\" + entityId + '\\'\' +
        \", eventType='\" + eventType + '\\'\' +
        \", eventData='\" + eventData + '\\'\' +
        \", timestamp='\" + timestamp + '\\'\' +
        \", userId='\" + userId + '\\'\' +
        '}';
  }
}

class OrderCreatedEvent {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;
    private final String shippingAddress;

    public OrderCreatedEvent(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return \"OrderCreatedEvent{\" +
                \"orderId='\" + orderId + '\\'\' +
                \", customerId='\" + customerId + '\\'\' +
                \", orderDate='\" + orderDate + '\\'\' +
                \", totalAmount=\" + totalAmount +
                \", currency='\" + currency + '\\'\' +
                \", shippingAddress='\" + shippingAddress + '\\'\' +
                '}';
    }
}

class Order {
  private final String orderId;
  private final String customerId;
  private final String orderDate;
  private final double totalAmount;
  private final String currency;
  private final String shippingAddress;

  public Order(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return \"Order{\" +
                \"orderId='\" + orderId + '\\'\' +
                \", customerId='\" + customerId + '\\'\' +
                \", orderDate='\" + orderDate + '\\'\' +
                \", totalAmount=\" + totalAmount +
                \", currency='\" + currency + '\\'\' +
                \", shippingAddress='\" + shippingAddress + '\\'\' +
                '}';
    }
}

5. 読み取りモデル（プロジェクション）を構築する

イベントストアはすべての変更の完全な履歴を提供しますが、読み取り操作のためにそれを直接クエリすることは効率的でないことがよくあります。代わりに、特定のクエリパターンに最適化された読み取りモデル（プロジェクションとも呼ばれる）を構築できます。これらの読み取りモデルはイベントストリームから派生し、新しいイベントが発行されると非同期で更新されます。

例: 特定の顧客のすべての注文のリストを含む読み取りモデルや、特定の製品の販売データを要約する読み取りモデルを作成できます。

読み取りモデルを構築するには、イベントストリームを購読し、各イベントを処理します。各イベントについて、それに応じて読み取りモデルを更新します。

例:

public class OrderSummaryReadModelUpdater {

    private final OrderSummaryRepository orderSummaryRepository;

    public OrderSummaryReadModelUpdater(OrderSummaryRepository orderSummaryRepository) {
        this.orderSummaryRepository = orderSummaryRepository;
    }

    public void handle(OrderCreatedEvent event) {
        OrderSummary orderSummary = new OrderSummary(
                event.getOrderId(),
                event.getCustomerId(),
                event.getOrderDate(),
                event.getTotalAmount(),
                event.getCurrency()
        );

        orderSummaryRepository.save(orderSummary);
    }

    // Other event handlers for PaymentReceivedEvent, OrderShippedEvent, etc.
}

interface OrderSummaryRepository {
    void save(OrderSummary orderSummary);
}

class OrderSummary {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;

    public OrderSummary(String orderId, String customerId, String orderDate, double totalAmount, String currency) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
    }
    //Getters
}

6. イベントストアを保護する

イベントストアには機密データが含まれているため、適切に保護することが重要です。次のセキュリティ対策を検討してください。

7. 監査とレポート機能を実装する

イベントソーシングを実装したら、イベントストリームを使用して監査レポートを生成し、セキュリティ分析を実行できます。イベントストアをクエリして、特定のユーザー、トランザクション、またはエンティティに関連するすべてのイベントを見つけることができます。また、イベントストリームを使用して、任意の時点のシステムの状態を再構築することもできます。

例: 特定の期間に特定のユーザープロファイルに対して行われたすべての変更を示すレポートや、特定のユーザーによって開始されたすべてのトランザクションを示すレポートを生成できます。

以下のレポート機能を検討してください。

イベントソーシングの課題

イベントソーシングには多くの利点がありますが、いくつかの課題も提示します。

イベントソーシングのベストプラクティス

イベントソーシングの課題を軽減するために、以下のベストプラクティスに従ってください。

イベントソーシングの現実世界での例

イベントソーシングは、以下を含むさまざまな業界やアプリケーションで使用されています。

結論

イベントソーシングは、監査証跡の実装を革新できる強力なアーキテクチャパターンです。それは比類ない追跡可能性、データ整合性、およびシステム回復力を提供します。いくつかの課題がある一方で、イベントソーシングの利点は、特に複雑で重要なシステムの場合、コストを上回ることがよくあります。このガイドに概説されているベストプラクティスに従うことで、イベントソーシングを成功裏に実装し、堅牢で監査可能なシステムを構築できます。

参考文献