Cleaning up Sitecore Controllers
0 likes44 views
This document introduces the Model Factory pattern for building view models in Sitecore controllers. It discusses using interfaces like IModelFactory and model builders to decouple model building from controllers. Model builders are single purpose and reusable. The pattern supports features like model validation, experience editor support, and nested model builders. Cons include added abstraction and potential complexity with nested models, but benefits include clean, testable controllers and reusable model building code.
Cleaning up Sitecore Controllers
- 1. Cleaning up Sitecore Controllers /ug/ch/
- 2. The Origin Story ● Introduction of NitroNet for Sitecore in our projects ● The ViewModel becomes the contract between frontend and backend ● We need a concept to embrace the building of the model
- 3. Quick Recap on NitroNet NitroNet for Sitecore brings at least two major changes to your development workflow ● No more razor views ○ All views are build with handlebars ● Controller renderings only ○ View renderings are not supported by NitroNet for Sitecore, although they can still be used in a hybrid scenario
- 4. Introducing the Model Factory
- 5. The Model Builder Interfaces
- 6. A Model Builder Interface in Detail
- 7. Example of a Model Builder
- 9. A cleanish Sitecore Controller
- 10. When Controllers have ambitions... All the controllers started to look the same, so we introduced three base classes for the most common patterns ● ControllerBase<TViewModel> ● ContextControllerBase<TDataModel,TViewModel> ● DatasourceControllerBase<TDataModel,TViewModel>
- 11. A clean Sitecore Controller
- 12. Stay DRY with Nested Model Builders There might be components that are reused as atoms in your code base like… ● Links ● Images ● Icons ● Many more...
- 13. Example of a Nested Model Builder
- 14. Add Model Validation to the mix
- 15. Add Model Validation to the mix
- 17. Example of a Model Validator
- 18. Summary of the Features ● IModelFactory as single point of entry ● Single purpose model builders ● Experience Editor support with EditingMocks ● Model Validation for inputs and outputs ● Simple Form support (attribute based)
- 19. Pros and Cons Pros ● Decouple model building ● Reusable model builders ● Small (single purpose) ● Integrated validation ● Works with GlassMapper ● Works with Synthesis ● Works with SXA Cons ● Another level of abstraction ● A potential complexity with many levels of nesting
- 20. Additional Resources ● Blog Posts ○ https://www.studert.com/cleaning-up-sitecore-controllers/ ○ https://www.studert.com/stay-dry-with-nested-model-builders/ ○ https://www.studert.com/what-happens-when-clean-sitecore-co ntrollers-have-ambitions/ ● Code will be available on GitHub ○ https://github.com/unic
- 21. About me ● Tobias Studer ○ Senior Tschipuperi @ Unic ○ Sitecore MVP since 2016 ● Find me here ○ Twitter: @studert ○ GitHub: https://github.com/studert ○ Blog: https://www.studert.com/
- 22. Thank you and check out... Women of Sitecore Building inclusion and diversity through community https://www.womenofsitecore.com/ /ug/ch/