Александр Кугушев «Roslyn: очевидные неочевидности»

Разработка синтаксических анализаторов и рефакторингов с помощью Roslyn (Microsoft.CodeAnalysys) интересное и захватывющее занятие. Но путь изучения тернист, полон неожиданностей и неочевидностей. Давайте же рассмотрим основные сложности, которые вы можете встретить и составим шпаргалку, которая поможет вам в нелёгком деле синтаксического анализа.

Transcript

1. Roslyn Очевидные неочевидности Кугушев Александр
2. Изучение Rolsyn Ожидание Реальность https://github.com/AleksandrKugushev/how-to-roslyn 2
3. Цели • Рассмотреть топ неочевидных особенностей CodeAnalysis • Синхронизировать свое мышление со спецификой рассматриваемого API • Написать шпаргалку молодого анализаторописателя https://github.com/AleksandrKugushev/how-to-roslyn 3
4. Service Locator Fixer До После https://github.com/AleksandrKugushev/how-to-roslyn 4
5. Первый шаг • Получить объект Syntax Tree • Получить корень этого дерева • Пройтись от корня по всему дереву в поисках класса • Внести необходимые изменения в класс • Заменить класс в исходном синтаксическом дереве • Вернуть измененное дерево в виде строки https://github.com/AleksandrKugushev/how-to-roslyn 5
6. Шпаргалка №1: Syntax Visualizer https://github.com/AleksandrKugushev/how-to-roslyn 6
7. Неочевидность №1: Для всего есть фабрика Фабричный метод • CSharpSyntaxTree Статическая фабрика • SyntaxFactory https://github.com/AleksandrKugushev/how-to-roslyn 7
8. Неочевидность №2: DescendantNodes Node Node Node Node Node Node Node Node Node Node https://github.com/AleksandrKugushev/how-to-roslyn 8
9. Неочевидность №3: 100 простых анализаторов лучше одного сложного https://github.com/AleksandrKugushev/how-to-roslyn 9
10. Шпаргалка №2: ReplaceNode – первый друг https://github.com/AleksandrKugushev/how-to-roslyn 10
11. Шпаргалка №3: Как получить текст SyntaxNode ToString ToFullString https://github.com/AleksandrKugushev/how-to-roslyn 11
12. ServiceLocator.Resolve<Service>() InvocationExpression SimpleMemberAccessExpression: ServiceLocator.Resolve<Service> OperatorToken: . IdentifierName: ServiceLocator Identifier: ServiceLocator GenericName: Resolve<Service> Identifier: Resolve TypeArgumentList: Service ArgumentList: () https://github.com/AleksandrKugushev/how-to-roslyn 12
13. Неочевидность №4: CodeAnalysys очень дружественна к F12 https://github.com/AleksandrKugushev/how-to-roslyn 13
14. Шпаргалка №4: Помимо типа узла есть SyntaxKind • В Syntax Visualizer отображается именно SyntaxKind • Все SyntaxToken различаются именно значением SyntaxKind • Если чего то нет в SyntaxKind, этого нет в языке https://github.com/AleksandrKugushev/how-to-roslyn 14
15. Неочевидность №5: Где имя, там Identifier https://github.com/AleksandrKugushev/how-to-roslyn 15
16. Шпаргалка №5: Есть Equals, а есть IsEquivalentTo IsEquivalentTo(false) IsEquivalentTo(true) https://github.com/AleksandrKugushev/how-to-roslyn 16
17. Как будем убивать ServiceLocator? • Создадим конструктор если нет подходящего • Добавим соотвествующие поля • Добавим в конструктор необходимые параметры • Проинициализируем поля в конструкторе • Заменим вызовы ServiceLocator обращениями к полям https://github.com/AleksandrKugushev/how-to-roslyn 17
18. Шпаргалка №6: SyntaxFactory – король этого мира https://github.com/AleksandrKugushev/how-to-roslyn 18
19. Шпаргалка №7: With….\Update…\Add… With…\Update… • Возвращает новый экземпляр с полностью замененной частью • Существует версия для любой части синтаксиса кнкретной SyntaxNode • Включает в себя токены Add… • Возвращает новый экземпляр с дополненой частью • Существует если только если в этом есть смысл https://github.com/AleksandrKugushev/how-to-roslyn 19
20. Шпаргалка №8: NormalizeWhitespace() До После https://github.com/AleksandrKugushev/how-to-roslyn 20
21. Шпаргалка №9: InsertNodesBefore и InsertNodesAfter https://github.com/AleksandrKugushev/how-to-roslyn 21
22. Неочевидность №6: Immutability, immutability everywhere https://github.com/AleksandrKugushev/how-to-roslyn 22
23. Неочевидность №7: Если меняешь узел дерева, меняешь все дерево Node Node Node Node Node Node* Node* Node* Node* https://github.com/AleksandrKugushev/how-to-roslyn 23
24. Шпаргалка №10: ReplaceNodes хорошо когда друзей много https://github.com/AleksandrKugushev/how-to-roslyn 24
25. Что мы узнали 1. Не забываем использовать SyntaxVisualizer что бы понять структуру кода 2. Узлы с одинаковым типом могут отличаться по SyntaxKind 3. Все объекты синтаксической модели создаются средствами SyntaxFactory 4. Все синтаксические узлы следуют конфенции именования Add/Update/With 5. Есть много полезных функций: ReplaceNode, IsEquivalentTo, NormalizeWhitespace и проч. https://github.com/AleksandrKugushev/how-to-roslyn 25
26. Вопросы?
27. Материалы • https://joshvarty.wordpress.com/learn-roslyn-now/ • http://sergeyteplyakov.blogspot.ru/2015/10/simple-roslyn-based- analyzer.html • https://github.com/dotnet/roslyn https://github.com/AleksandrKugushev/how-to-roslyn 27