Why you're missing out if you're not making Quarkus extensions

Holly Cummins @holly_cummins

Georgios Andrianakis @geoand86
Red Hat

Why you're missing out if you're not
making Quarkus extensions

View Slide

@holly_cummins @geoand86
#Quarkus #RedHat
Hi
Georgios!

View Slide

#Quarkus #RedHat
extenwhats?

View Slide

#Quarkus #RedHat
Quarkus core

View Slide

#Quarkus #RedHat
Quarkus core
JAX-RS

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
Elasticsearch

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
Elasticsearch
Apache Camel

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Apache Camel

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Apache Camel
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Netty
extension
Apache Camel
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Netty
extension
JAX-RS
extension
Apache Camel
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Apache Camel
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
Apache Camel
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
Apache Camel
Camel
extension
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
JWT
extension
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
Apache Camel
Camel
extension
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
gRPC
extension
JWT
extension
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
Apache Camel
Camel
extension
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
gRPC
extension
JWT
extension
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
lots more
extensions
Apache Camel
Camel
extension
…

View Slide

#Quarkus #RedHat
Quarkus core
Hibernate
JAX-RS
Netty
JWT
gRPC
Elasticsearch
gRPC
extension
JWT
extension
Netty
extension
JAX-RS
extension
Elasticsearch
extension
Hibernate
extension
lots more
extensions
Apache Camel
Camel
extension
…
quarkiverse

View Slide

#Quarkus #RedHat
why?

View Slide

#Quarkus #RedHat
reminder:

what makes quarkus special

View Slide

traditional way vs quarkus way
@
 
@
>
build time
runtime

View Slide

@
 
@
>
@
 
@
>
build time
runtime
build time

View Slide

@
 
@
>
@
 
@
>
build time
runtime
runtime
build time

View Slide

the quarkus way enables native compilation
native
@
 
@
>
JVM
build time

View Slide

9
but … for a normal framework …

View Slide

9
they load way too many classes

View Slide

9
they are way too dynamic

View Slide

9
(which means they use way too much reflection)

View Slide

9
(which means they use way too much reflection)
they perform a lot of initialization at runtime

View Slide

@
 
@
>
Packaging
 
(maven, gradle…)
build time
runtime
how does a framework start?

View Slide

@
 
@
>
Load and parse config files,
properties, yaml, xml, etc.
build time
runtime

View Slide

@
 
@
>
Classpath scanning and
annotation discovery

Attempt to load class to

enable/disable features
build time
runtime

View Slide

@
 
@
>
Build its metamodel
of the world.
build time
runtime

View Slide

@
 
@
>
Start thread pools,
IO, etc.
build time
runtime

View Slide

Do the work once, not at each start

Get rid of all bootstrap classes

Less time to start, less memory needed

Less or no reflection nor dynamic proxies
what if we initialize at build time?

View Slide

@
 
@
>
build time




View Slide

@
 
@
>
runtime
build time




View Slide

and another thing

View Slide

and another thing
developer experience

View Slide

and another thing
developer experience
developer joy

View Slide

“while we’re manipulating the
bytecode to support native, why
don’t we make coding … easier?”
[warning: may not actually be Quarkus origin story]

View Slide

automagic dev instances (“dev services”)

unified config

opinionated shortcuts
joy comes in several forms:

View Slide

#Quarkus #RedHat
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">

persistence.xml
hibernate extension

View Slide

#Quarkus #RedHat
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">

persistence.xml
hibernate extension
the hibernate extension makes this go away

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
dynamic-but-static

View Slide

#Quarkus #RedHat
dynamic-but-static
“wouldn’t it be nice if …
 
… but it’s too expensive to do it at runtime.”

View Slide

#Quarkus #RedHat
public class CassandraConnector {
private Cluster cluster;
private Session session;
public void connect(String node, Integer port) {
Builder b = Cluster.builder().addContactPoint(node);
if (port != null) {
b.withPort(port);
}
cluster = b.build();
session = cluster.connect();
}
public Session getSession() {
return this.session;
}
public void close() {
session.close();
cluster.close();
}
}

View Slide

#Quarkus #RedHat
public class CassandraConnector {
private Cluster cluster;
private Session session;
public void connect(String node, Integer port) {
Builder b = Cluster.builder().addContactPoint(node);
if (port != null) {
b.withPort(port);
}
cluster = b.build();
session = cluster.connect();
}
public Session getSession() {
return this.session;
}
public void close() {
session.close();
cluster.close();
}
}
@Inject
private QuarkusCqlSession session;

View Slide

#Quarkus #RedHat
“opinionated choices
and educated guesses.”

View Slide

#Quarkus #RedHat
recap: why extensions?
• good behaviour in native mode

• fast behaviour in normal mode (pre-do all the things)

• good dev experience

View Slide

@geoand86 @holly_cummins
#Quarkus #RedHat

View Slide

#Quarkus #RedHat
why write a new extension?
• the community hasn’t written one yet

• it’s your library

• support a use case particular to your environment

View Slide

#Quarkus #RedHat
“hook a build step?”

View Slide

#Quarkus #RedHat
how?

View Slide

#Quarkus #RedHat
extension concept
deployment

+

runtime

View Slide

#Quarkus #RedHat
extension concept
build phase

+

startup phase

View Slide

#Quarkus #RedHat
Quarkus

View Slide

#Quarkus #RedHat
Quarkus
deployment

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
bytecode

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
bytecode
extension

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
bytecode
extension

deployment

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
bytecode
extension

deployment runtime

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
bytecode
extension

deployment runtime
bytecode

View Slide

#Quarkus #RedHat
deployment

View Slide

#Quarkus #RedHat
understand app
deployment

View Slide

#Quarkus #RedHat
understand app
convert annotations to bytecode
deployment

View Slide

#Quarkus #RedHat
understand app
convert annotations to bytecode
optimize
deployment

View Slide

#Quarkus #RedHat
extension concept
build steps

+

build items

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
build steps

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
build items

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
framework automatically
determines correct execution
order and injects parameters

View Slide

#Quarkus #RedHat
build items are communication
mechanism between build steps
framework automatically
determines correct execution
order and injects parameters

View Slide

#Quarkus #RedHat
initial state build items intermediate state build items terminal state build items

View Slide

#Quarkus #RedHat
initial state build items
JarResultBuildStep
intermediate state build items terminal state build items

View Slide

#Quarkus #RedHat
JarResultBuildStep
GeneratedResourceBuildItem

View Slide

#Quarkus #RedHat
JarResultBuildStep
ConfigClassBuildItem

View Slide

#Quarkus #RedHat
JarResultBuildStep
UnremovableBeanBuildItem

View Slide

#Quarkus #RedHat
JarResultBuildStep
BuildSystemTargetBuildItem

View Slide

#Quarkus #RedHat
JarResultBuildStep
LaunchModeBuildItem

View Slide

#Quarkus #RedHat
JarResultBuildStep
LaunchModeBuildItem
most extensions do stuff here

View Slide

#Quarkus #RedHat
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

…

View Slide

#Quarkus #RedHat
existing build items
cover almost all needs
like a library for extension writers

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
extension concept
index

View Slide

#Quarkus #RedHat
extension concept
index
eliminates need for runtime classpath scanning

View Slide

#Quarkus #RedHat
extension concept
index
“jandex”
eliminates need for runtime classpath scanning

View Slide

#Quarkus #RedHat
open world closed world

View Slide

#Quarkus #RedHat
hard to build-time optimise

View Slide

#Quarkus #RedHat
hard to build-time optimise easy to build-time optimise

View Slide

#Quarkus #RedHat
runtime class surprise!

View Slide

#Quarkus #RedHat
no worries

View Slide

#Quarkus #RedHat
uh oh, this is outside
our closed world
no worries

View Slide

#Quarkus #RedHat
AdditionalBeanBuildItem

View Slide

#Quarkus #RedHat
extension concept
bytecode recording
easier than writing ASM

(if recording isn’t optimised enough,
use Gizmo to hand-craft bytecode)

View Slide

Example
@Recorder

public class CaffeineCacheBuildRecorder {

// a proxy of this is invoked at build time

// the “real” invocation happens at runtime with the CaffeineCacheInfo obtained at build time

public Supplier getCacheManagerSupplier(Set cacheInfos) {

return new Supplier() {

@Override

public CacheManager get() {

if (cacheInfos.isEmpty()) {

return new CacheManagerImpl(Collections.emptyMap());

} else {

Map caches = new HashMap<>(cacheInfos.size() + 1, 1.0F);

for (CaffeineCacheInfo cacheInfo : cacheInfos) {

CaffeineCache cache = new CaffeineCache(cacheInfo);

caches.put(cacheInfo.name, cache);

}

return new CacheManagerImpl(caches);

}

}

};

}

}

View Slide

#Quarkus #RedHat
extension concept
configuration

View Slide

#Quarkus #RedHat
Quarkus

View Slide

#Quarkus #RedHat
Quarkus
deployment

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
extension

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
extension

deployment

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
extension

deployment runtime

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
extension

deployment runtime
config
config

View Slide

#Quarkus #RedHat
Quarkus
deployment runtime
extension

deployment runtime
config
config
config
config

View Slide

#Quarkus #RedHat
demo

View Slide

#Quarkus #RedHat
demo: recap

View Slide

#Quarkus #RedHat
https://github.com/holly-cummins/quarkus-minecraft-observability-extension

View Slide

#Quarkus #RedHat

View Slide

#Quarkus #RedHat
https://github.com/holly-cummins/
quarkus-minecraft-observability-extension

View Slide

#Quarkus #RedHat
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

View Slide

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) {

}

}

View Slide

Real world examples
● Jackson extension
 
● Hibernate Validator extension
 
● Spring DI extension
 
 
Resources
● http:/
/quarkus.io

● https:/
/quarkus.io/guides/all-builditems

● https:/
/quarkus.io/blog/quarkus-aws-cloudwatch_extension/

● https:/
/quarkus.io/blog/solving-problems-with-custom-extensions/

View Slide

®
thank you

@holly_cummins

@geoand86
https://github.com/holly-
cummins/quarkus-minecraft-
observability-extension
code

View Slide

Why you're missing out if you're not making Quarkus extensions

Why you're missing out if you're not making Quarkus extensions

Holly Cummins

More Decks by Holly Cummins

Other Decks in Programming

Featured

Transcript