![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/eclipse-foundation.png\")
<\/figure>\n<\/div>\n\n\n<\/p>\n\n\n\n
Fin 2016 la fondation Eclipse a lanc\u00e9 l\u2019initiative MicroProfile autour de deux id\u00e9es :<\/p>\n\n\n\n
- \n
- D\u00e9finir un sous ensemble de sp\u00e9cifications JakartaEE pour proposer un serveur plus l\u00e9ger<\/li>\n\n\n\n
- D\u00e9finir de nouvelles sp\u00e9cifications pour une meilleure int\u00e9gration au cloud<\/li>\n<\/ul>\n\n\n\n
Voici le d\u00e9tail de la derni\u00e8re version :<\/p>\n\n\n
\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/1infoq-microprofile-3.png\")
<\/figure>\n<\/div>\n\n\nVous retrouverez l\u2019ensemble des sp\u00e9cifications sur le compte Github<\/a> de la Fondation Eclipse. A noter qu\u2019elle dispose de son propre syst\u00e8me de validation de sp\u00e9cifications, l\u2019Eclipse Foundation Specification Process (EFSP). Une nouvelle release est publi\u00e9e tous les trimestres. L\u2019objectif est que ces composants fassent l\u2019objet d\u2019une JCP (Java Community Process) pour int\u00e9grer les JSR (Java Specification Requests).<\/p>\n\n\n\n
\n\n\n\nMais de quoi est compos\u00e9 une sp\u00e9cification Eclipse Microprofile ?<\/h3>\n\n\n\n
- \n
- La sp\u00e9cification sous forme asciidoc<\/li>\n\n\n\n
- L\u2019API, ensemble d\u2019interfaces \/ \u00e9num\u00e9rations Java permettant de d\u00e9finir les fonctionnalit\u00e9s \u00e0 impl\u00e9menter<\/li>\n\n\n\n
- Suite de tests appel\u00e9e TCK (Technology Compatibility Kit) permettant de valider une impl\u00e9mentation<\/li>\n<\/ul>\n\n\n\n
N\u2019h\u00e9sitez pas \u00e0 y jeter un coup d\u2019\u0153il, les sp\u00e9cifications<\/a> sont de v\u00e9ritables mines d\u2019or. Elles d\u00e9crivent et d\u00e9taillent l\u2019ensemble des fonctionnalit\u00e9s qui la compose. En les consultant vous y d\u00e9couvrirez peut \u00eatre une feature qui vous sera utile !<\/p>\n\n\n\n
N\u2019oublions pas qu\u2019il s\u2019agit de sp\u00e9cifications, vous ne trouverez pas d\u2019impl\u00e9mentation dans ce type de repos.<\/p>\n\n\n\n
Faisons un petit tour du propri\u00e9taire<\/h2>\n\n\n\n
J\u2019ai d\u00e9coup\u00e9 les sp\u00e9cifications en 3 cat\u00e9gories.<\/p>\n\n\n\n
1) Les composants JakartaEE<\/h2>\n\n\n\n
Il s\u2019agit de composants repris des sp\u00e9cifications JakartaEE, ils forment les fondations de notre MicroProfile (n\u2019h\u00e9sitez pas \u00e0 lire l\u2019article JakartaEE<\/a> sur notre blog).<\/p>\n\n\n\n
CDI<\/h3>\n\n\n\n
Context and Dependency Injection est le m\u00e9canisme central sur lequel se repose bon nombre de composants. Ce syst\u00e8me permet de limiter le couplage entre les objets en facilitant le remplacement des impl\u00e9mentations. La plupart de ses fonctionnalit\u00e9s s\u2019effectuent en phase de compilation.<\/p>\n\n\n\n
@Produces\n@ApplicationScoped\npublic static ObjectMapper creerMapper() {\n return new ObjectMapper();\n}\n\n...\n\n@Inject\nFishService fishService;\n\n@Inject\nObjectMapper objectMapper;<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
JAX-RS<\/h3>\n\n\n\n
Je ne m\u2019attarderai pas sur la sp\u00e9cification standardisant les applications Rest bien connue de tous. Il s\u2019agit certainement avec CDI de la sp\u00e9cification la plus fournie en fonctionnalit\u00e9s.<\/p>\n\n\n\n
<\/p>\n\n\n\n
JSON-P<\/h3>\n\n\n\n
Sp\u00e9cification permettant de faciliter la manipulation de json (parsing, cr\u00e9ation, transformation, recherche).<\/p>\n\n\n\n
JsonBuilderFactory bf = Json.createBuilderFactory(null)\nJsonArray array = bf.createArrayBuilder()\n.add(bf.createObjectBuilder()\n.add(\"id\", 1)\n.add(\"name\", \"Cichlidae\")\n.add(\"water_type\", 0))\n.add(bf.createObjectBuilder()\n.add(\"id\", 2)\n.add(\"name\", \"Cyprinidae\")\n.add(\"water_type\", 0))\n.build();<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
JSON-B<\/h3>\n\n\n\n
Cette sp\u00e9cification permet de d\u00e9finir la fa\u00e7on de mapper un objet java en json et vice versa.<\/p>\n\n\n\n
public class Fish {\n public long id;\n public String name;\n public WaterType waterType;\n}\n\nJsonb jsonb = JsonbBuilder.create();\n\nFish maurice = new Fish();\nmaurice.id = 1;\nmaurice.name = \"Maurice\";\nmaurice.waterType= WaterType.FRESH;\n\nString mauriceJson = jsonb.toJson(maurice);\nSystem.out.println(mauriceJson); \/\/ {\"id\":1,\"name\":\"Maurice\",\"waterType\": 1}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n
\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/wheel_jakarta_microprofile_opacity-293x300-1.png\")
<\/figure>\n<\/div>\n\n\n<\/p>\n\n\n\n
Sp\u00e9cifications utilitaires<\/h2>\n\n\n\n
Ces sp\u00e9cifications ne sont pas indispensables au bon fonctionnement de votre projet mais elles vous faciliteront la vie.<\/p>\n\n\n\n
Open API<\/h3>\n\n\n\n
Cette sp\u00e9cification standardise la documentation des API, c\u2019est sur ce standard que repose Swagger.<\/p>\n\n\n\n
@GET\n@Path(\"\/{fishname}\")\n@Operation(summary = \"Get fish by fish name\")\n@APIResponse(description = \"The fish\",\ncontent = @Content(mediaType = \"application\/json\",\nschema = @Schema(implementation = Fish.class))),\n@APIResponse(responseCode = \"400\", description = \"Fish not found\")\npublic Response getFishByName(\n@Parameter(description = \"The name that needs to be fetched. Use fish1 for testing. \", required = true) @PathParam(\"fishname\") String fishname)<\/code><\/pre>\n\n\n\nGET \/openapi<\/code><\/pre>\n\n\n\n\/fish\/{fishname}:\nget:\nsummary: Get fish by fish name\noperationId: getFishByName\nparameters:\n- name: fishname\nin: path\ndescription: 'The name that needs to be fetched. Use fish1 for testing. '\nrequired: true\nschema:\ntype: string\nresponses:\ndefault:\ndescription: The fish\ncontent:\napplication\/json:\nschema:\n$ref: '#\/components\/schemas\/Fish'\n400:\ndescription: Fish not found<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
Rest Client<\/h3>\n\n\n\n
Cette sp\u00e9cification particuli\u00e8rement riche standardise les clients Rest. La fonctionnalit\u00e9 principale de cette API est de pouvoir cr\u00e9er un proxy de service Rest.<\/p>\n\n\n\n
@Path(\"\/fishs\")\n@Produces(\"application\/json\")\n@Consumes(\"application\/json\")\npublic interface FishServiceClient {\n @GET\n @Path(\"family\/{fishFamily}\")\n Response countByFamily(@PathParam(\"fishFamily\") String fishFamily);\n\n @PUT\n Response updateFish(@BeanParam PutFish putFish);\n}\n\npublic class PutFish {\n @HeaderParam(\"Authorization\")\n private String authorization;\n @PathParam(\"fishId\")\n private String fishId;\n \/\/ getters, setters, constructors omitted\n}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
Fault tolerance<\/h3>\n\n\n\n
Cette sp\u00e9cification permet de rendre votre application plus r\u00e9siliente en cas de perte de d\u00e9pendances externes (service, database, etc).<\/p>\n\n\n\n
Prenons l\u2019exemple d\u2019une application affichant le d\u00e9tail d\u2019une fiche d\u2019un poisson. Son contenu doit \u00eatre affich\u00e9 m\u00eame sous forme d\u00e9grad\u00e9. Une partie de ces informations provient d\u2019un service externe qui devient brusquement indisponible.<\/p>\n\n\n\n
@Retry(maxRetries = 2)\n@Fallback(fallbackMethod= \"fallbackForFindFamilyName\")\npublic String findFamilyName(String fishName) {\n return fishServiceClient.findFamilyName(fishName);\n}\n\nprivate String fallbackForFindFamilyName() {\n return \"Missing information\";\n}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
JWT Propagation<\/h3>\n\n\n\n
Json Web Token Propagation nous aide \u00e0 r\u00e9cup\u00e9rer les informations sur le Principal du contexte. Il suffit juste d\u2019utiliser des annotations via son int\u00e9gration \u00e0 CDI (header, claim et signature).<\/p>\n\n\n\n
@Inject\nprivate JsonWebToken callerPrincipal;\n\n@Inject\n@Claim(\"raw_token\")\nprivate String rawToken;\n\n@Inject\n@Claim(\"groups\")\nprivate Set groups;\n\n@Inject\n@Claim(\"exp\")\nprivate long expiration;\n\n@Inject\n@Claim(\"sub\")\nprivate String subject;<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
Open tracing<\/h3>\n\n\n\n
Cette sp\u00e9cification permet de standardiser la mani\u00e8re de tracer les appels dans un contexte distribu\u00e9. Ces flux pourront \u00eatre exploit\u00e9s par des outils tels que Jaeger ou Zipkin. Cette fonctionnalit\u00e9 ne n\u00e9cessite pas d\u2019activation particuli\u00e8re si vous disposez d\u2019une application JAX-RS. Dans le cas contraire il est possible d\u2019utiliser l\u2019annotation @Traced.<\/p>\n\n\n\n
<\/p>\n\n\n\n
Sp\u00e9cifications permettant l’int\u00e9gration \u00e0 un environnement Cloud<\/h2>\n\n\n\n
Microprofile Config<\/h3>\n\n\n\n
C\u2019est l\u2019une des sp\u00e9cifications que je trouve la plus int\u00e9ressante, elle standardise le chargement de configurations. Elle est capable de r\u00e9cup\u00e9rer ces informations depuis plusieurs sources, fichiers, param\u00e8tres de lancement du serveur, variables d\u2019environnements etc. Il existe des impl\u00e9mentations vers ZooKeeper Consule ou encore Etcd.<\/p>\n\n\n\n
Prenons l\u2019exemple d\u2019une variable d\u2019environnement appel\u00e9e $SHOP_NAME=FishParadise, que vous souhaitez exploiter dans votre application.<\/p>\n\n\n\n
@Inject @ConfigProperty(name=\"SHOP_NAME\", defaultValue=\"FishMarket\")\nString shopName<\/code><\/pre>\n\n\n\nA noter que le fichier de configuration par d\u00e9faut pour un Microprofile Eclipse est le fichier microprofile-config.properties.<\/p>\n\n\n\n
Microprofile Health<\/h3>\n\n\n\n
Cette sp\u00e9cification permet de sonder l\u2019\u00e9tat d\u2019une application. Elle expose plusieurs endpoints permettant de v\u00e9rifier que votre application est lanc\u00e9e (Liveness), ou pr\u00eate \u00e0 fournir son service (Readyness). Il est possible d\u2019ajouter soi-m\u00eame ses v\u00e9rifications en les impl\u00e9mentant.<\/p>\n\n\n\n
GET \/health\/live<\/code><\/pre>\n\n\n\n{\n \"status\" : \"UP\",\n \"checks\" : [ {\n \"name\" : \"DataSourceHealthCheck\",\n \"status\" : \"UP\"\n } ]\n}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
Microprofile Metric<\/h3>\n\n\n\n
Sp\u00e9cification permettant de r\u00e9cup\u00e9rer des statistiques sur l\u2019usage de l\u2019application. Ces m\u00e9triques sont divis\u00e9es en 3 cat\u00e9gories Base, Application, Vendor. Elles sont accessibles via l\u2019url \/metrics\/[Base|Vendor|Application]. Vous y trouverez des informations sur l\u2019usage du CPU, l\u2019\u00e9tat de la jvm ou encore sur votre pool http. Il est \u00e9galement possible d\u2019ajouter vos propres m\u00e9triques m\u00e9tier.<\/p>\n\n\n\n
La sp\u00e9cification fournit de nombreuses annotations @Counted @ConcurrentGauge @Gauge @Metered @Metric @Timed @SimplyTimed. Elles pourront \u00eatre appliqu\u00e9es selon les cas, \u00e0 des m\u00e9thodes, types ou classes.<\/p>\n\n\n\n
@Gauge(unit = MetricUnits.NONE, name = \"fishQueueSize\")\npublic int getFishQueueSize() {\n return fishQueue.size;\n}<\/code><\/pre>\n\n\n\n<\/p>\n\n\n\n
GET \/metrics<\/code><\/pre>\n\n\n\n# TYPE base_jvm_uptime_seconds gauge\n# HELP base_jvm_uptime_seconds Displays the start time of the Java virtual machine in milliseconds. This attribute displays the approximate time when the Java virtual machine started.\nbase_jvm_uptime_seconds{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 315.14300000000003\n# TYPE base_classloader_loadedClasses_total_total counter\n# HELP base_classloader_loadedClasses_total_total Displays the total number of classes that have been loaded since the Java virtual machine has started execution.\nbase_classloader_loadedClasses_total_total{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 12580\n# TYPE base_thread_count gauge\n# HELP base_thread_count Displays the current number of live threads including both daemon and non-daemon threads\nbase_thread_count{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 28\n# TYPE base_memory_committedHeap_bytes gauge\n# HELP base_memory_committedHeap_bytes Displays the amount of memory in bytes that is committed for the Java virtual machine to use. This amount of memory is guaranteed for the Java virtual machine to use.\nbase_memory_committedHeap_bytes{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 3.16669952E8\n# TYPE base_gc_total_total counter\n# HELP base_gc_total_total Displays the total number of collections that have occurred. This attribute lists -1 if the collection count is undefined for this collector.\nbase_gc_total_total{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",name=\"G1-Young-Generation\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 6\n# TYPE base_gc_total_total counter\n# HELP base_gc_total_total Displays the total number of collections that have occurred. This attribute lists -1 if the collection count is undefined for this collector.\nbase_gc_total_total{environment=\"dev\",instanceId=\"9afb9093-e0a9-4518-8b66-852f6b9c310a\",name=\"G1-Old-Generation\",serviceName=\"UNKNOWN\",serviceVersion=\"1.0.0\"} 0<\/code><\/pre>\n\n\n\n
\n\n\n\nC’est bien beau de voir les sp\u00e9cifications, mais sans impl\u00e9mentations \u00e7a ne fonctionne pas !<\/h3>\n\n\n\n
Il en existe de nombreuses fournies par Oracle, RedHat, IBM etc. Je vous propose de jeter un coup d\u2019\u0153il sur l\u2019impl\u00e9mentation la plus utilis\u00e9e (licence apache) :<\/p>\n\n\n
\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/smallrye_project_logo.png\")
<\/figure>\n<\/div>\n\n\n<\/p>\n\n\n\n
Mais quels serveurs sont compatibles ?<\/h3>\n\n\n\n
Voici un web starter<\/a> permettant de cr\u00e9er votre projet MicroProfile Eclipse.<\/p>\n\n\n
\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/starter.png\")
<\/figure>\n<\/div>\n\n\nVous y trouverez des noms bien connus tel que Wildfly et OpenLiberty TomEE et des petits nouveaux comme Payara, KumuluzEE, Helidon et Quarkus.<\/p>\n\n\n\n
<\/p>\n\n\n\n
\n\n\n\nUn peu de pratique<\/h2>\n\n\n\n
![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/kumuluzee-logo.png\"){kind=logo}
<\/figure>\n<\/div>\n\n\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/heap_memory-1-1024x718-1.png\")
<\/figure>\n\n\n\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/rancher-logo-horiz-color-300x44-1.png\"){kind=logo}
<\/figure>\n<\/div>\n\n\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/gitlab.png\")
<\/a><\/figure>\n<\/div>\n\n\n![\"\"](\"http:\/\/baptiste-meynier.com\/wp-content\/uploads\/2020\/11\/makeChoiceThree.png\")
<\/figure>\n<\/div>\n\n\n