Magento 2 Best Practice Workfow // David Lambauer // Meet Magento 2017 // Leipzig
âąTransferir como PPTX, PDFâą
5 gostaramâą1,766 visualizaçÔes
This Slidedeck was used for my talk at MMDE17 in Leipzig. The Talk is about a best practice workflow in Magento and targets developer who are used to write a lot of modules in their daily work.
Recomendados
Mais conteĂșdo relacionado
Mais procurados
Mais procurados (20)
Semelhante a Magento 2 Best Practice Workfow // David Lambauer // Meet Magento 2017 // Leipzig
Semelhante a Magento 2 Best Practice Workfow // David Lambauer // Meet Magento 2017 // Leipzig (20)
Mais de AOE
Mais de AOE (20)
Ăltimo
Ăltimo (20)
Magento 2 Best Practice Workfow // David Lambauer // Meet Magento 2017 // Leipzig
- 1. 1 Magento 2 Best Practice Workflow
- 2. Twitter: @DavidLambauer2 David Lambauer // Software Developer I â„ïž Open Source Software Quality Quotes, Emojiâs and Memes
- 3. Twitter: @DavidLambauer3 Twitter and GitHub @DavidLambauer github.com/DavidLambauer
- 4. Twitter: @DavidLambauer4 Abbildung: https://www.aoe.com/de/home.html
- 5. 5 Motivation
- 6. Twitter: @DavidLambauer6 That moment when you feel like a total noob.
- 7. 7 No matter how good you are at something, there's always about a million people better than you. - Homer Simpson
- 9. Twitter: @DavidLambauer9 âą Documentation âą Automation / Generation âą Code Segmentation (Business Logic, Framework, Application) âą Tests (Unit // Api // Integration // Static // âŠ) âą Reusability âą Maintenance âą â„ïž the Details! ⹠⊠How do I write awesome Code (in Magento) ?
- 10. Twitter: @DavidLambauer10 Same procedure, every Module Abstract Module Components App Code Business Logic Framework Meta Entry Points like Plugins. Code to make things work like the registration.php. Code that works only in the Context of Magento. Non coupled Components which implement a specific business logic. Code that can be used in different projects and has injected dependencies. Components that are totally independent: e.g. Fileparser / HTTP Clients / DB Abstraction. Documentation / Specification / Guidelines. Automated Tests / Dependencies.
- 11. 11 The Story
- 12. Twitter: @DavidLambauer12 As a Sir, I donât want minors buy Alcohol.
- 13. Twitter: @DavidLambauer13 General Workflow Works for most custom modules. ReviewImplementTest SpecifyUnderstand Research Core Not as time consuming as you might think. Defining a Specification is an early documentation of your work. The Spec can be used to share work between the team more easy.
- 14. Twitter: @DavidLambauer14 Research Core DISCOVER THE CORE TO REUSE MAGENTO COMPONENTS Due to the research, youâll learn the âMagento Wayâ of solving problems and speed up further developments. Discover Entry Points. Check if there are any Components you can reuse, like a ValidationInterface where you are able to add another Validation. The DevDocs do also have great examples! Check relevant Modules âą module-sales âą module-checkout âą module-customer Check APIâs and Events first âą Checkout ï AgreementsValidatorInterface::isValid() âą Sales ï OrderManagementInterface::place() âą Customer ï AccountManagementInterface::validate() Evaluate & Debug Try to find where your search results are used. A quick debugging session could help a lot. Add breakpoints to each result to check when they are called. 01 02 03
- 15. Twitter: @DavidLambauer15 Add the Specification âą Use a Format that is easy to read, easy to use and fast to write. âą Markdown â„ïž // reStrcuturedText // LaTeX âą Use a Tool to share your Work in PDF or HTML. âą Add UML Diagrams, so people have the chance to dive into your specs quickly. âą Write Specifications for Humans. Add general information! âą Donât shorten, make sentences.
- 16. Twitter: @DavidLambauer16 Avoid hand-hacking; write programs to write programs when you can. Rule of Generation - Eric Raymondâs
- 19. Twitter: @DavidLambauer19 Adding a Specification - Bird Eye View âą Add a StoreConfig to â Section / Group / Field â Define Label / Id / Note / Type / ... âą Add a beforePlaceOrder Plugin. â Define Classname / Dependencies / Methods / Parameter / Usage âą Add a Validator to check the age. â Define Classname / Interface / Dependencies / Methods / Parameters / Usage
- 20. Twitter: @DavidLambauer20 [Without unit tests] You're not refactoring, you're just changing shit. - Hamlet D'Arcy
- 21. Twitter: @DavidLambauer21 Testing Overview Unit & Static Testing Unit testing is the testing of an individual unit or group of related units. Integration Testing Integration testing is testing in which a group of components are combined to produce output. Functional Testing Functional testing is the testing to ensure that the specified functionality required in the system requirements works. System / Performance / Frontend / ⊠Depending on the complexity and the business impact of your module, add as many tests as you need. Abbildung: Eigendarstellung
- 22. Twitter: @DavidLambauer22 Writing Unit Tests âą Use File- and Live Templates (PHPStorm). âą Assertion should be as simple as possible. âą Test possible Exceptions with Annotation (i.e: @expectedException). âą Unit Test can be a 3-Liner. âą Use Multi-Cursor whenever it is possible.
- 23. Twitter: @DavidLambauer23 Abbildung: PHPStorm EAP 2017.1
- 24. Twitter: @DavidLambauer24 Abbildung: PHPStorm EAP 2017.1
- 25. Twitter: @DavidLambauer25 Implement âą After the Specification, generate standard Magento Code. âą Implement the business Logic. âą Thatâs it! We already did the main work by adding the Specs.
- 28. Twitter: @DavidLambauer28 In case you missed it, what did we actually do? âą Learned from the Core. âą Added some Markdown to have a Specification. âą Generated a good looking Document with a single Command. âą Generated UML Diagrams by adding some simple Code. âą Generated Unit Tests with File- and Live Templates. âą Generated Magento Standard Code with one of the great Code Generator.
- 29. Twitter: @DavidLambauer29 Avoid hand-hacking; write programs to write programs when you can. Rule of Generation - Eric Raymondâs
- 30. Twitter: @DavidLambauer30 Started on GitHub! AOEpeople/Magento-2-Module-Skeleton Get situated under a minute.
- 32. Twitter: @DavidLambauer32 One more thingâŠ
- 33. Twitter: @DavidLambauer33 As a Troll, I do change my requirements! Minors should not be able to register either!
- 34. Twitter: @DavidLambauer34 Add one more entry point and weâre good. Restart the Workflow, donât forget to add the new specs.
- 35. Twitter: @DavidLambauer35 Thatâs it! Thank you so much for your attention, I would love to answer some questions.
Notas do Editor
- Hallo zusammen, Freut mich das so viele gekommen sind. Heute geht es um Magento 2 Best Practice Workflow und zwar in der Modulentwicklung. Ich möchte zum einen zeigen, welche Vorgehensweise sich bewÀhrt hat und wie man diese Vorgehensweise wirtschaftlich effizient und technisch qualitativ hochwertig einsetzten kann.
- Bevor wir anfangen, ein paar Worte zu mir: Ich bin David Lambauer, Software Entwickler und habe ein Fabel fĂŒr Open Source, Software QualitĂ€t, Zitate, Emojis und Memes. HĂ€tte man aber bestimmt auch gemerkt im Laufe des Vortrags :D
- Ich bin zu finden auf Github und Twitter...
- Und ich arbeite bei AOE in Wiesbaden!
- Jedem ist es schon einmal passiert, dass man in ein fachliches GesprÀch gekommen ist und der GesprÀchspartner von Dingen erzÀhlt von denen man noch nie etwas gehört hat. Nach diesen Situationen gehe ich immer total geflasht raus und frage mich wie es sein kann das ich absolut noch nie etwas von dem Inhalt des GesprÀchs vorher gehört habe.
- In diesem Momenten fĂŒhlt man sich immer wie ein totaler noob :D Das ganze ist aber nur semi schlimm und mittlerweile mag ich es total in solche Situationen zu kommen, denn nur so wird man wirklich besser.
- Es gibt immer jemanden der besser auf einem bestimmten Gebiet ist als man selbst. Das sollte man definitiv fĂŒr sich nutzen und so viel Wissen einsammeln wie es nur geht. Deswegen wird dieser Vortrag auch keine expliziete Schritt fĂŒr Schritt Anleitung sondern eher eine theoretische Story mit vielen Buzzwords ï
- Nachdem ich wiederholt auf die fachlich vermeintlich besseren Menschen traf habe ich beschlossen zu analysieren was denn eigentlich so cool ist und warum sie so gut sind wie sie sind.
- Als Grundlage dafĂŒr habe ich mir verschiedene Quellen gesucht. Zum einen habe ich klassische Literatur gelesen wie etwa das Gang of Four Buch oder Clean Code. Zum anderen habe ich meine Kollegen beobachtet, GitHub Module analysiert und versucht diese Quellen zusammen zu bringen und auf Magento 2 zu mĂŒnzen. Es gibt eine Hand von Buzzwords die mir besonders im Magento 2 Umfeld wichtig waren. Diese habe ich mal wie folgt definiert: Spiegelstriche vorlesen.... Nachdem ich diese sehr Allgemeine Analyse gemacht habe, habe ich eine weitere Analyse zu Magento 2 Modulen erstellt. Das Ergebnis davon ist etwa das folgende:
- Ein M2 Modul besteht prinzipiell aus vier Bestandteilen. Application Code ï Registration.php // di.xml // module.xml Business Logic ï Komponenten die mit Magento interagieren aber kein direkter Bestandteil des Systems sein mĂŒssen. Framework oder Library ï Guzzle // CsvParser // FileWriter Meta ï Tests // Composer Dependencies // Dokumentation // Spezifikation Diese vier Bestandteile sollten wir im Hinterkopf behalten.
- Um unsere Analysen nun auch nutzen zu können, habe ich mir eine Super simple Story ausgedacht, die aber recht anschaulich ein Beispiel zeigen sollte
- Ich möchte nicht, das Jugendliche in einem definierten Alter Alkohol in meinem Shop kaufen