Упражнение. Создание приложения Quarkus

10 мин

В этом уроке вы создадите базовое приложение Quarkus. Вы используете Maven для загрузки приложения и интегрированной среды разработки (IDE) для редактирования кода. Используйте терминал для запуска кода. Вы используете Docker для запуска локальной базы данных PostgreSQL, чтобы запустить и протестировать приложение локально.

Создание приложения Quarkus с помощью Maven

Существует несколько способов создания структуры проекта Quarkus. Вы можете использовать веб-интерфейс Quarkus, плагин IDE или плагин Quarkus Maven. Давайте используем плагин Maven для создания структуры проекта.

Вы создаете приложение с несколькими зависимостями:

Зависимость resteasy для предоставления конечной точки REST
Зависимость jackson для сериализации и десериализации JSON
Зависимость hibernate для взаимодействия с базой данных
Зависимость postgresql для подключения к базе данных PostgreSQL
Зависимость docker для создания образа Docker

Вам не нужно указывать зависимости Azure, так как сначала вы запускаете своё приложение локально, а затем разворачиваете его контейнерную версию в Azure Container Apps.

В командной строке создайте приложение to-do:

mvn -U io.quarkus:quarkus-maven-plugin:3.19.0:create \
    -DplatformVersion=3.18.4 \
    -DprojectGroupId=com.example.demo \
    -DprojectArtifactId=todo \
    -DclassName="com.example.demo.TodoResource" \
    -Dpath="/api/todos" \
    -DjavaVersion=17 \
    -Dextensions="resteasy-jackson, hibernate-orm-panache, jdbc-postgresql, docker"

Эта команда создает проект Quarkus. Он создает структуру каталогов Maven (src/main/java для исходного кода и src/test/java для тестов). Создаются несколько классов Java, несколько тестов и несколько Docker-файлов. Он также создает файлpom.xml со всеми необходимыми зависимостями (Hibernate, RESTEasy, Джексон, PostgreSQL и Docker):

  <dependencies>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-hibernate-orm-panache</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-resteasy-jackson</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-jdbc-postgresql</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-container-image-docker</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-arc</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-hibernate-orm</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-resteasy</artifactId>
    </dependency>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-junit5</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>io.rest-assured</groupId>
      <artifactId>rest-assured</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

Заметка

Все зависимости в файлеpom.xml определяются в спецификации BOM Quarkus io.quarkus.platform:quarkus-bom.

Код приложения

Затем переименуйте созданный класс MyEntity.java на Todo.java (расположен в той же папке, что и файл TodoResource.java ). Замените существующий код следующим кодом Java. Он использует API сохраняемости Java (jakarta.persistence.* пакет) для хранения и получения данных с сервера PostgreSQL. Он также использует Hibernate ORM с Panache (наследуя от io.quarkus.hibernate.orm.panache.PanacheEntity) для упрощения слоя сохраняемости.

Для сопоставления объекта Java @Entity непосредственно с таблицей PostgreSQL Todo используется сущность JPA (Todo). Затем конечная точка REST TodoResource создает новый класс сущности Todo и сохраняет его. Этот класс представляет собой модель домена, сопоставленную с таблицей Todo. Таблица автоматически создается JPA.

Расширение PanacheEntity позволяет использовать ряд универсальных методов создания, чтения, обновления и удаления (CRUD) для вашего типа. Таким образом, вы можете выполнять такие действия, как сохранение и удаление объектов Todo только в одной строке кода Java.

Добавьте следующий код в сущность Todo:

package com.example.demo;

import io.quarkus.hibernate.orm.panache.PanacheEntity;

import jakarta.persistence.Entity;
import java.time.Instant;

@Entity
public class Todo extends PanacheEntity {

    public String description;

    public String details;

    public boolean done;

    public Instant createdAt = Instant.now();

    @Override
    public String toString() {
        return "Todo{" +
                "id=" + id + '\'' +
                ", description='" + description + '\'' +
                ", details='" + details + '\'' +
                ", done=" + done +
                ", createdAt=" + createdAt +
                '}';
    }
}

Чтобы управлять этим классом, обновите TodoResource, чтобы опубликовать интерфейсы REST для хранения и извлечения данных с помощью ПРОТОКОЛА HTTP. Откройте класс TodoResource и замените код следующим образом:

package com.example.demo;

import jakarta.inject.Inject;
import jakarta.transaction.Transactional;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriBuilder;
import jakarta.ws.rs.core.UriInfo;
import org.jboss.logging.Logger;

import java.util.List;

@Path("/api/todos")
@Consumes(APPLICATION_JSON)
@Produces(APPLICATION_JSON)
public class TodoResource {

    @Inject
    Logger logger;

    @Inject
    UriInfo uriInfo;

    @POST
    @Transactional
    public Response createTodo(Todo todo) {
        logger.info("Creating todo: " + todo);
        Todo.persist(todo);
        UriBuilder uriBuilder = uriInfo.getAbsolutePathBuilder().path(todo.id.toString());
        return Response.created(uriBuilder.build()).entity(todo).build();
    }

    @GET
    public List<Todo> getTodos() {
        logger.info("Getting all todos");
        return Todo.listAll();
    }
}

Запуск приложения

При запуске приложения в режиме разработки Docker должен быть запущен. Это связано с тем, что Quarkus обнаруживает, что требуется база данных PostgreSQL (из-за зависимости quarkus-jdbc-postgresql PostgreSQL, объявленной в файлеpom.xml ), загружает образ Docker PostgreSQL и запускает контейнер с базой данных. Затем он автоматически создает таблицу Todo в базе данных.

Убедитесь, что Docker работает локально на компьютере и запускает приложение to-do с помощью следующей команды:

cd todo
./mvnw quarkus:dev    # On Mac or Linux
mvnw.cmd quarkus:dev  # On Windows

Приложение Quarkus должно запускаться и подключаться к базе данных. Вы увидите следующие выходные данные:

2025-02-28 08:38:33,418 INFO  [io.qua.dat.dep.dev.DevServicesDatasourceProcessor] (build-28) Dev Services for default datasource (postgresql) started - container ID is ce37977203b0
2025-02-28 08:38:33,421 INFO  [io.qua.hib.orm.dep.dev.HibernateOrmDevServicesProcessor] (build-6) Setting quarkus.hibernate-orm.database.generation=drop-and-create to initialize Dev Services managed database
__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
2025-02-28 08:38:35,278 INFO  [io.quarkus] (Quarkus Main Thread) todo 1.0.0-SNAPSHOT on JVM (powered by Quarkus 3.18.4) started in 5.367s. Listening on: http://localhost:8080

2025-02-28 08:38:35,280 INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
2025-02-28 08:38:35,280 INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [agroal, cdi, hibernate-orm, hibernate-orm-panache, jdbc-postgresql, narayana-jta, resteasy, resteasy-jackson, smallrye-context-propagation, vertx]

--
Tests paused
Press [e] to edit command line args (currently ''), [r] to resume testing, [o] Toggle test output, [:] for the terminal, [h] for more options>

Для тестирования приложения можно использовать cURL.

В отдельном терминале создайте новый элемент to-do в базе данных с помощью следующей команды. Вы увидите журнал в консоли Quarkus:

curl --header "Content-Type: application/json" \
    --request POST \
    --data '{"description":"Take Quarkus MS Learn","details":"Take the MS Learn on deploying Quarkus to Azure Container Apps","done": "true"}' \
    http://127.0.0.1:8080/api/todos

Эта команда должна возвращать созданный элемент (с идентификатором):

{"id":1,"description":"Take Quarkus MS Learn","details":"Take the MS Learn on deploying Quarkus to Azure Container Apps","done":true,"createdAt":"2025-02-26T07:27:30.093447Z"}

Создайте вторую to-do с помощью следующей команды cURL:

curl --header "Content-Type: application/json" \
    --request POST \
    --data '{"description":"Take Azure Container Apps MS Learn","details":"Take the ACA Learn module","done": "false"}' \
    http://127.0.0.1:8080/api/todos

Затем получите данные с помощью нового запроса cURL:

curl http://127.0.0.1:8080/api/todos

Эта команда возвращает список to-do элементов, включая созданные элементы:

[ 
  {"id":1,"description":"Take Quarkus MS Learn","details":"Take the MS Learn on deploying Quarkus to Azure Container Apps","done":true},
  {"id":2,"description":"Take Azure Container Apps MS Learn","details":"Take the ACA Learn module","done":false}
]

Тестирование приложения

Для тестирования приложения можно использовать существующий класс TodoResourceTest. Он должен протестировать конечную точку REST. Для тестирования конечной точки используется RESTAssured. Замените код в классе TodoResourceTest следующим кодом:

package com.example.demo;

import io.quarkus.test.junit.QuarkusTest;
import static io.restassured.RestAssured.given;
import static jakarta.ws.rs.core.HttpHeaders.CONTENT_TYPE;
import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
import org.junit.jupiter.api.Test;

@QuarkusTest
class TodoResourceTest {

    @Test
    void shouldGetAllTodos() {
        given()
                .when().get("/api/todos")
                .then()
                .statusCode(200);
    }

    @Test
    void shouldCreateATodo() {
        Todo todo = new Todo();
        todo.description = "Take Quarkus MS Learn";
        todo.details = "Take the MS Learn on deploying Quarkus to Azure Container Apps";
        todo.done = true;

        given().body(todo)
                .header(CONTENT_TYPE, APPLICATION_JSON)
                .when().post("/api/todos")
                .then()
                .statusCode(201);
    }
}

При тестировании приложения Docker Desktop необходимо запустить, так как Quarkus обнаруживает, что для тестирования требуется база данных PostgreSQL. Протестируйте приложение с помощью этой команды:

./mvnw clean test    # On Mac or Linux
mvnw.cmd clean test  # On Windows

Вы увидите выходные данные, которые выглядят примерно так:

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.example.demo.TodoResourceTest
[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

Упражнение. Создание приложения Quarkus

Создание приложения Quarkus с помощью Maven

Код приложения

Запуск приложения

Тестирование приложения

Обратная связь