Quarkus: модернизация на приложения на примера helloworld от JBoss EAP Quickstart

Здравейте всички в този блог, и с вас четвъртият пост от серията за Quarkus!

Предишният пост беше за това как Quarkus обединява MicroProfile и Spring. Да напомним, че Quarkus се позиционира като „супер бърза субатомна Java“, а именно „Kubernetes-ориентиран Java стек, оптимизиран за GraalVM и OpenJDK HotSpot, събран от най-добрите библиотеки и стандарти“. Днес ще покажем как да модернизирате вече съществуващи Java приложения, използвайки възможностите на Quarkus, на примера на приложението helloworld от репозитория Red Hat JBoss Enterprise Application Platform (JBoss EAP) Quickstart, в което се използват поддържаните в Quarkus технологии CDI и Servlet 3.

Важно е да се отбележи, че както Quarkus, така и JBoss EAP акцентират на използването на инструменти, изградени максимално на база стандарти. Нямате приложение, работещо на JBoss EAP? Няма проблем, лесно може да се прехвърли от текущия сървър на приложения на JBoss EAP с помощта на Red Hat Application Migration Toolkit. След което финалната и работеща версия на модернизирания код ще бъде достъпна в репозитория github.com/mrizzi/jboss-eap-quickstarts/tree/quarkus, в модула helloworld.

При написването на този пост се използваха ръководства по Quarkus, основно Creating Your First Application и Building a Native Executable.

Обзавеждаме се с код

Първо, нека създадем локален клон на репозитория JBoss EAP quickstarts:

$ git clone https://github.com/jboss-developer/jboss-eap-quickstarts.git
Клонираме в 'jboss-eap-quickstarts'...
remote: Изброяване на обекти: 148133, приключено.
remote: Общо 148133 (делта 0), повторно използвани 0 (делта 0), опаковани повторно 148133
Получаване на обекти: 100% (148133/148133), 59.90 MiB | 7.62 MiB/s, готово.
Разрешаване на делти: 100% (66476/66476), готово.
$ cd jboss-eap-quickstarts/helloworld/

Нека видим как работи оригиналният helloworld

Същността на това приложение е ясна от името, но ще модернизираме кода му строго научно. Затова първо ще погледнем на това приложение в оригиналния му вид.

Разгръщаме helloworld

1. Отваряме терминал и преминаваме в корена на папката JBoss EAP (може да я изтеглите тук.), т.е. папката EAP_HOME.

2. Стартираме сървъра JBoss EAP с дефолтния профил:

$ EAP_HOME/bin/standalone.sh

Бележка: на Windows за стартиране се използва сценарият EAP_HOMEbinstandalone.bat.

След няколко секунди в логовете трябва да се появи нещо такова:

[org.jboss.as] (Контролен поток на зареждане) WFLYSRV0025: JBoss EAP 7.2.0.GA (WildFly Core 6.0.11.Final-redhat-00001) стартиран за 3315мс - Стартирани 306 от 527 услуги (321 услуги са мъртви, пасивни или по заявка)

3. Отваряме в браузър 127.0.0.1:8080 и виждаме това:

Рис. 1. Начална страница на JBoss EAP.

4. Следваме инструкциите в ръководството Build and Deploy the Quickstart: разгръщаме helloworld и изпълняваме (от коренната папка на проекта) следната команда:

$ mvn clean install wildfly:deploy

След успешното изпълнение на тази команда в логовете ще видим нещо като следното:

[INFO] ------------------------------------------------------------------------ 
[INFO] УСПЕШНА СТРОЕЖ 
[INFO] ------------------------------------------------------------------------ 
[INFO] Общо време: 8.224 с

И така, първоначалното разгръщане на приложението helloworld на JBoss EAP отне малко повече от 8 секунди.

Тестваме helloworld

Действайки стриктно според ръководството Достъп до приложението, отваряме в браузъра 127.0.0.1:8080/helloworld и виждаме следното:

Фиг. 2. Изходен Hello World от JBoss EAP.

Внасяме промени

Променяме входния параметър createHelloMessage(String name) от World на Marco:

writer.println("<h1>" + helloService.createHelloMessage("Marco") + "</h1>");

Отново изпълняваме следната команда:

$ mvn clean install wildfly:deploy

След това обновяваме страницата в браузъра и виждаме, че текстът се е променил:

Фиг. 3. Hello Marco в JBoss EAP.

Отказваме разгръщането на helloworld и завършваме работата на JBoss EAP

Това не е задължително, но ако искате да отмените разгръщането, можете да направите следната команда:

$ mvn clean install wildfly:undeploy

За да завършите работата на инстанцията на JBoss EAP, просто натиснете Ctrl+C в терминалния прозорец.

Модернизираме helloworld

Сега ще се заемем с модернизацията на изходното приложение helloworld.

Създаваме нов клон

Създаваме нов работен клон след завършването на проекта quickstart:

$ git checkout -b quarkus 7.2.0.GA

Променяме файла pom.xml

Ще започнем да променяме приложението от файла pom.xml. За да може Quarkus да вмъква XML блокове в него, ще изпълним следната команда в папката helloworld:

$ mvn io.quarkus:quarkus-maven-plugin:0.23.2:create

При написването на тази статия се използва версия 0.23.2. Quarkus често излиза с нови версии, можете да видите коя версия е последната на сайта github.com/quarkusio/quarkus/releases/latest.

По-горната команда ще вмъкне следните елементи в pom.xml:

• Свойството , задаващо използваната версия на Quarkus.
• Блокът за импортиране на Quarkus BOM (bill of materials), така че да не добавяте версия за всяка зависимост на Quarkus.
• Плъгинът quarkus-maven-plugin, отговорен за опаковането на приложението и предоставящ режим development mode.
• Профил native за създаване на изпълними файлове на приложението.

Освен това, в pom.xml ръчно правим следните промени:

1. Извеждаме таг от блока и го поставяме над таг . Тъй като на следващия етап ще премахнем блока , е нужно да запазим .
2. Премахваме блока , тъй като това приложение вече не се нуждае от родителски pom от JBoss при работа с Quarkus.
3. Добавяме таг и го поставяме под тага . Можете да посочите номер на версията, какъвто искате.
4. Премахваме тага , тъй като това приложение вече не е WAR, а обикновен JAR.
5. Модифицираме следните зависимости:
   1. Сменяме зависимостта javax.enterprise:cdi-api на io.quarkus:quarkus-arc, премахвайки provided, тъй като (според документацията) това Quarkus разширение осигурява инжектиране на зависимост CDI.
   2. Сменяме зависимостта org.jboss.spec.javax.servlet:jboss-servlet-api_4.0_spec на io.quarkus:quarkus-undertow, премахвайки provided, тъй като (според документацията) това Quarkus разширение осигурява поддръжка на сервлети.
   3. Премахваме зависимостта org.jboss.spec.javax.annotation:jboss-annotations-api_1.3_spec, тъй като тя идва в комплект с зависимостите, които току-що променихме.

Версията на файла pom.xml с всички промени се намира на адрес github.com/mrizzi/jboss-eap-quickstarts/blob/quarkus/helloworld/pom.xml.

Обърнете внимание, че командата mvn io.quarkus:quarkus-maven-plugin:0.23.2:create не само променя файла pom.xml, но и добавя редица компоненти в проекта, а именно, следните файлове и папки:

• Файловете mvnw и mvnw.cmd и папката .mvn: Maven Wrapper позволява стартиране на Maven проекти с определена версия на Maven без инсталиране на самата версия.
• Папката docker (в каталога src/main/): тук се намират примерни файлове Dockerfile за режимите native и jvm (заедно с файла .dockerignore).
• Папката resources (в каталога src/main/): тук има празен файл application.properties и примерна стартова страница Quarkus index.html (повече можете да прочетете в секцията Run the modernized helloworld).

Стартираме helloworld
За да тестваме приложението, използваме quarkus:dev, който стартира Quarkus в режим на развитие (повече информация можете да намерите в този раздел на ръководството за Режим на развитие).

Бележка: този етап логично ще доведе до грешка, тъй като не сме направили всички необходими промени.

Сега стартираме командата, за да проверим как ще сработи:

$ ./mvnw compile quarkus:dev
[INFO] Търсене на проекти...
[INFO]
[INFO] ----------------< org.jboss.eap.quickstarts:helloworld >----------------
[INFO] Изграждане на пример: helloworld quarkus
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ helloworld ---
[INFO] Използва се кодировката 'UTF-8' за копиране на филтрирани ресурси.
[INFO] Копиране на 2 ресурса
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ helloworld ---
[INFO] Няма какво да се компилира - всички класове са актуални
[INFO]
[INFO] --- quarkus-maven-plugin:0.23.2:dev (default-cli) @ helloworld ---
Слушане на транспорт dt_socket на адрес: 5005
INFO  [io.qua.dep.QuarkusAugmentor] Започва увеличаването на quarkus
INFO  [org.jbo.threads] JBoss Threads версия 3.0.0.Final
ERROR [io.qua.dev.DevModeMain] Неуспех при стартиране на quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Неуспех при изграждане: Изграждането не можа да бъде завършено поради грешки
	[error]: Стъпка за изграждане io.quarkus.arc.deployment.ArcProcessor#validate хвърли изключение: javax.enterprise.inject.spi.DeploymentException: javax.enterprise.inject.UnsatisfiedResolutionException: Неудовлетворена зависимост за тип org.jboss.as.quickstarts.helloworld.HelloService и квалификатори [@Default]
	- java член: org.jboss.as.quickstarts.helloworld.HelloWorldServlet#helloService
	- деклариран в класовия бийн [types=[javax.servlet.ServletConfig, java.io.Serializable, org.jboss.as.quickstarts.helloworld.HelloWorldServlet, javax.servlet.GenericServlet, javax.servlet.Servlet, java.lang.Object, javax.servlet.http.HttpServlet], qualifiers=[@Default, @Any], target=org.jboss.as.quickstarts.helloworld.HelloWorldServlet]
	at io.quarkus.arc.processor.BeanDeployment.processErrors(BeanDeployment.java:841)
	at io.quarkus.arc.processor.BeanDeployment.init(BeanDeployment.java:214)
	at io.quarkus.arc.processor.BeanProcessor.initialize(BeanProcessor.java:106)
	at io.quarkus.arc.deployment.ArcProcessor.validate(ArcProcessor.java:249)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(Native Method)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at io.quarkus.deployment.ExtensionLoader$1.execute(ExtensionLoader.java:780)
	at io.quarkus.builder.BuildContext.run(BuildContext.java:415)
	at org.jboss.threads.ContextClassLoaderSavingRunnable.run(ContextClassLoaderSavingRunnable.java:35)
	at org.jboss.threads.EnhancedQueueExecutor.safeRun(EnhancedQueueExecutor.java:2011)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.doRunTask(EnhancedQueueExecutor.java:1535)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1426)
	at java.lang.Thread.run(Thread.java:748)
	at org.jboss.threads.JBossThread.run(JBossThread.java:479)
Причина: javax.enterprise.inject.UnsatisfiedResolutionException: Неудовлетворена зависимост за тип org.jboss.as.quickstarts.helloworld.HelloService и квалификатори [@Default]
	- java член: org.jboss.as.quickstarts.helloworld.HelloWorldServlet#helloService
	- деклариран в класовия бийн [types=[javax.servlet.ServletConfig, java.io.Serializable, org.jboss.as.quickstarts.helloworld.HelloWorldServlet, javax.servlet.GenericServlet, javax.servlet.Servlet, java.lang.Object, javax.servlet.http.HttpServlet], qualifiers=[@Default, @Any], target=org.jboss.as.quickstarts.helloworld.HelloWorldServlet]
	at io.quarkus.arc.processor.Beans.resolveInjectionPoint(Beans.java:428)
	at io.quarkus.arc.processor.BeanInfo.init(BeanInfo.java:371)
	at io.quarkus.arc.processor.BeanDeployment.init(BeanDeployment.java:206)
	... 14 more

Да, не работи... А защо?

Изключението UnsatisfiedResolutionException указва на класа HelloService, който е член на класа HelloWorldServlet (java member: org.jboss.as.quickstarts.helloworld.HelloWorldServlet#helloService). Проблемата е, че HelloWorldServlet се нуждае от инжектиран екземпляр HelloService, а такъв не може да бъде намерен (въпреки че и двата класа са в един и същи пакет).

Най-подходящият момент да се върнем към документацията и да прочетем как работи в Quarkus Inject, следователно и Contexts and Dependency Injection (CDI). Затова отваряме ръководството Contexts and Dependency Injection и в раздела Bean Discovery четем: «Bean-клас, който няма определяща bean анотация, не се търси».

Поглеждаме класа HelloService – в него наистина няма такава анотация. Следователно трябва да добавим такава, за да може Quarkus да търси и намира bean. И тъй като това е stateless-обект, спокойно можем да добавим анотацията @ApplicationScoped по следния начин:

@ApplicationScoped
public class HelloService {

Бележка: тук средата за разработка може да ви помоли да добавите необходимия пакет (вижте реда по-долу), и това ще трябва да направите ръчно, по следния начин:

import javax.enterprise.context.ApplicationScoped;

Ако се съмнявате каква област scope да използвате, когато за изходния bean не е зададена вообще, прегледайте документацията JSR 365: Contexts and Dependency Injection for Java 2.0—Default scope.

Сега отново пробваме да стартираме приложението с командата .\/mvnw compile quarkus:dev:

$ .\/mvnw compile quarkus:dev
[INFO] Сканиране за проекти...
[INFO]
[INFO] ----------------< org.jboss.eap.quickstarts:helloworld >----------------
[INFO] Създаване на Quickstart: helloworld quarkus
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ helloworld ---
[INFO] Използване на 'UTF-8' кодиране за копиране на филтрирани ресурси.
[INFO] Копиране на 2 ресурси
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ helloworld ---
[INFO] Открити промени - преработване на модула!
[INFO] Компилиране на 2 изходни файла в \/home\mrizzi\git\forked\jboss-eap-quickstarts\helloworld\target\classes
[INFO]
[INFO] --- quarkus-maven-plugin:0.23.2:dev (default-cli) @ helloworld ---
Слушане за транспорт dt_socket на адрес: 5005
INFO  [io.qua.dep.QuarkusAugmentor] (main) Започване на quarkusaugmentation
INFO  [io.qua.dep.QuarkusAugmentor] (main) Quarkus augmentation завършено за 576ms
INFO  [io.quarkus] (main) Quarkus 0.23.2 стартирано за 1.083s. Слушане на: http:\/\/0.0.0.0:8080
INFO  [io.quarkus] (main) Профил dev активиран. Активирано живо програмиране.
INFO  [io.quarkus] (main) Инсталирани функции: [cdi]

Сега всичко преминава без грешки.

Стартиране на модернизирания helloworld
Както е написано в логовете, отваряме в браузъра 0.0.0.0:8080 (началната страница на Quarkus по подразбиране) и виждаме следното:

Рис. 4. Началната страница на Quarkus dev.

В анотацията WebServlet на това приложение е зададено следното определение на контекста:

@WebServlet("\/HelloWorld")
public class HelloWorldServlet extends HttpServlet {

Така че, отиваме в браузъра на 0.0.0.0:8080/HelloWorld и виждаме следното:

Рис. 5: Страницата на The Quarkus dev за приложението Hello World.

Ето, всичко работи.

Сега правим промени в кода. Обърнете внимание, че командата ./mvnw compile quarkus:dev все още работи и нямаме намерение да я спираме. Сега ще опитаме да приложим същите – много тривиални – промени в самия код и да видим как Quarkus улеснява живота на разработчика:

writer.println("<h1>" + helloService.createHelloMessage("Marco") + "</h1>");

Запазваме файла и след това обновяваме уеб страницата, за да видим надписа Hello Marco, както е показано на екрана по-долу:

Рис. 6. Страницата Hello Marco в Quarkus dev.

Сега да проверим изхода в терминала:

INFO  [io.qua.dev] (vert.x-worker-thread-3) Обнаружени изменения в изходните файлове, пре компилирането [/home/mrizzi/git/forked/jboss-eap-quickstarts/helloworld/src/main/java/org/jboss/as/quickstarts/helloworld/HelloWorldServlet.java]
INFO  [io.quarkus] (vert.x-worker-thread-3) Quarkus спряно за 0.003s
INFO  [io.qua.dep.QuarkusAugmentor] (vert.x-worker-thread-3) Започва augmentaция на Quarkus
INFO  [io.qua.dep.QuarkusAugmentor] (vert.x-worker-thread-3) Augmentацията на Quarkus завърши за 232ms
INFO  [io.quarkus] (vert.x-worker-thread-3) Quarkus 0.23.2 стартирано за 0.257s. Слушане на: http://0.0.0.0:8080
INFO  [io.quarkus] (vert.x-worker-thread-3) Профил dev активиран. Активирано живо кодиране.
INFO  [io.quarkus] (vert.x-worker-thread-3) Инсталирани функции: [cdi]
INFO  [io.qua.dev] (vert.x-worker-thread-3) Общо време за гореща подмяна: 0.371s

Обновлението на страницата задейства откритие на промени в изходния код, и Quarkus автоматично изпълни процедурата „стоп-старт“. И всичко това стана за само 0.371 секунди (ето я, т.нар. „супер бърза субатомна Java“).

Извършване на изграждане на helloworld в JAR пакет
Сега, когато кодът работи както трябва, ще го опаковаме с следната команда:

$ ./mvnw clean package

Тази команда създава два JAR файла в папката /target: файлът helloworld-.jar, който представлява стандартния артефакт, събран от Maven командата заедно с класовете и ресурсите на проекта. И файлът helloworld-runner.jar, представляващ изпълняемия JAR.

Обърнете внимание, че това не е убер-jar, тъй като всички зависимости просто се копират в папката /target/lib (а не се опаковат в JAR файла). Следователно, за да стартирате този JAR от друга папка или на друг хост, трябва да копирате както самия JAR файл, така и папката /lib, като се има предвид, че елементът Class-Path в файла MANIFEST.MF в JAR пакета съдържа явно изброяване на JAR-овете от папката lib.
За да научите как да създавате приложения убер-jar, моля, обърнете се към ръководството Създаване на Uber-Jar.

Стартиране на helloworld, опакован в JAR

Сега можем да стартираме нашия JAR с помощта на стандартната команда java:

$ java -jar ./target/helloworld--runner.jar
INFO  [io.quarkus] (main) Quarkus 0.23.2 стартирано за 0.673s. Слуша на: http://0.0.0.0:8080
INFO  [io.quarkus] (main) Активиран профил прод.
INFO  [io.quarkus] (main) Инсталирани функции: [cdi]

След като всичко това е извършено, отидете в браузъра на 0.0.0.0:8080 и проверете, че всичко работи както трябва.

Събираме helloworld в нативен изпълним файл

И така, нашият helloworld работи като самостоятелно Java приложение, използвайки зависимостите на Quarkus. Но можем да отидем по-далече и да го превърнем в нативен изпълним файл.

Инсталираме GraalVM
Първо, за целта трябва да инсталираме необходимите инструменти:

1. Изтеглете GraalVM 19.2.0.1 от github.com/oracle/graal/releases/tag/vm-19.2.0.1.

2. Разархивирайте изтегления архив:

$ tar xvzf graalvm-ce-linux-amd64-19.2.0.1.tar.gz

3. Отиваме в папката untar.

4. Изпълняваме следната команда, за да изтеглим и добавим нативния образ:

$ ./bin/gu install native-image

5. Записваме папката, създадена на стъпка 2, в променливата среда GRAALVM_HOME:

$ export GRAALVM_HOME={untar-folder}/graalvm-ce-19.2.0.1)

Допълнителна информация и инструкции за инсталиране на други ОС можете да намерите в ръководството Building a Native Executable—Prerequisites.

Изпълняваме сборка на helloworld в нативен изпълним файл
Четем ръководството Building a Native Executable—Producing a native executable: «А сега ще създадем нативен изпълним файл за нашето приложение, за да намалим времето за стартиране и размера на диска. Изпълнимият файл ще съдържа всичко необходимо за стартиране на приложението, включително JVM машина (по-скоро, нейна съкратена версия, съдържаща само това, което е необходимо за изпълнение на приложението) и самото ни приложение».

За да създадете нативен изпълним файл, трябва да включите native профила Maven:

$ ./mvnw package -Pnative

Сборката ни отне една минута и 10 секунди, а крайният файл helloworld—runner беше създаден в папката /target.

Стартираме нативния изпълним файл helloworld

На предишната стъпка получихме изпълним файл /target/helloworld—runner. Сега да го стартираме:

$ ./target/helloworld--runner
INFO  [io.quarkus] (main) Quarkus 0.23.2 стартирано за 0.006s. Слуша на: http://0.0.0.0:8080
INFO  [io.quarkus] (main) Активиран профил прод.
INFO  [io.quarkus] (main) Инсталирани функции: [cdi]

Отново отваряме в браузъра 0.0.0.0:8080 и проверяваме, че всичко работи както трябва.

Продължава!

Смятаме, че представеният в този пост (дори и на прост пример) метод за модернизация на Java-приложения с помощта на възможностите на Quarkus си заслужава да бъде активно прилаган в реалния живот. При това, вие вероятно ще се сблъскате с редица проблеми, решението на които частично ще разгледаме в следващия пост, където ще говорим за това как да измерваме консумацията на памет, за да оценим подобренията в производителността, важна част от целия процес на модернизация на приложенията.

Източник: habr.com