Николай Михайлычев "Подход Contract-First при разработке распределенных систем"

Расскажу о простых программистских проблемах, ежедневно возникающих при разработке и потреблении различных API в распределенных системах: 
- как добиться гарантированной совместимости клиентской и серверной сторон;
- как избежать потери времени разработчиков на описание развесистых моделей на каждом из задействованных узлов;
- как вовремя донести до разработчика серверной части пожелания клиентской, чтобы его работа не улетела в стол;
А еще рассмотрю подходы и инструменты, имеющиеся на .NET для .NET (и не только), с помощью которых можно решить эти маленькие проблемы, которые оказываются совсем не маленькими в пересчете на человекочасы.

Transcript

1. Подход Contract-First при разработке распределенных систем Николай Михайлычев Positive Technologies
2. Распределённые системы 2 Frontend Backend Goods Orders Sales
3. Распределённые системы 3 Frontend Backend Goods Orders Sales
4. Контракты 4 • Согласование
5. Контракты 5 • Согласование • Поддержание актуальности
6. Контракты 6 • Согласование • Поддержание актуальности • Документирование
7. Классический процесс разработки 7 • Согласование • Описание контракта • Документировани е API • Разработка • Services • Clients • UI • Интеграция • Приводим в работоспособное состояние
8. Классический процесс разработки 8 • Согласование • Описание контракта • Документировани е API • Разработка • Services • Clients • UI • Интеграция • Приводим в работоспособное состояние
9. Проблемы • Необходимость ручной имплементации 9
10. Проблемы • Необходимость ручной имплементации • Ошибки при переносе в код 10
11. Проблемы • Необходимость ручной имплементации • Ошибки при переносе в код • Необходимость поддержки документации 11
12. Проблемы • Необходимость ручной имплементации • Ошибки при переносе в код • Необходимость поддержки документации • Проблемы коммуникации и доработок 12
13. Проблемы • Необходимость ручной имплементации • Ошибки при переносе в код • Необходимость поддержки документации • Проблемы коммуникации и доработок • Непредсказуемая интеграция 13
14. Проблемы • Необходимость ручной имплементации • Ошибки при переносе в код • Необходимость поддержки документации • Проблемы коммуникации и доработок • Непредсказуемая интеграция Могут отнимать до 20% времени разработки 14
15. Кодогенерация • Устранение двойной работы • Соответствие контракта • Документация • Формализованное описание (спецификация)? 15
16. Как делали раньше? SOAP: Web Services Description Language (WSDL) • XML-based • Применялся в WCF 16
17. Open API https://swagger.io/ • Json Schema-Based • YAML или JSON • Большой выбор инструментов 17
18. Open API 18 ---
 swagger: '2.0'
 info:
 version: 1.0.0
 title: Sample CERT API
 description: Sample CERT API
 schemes:
 - http
 consumes:
 - application/json
 produces:
 - application/json
 paths:
 /api/incidents: ... definitions:
 IncidentListDto:
19. NSwag https://github.com/RicoSuter/ NSwag • Полный набор инструментов для swagger • На .NET • nuget & npm • Поддерживает C# и TypeScript 19
20. Процесс Contract-First 20 • Разработк а Специфик ации • Согласова ние Специфик ации • Выпуск Артефакта Специфик ации • Генерация Клиента и Сервера • Разработк а • Интеграци я
21. Демо 21
22. Альтернативы • Swagger Codegen - https://swagger.io/tools/swagger-codegen/ • Java on-premise or cloud-based 22
23. Альтернативы • Swagger Codegen - https://swagger.io/tools/swagger-codegen/ • Java on-premise or cloud-based • SwaggerHub - https://swagger.io/tools/swaggerhub/ • 15$/user/month Cloud less than 25 users or Enterprise over 25 users 23
24. Альтернативы • Swagger Codegen - https://swagger.io/tools/swagger-codegen/ • Java on-premise or cloud-based • SwaggerHub - https://swagger.io/tools/swaggerhub/ • 15$/user/month Cloud less than 25 users or Enterprise over 25 users • RAML Toolkit - https://raml.org/ 24
25. Альтернативы • Swagger Codegen - https://swagger.io/tools/swagger-codegen/ • Java on-premise or cloud-based • SwaggerHub - https://swagger.io/tools/swaggerhub/ • 15$/user/month Cloud less than 25 users or Enterprise over 25 users • RAML Toolkit - https://raml.org/ • API Blueprint - https://apiblueprint.org/ 25
26. Альтернативы Не JSON? 26
27. gRPC https://grpc.io • Кросс-платформенный • Производительный • HTTP/2 • Google protobuf-based • ASP.NET Core 3.0 – полностью поддерживает 27
28. Демо 28
29. Contract-First • Сократили время на имплементацию (генерируем клиент) • Сократили время на интеграцию(Гарантировали согласованность API) • Получили автодокументирование (Swagger UI) • Согласование через Code-review • Доступность подхода для разных протоколов и технологий 29
30. Недостатки подхода • Необходимость разработки спецификации • Привязка к набору инструментов • Особенности кодогенерации 30 oneOf:
 - $ref: '#/components/schemas/ Cat'
 - $ref: '#/components/schemas/ Dog'
 discriminator:
 propertyName: pet_type
31. Спасибо за внимание Примеры тут: https://github.com/Em1ss1oN/Contract-First-Meetup-Examples Вопросы? 31