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, основно Създаване на вашето първо приложение и Създаване на роден изпълним файл.

Снабдяваме се с кода

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

$ git clone https://github.com/jboss-developer/jboss-eap-quickstarts.git
Клониране в 'jboss-eap-quickstarts'...
remote: Изчисляване на обекти: 148133, завършено.
remote: Общо 148133 (delta 0), повторно използвани 0 (delta 0), pack-reused 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] (Контролен Boot Thread) WFLYSRV0025: JBoss EAP 7.2.0.GA (WildFly Core 6.0.11.Final-redhat-00001) стартиран за 3315ms - Стартирани 306 от 527 услуги (321 услуги са лениви, пасивни или по поръчка)

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

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

4. Следваме указанията в ръководството Създайте и разположете 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:

писателят.println("<h1>" + helloService.createHelloMessage("Марко") + "</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 (сметка на материалите), за да не добавяте версия за всяка зависимост от Quarkus.
• Плъгинът quarkus-maven-plugin, който отговаря за опаковането на приложението и предоставящ режим на развитие.
• Профил 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 (повече информация вижте в Ръководството за модернизиран хеллоуорлд).

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

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

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

$ .\/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]
[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
	- деклариран на CLASS bean [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(NativeMethodAccessorImpl.java:62)
	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
	- деклариран на CLASS bean [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 повече

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

Исключението 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) Започва quarkus увеличаване
INFO  [io.qua.dep.QuarkusAugmentor] (main) Quarkus увеличаването е завършено за 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 улеснява живота на разработчика:

писателят.println("<h1>" + helloService.createHelloMessage("Марко") + "</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) Започва увеличаване на Quarkus
INFO  [io.qua.dep.QuarkusAugmentor] (vert.x-worker-thread-3) Увеличаването на 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 Creation.

Стартираме 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) Профил prod активиран.
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)

Допълнителна информация и инструкции за инсталиране на други ОС можете да намерите в ръководството Създаване на нативен изпълним файл—Предварителни условия.

Изпълняваме изграждането на helloworld в нативен изпълним файл
Прочитаме ръководството Създаване на нативен изпълним файл—Производство на нативен изпълним файл: «А сега да създадем нативен изпълним файл за нашето приложение, за да намалим времето за стартиране и размера на диска. Испълнимият файл ще има всичко необходимо за стартиране на приложението, включително 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) Профил prod активиран.
INFO  [io.quarkus] (main) Инсталирани функции: [cdi]

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

Продължението следва!

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

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