Quarkus: Модернизация на приложения с помощта на Helloworld като пример от JBoss EAP Quickstart

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

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

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

Когато пишехме тази публикация, използвахме Уроци по Quarkus, общо взето Създаване на вашето първо приложение и Сграда a Роден изпълним файл.

Да вземем кода

Първо, нека създадем локален клонинг на хранилището JBoss EAP бърз старт:

$ git clone https://github.com/jboss-developer/jboss-eap-quickstarts.git
Cloning into 'jboss-eap-quickstarts'...
remote: Enumerating objects: 148133, done.
remote: Total 148133 (delta 0), reused 0 (delta 0), pack-reused 148133
Receiving objects: 100% (148133/148133), 59.90 MiB | 7.62 MiB/s, done.
Resolving deltas: 100% (66476/66476), done.
$ 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] (Controller Boot Thread) WFLYSRV0025: JBoss EAP 7.2.0.GA (WildFly Core 6.0.11.Final-redhat-00001) started in 3315ms - Started 306 of 527 services (321 services are lazy, passive or on-demand)

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

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

4. Следвайте инструкциите в ръководството Изграждане и внедряване на Quickstart: разгънете helloworld и изпълнете (от основната папка на проекта) следната команда:

$ mvn clean install wildfly:deploy

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

[INFO] ------------------------------------------------------------------------ 
[INFO] BUILD SUCCESS 
[INFO] ------------------------------------------------------------------------ 
[INFO] Total time: 8.224 s

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

Тестване на helloworld

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

Ориз. 2. Оригинален Hello World от JBoss EAP.

Правене на промени

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

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

Изпълнете отново следната команда:

$ mvn clean install wildfly:deploy

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

Ориз. 3. Здравей Марко в JBoss EAP.

Върнете обратно внедряването на helloworld и изключете JBoss EAP

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

$ mvn clean install wildfly:undeploy

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

Надграждане на helloworld

Сега нека модернизираме оригиналното приложение helloworld.

Създайте нов клон

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

$ 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 е отговорен за опаковането на приложението и осигуряването на режим на разработка.
• Родният профил за създаване на изпълними файлове на приложения.

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

1. Издърпване на етикета от блока и го поставете над етикета . Тъй като в следващата стъпка ще премахнем блока , тогава трябва да запазите .
2. Премахване на блок , защото когато работи с Quarkus, това приложение вече няма да се нуждае от родителски pom от JBoss.
3. Добавяне на етикет и го поставете под етикета . Можете да посочите номера на версията, която искате.
4. Премахване на етикета , тъй като това приложение вече не е WAR, а обикновен JAR.
5. Променяме следните зависимости:
   1. Променете зависимостта javax.enterprise:cdi-api на io.quarkus:quarkus-arc, като премахнете предоставени , тъй като (според документите) това разширение на Quarkus осигурява инжектиране на CDI зависимости.
   2. Променете зависимостта org.jboss.spec.javax.servlet:jboss-servlet-api_4.0_spec на io.quarkus:quarkus-undertow, като премахнете предоставени , защото (според документите) това разширение на 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/): Това съдържа примерни файлове на Docker за режими native и jvm (заедно с файла .dockerignore).
• Папка Resources (в директорията src/main/): Това съдържа празен файл application.properties и примерна начална страница Quarkus index.html (вижте Стартиране на модернизирания helloworld за повече подробности).

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

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

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

$ ./mvnw compile quarkus:dev
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< org.jboss.eap.quickstarts:helloworld >----------------
[INFO] Building Quickstart: helloworld quarkus
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ helloworld ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 2 resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ helloworld ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- quarkus-maven-plugin:0.23.2:dev (default-cli) @ helloworld ---
Listening for transport dt_socket at address: 5005
INFO  [io.qua.dep.QuarkusAugmentor] Beginning quarkus augmentation
INFO  [org.jbo.threads] JBoss Threads version 3.0.0.Final
ERROR [io.qua.dev.DevModeMain] Failed to start quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkus.arc.deployment.ArcProcessor#validate threw an exception: javax.enterprise.inject.spi.DeploymentException: javax.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type org.jboss.as.quickstarts.helloworld.HelloService and qualifiers [@Default]
	- java member: org.jboss.as.quickstarts.helloworld.HelloWorldServlet#helloService
	- declared on 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)
Caused by: javax.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type org.jboss.as.quickstarts.helloworld.HelloService and qualifiers [@Default]
	- java member: org.jboss.as.quickstarts.helloworld.HelloWorldServlet#helloService
	- declared on 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 more

И така, не работи... Защо?

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

Време е да се върнете към документация и прочетете как работи в Quarkus Инжектират, и следователно Контексти и инжектиране на зависимости (CDI). Затова отворете ръководството за инжектиране на контексти и зависимости и в раздела Bean Discovery четем: „Клас bean, който няма анотация, дефинираща bean, не се търси.“

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

@ApplicationScoped
public class HelloService {

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

import javax.enterprise.context.ApplicationScoped;

Ако се съмнявате кой обхват трябва да се използва в случай, че изобщо не е указан за изходния компонент, прочетете документацията JSR 365: Контексти и инжектиране на зависимости за Java 2.0—обхват по подразбиране.

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

$ ./mvnw compile quarkus:dev
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< org.jboss.eap.quickstarts:helloworld >----------------
[INFO] Building Quickstart: helloworld quarkus
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ helloworld ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 2 resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ helloworld ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 2 source files to /home/mrizzi/git/forked/jboss-eap-quickstarts/helloworld/target/classes
[INFO]
[INFO] --- quarkus-maven-plugin:0.23.2:dev (default-cli) @ helloworld ---
Listening for transport dt_socket at address: 5005
INFO  [io.qua.dep.QuarkusAugmentor] (main) Beginning quarkus augmentation
INFO  [io.qua.dep.QuarkusAugmentor] (main) Quarkus augmentation completed in 576ms
INFO  [io.quarkus] (main) Quarkus 0.23.2 started in 1.083s. Listening on: http://0.0.0.0:8080
INFO  [io.quarkus] (main) Profile dev activated. Live Coding activated.
INFO  [io.quarkus] (main) Installed features: [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: Страницата 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) Changed source files detected, recompiling [/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 stopped in 0.003s
INFO  [io.qua.dep.QuarkusAugmentor] (vert.x-worker-thread-3) Beginning quarkus augmentation
INFO  [io.qua.dep.QuarkusAugmentor] (vert.x-worker-thread-3) Quarkus augmentation completed in 232ms
INFO  [io.quarkus] (vert.x-worker-thread-3) Quarkus 0.23.2 started in 0.257s. Listening on: http://0.0.0.0:8080
INFO  [io.quarkus] (vert.x-worker-thread-3) Profile dev activated. Live Coding activated.
INFO  [io.quarkus] (vert.x-worker-thread-3) Installed features: [cdi]
INFO  [io.qua.dev] (vert.x-worker-thread-3) Hot replace total time: 0.371s

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

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

$ ./mvnw clean package

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

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

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

Сега можем да стартираме JAR чрез стандартната java команда:

$ java -jar ./target/helloworld-<version>-runner.jar
INFO  [io.quarkus] (main) Quarkus 0.23.2 started in 0.673s. Listening on: http://0.0.0.0:8080
INFO  [io.quarkus] (main) Profile prod activated.
INFO  [io.quarkus] (main) Installed features: [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 (или по-скоро негова съкратена версия, съдържаща само това, което е необходимо за стартиране на приложението) и самото ни приложение.

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

$ ./mvnw package -Pnative

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

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

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

$ ./target/helloworld-<version>-runner
INFO  [io.quarkus] (main) Quarkus 0.23.2 started in 0.006s. Listening on: http://0.0.0.0:8080
INFO  [io.quarkus] (main) Profile prod activated.
INFO  [io.quarkus] (main) Installed features: [cdi]

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

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

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

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