M

MLOG

Українська

Дізнайтеся, як Event Sourcing може революціонізувати вашу реалізацію аудит-трейлів, пропонуючи неперевершену трасування, цілісність даних та стійкість системи. Ознайомтесь із практичними прикладами та стратегіями впровадження.

Event Sourcing: Впровадження аудит-трейлів для надійних і відстежуваних систем

У сучасному складному та взаємопов'язаному цифровому ландшафті підтримка надійного та всебічного аудит-трейлу має першорядне значення. Це не тільки часто є регуляторною вимогою, але й має вирішальне значення для налагодження, аналізу безпеки та розуміння еволюції вашої системи. Event Sourcing, архітектурний шаблон, який фіксує всі зміни стану програми як послідовність подій, пропонує елегантне та потужне рішення для впровадження аудит-трейлів, які є надійними, підлягають аудиту та розширюваними.

Що таке Event Sourcing?

Традиційні програми зазвичай зберігають лише поточний стан даних у базі даних. Цей підхід ускладнює відновлення минулих станів або розуміння серії подій, що призвели до поточного стану. Event Sourcing, навпаки, зосереджується на фіксації кожної значної зміни стану програми як незмінної події. Ці події зберігаються у сховищі подій із лише додатковим записом, утворюючи повний і хронологічний запис усіх дій у системі.

Уявіть це як виписку з банківського рахунку. Замість простого запису поточного балансу, кожне поповнення, зняття та переказ записуються як окрема подія. Відтворивши ці події, ви можете відтворити стан рахунку в будь-який момент часу.

Чому використовувати Event Sourcing для аудит-трейлів?

Event Sourcing пропонує кілька переконливих переваг для впровадження аудит-трейлів:

Впровадження Event Sourcing для аудит-трейлів: покрокова інструкція

Ось практичний посібник з впровадження Event Sourcing для аудит-трейлів:

1. Визначте ключові події

Першим кроком є визначення ключових подій, які ви хочете зафіксувати у своєму аудит-трейлі. Ці події мають представляти значні зміни в стані програми. Розгляньте такі дії:

Приклад: Для платформи електронної комерції ключові події можуть включати «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) {
    // ... бізнес-логіка для створення замовлення ...

    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) {
    // Створити об'єкт події
    EventRecord eventRecord = new EventRecord(
        UUID.randomUUID(), // eventId
        streamName,  // streamName
        entityId,   // entityId
        event.getClass().getName(), // eventType
        toJson(event),  // eventData
        Instant.now().toString(), // timestamp
        userId  // userId
    );

    // Серіалізувати подію
    String serializedEvent = toJson(eventRecord);

    // Додати подію до сховища подій (реалізація залежить від обраного сховища подій)
    storeEventInDatabase(serializedEvent);

    // Опублікувати подію передплатникам (необов'язково)
    publishEventToMessageQueue(serializedEvent);
  }

  // Заповнювачі методів для взаємодії з базою даних та чергою повідомлень
  private void storeEventInDatabase(String serializedEvent) {
    // Реалізація для збереження події в базі даних
    System.out.println("Збереження події в базі даних: " + serializedEvent);
  }

  private void publishEventToMessageQueue(String serializedEvent) {
    // Реалізація для публікації події в черзі повідомлень
    System.out.println("Публікація події в черзі повідомлень: " + serializedEvent);
  }

  private String toJson(Object obj) {
    // Реалізація серіалізації події до JSON
    try {
      ObjectMapper mapper = new ObjectMapper();
      return mapper.writeValueAsString(obj);
    } catch (Exception e) {
      throw new RuntimeException("Помилка серіалізації події до 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);
    }

    // Інші обробники подій для PaymentReceivedEvent, OrderShippedEvent тощо.
}

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. Реалізуйте аудит і звітність

Після того, як ви реалізували Event Sourcing, ви можете використовувати потік подій для створення аудит-звітів і виконання аналізу безпеки. Ви можете запитувати сховище подій, щоб знайти всі події, пов'язані з певним користувачем, транзакцією або сутністю. Ви також можете використовувати потік подій для відновлення стану системи в будь-який момент часу.

Приклад: Ви можете створити звіт, який показує всі зміни, внесені до певного профілю користувача за певний період часу, або звіт, який показує всі транзакції, ініційовані певним користувачем.

Розгляньте такі можливості звітності:

Виклики Event Sourcing

Хоча Event Sourcing пропонує багато переваг, він також представляє певні виклики:

Найкращі практики Event Sourcing

Щоб пом'якшити проблеми Event Sourcing, дотримуйтесь цих найкращих практик:

Приклади Event Sourcing у реальному світі

Event Sourcing використовується в різних галузях і додатках, зокрема:

Висновок

Event Sourcing – це потужний архітектурний шаблон, який може революціонізувати вашу реалізацію аудит-трейлу. Він забезпечує неперевершену трасування, цілісність даних і стійкість системи. Незважаючи на певні виклики, переваги Event Sourcing часто переважають витрати, особливо для складних і критичних систем. Дотримуючись найкращих практик, викладених у цьому посібнику, ви можете успішно впровадити Event Sourcing і створити надійні та підлягаючі аудиту системи.

Додаткове читання