Learn_4_Key_Principles_to_Craft_High-Quality_Code.pdf

Transcript

1. 4 Key Principles to Craft High-Quality Code Thiago Bomfim
2. Table of contents The Dependency Inversion Principle The Single Responsibility Principle Don’t Repeat Yourself Keep It Simple, Stupid 01 02 04 03 SRP DRY DIP KISS
3. SRP The Single Responsibility Principle 01
4. — Robert C. Martin “Gather together those things that change for the same reason, and separate those things that change for different reasons. ”
5. The Single Responsibility Principle How can you apply SRP? • Keep your classes and methods small. • Be careful with many dependencies, look at your imports.
6. The Single Responsibility Principle How can you identify if you are not applying the SRP? • If you need to change many files to include or change a behavior. • If you need to change the same file for more than one reason.
8. DRY Don’t Repeat Yourself 02
9. — Robert C. Martin - Clean Code “This is one of the most important rules in this book, and you should take it very seriously. ”
10. Don’t Repeat Yourself How can you apply DRY? • Avoid duplication. • Any time you see duplication in the code, it could probably become a subroutine or maybe another class outright.
11. Don’t Repeat Yourself How can you identify if you are not applying the DRY? • If you are doing Ctrl+C/Ctrl+V and nothing changes. • If you need to resolve the same problem twice in different places.
13. DIP The Dependency Inversion Principle 03
14. — Robert C. Martin “Depend in the direction of abstraction. High level modules should not depend upon low level details. ”
15. The Dependency Inversion Principle How can you apply DIP? • Use abstraction to separate the layers. • Don’t depend on the implementation, depend on the abstractions.
16. The Dependency Inversion Principle How can you identify if you are not applying the DIP? • If you need to change your core application, or your domain because some API you consume changes, you are probably violating the DRY. • Can you change the API you consume to another vendor? If you can’t, maybe you are violation the DRY.
19. KISS Keep It Simple, Stupid 04
20. — Leonardo da Vinci “Simplicity is the ultimate sophistication. ”
21. — Antoine de Saint-Exupery “Perfection is achieved not when there is nothing more to add, but when there is nothing left to take away. ”
22. Keep It Simple, Stupid How can you apply KISS? • Avoid complex architectures and design solutions to solve simple problems. • Simplicity should be a key design goal, and complicated complexity should be avoided.
23. Keep It Simple, Stupid How can you identify if you are not applying the KISS? • How easy is your solution to be understood and extended? • Are you doing premature optimization?
26. REFERENCES Keep Learning 05
27. Clean Code A Handbook of Agile Software Craftsmanship - Robert Cecil Martin.
28. The Pragmatic Programmer - Andy Hunt, Dave Thomas
29. Test-Driven Java Development - Viktor Farcic, Alex Garcia
30. CREDITS: This presentation template was created by Slidesgo, and includes icons by Flaticon, and infographics & images by Freepik Thanks! Do you have any questions? @ThiagoBfim