Игорь Мамай «Анализаторы кода и их польза для прикладной разработки»

Мы ежедневно используем анализаторы кода — например, запускаем компилятор Roslyn, который выдаёт ошибки и предупреждения, или настраиваем правила для линтеров, которые фиксируют командные практики и договоренности. Однако есть много других способов извлечь пользу из анализаторов кода в повседневной работе. Игорь сравнит анализаторы с программным API (Roslyn и ReSharper) и расскажет, для решения каких задач они используются в его команде (60 человек в 3 городах).

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

Transcript

1. Анализаторы кода и их польза Анализаторы кода и их польза в сельском хозяйстве в сельском хозяйстве Мамай Игорь mamay.igor@gmail.com https://github.com/BigBabay 1
2. О чем поговорим О чем поговорим Зачем нам анализаторы Примеры задач из жизни нашей команды Советы по выбору анализатора 2
3. Останется за кадром Останется за кадром Общая теория анализаторов Код использования анализаторов 3
4. Зачем нам анализаторы? Зачем нам анализаторы? Большая команда (20 бекэнд-разработчиков) Большая кодовая база (1 000 000 строк кода) Shared Code Ownership Единый стиль кодирования 4
5. Анализаторов много Анализаторов много Поиск багов Fxcop Clocksharp PRQA QA·C# PVS-Studio CAT.NET Spec# ... Оценка качества кода NDepend Nitriq RSM Squared C# Metrics SourceMonitor Code Metrics Vil Общий стиль StyleCop Agent Smith Поиск дублирующегося кода Simian CloneDR Clone Detective Atomiq 5
6. Анализаторы с Анализаторы с програмным API програмным API 6
7. Классы задач Классы задач Анализ Миграции Рефакторинг Собственные инструменты 7
8. Граф вызовов Граф вызовов Class1 Class2 Анализ Анализ 8
9. Граф вызовов RPC Граф вызовов RPC Service1 Service2 HTTP 9
10. Граф вызовов с очередью Граф вызовов с очередью Service1 Service2 MessageBus Service3 10
11. Граф вызовов на сторонние Граф вызовов на сторонние сервисы сервисы Service2 Service1 Сторонний сервис 11
13. Миграция или обновление Миграция или обновление технологии технологии 13
14. 2.x to 3.x 2.x to 3.x 14
15. 2.x to 3.x 2.x to 3.x Найти методы, размеченные ExpectedException Найти тестируемый метод Завернуть в обертку, подставив данные из ExpectedException 15
16. Рефакторинг Рефакторинг Программисты любят рефакторить Никто не любит делать одно и тоже больше 1 раза Иногда нужно изменить концепт, который используется по всему коду 16
17. Способы решения Способы решения Посмотреть в IDE Сделать руками (посадить стажера) Нажать Ctrl+H и попробовать заменить Написать RegEx Использовать ReplacePattern Написать утилиту, которая все 17
18. 1 2 3 4 5 6 7 8 18
19. Написание собственных Написание собственных инструментов инструментов 19
20. Возможности Возможности Интегрируются в повседневную работу Автоматизируют ваши стилистические договоренности Встраиваются в CI Помогают при переходе к новым парадигмам 20
21. Переход к асинхронному Переход к асинхронному взаимодействию Async/Await взаимодействию Async/Await Бережем ThreadPool Бережем ThreadPool 21
22. Плагин AsyncConverter – помощник Плагин AsyncConverter – помощник по написанию асинхронного кода по написанию асинхронного кода 22
23. AsyncConverter AsyncConverter Потенциальная ошибка Потенциальная ошибка 23
24. AsyncConverter AsyncConverter Суффикс Async Суффикс Async 24
25. AsyncConverter AsyncConverter Обязательный ConfigureAwait Обязательный ConfigureAwait 25
26. AsyncConverter AsyncConverter Использование неправильного метода Использование неправильного метода 26
27. AsyncConverter AsyncConverter Возможность убрать async/await Возможность убрать async/await 27
28. AsyncConverter AsyncConverter Конвертация из синхронных в асинхронные Конвертация из синхронных в асинхронные 28
29. AsyncConverter AsyncConverter Заменить возвращаемый тип Добавить суффикс Async Добавить пространство имен Посмотреть все вызовы, если есть асинхронные аналоги, то заменить Заменить вызовы .Result и .Wait() на await Во всех точках вызовов либо вызвать await, либо .Result, либо .Wait() Конвертация из синхронных в асинхронные Конвертация из синхронных в асинхронные 29
30. AsyncConverter AsyncConverter 30
31. Автоматизируй это! Автоматизируй это! Если повторяете что-то – может есть алгоритм Если есть алгоритм – можно автоматизировать Если автоматизируете – идите от простого Получайте удовольствие от автоматизации 31
32. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 32
33. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 33
34. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 34
35. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 35
36. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 36
37. Roslyn ReSharper Написание внешней утилиты ✔ ❌ Поддержка IDE VisualStudio Rider(2018.1 EAP) VisualStudio+ReSharper Rider Удобство написания Шаблон от MS Syntax Visualizer Тестовый фреймворк PSI Viewer Способ распространения Локальная установка Референс в проект Локальная установка Настройки TeamSettings Интеграция с CI Встраивается в билд ReSharper CLT Поддеживаемые технологии C#, VB.NET JetBrains products(dotPeek, dotMemory, dotTrace, dotCover) Языки C#, VB.NET, C++, HTML, ASP.NET, JavaScript, TypeScript, Angular 2 HTML, CSS, JSON, XML, XAML, MSBuild, Protobuf 37
38. Мамай Игорь mamay.igor@gmail.com https://github.com/BigBabay https://github.com/BigBabay/AsyncConverter 38