В Python web разработке есть стандартные подходы к архитектуре и дизайну кода, привнесённые распространёнными web-фреймворками, но они не давали нам достаточной простоты и гибкости. Поэтому мы решили попробовать другое: немного Domain-Driven Design, немного слоёв в архитектуре, немного (микро-) сервисов. В результате проекты стали проще для понимания, оптимизации и изменения. Теперь мы можем быстрее их начинать и быстрее добавлять новых разработчиков даже на последнем этапе (мы почти отменили закон Брукса!). В докладе я хочу поделиться нашим опытом и практическими рекомендациями, которые мы сформировали для наших проектов. Доклад, в основном, практический, может быть интересен как тимлидам и python-разработчикам, знакомым с вышеупомянутыми концепциями, но не использующим их на практике, так и видящим их впервые.

1. — Мой учитель
«Перед презентацией проверь, работает ли переключатель слайдов»

2. Борис Цема
Game Services
Wargaming
Как мы уменьшили сложность наших
проектов

3. 3
Кадр из к/ф «Криминальное чтиво»

4. 4

5. 5
Команда
разработки
Проект WG
XMLRPC
Проект WG
Kafka
Проект WG
HTTP + AMQP
Проект WG
HTTP + AMQP
Проект WG
Проект WG
Проект WG
10-20 интеграций
Различные транспорты
Разные протоколы общения
Проект WG
SQL
JIRA

6. Как мы обычно делали
• SQLAlchemy
• HTTP API и/или MVC
• Pure Python или Django
• Deploy:
• Один WSGI App (несколько инстансов)
• БД (с репликами по необходимости)
• несколько long-run python процесов (aka workers)
6

7. • Просто начать.
• Подходит большинству
проектов.
• Знаком почти всем python
разработчикам.
• В большинстве случае
нормальная
производительность.
7
• Сложно добиться очень высокой
производительности.
• Поставка новых игровых фичей со
временем замедляется.
• Со временем повышается
вероятность внесения багов.
Что хорошо Что не очень

8. 8
Как сделать лучше
https://martinfowler.com/bliki/PresentationDomainDataLayering.html
http://confluent.io
Wikipedia

9. Как мы теперь это делаем
Мы пишем код

10. Реферальная программа 2.0
13
…

11. 14
• id
• nickname
• clan_tag
• clan_color
• is_banned
• recruits_total
• battles_count
• …
• id
• account_id
• text
• expiration_date
• …
• recruiter_id
• recruit_id
• points
• status
• …
Account Referral Link Relation
Определение предметной области

12. 15class Account:
def __init__(
self,
id_: AccountID,
nickname: str,
clan: Clan,
exclusion_reasons: List[ExcludedAccount],
recruits_total: int,
arenas: Collection[Arena],
) -> None:
assert isinstance(clan, Clan), type(clan)
self.clan = clan
self._arenas = arenas
# More init code here...
@property
def battles_count(self) -> int:
return len(self._arenas)
@property
def clan_tag(self) -> str:
return self.clan.tag

13. Может ORM?
• Проектирование БД мешает на этапе выявления сущностей и их
взаимодействия.
• При первоначальном кодировании сущностей могут возникнуть
вопросы к бизнесу, которые изменят требования.
• Может оказаться что БД не нужна, или нужна в другом виде.
16

14. 17
Account
Clan
ExcludedAccount
ArenasDomain Layer

15. User Story
Я как пользователь хочу зарегистрироваться в реферальной
программе чтобы иметь возможность приглашать других игроков.
18

16. 19
• Ожидаем ли пика регистрации? (хранить кланы у себя или ходить за ними?)
• Откуда может прийти запрос на регистрацию: знают ли они nickname игрока?
• Должен ли процесс регистрации быть транзакцией?
=> Идём задавать вопросы в бизнес и проекты-интеграции.
class AccountService:
def register_account(self, account_id: AccountID) -> Account:
clan = self._get_clan(account_id)
nickname = self._get_nickname(account_id)
if self._is_account_banned(account_id):
raise Exception('Account can not be created.')
account = Account(account_id, nickname, clan)
self._save_account(account)
return account
def _get_clan(self, account_id: AccountID) -> Optional[Clan]:
pass

17. 22
AccountServiceService Layer
Account
Clan
ExcludedAccount
ArenasDomain Layer

18. 23
class AccountService:
def register_account(self, account_id: AccountID) -> Account:
clan = self._get_clan(account_id)
nickname = self._get_nickname(account_id)
if self._is_account_banned(account_id):
raise Exception('Account can not be created.')
account = Account(account_id, nickname, clan)
self._save_account(account)
return account

19. 24
class AccountService:
def register_account(self, account_id: AccountID) -> Account:
clan = self._get_clan(account_id)
nickname = self._get_nickname(account_id)
if self._is_account_banned(account_id):
raise Exception('Account can not be created.')
account = Account(account_id, nickname, clan)
self.account_repo.insert(account)
return account

20. 25
class AccountRepository:
def get_by_id(self, instance_id: AccountID) -> Optional[Account]:
pass
def get_or_raise_by_id(self, instance_id: AccountID) -> Account:
pass
def insert(self, instance: Account) -> None:
pass
def update(self, instance: Account) -> None:
pass
def delete(self, instance: Account) -> None:
pass

21. 26
class AccountService:
def __init__(self) -> None:
self.account_repo = AccountRepository()

22. 27
class BaseQueryBuilderMixin:
@property
def table(self) -> Table:
raise NotImplementedError()
@property
def id_query(self) -> BinaryExpression:
return self.table.c.id == bindparam('instance_id')
@property
def get_by_id_query(self) -> Select:
return self.get_all_query().where(self.id_query)
@property
def get_by_id_for_update_query(self) -> Select:
return self.get_all_query().with_for_update(key_share=True).where(
self.id_query)
@property
def delete_by_id_query(self) -> Delete:
return self.table.delete().where(self.id_query)

23. 28
class BaseSerializerMixin(Generic[T, T_ID]):
def get_instance_id(self, instance: T) -> T_ID:
raise NotImplementedError()
def get_instances(self, records: List[RowProxy]) -> List[T]:
return list(map(self.get_instance, records))
def get_instance(self, record: RowProxy) -> T:
raise NotImplementedError()
def instance_to_dict(self, instance: T) -> Dict:
serializer = getattr(instance, 'to_dict', None)
if callable(serializer):
return serializer()
raise NotImplementedError()
def instance_id_as_dict(self, instance_id: T_ID) -> Dict[str, Any]:
return {'instance_id': instance_id}

24. 29
class BaseSyncRepository(Generic[T, T_ID], BaseQueryBuilderMixin,
BaseSerializerMixin[T, T_ID]):
def insert(self, instance: T) -> ResultProxy:
query = self.insert_query
params = self.instance_to_dict(instance)
return self._execute(query, **params)
def exists_by_id(self, instance_id: T_ID) -> bool:
query = exists().where(self.id_query).select()
return self._exists(query, **self.instance_id_as_dict(instance_id))

25. 30
class BaseAsyncRepository(Generic[T, T_ID], BaseQueryBuilderMixin,
BaseSerializerMixin[T, T_ID]):
async def get_by_id(self, instance_id: T_ID) -> Optional[T]:
query, args = self._get_query_and_args(
self.get_by_id_query, self.instance_id_as_dict(instance_id)
)
result = await self._fetchone(query, *args)
if result is None:
return None
return self.get_instance(result)
async def insert(self, instance: T) -> int:
params = self.instance_to_dict(instance)
query, args = self._get_query_and_args(self.insert_query, params)
result = await self._execute(query, *args)
return self._get_row_count(result)

26. 31
class CachedSyncRepository(Generic[T, T_ID], BaseSyncRepository[T, T_ID]):
def insert(self, instance: T) -> ResultProxy:
result = super(CachedSyncRepository, self).insert(instance)
self._save_instance_in_cache(instance)
return result
def get_by_id(self, instance_id: T_ID) -> Optional[T]:
result = self._get_instance_from_cache(instance_id)
if result is not None:
return result
instance = super(CachedSyncRepository, self).get_by_id(instance_id)
if instance is None:
return None
self._save_instance_in_cache(instance)
return instance

27. 32
AccountServiceService Layer
AccountRepositoryInfrastructure Layer
Account
Clan
ExcludedAccount
ArenasDomain Layer

28. Требование
Через некоторый срок неактивности аккаунт должен быть удалён из
системы, с предупреждением игрока за месяц.
33

29. Теперь нам нужен scheduler
• cron/at?
• celery?
• Написать свой?
34
Отложим выбор на потом

30. 35
class SchedulingTask:
def __init__(
self,
task_name: str,
must_complete_at: datetime = None,
task_id: str = None,
params: Dict = None,
) -> None:
self.task_name = task_name
self.task_id = task_id or uuid.uuid4()
self.params = params or {}
self.must_complete_at = must_complete_at
class SchedulingTaskRepository:
def insert_many(self, instances: List[SchedulingTask]) -> None:
for instance in instances:
self.insert(instance)
def insert(self, task: SchedulingTask) -> None:
pass

31. 36
class SchedulingTaskRepository:
def insert(self, task: SchedulingTask) -> None:
celery_app.send_task(task.task_name, [task.params], **task.celery_opts)
class SchedulingTask:
def __init__(
self,
task_name: str,
must_complete_at: datetime = None,
task_id: str = None,
params: Dict = None,
celery_opts: Dict = None,
) -> None:
self.task_name = task_name
self.task_id = task_id or uuid.uuid4()
self.params = params or {}
self.celery_opts = celery_opts or {}
self.celery_opts['task_id'] = self.task_id
if must_complete_at is not None:
self.celery_opts['eta'] = must_complete_at

32. • Если взаимодействие может быть ограничено CRUD запросами.
• Если объект можно легко сконструировать.
• Если абстракция репозитория не протекает.
37
Когда можно так делать
В остальных случаях используем класс-сервис.

33. 38
AccountServiceService Layer
AccountRepository SchedulerRepositoryInfrastructure Layer
Account
Clan
ExcludedAccount
ArenasDomain Layer

34. Endpoints: HTTP API
39
class AccountCreatingResource(BaseFalconResource):
def __init__(self, service: AccountService) -> None:
self.service = service
def on_post(self, req: falcon.Request, resp: falcon.Response) -> None:
account_id = req.get_param_as_int('account_id', required=True)
self.service.register_account(account_id)
resp.status_code = falcon.HTTP_201

35. Endpoints: CLI
40
@click.command('account')
def account_command():
pass
@account_command.command('register')
@click.option('-i', '--id', 'id_', type=int, required=True,
help='Account id to create.')
def register_account(id_: int) -> None:
service = AccountService()
existed_account = service.get_account(id_)
if existed_account is None:
service.register_account(id_)
logger.info('Account was successfully created.')
else:
logger.error('Account already exist.')
sys.exit(1)

36. 41
AccountServiceService Layer
AccountRepository SchedulerRepositoryInfrastructure Layer
Account
Clan
ExcludedAccount
ArenasDomain Layer
Application Layer HTTP API CLI RPC MQ Listener

37. User Story
Я как пользователь хочу зарегистрироваться в реферальной
программе чтобы иметь возможность приглашать других игроков.
42

38. 43
class AccountService:
def register_account(self, account_id: AccountID) -> Account:
clan = self._get_clan(account_id)
nickname = self._get_nickname(account_id)
if self._is_account_banned(account_id):
raise Exception('Account can not be created.')
account = Account(account_id, nickname, clan)
self.account_repo.insert(account)
self._create_referral_link(account)
return account
def _create_referral_link(self, account: Account) -> None:
if not account.can_be_recruiter:
return
link = ReferralLink(account.id)
self.referral_link_repo.insert(link)

39. 44
Регистрация аккаунта и CRUD операции
Регистрация ссылки
Уведомления об операциях с ссылками
Блокировка ссылок
Блокировка аккаунта
Соблюдение GDPR
Соблюдение GDPR
Account Context
Referral Link Context
Соблюдение TTL ссылки

40. 45
Регистрация аккаунта и CRUD операции
Регистрация ссылки
Уведомления об операциях с ссылками
Блокировка ссылок
Блокировка аккаунта
Соблюдение GDPR
Соблюдение GDPR
AccountService
ReferralLinkService
Соблюдение TTL ссылки

41. 46
class ReferralLinkService:
def get_or_create_referral_link(self, account_id: AccountID) -> ReferralLink:
existed_link = self.referral_link_repo.get_by_account_id(account_id)
if existed_link is not None:
return existed_link
link = ReferralLink(account_id)
self.referral_link_repo.insert(link)
return link
class AccountService:
def register_account(self, account_id: AccountID) -> Account:
# ...
if account.can_be_recruiter:
self.referral_link_service.get_or_create_referral_link(account.id)
return account

42. 47
Регистрация аккаунта и CRUD операции
Регистрация ссылки
Уведомления об операциях с ссылками
Блокировка ссылок
Блокировка аккаунта
Соблюдение GDPR
Соблюдение GDPR
AccountService
ReferralLinkService
Соблюдение TTL ссылки
Некоторый маппер

43. 48
class ReferralLinkService:
def get_or_create_referral_link(self, account: Account) -> ReferralLink:
if not account.can_be_recruiter:
raise Exception(‘Referral link can not be created.')
existed_link = self.referral_link_repo.get_by_account_id(account.id)
if existed_link is not None:
return existed_link
link = ReferralLink(account.id)
self.referral_link_repo.insert(link)
return link
Если что – потом отрефакторим. Система должна эволюционировать.

44. 49
AccountServiceReferralLinkServiceService Layer
AccountRepositoryReferralLinkRepository SchedulerRepositoryInfrastructure Layer
Account
Clan
ExcludedAccount
ArenasReferralLinkDomain Layer
Application Layer HTTP API CLI RPC MQ Listener

45. User Story
Я как игрок хочу иметь возможность приглашать рефералов
после достижения 1000 боёв.
50

46. 51
class AccountService:
def add_battle_to_account(self, account: Account,
battle: PlayerBattle) -> None:
account.add_battle(battle)
with db.transaction:
self.account_repo.update(account)
self._drop_caches_for_account(account)
if account.can_be_recruiter:
self.referral_link_service.get_or_create_referral_link(
account.id)

47. 52
Пример: контекст и переиспользование методов
class AccountService:
def is_banned(self, account_id: AccountID) -> bool:
for reason in self.excluded_account_repo.get_by_account_id(account_id):
if reason.is_ban:
return True
return False
• Требуется бОльшая производительность.
• Логика не сложная и покрыта тестами.
Когда использовать:

48. 53
def register_account(self, account_id: AccountID, force: bool = False,
for_link: ReferralLink = None) -> Account:
Пример: ограниченные интерфейсы
def register_account(self, account_id: AccountID) -> Account:
def register_account_by_referral_link(self, account_id: AccountID,
link: ReferralLink) -> Account:
def register_account_if_satisfied(
self, account_id: AccountID, specification: BaseSpecification
) -> Account:

49. 54
class AccountService:
def add_battle_to_account(self, account: Account,
battle: PlayerBattle) -> None:
account.add_battle(battle)
with db.transaction:
self.account_repo.update(account)
self._drop_caches_for_account(account)
if account.can_be_recruiter:
self.referral_link_service.get_or_create_referral_link(
account.id)

50. 55
class AccountService:
def add_battle_to_account(self, account: Account,
battle: PlayerBattle) -> None:
account.add_battle(battle)
with db.transaction:
self.account_repo.update(account)
self._drop_caches_for_account(account)
if account.can_be_recruiter:
self.referral_link_service.get_or_create_referral_link(
account.id)

51. 56
class AccountService:
def add_battle_to_account(self, account: Account,
battle: PlayerBattle) -> None:
account.add_battle(battle)
with db.transaction:
self.account_repo.update(account)
CachingService.instance.drop_caches_for_account(account)
if account.can_be_recruiter:
self.referral_link_service.get_or_create_referral_link(
account.id)

52. 60

53. Что мы получили
• Оптимизация после performance теста проводится почти мгновенно и
без внесения багов.
• Высокая степень покрытия тестами при небольших затратах на
тестирование.
• При разработке игрового события средней сложности у нас теперь
уходит гораздо меньше ресурсов на бэкенде.
• Проще добавлять новых разработчиков.
• Проще bootstrap нового проекта.
61

54. 62
Всё стало проще

55. Как внедрять
63

56. Если добавляете новую фичу
• Определите единый язык (может помочь составление глоссария)!
• Найдите в каком контексте появляется новая фича.
• Найдите основные сущности и создайте pure python классы.
• Выделите бизнесовые связи между ними и найдите корень агрегата.
• Создайте класс Service с методами на каждую User Story/Use Case и
выделите методы, которые можно переиспользовать в проекте.
• Постепенно мигрируйте логику, связанную с этим контекстом, из всего
кода в этот Service.
64

57. Если нужно много и сложно общаться с базой
• Пересмотрите предметную область (помогает разделение
контекстов).
• Не стесняйтесь доставать из базы отдельные значения
(например,get_link_text_by_id, но только при необходимости).
• Ограничьте контекст где «программирование на SQLAlchemy»
необходимо.
65

58. В любом случае
• Найти единый язык (может помочь составление глоссария).
• Найти контексты и ограничить их проникновение друг в друга.
• Разделить ответственности по слоям (hexagon/layered architecture).
• Уменьшать когнитивную нагрузку при любом удобном случае.
• Рефакторинг должен быть непрерывным.
• Использовать type hinting!
• Следование стратегическому дизайну DDD — инструмент а не цель.
66

59. Domain Layer
• Pure Python (standard library, third-party libraries)
• Интерфейс класса использует единый язык, на котором говорят все в
проекте (бизнес, дизайнеры, реклама и т.д.)
• Язык можно менять, хорошо составить глоссарий.
• Забыть об инфраструктурной части (БД, очереди, протоколы).
67

60. Service Layer
• Сервис соответствует не агрегату, а некоторому контексту
использования, но не более одного агрегата на сервис.
• Интерфейсы методов должны быть полны и ограничены.
• Допустимо передавать агрегат из сервиса в сервис.
• Допустимо использовать один сервис из другого.
• Сервис не всегда связан с объектом предметной области, иногда он
может лежать в инфраструктурном слое.
• Сервисы должны подвергаться постоянному рефакторингу.
68

61. Infrastructure Layer
• Единый интерфейс, не требующий документации (методы get_by_…,
get_or_raise_by_…).
• Типизация параметров и возвращаемых значений.
• __init__ без параметров без явной необходимости.
• Не стесняться писать дополнительные методы при необходимости.
• По возможности оперирует целыми объектами предметной области а не
их частью (не возвращает специфичные словари и списки).
• Зависит только от объектов предметной области и сторонних библиотек.
69

62. 70
AccountServiceReferralLinkServiceService Layer
AccountRepositoryReferralLinkRepository SchedulerRepositoryInfrastructure Layer
Account
Clan
ExcludedAccount
ArenasReferralLinkDomain Layer
Application Layer HTTP API CLI RPC MQ Listener

63. Вопросы?
• Если кодовая база уже есть как переписать?
• Почему не микросервисы?
• Почему классы а не модули? Чем не подходит logic.py?
• Почему столько отклонений от DDD?
• Подходит ли это мне?
71

64. Борис Цема / Boris Tsema
boris@tsema.ru