mufassall

Шпаргалка · Целые системы

От требований к дизайну

13 мин · Начальный · mufassall.dtwin.uz/ru/l/hld-lld/

← Открыть урок

Проблема

Как подойти к задаче на дизайн, не бросаясь сразу рисовать квадратики. Одна небольшая система, табло прибытия городских автобусов, проходит через требования, грубые оценки, высокоуровневую картину и детальный дизайн одной части, с записанными компромиссами.

Чему вы научитесь

  • Функциональные и нефункциональные требования и почему именно вторые определяют дизайн
  • Оценки на салфетке: чтения, записи и объём из нескольких известных чисел
  • High-level дизайн: блоки, стрелки и два пути системы
  • Low-level дизайн одного компонента: API, раскладка данных, схема и записанный компромисс
Итоговая сцена
35%40%60%

Диаграмма как код

Итоговая схема урока в виде текста: вставьте её в Jira, GitLab, GitHub, Notion или документацию, там Mermaid рисуется сам. Есть варианты для D2 и PlantUML (Confluence, IntelliJ).

Mermaid: схема

flowchart LR
  n_rider(["Приложение пассажира"])
  n_bus(["GPS-трекер автобуса"])
  n_api["API прибытий"]
  n_db[("База")]
  n_ingest["Сервис приёма"]
  n_queue[["Поток позиций"]]
  n_worker("ETA-воркеры")
  n_cache{{"Кэш ETA"}}
  n_bus --> n_ingest
  n_rider --> n_api
  n_ingest --> n_queue
  n_queue --> n_worker
  n_worker --> n_cache
  n_worker --> n_db
  n_api --x n_cache
  n_api --> n_db
  classDef down fill:#fde2e2,stroke:#c62828,color:#4a0d0d,stroke-dasharray:4 3
  class n_cache down

Mermaid: последовательность запросов

sequenceDiagram
  participant n_bus as GPS-трекер автобуса
  participant n_api as API прибытий
  participant n_rider as Приложение пассажира
  participant n_ingest as Сервис приёма
  participant n_queue as Поток позиций
  participant n_worker as ETA-воркеры
  participant n_cache as Кэш ETA
  participant n_db as База
  Note over n_bus,n_api: «Сделайте табло прибытия автобусов»
  n_bus->>n_api: POST /positions HTTP/1.1
  n_api-->>n_bus: HTTP/1.1 204 No Content
  Note over n_rider,n_api: Требования: что делает и насколько хорошо
  n_rider->>n_api: GET /stops/s_204/arrivals HTTP/1.1
  n_api-->>n_rider: HTTP/1.1 200 OK
  Note over n_ingest,n_queue: High-level дизайн: два пути
  n_ingest->>n_queue: topic bus-positions, key b_17, partition 3
  Note over n_queue,n_worker: Воркер отстаёт
  n_queue->>n_worker: consumer group eta-workers
  Note over n_rider,n_api: Low-level дизайн: API прибытий
  n_rider->>n_api: GET /v1/stops/s_204/arrivals HTTP/1.1
  n_api-->>n_rider: HTTP/1.1 200 OK
  Note over n_worker,n_cache: Low-level дизайн: один ключ на остановку
  n_worker->>n_cache: HSET arrivals:s_204 R11 240 R3 610 updated_at 1795421720
  n_cache-->>n_worker: (integer) 3
  Note over n_worker,n_db: Low-level дизайн: таблица истории
  n_worker->>n_db: INSERT INTO positions (bus_id, route, ts, lat, lon)
  n_db-->>n_worker: INSERT 0 1
  Note over n_rider,n_api: Компромисс: устаревшее, но доступное
  n_rider->>n_api: GET /v1/stops/s_204/arrivals HTTP/1.1
  n_api-->>n_rider: HTTP/1.1 200 OK

D2

direction: right

n_rider: "Приложение пассажира" {
  shape: rectangle
}
n_bus: "GPS-трекер автобуса" {
  shape: rectangle
}
n_api: "API прибытий" {
  shape: rectangle
}
n_db: "База" {
  shape: cylinder
}
n_ingest: "Сервис приёма" {
  shape: rectangle
}
n_queue: "Поток позиций" {
  shape: queue
}
n_worker: "ETA-воркеры" {
  shape: rectangle
  style.multiple: true
}
n_cache: "Кэш ETA" {
  shape: hexagon
  style.fill: "#fde2e2"
  style.stroke: "#c62828"
  style.stroke-dash: 3
}

n_bus -> n_ingest
n_rider -> n_api
n_ingest -> n_queue
n_queue -> n_worker
n_worker -> n_cache
n_worker -> n_db
n_api -> n_cache {
  target-arrowhead.shape: cross
}
n_api -> n_db

PlantUML: последовательность запросов

@startuml
participant "GPS-трекер автобуса" as n_bus
participant "API прибытий" as n_api
participant "Приложение пассажира" as n_rider
participant "Сервис приёма" as n_ingest
queue "Поток позиций" as n_queue
participant "ETA-воркеры" as n_worker
collections "Кэш ETA" as n_cache
database "База" as n_db
note over n_bus, n_api : «Сделайте табло прибытия автобусов»
n_bus -> n_api : POST /positions HTTP/1.1
n_api --> n_bus : HTTP/1.1 204 No Content
note over n_rider, n_api : Требования: что делает и насколько хорошо
n_rider -> n_api : GET /stops/s_204/arrivals HTTP/1.1
n_api --> n_rider : HTTP/1.1 200 OK
note over n_ingest, n_queue : High-level дизайн: два пути
n_ingest -> n_queue : topic bus-positions, key b_17, partition 3
note over n_queue, n_worker : Воркер отстаёт
n_queue -> n_worker : [повтор] consumer group eta-workers
note over n_rider, n_api : Low-level дизайн: API прибытий
n_rider -> n_api : GET /v1/stops/s_204/arrivals HTTP/1.1
n_api --> n_rider : HTTP/1.1 200 OK
note over n_worker, n_cache : Low-level дизайн: один ключ на остановку
n_worker -> n_cache : HSET arrivals:s_204 R11 240 R3 610 updated_at 1795421720
n_cache --> n_worker : (integer) 3
note over n_worker, n_db : Low-level дизайн: таблица истории
n_worker -> n_db : INSERT INTO positions (bus_id, route, ts, lat, lon)
n_db --> n_worker : INSERT 0 1
note over n_rider, n_api : Компромисс: устаревшее, но доступное
n_rider -> n_api : GET /v1/stops/s_204/arrivals HTTP/1.1
n_api --> n_rider : HTTP/1.1 200 OK
@enduml

PlantUML: компоненты

@startuml
left to right direction
agent "Приложение пассажира" as n_rider
agent "GPS-трекер автобуса" as n_bus
component "API прибытий" as n_api
database "База" as n_db
component "Сервис приёма" as n_ingest
queue "Поток позиций" as n_queue
collections "ETA-воркеры" as n_worker
stack "Кэш ETA" as n_cache #fde2e2;line:c62828;line.dashed
n_bus --> n_ingest
n_rider --> n_api
n_ingest --> n_queue
n_queue --> n_worker
n_worker --> n_cache
n_worker --> n_db
n_api -[#c62828]-> n_cache
n_api --> n_db
@enduml

Итог

Дизайн — это цепочка решений, каждое привязано к числу.

1) Сначала запишите функциональные и нефункциональные требования: дизайн определяют вторые. 2) Оцените чтения, записи и объём, чтобы найти тяжёлую часть. 3) High level: блоки и стрелки, отдельные пути для разной нагрузки. 4) Low level по одному компоненту за раз: API, раскладка данных, схема. 5) Записывайте каждый компромисс и требование, стоящее за ним.

Показатели: в начале и в конце

ПоказательВ началеВ конце
Входящие позиции80/с80/с
Запросы пассажиров3 000/с3 000/с
Ответ p95900 мс180 мс
Возраст ETA12 с60 с

Шаги

  1. Проблема «Сделайте табло прибытия автобусов»

    Задача — одна фраза.

  2. Решение Требования: что делает и насколько хорошо

    Функциональные: автобус шлёт позицию каждые 10 секунд; пассажир открывает остановку и видит ближайшие автобусы с минутами до прибытия.

  3. Кейс Грубые числа до любых блоков

    800 автобусов, одна позиция в 10 секунд: 80 записей в секунду.

  4. Решение High-level дизайн: два пути

    На картинке теперь два отдельных пути.

  5. Проблема Воркер отстаёт

    В час пик один воркер считает время прибытия для каждой позиции.

  6. Решение Больше воркеров, партиции между ними

    Группа воркеров вырастает до четырёх экземпляров, и 12 партиций делятся между ними.

  7. Решение Low-level дизайн: API прибытий

    Теперь один компонент в деталях.

  8. Решение Low-level дизайн: один ключ на остановку

    В кэше один hash на остановку: маршрут и секунды до прибытия плюс время расчёта.

  9. Решение Low-level дизайн: таблица истории

    История только дописывается: одна строка на позицию, без обновлений.

  10. Кейс Компромисс: устаревшее, но доступное

    Кэш падает.

  11. Итоги Итоги

    Дизайн — это цепочка решений, каждое привязано к числу.