How to create your own Quarkus extension

Quarkus Insights: Holly Cummins discusses the basics, tips and tricks of creating your own Quarkus extensions.

https://www.youtube.com/watch?v=90FEj1zqjWQ

Transcript

1. decide to write extension write extension share extension
2. decide to write extension write extension share extension
3. why? (in general)
4. reminder: what makes quarkus special
5. @holly_cummins Java dynamism
6. @holly_cummins Java dynamism build time
7. @holly_cummins Java dynamism build time runtime
8. @holly_cummins Java dynamism build time runtime
9. @holly_cummins Java dynamism packaging (maven, gradle…) build time runtime
10. @holly_cummins Java dynamism build time runtime
11. @holly_cummins Java dynamism build time runtime
12. @holly_cummins Java dynamism </> build time runtime load and parse • config files • properties • yaml • xml • etc.
13. @holly_cummins Java dynamism </> build time runtime
14. @holly_cummins Java dynamism @ @ </> build time runtime • classpath scanning and annotation discovery • attempt to load class to enable/disable features
15. @holly_cummins Java dynamism @ @ </> build time runtime
16. @holly_cummins Java dynamism @ @ </> build time runtime build a metamodel of the world
17. @holly_cummins Java dynamism @ @ </> build time runtime
18. @holly_cummins Java dynamism @ @ </> build time runtime start • thread pools • I/O • etc.
19. @holly_cummins Java dynamism @ @ </> build time runtime ready to do work!
20. @holly_cummins what if we start the application more than once? @ @ </>
21. @holly_cummins what if we start the application more than once? @ @ </> @ @ </>
22. @holly_cummins what if we start the application more than once? @ @ </> @ @ </> @ @ </>
23. @holly_cummins what if we start the application more than once? @ @ </> @ @ </> @ @ </> @ @ </>
24. @holly_cummins what if we start the application more than once? @ @ </> @ @ </> @ @ </> @ @ </>
25. @holly_cummins what if we start the application more than once? @ @ </> @ @ </> @ @ </> @ @ </> so much work gets redone every time
26. @holly_cummins how do we fix all this?
27. @holly_cummins @ @ </> build time runtime what if we initialize at build time?
28. @holly_cummins @ @ </> build time runtime what if we initialize at build time?
29. @holly_cummins @ @ </> build time runtime start • thread pools • I/O • etc. what if we initialize at build time?
30. @holly_cummins @ @ </> build time runtime ready to do work! start • thread pools • I/O • etc. what if we initialize at build time?
31. @holly_cummins @ @ </> repeated starts are now efficient
32. @holly_cummins @ @ </> repeated starts are now efficient
33. @holly_cummins @ @ </> repeated starts are now efficient
34. @holly_cummins @ @ </> repeated starts are now efficient
35. @holly_cummins @ @ </> repeated starts are now efficient
36. @holly_cummins @ @ </> repeated starts are now efficient
37. @holly_cummins @ @ </> repeated starts are now efficient less wasted work
38. @holly_cummins
39. @holly_cummins doing more up-front
40. @holly_cummins doing more up-front - speeds up start
41. @holly_cummins doing more up-front - speeds up start - shrinks memory footprint
42. @holly_cummins doing more up-front - speeds up start - shrinks memory footprint - improves throughput (!)
43. @holly_cummins but what about other libraries?
44. @holly_cummins but what about other libraries? @ @ </>
45. @holly_cummins but what about other libraries? @ @ </> @ @ </>
46. @holly_cummins but what about other libraries? @ @ </> @ @ </> @ @ </>
47. @holly_cummins but what about other libraries? @ @ </> @ @ </> @ @ </>
48. @holly_cummins the quarkus build process is extensible what extensions do is participate in the build process
49. and another thing
50. and another thing
51. and another thing developer experience
52. and another thing developer experience developer joy
54. dynamic-but-static
55. dynamic-but-static “wouldn’t it be nice if … … but it’s too expensive to do it at runtime.”
56. why? (for you)
57. why write a new extension? • the community hasn’t written one yet • it’s your library • support a use case particular to your environment
58. how?
59. decide to write extension write extension share extension
60. extension concept deployment + runtime
61. extension concept build phase + startup phase
62. Quarkus
63. Quarkus deployment
64. Quarkus deployment runtime
65. Quarkus deployment runtime
66. Quarkus deployment runtime bytecode
67. Quarkus deployment runtime bytecode extension
68. Quarkus deployment runtime bytecode extension deployment
69. Quarkus deployment runtime bytecode extension deployment runtime
70. Quarkus deployment runtime bytecode extension deployment runtime
71. Quarkus deployment runtime bytecode extension deployment runtime
72. Quarkus deployment runtime bytecode extension deployment runtime bytecode
73. extension concept build steps + build items
75. build steps
77. build items
79. framework automatically determines correct execution order and injects parameters
80. build items are communication mechanism between build steps framework automatically determines correct execution order and injects parameters
81. initial state build items intermediate state build items terminal state build items
82. initial state build items JarResultBuildStep intermediate state build items terminal state build items
83. initial state build items JarResultBuildStep GeneratedResourceBuildItem intermediate state build items terminal state build items
84. initial state build items JarResultBuildStep GeneratedResourceBuildItem ConfigClassBuildItem intermediate state build items terminal state build items
85. initial state build items JarResultBuildStep GeneratedResourceBuildItem ConfigClassBuildItem UnremovableBeanBuildItem intermediate state build items terminal state build items
86. initial state build items JarResultBuildStep GeneratedResourceBuildItem ConfigClassBuildItem UnremovableBeanBuildItem BuildSystemTargetBuildItem intermediate state build items terminal state build items
87. initial state build items JarResultBuildStep GeneratedResourceBuildItem ConfigClassBuildItem UnremovableBeanBuildItem BuildSystemTargetBuildItem LaunchModeBuildItem intermediate state build items terminal state build items
88. initial state build items JarResultBuildStep GeneratedResourceBuildItem ConfigClassBuildItem UnremovableBeanBuildItem BuildSystemTargetBuildItem LaunchModeBuildItem most extensions do stuff here intermediate state build items terminal state build items
89. what kind of things can build items do? Create a servlet Create a route Pull an external bean into the closed world Turn one annotation into another Add a log handler Read an extra application archive Flag a capability as present Interact with Kubernetes Communicate between extensions! …
90. existing build items cover almost all needs like a library for extension writers but you can write your own too
92. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template maturity model for quarkus extensions
93. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template maturity model for quarkus extensions
94. @holly_cummins the Quarkus way enables native compilation native (graalvm) @ @ </> jvm build time
95. @holly_cummins the Quarkus way enables native compilation native (graalvm) @ @ </> jvm build time
96. extension concept GraalVM • Contribute GraalVM configuration ◦ Reflection registration ◦ Dynamic proxy registration ◦ Resource files ◦ Message bundles ◦ Etc. • Provide substitutions ◦ Pieces of code that are used in place of regular library code when in native mode
97. Substitutions @TargetClass(org.infinispan.client.hotrod.impl.RemoteCacheImpl.class) public final class SubstituteRemoteCacheImpl { @Delete private ObjectName mbeanObjectName; @Substitute private void registerMBean(ObjectName jmxParent) { } @Substitute private void unregisterMBean() { } @Delete public void init(OperationsFactory operationsFactory, Configuration configuration, ObjectName jmxParent) { } }
98. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template maturity model for quarkus extensions
99. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template examples: configuration
100. Quarkus
101. Quarkus deployment
102. Quarkus deployment runtime
103. Quarkus deployment runtime extension
104. Quarkus deployment runtime extension deployment
105. Quarkus deployment runtime extension deployment runtime
106. Quarkus deployment runtime extension deployment runtime config config
107. Quarkus deployment runtime extension deployment runtime config config config config
108. Quarkus deployment runtime extension deployment runtime config config config config
109. demo https://github.com/holly-cummins/quarkus-minecraft-observability-extension
110. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template examples: dev service
111. demo https://github.com/holly-cummins/quarkus-minecraft-observability-extension
112. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template examples: dev ui
113. Uses JBoss log consumer which pipes output from dev container to a tab in the dev service
114. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template examples: joyful programming model
115. extension concept index
116. extension concept index
117. extension concept index “offline-reflection”
118. extension concept index jandex “offline-reflection”
119. extension concept index jandex “offline-reflection” eliminates need for runtime classpath scanning
120. open world closed world
121. open world closed world hard to build-time optimise
122. open world closed world hard to build-time optimise easy to build-time optimise
123. open world closed world hard to build-time optimise easy to build-time optimise runtime class surprise!
124. open world closed world hard to build-time optimise easy to build-time optimise runtime class surprise!
125. open world closed world hard to build-time optimise easy to build-time optimise no worries runtime class surprise!
126. open world closed world hard to build-time optimise easy to build-time optimise no worries runtime class surprise!
127. open world closed world hard to build-time optimise easy to build-time optimise uh oh, this is outside our closed world no worries runtime class surprise!
128. AdditionalBeanBuildItem
129. AdditionalBeanBuildItem
130. extension concept bytecode recording easier than writing ASM
131. extension concept gizmo when you don’t want to ASM… … but bytecode recording isn’t enough
132. <persistence xmlns="https://jakarta.ee/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" version="3.0" xsi:schemalocation="https://jakarta.ee/xml/ns/ persistence https://jakarta.ee/xml/ns/persistence/ persistence_3_0.xsd"> <!-- Define persistence unit --> <persistence-unit name="my-persistence-unit"> </persistence-unit> </persistence> persistence.xml hibernate extension
133. <persistence xmlns="https://jakarta.ee/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" version="3.0" xsi:schemalocation="https://jakarta.ee/xml/ns/ persistence https://jakarta.ee/xml/ns/persistence/ persistence_3_0.xsd"> <!-- Define persistence unit --> <persistence-unit name="my-persistence-unit"> </persistence-unit> </persistence> persistence.xml hibernate extension the hibernate extension makes this go away
134. works in dev mode works in JVM works in native mode con fi guration provides a dev service supersonic performance joyful programming model dev UI codestart template examples: supersonic subatomic performance
135. deployment
136. understand app deployment
137. understand app eliminate reflection deployment
138. understand app eliminate reflection convert annotations to bytecode deployment
139. understand app eliminate reflection convert annotations to bytecode optimize deployment
140. @holly_cummins Hibernate speed example: JTA auto-wiring
141. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”);
142. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”);
143. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”);
144. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”);
145. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); …
146. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); Class.forName(“NicheJTAImplementation”); …
147. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); Class.forName(“NicheJTAImplementation”); Class.forName(“VeryNicheJTAImplementation”); …
148. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); Class.forName(“NicheJTAImplementation”); Class.forName(“VeryNicheJTAImplementation”); …
149. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); Class.forName(“NicheJTAImplementation”); Class.forName(“VeryNicheJTAImplementation”); … ~129 auto-wiring attempts
150. @holly_cummins Hibernate speed example: JTA auto-wiring Class.forName(“LikelyJTAImplementation”); Class.forName(“APossibleJTAImplementation”); Class.forName(“AnotherJTAImplementation”); Class.forName(“NicheJTAImplementation”); Class.forName(“VeryNicheJTAImplementation”); … ~129 auto-wiring attempts every single start.
151. @holly_cummins it’s not just JTA this happens for lots of internal service bindings
152. @holly_cummins JVM footprint example: Hibernate
153. @holly_cummins JVM spends time loading classes for specific databases JVM class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database footprint example: Hibernate
154. @holly_cummins JVM spends time loading classes for specific databases JVM class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database class for unused database turns out they’re never used footprint example: Hibernate
155. @holly_cummins JVM spends time loading classes for specific databases JVM turns out they’re never used JIT spends time unloading classes footprint example: Hibernate
156. @holly_cummins Hibernate example: ~500 classes which are only useful if you're running an Oracle database loaded and then unloaded
157. @holly_cummins Hibernate example: ~500 classes which are only useful if you're running an Oracle database loaded and then unloaded every single start.
158. @holly_cummins the true cost of loaded classes isn’t just memory + start time
159. @holly_cummins the true cost of loaded classes isn’t just memory + start time method dispatching:
160. @holly_cummins interface the true cost of loaded classes isn’t just memory + start time method dispatching:
161. @holly_cummins unused implementation the one we want interface unused implementation unused implementation the true cost of loaded classes isn’t just memory + start time method dispatching:
162. @holly_cummins unused implementation the one we want interface unused implementation unused implementation the true cost of loaded classes isn’t just memory + start time method dispatching:
163. @holly_cummins unused implementation the one we want interface megamorphic call slow dispatching unused implementation unused implementation the true cost of loaded classes isn’t just memory + start time method dispatching:
164. @holly_cummins the true cost of loaded classes isn’t just memory + start time the one we want interface
165. @holly_cummins the true cost of loaded classes isn’t just memory + start time the one we want monomorphic call fast dispatching interface
166. decide to write extension write extension share extension