I’m sometimes asked for a list of resources for writing Quarkus extensions. It’s a topic I’ve been meaning to write more about, but I haven’t yet, because as Emmanuel Bernard says, the todo list is infinite. Every time someone asks me, I re-assemble my list of favourite links. To save redoing that step each time, I’m writing the list down in a permanent place.
The Quarkus Team have two guides about writing extensions, a simple one, and a deeper one.
The deeper guide is now linked from the top menu bar of quarkus.io as “Create Extensions” to make it easier to find.
I sometimes think we could use a “my second extension” guide, but we haven’t written one yet. (Remember, the todo list is infinite.) However, there are some great community blogs/instructions that fill in that gap:
A walkthrough of writing an extension to log to Amazon cloud watch, which is an excellent general tutorial about writing an extension. This is the tutorial I followed when writing my first extension.
A thorough walk through of writing an extension, including a dev service. This is relatively recent, and it’s great.
How extensions can help with byte-code rewriting and other similar use cases:
My and Georgios Andrianakis’s talk about writing extensions with an introduction to writing extensions. The demo is using minecraft for logging. I’m hoping to keep the source code for that extension up to date as a bit of a reference for some extension scenarios.
Apart from the chicken-proliferation-jokes, this is my favourite bit of that talk, and it’s not in other resources, so I’ve included it here as an animation.
One of the most important resources is the list of all build items, the guide which lists all build items. The build items are a bit like the SPI for extensions. Almost everything that an extension might want to do can be handled by an existing build item or chain of build items. The trick is knowing which one! It’s a good idea to browse the list of build items to see if there’s one which meets your needs when you get started. I also re-review the list every now and then to make sure there’s nothing I’ve forgotten or missed.