Quand on d\u00e9veloppe une application compos\u00e9e de plusieurs composants, il est fr\u00e9quent de vouloir partager du code dans une librairie externe, par exemple via un JAR externe int\u00e9gr\u00e9 comme une d\u00e9pendance de vos composants.<\/p>\n
Quarkus est un framework d’extension, chaque extension qu’il propose permet d’int\u00e9grer une technologie (client BDD, framework ORM, …) \u00e0 Quarkus, pour qu’elle puisse \u00eatre configur\u00e9e globalement, utilis\u00e9e facilement via CDI (injection de d\u00e9pendances), fonctionner avec GraalVM, …<\/p>\n
Quarkus a son propre syst\u00e8me de build, via son plugin Maven ou Gradle, qui permet de d\u00e9porter au build une partie du d\u00e9marrage de votre application via une extension. Il serait donc naturel de partager le code commun \u00e0 plusieurs composants d\u00e9velopp\u00e9s avec Quarkus via une extension.<\/p>\n
Hors, cr\u00e9er une extension est compliqu\u00e9 et n\u00e9cessite des comp\u00e9tences pouss\u00e9es sur le fonctionnement interne de Quarkus. A part si vous avez besoin de fonctionnalit\u00e9s pouss\u00e9es telles que d\u00e9crites dans le guide d’\u00e9criture des extensions<\/a>, il est souvent suffisant de cr\u00e9er un JAR \u00ab\u00a0standard\u00a0\u00bb avec la technique d\u00e9crite dans la suite de ce billet.<\/p>\n Nous allons donc cr\u00e9er un JAR standard via un module Maven tout ce qu’il y a de plus classique ; la seule sp\u00e9cificit\u00e9 est que pour que le code de ce JAR soit \u00ab\u00a0d\u00e9couvert\u00a0\u00bb par Quarkus, il faut qu’il soit index\u00e9 par Jandex. Jandex<\/a> est utilis\u00e9 par Quarkus pour d\u00e9couvrir le code de votre application au build via une indexation du code de votre application, au lieu de le d\u00e9couvrir au runtime via des m\u00e9canismes plus standard tel que le scan de classpath et la r\u00e9flexion.<\/p>\n Quarkus va automatiquement indexer le code de votre application, mais pas de ses d\u00e9pendances, on va donc ajouter le plugin Maven Jandex pour cr\u00e9er un index du code de votre JAR commun lors du packaging de celui-ci par Maven :<\/p>\n Maintenant, nous allons pouvoir \u00e9crire du code qui sera d\u00e9couvert par Quarkus : par exemple, fournir des beans CDI que l’on pourra ensuite injecter dans notre code applicatif.<\/p>\n Prenons par exemple la cr\u00e9ation d’un client pour Consul bas\u00e9 sur le Consul Client for Java<\/a>.<\/p>\n La premi\u00e8re \u00e9tape consiste \u00e0 cr\u00e9er une classe repr\u00e9sentant la configuration du client, pour cela, on va utiliser le principe du Config Mapping<\/a> : une interface qui repr\u00e9sente vos options de configurations :<\/p>\n Cette classe peut avoir une configuration par d\u00e9faut que se retrouve dans le fichier On peut ensuite \u00e9crire un producer CDI qui se basera sur votre classe de configuration pour produire un client Consul comme un bean CDI injectable dans le code de votre application :<\/p>\n Une fois ce JAR packag\u00e9, il suffit de l’ajouter comme d\u00e9pendance \u00e0 notre application, puis de configurer les propri\u00e9t\u00e9s qui doivent l’\u00eatre dans notre fichier Pour finir, nous pouvons injecter le bean du client Consul dans notre code application, ici un endpoint REST (JAX-RS) :<\/p>\n Ici, le client Consul est inject\u00e9 dans notre endpoint JAX-RS, puis utilis\u00e9 dans la m\u00e9thode J’en ai parl\u00e9 en d\u00e9but d’article, une des fonctionnalit\u00e9 les plus classique fournie par une extension, est le support de la compilation native GraalVM. M\u00eame si on peut en faire une plus pouss\u00e9e via une extension, on peut quand m\u00eame via un simple JAR commun fournir une liste de classe \u00e0 enregistrer pour r\u00e9flexion via l’annotation @RegisterForReflection<\/code>code>@RegisterForReflection<\/code<\/a>.\nVoici un exemple qui enregistrer 3 classes fictives pour r\u00e9flexion (cette \u00e9tape n’est pas n\u00e9cessaire pour notre client Consul) :<\/p>\n On peut aussi fournir directement les configurations GraalVM standard via les fichiers de configuration standard<\/a> ou via des substitutions<\/a>.<\/p>\n Et voil\u00e0 comment ne pas<\/strong> cr\u00e9er une extension Quarkus.\nSi vous insistez \u00e0 vouloir en cr\u00e9er une, vous pouvez regarder mon talk sur fait \u00e0 Devoxx FR 2021<\/a> sur le sujet ;)<\/p>","protected":false},"excerpt":{"rendered":" Quand on d\u00e9veloppe une application compos\u00e9e de plusieurs composants, il est fr\u00e9quent de vouloir partager du code dans une librairie externe, par exemple via un JAR externe int\u00e9gr\u00e9 comme une d\u00e9pendance de vos composants. Quarkus est un framework d’extension, chaque extension qu’il propose permet d’int\u00e9grer une technologie (client BDD, framework ORM, …) \u00e0 Quarkus, pour qu’elle puisse \u00eatre configur\u00e9e globalement, utilis\u00e9e facilement via CDI (injection de d\u00e9pendances), fonctionner avec GraalVM, … Quarkus a son propre syst\u00e8me de build, via son…\n\n \n \n org.jboss.jandex\n jandex-maven-plugin\n 1.2.1\n \n \n make-index\n \n jandex\n \n \n \n \n \n\n<\/pre>\n
\n@ConfigMapping(prefix = \"consul\")\ninterface ConsulConfig {\n String host();\n int port();\n}\n<\/pre>\nMETA-INF\/microprofile.properties<\/code>, ce fichier est automatiquement d\u00e9couvert par le syst\u00e8me de configuration de Quarkus dans chaque JAR du classpath.\nVous pourrez ensuite surcharger cette configuration si n\u00e9cessaire dans le fichier application.properties<\/code> de votre application.<\/p>\n\nconsul.host=localhost\nconsul.port=8500\n<\/pre>\n
\n@ApplicationScoped \/\/ 1\npublic class ConsulClientProducer {\n @Inject ConsulConfig config; \/\/ 2\n\n @Produces \/\/ 3\n @ApplicationScoped \/\/ 4\n public Consul consulClient() {\n HostAndPort hostPort = HostAndPort.fromParts(config.host(), config.port());\/\/ 5\n return Consul.builder().withHostAndPort(hostPort).build(); \/\/ 6\n }\n}\n<\/pre>\n@Produces<\/code>.<\/li>\n\n@ApplicationScoped<\/code>.<\/li>\n\napplication.properties<\/code> (elle surchargeront celle du fichier microprofile.properties<\/code> du JAR commun) :<\/p>\n\nconsul.host=my.consul.host\n<\/pre>\n
\n@Path(\"\/\")\npublic class HelloConsulEndpoint {\n @Inject Consul consulClient;\n\n @GET\n public String getFromConsul() {\n KeyValueClient kvClient = consulClient.keyValueClient();\n return kvClient.getValueAsString(\"foo\").get(); \n }\n}\n<\/pre>\ngetFromConsul()<\/code> pour r\u00e9cup\u00e9rer la valeur d’une cl\u00e9 depuis Consul et la retourner \u00e0 l’utilisateur.<\/p>\n\n@RegisterForReflection(targets={ FirstClass.class, SecondClass.class, FictiveClass})\npublic class NativeImageReflectiveConfiguration {\n}\n<\/pre>\n