Как Quarkus обединява MicroProfile и Spring

Здравейте на всички и ето ни с третия пост от серията за Quarkus!

При разработката на Java микросервиси често се смята, че Eclipse MicroProfile и Spring Boot е набор от отделни и независими API. По подразбиране разработчиците обикновено използват API, с които вече са свикнали, тъй като изучаването на нови фреймворкове и компоненти на изпълнение отнема много време. Днес ще опитаме да опростим усвояването на някои популярни MicroProfile API за Spring разработчици и ще покажем как да се използват едновременно Spring API и новите полезни възможности. Quarkus.

Ако разгледаме по-подробно, първо ще се запознаем с обхвата и детайлите на това как Quarkus поддържа Spring API, за да покажем на Spring разработчиците как могат да прилагат MicroProfile API в ежедневната си работа. След това ще разгледаме MicroProfile API, които ще бъдат полезни на Spring разработчиците при създаването на микросервиси.

Защо именно Quarkus? Първо, това е live coding, т.е. автоматично презареждане на всякакви промени в MicroProfile API, Spring API и други Java API, което се извършва с една команда: mvn quarkus:dev. На второ място, обектът в нашия пример сервиз Person (който се компилира от Spring API, MicroProfile и JPA в бинарен файл с помощта на нативен образ от GraalVM) стартира за само 0.055 секунди и заема около 90 MB в оперативната памет (RSS) на крайна точка на RESTful приложението. Освен това самата компилация се извършва с една команда: mvn package -Pnative.

Няма да се задълбочаваме в детайлите на MicroProfile, а просто ще се опитаме да помогнем на Spring разработчиците да разберат как да използват Spring API заедно с MicroProfile API в Quarkus.

Контейнери и Kubernetes

За да не натоварваме статията, ще разгледаме само високо ниво на поддръжка Kubernetes, тъй като е важно да се разбере. Quarkus се позиционира като Java стек за Kubernetes, той цели да минимизира разхода на памет и време за стартиране на Java приложения и услуги, и следователно да увеличи плътността на тяхното разполагане на хоста и да намали общите разходи.

Quarkus също поддържа автоматична генерация на ресурси за Kubernetes и предлага руководства забележки за разполагане на платформи Kubernetes и Red Hat OpenShift. Освен това, Quarkus автоматично генерира файлове Dockerfile.jvm (опаковане на JVM) и Dockerfile.native (опаковане на нативен бинарен файл), необходими за създаване на контейнери.

И накрая, ориентирайки се към Kubernetes като целевата среда за разгръщане, Quarkus не използва Java рамки, когато подобна функционалност се реализира на ниво самата платформа Kubernetes. В Таблица 1 е представена картата на функционалното съответствие между Kubernetes и типичните Java рамки, използвани от Spring разработчиците.

Таблица 1. Карта на функционалното съответствие между Java рамките и Kubernetes.

Функционалност
Традиционен Spring Boot
Kubernetes

Откриване на услуги
Eureka
DNS

Конфигурация
Spring Cloud Config
Config Maps / Secrets

Натоварване на баланс
Ribbon (на страната на клиента)
Service, Replication Controller (на страната на сървъра)

Компилация и стартиране на кода от примера

В тази статия се позоваваме на примерния проект, където API интерфейсите на Spring и MicroProfile се използват съвместно и дори този конкретен Java клас. Кодът от този пример може да бъде компилиран и стартиран от командния ред, подробности можете да намерите във файла README.md.

API интерфейсите на Spring Framework

Dependency Injection

Quarkus поддържа редица API интерфейси за контексти и инжектиране на зависимости (CDI) и API интерфейси за инжектиране на зависимости на Spring (Spring DI). Ако работите с MicroProfile, Java EE и Jakarta EE, вероятно вече сте запознати с CDI. От друга страна, разработчиците на Spring могат да използват Quarkus Extension за API на Spring DI за осигуряване на съвместимост с Spring DI. Примери за използване на поддържаните API за Spring DI са представени в Таблица 2.

В в проекта от нашия пример се използват и CDI, и инжектиране на зависимости на Spring. Допълнителна информация и примери по темата можете да намерите в ръководството на Quarkus, наречено Spring DI Guide.

Таблица 2. Примери за използване на поддържаните API интерфейси на Spring DI.

Поддържани функции на Spring DI
Примери

Инжектиране на конструктор

public PersonSpringController(
   PersonSpringRepository personRepository,  // инжектирано      
   PersonSpringMPService personService) {    // инжектирано
      this.personRepository = personRepository;
      this.personService = personService;
}

Инжектиране на поле
@Autowired
Стойност

@Autowired
@RestClient
SalutationRestClient salutationRestClient;

@Value("${fallbackSalutation}")
String fallbackSalutation;

Bean
@Configuration

@Configuration
public class AppConfiguration {
   @Bean(name = "capitalizeFunction")
   public StringFunction capitalizer() {
      return String::toUpperCase;
   }
}

Компонент

@Component("noopFunction")
public class NoOpSingleStringFunction implements StringFunction {
   @Override
   public String apply(String s) {
      return s;
   }
}

Услуга

@Service
public class MessageProducer {
   @Value("${greeting.message}")
   String message;

   public String getPrefix() {
      return message;
   }
}

Web Framework

Потребителите на MicroProfile ще се зарадват, че Quarkus поддържа JAX-RS, MicroProfile Rest Client, JSON-P и JSON-B като основна моделна платформа за уеб програмиране. Разработчиците на Spring също ще бъдат доволни от новата поддръжка на Spring Web API в Quarkus, особено интерфейсите, отговарящи за REST. Подобно на Spring DI, основната цел на поддръжката на Spring Web API е да позволи на разработчиците на Spring да използват API интерфейсите на Spring Web заедно с API интерфейсите на MicroProfile. Примери за използването на поддържаните Spring Web API са представени в таблица 3, а допълнителна информация и примери по темата могат да бъдат намерени в ръководството на Quarkus, наречено Spring Web Guide.

Таблица 3. Примери за използване на поддържаните API интерфейси на Spring Web.

Поддържани функции на Spring Web
Примери

@RestController
@RequestMapping

@RestController
@RequestMapping("/person")
public class PersonSpringController {
   ...
   ...
   ...
}

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping
@RequestParam
@RequestHeader
@MatrixVariable
@PathVariable
@CookieValue
@RequestBody
@ResponseStatus
@ExceptionHandler
@RestControllerAdvice (частично)

@GetMapping(path = "/greet/{id}",
   produces = "text/plain")
   public String greetPerson(
   @PathVariable(name = "id") long id) {
   ...
   ...
   ...
}

Spring Data JPA

Потребителите на MicroProfile също ще се зарадват, че Quarkus поддържа JPA с използването на Hibernate ORM. И за разработчиците на Spring има добри новини: Quarkus поддържа общоизвестни аннотации и типове на Spring Data JPA. Примери за използването на поддържаните API интерфейси на Spring Data JPA са представени в таблица 4.
В в проекта от нашия пример използват се API интерфейси на Spring Data JPA, а допълнителна информация е налична в ръководството на Quarkus, наречено Spring Data JPA Guide.

Таблица 4. Примери за използване на поддържаните API интерфейси на Spring Data JPA.

Поддържани функции на Spring Data JPA
Примери

CrudRepository

public interface PersonRepository
         extends JpaRepository,
                 PersonFragment {
   ...
}

Repository
JpaRepository
PagingAndSortingRepository

public class PersonRepository extends 

    Repository {

    Person save(Person entity);

    Optional findById(Person entity);
}

Резюме на репозиториите

public interface PersonRepository
         extends JpaRepository,
                 PersonFragment {
   ...
}

Методи за заявки по произход

public interface PersonRepository extends CrudRepository {

    List findByName(String name);
    
    Person findByNameBySsn(String ssn);
    
    Optional 
       findByNameBySsnIgnoreCase(String ssn);

    Boolean existsBookByYearOfBirthBetween(
            Integer start, Integer end);
}

Потребителски дефинирани заявки

public interface MovieRepository
         extends CrudRepository {

    Movie findFirstByOrderByDurationDesc();

    @Query("select m from Movie m where m.rating = ?1")
    Iterator findByRating(String rating);

    @Query("from Movie where title = ?1")
    Movie findByTitle(String title);
}

API интерфейси на MicroProfile

Отказоустойчивост (Fault tolerance)

Конструкциите за отказоустойчивост са изключително важни за предотвратяване на каскадни откази и за изграждане на надеждни микросервизни архитектури. Разработчиците на Spring вече от много години използват circuit-breakers за отказоустойчивост. Hystrix. Въпреки това, Hystrix отдавна не е обновяван, а MicroProfile Fault Tolerance активно се развива и вече има няколко години продуктивна употреба зад гърба си. Следователно, за повишаване на надеждността на услугите в Quarkus е препоръчително да се използват API интерфейсите на MicroProfile Fault Tolerance, примери за които са посочени в таблица 5. Допълнителни сведения за това можете да намерите в ръководството Quarkus. Fault Tolerance Guide.

Таблица 5. Примери за използване на поддържаните API интерфейси на MicroProfile Fault Tolerance.

Функции на MicroProfile Fault Tolerance
Описание
Примери

@Asynchronous

Изпълнение на логика в отделен поток

@Asynchronous
@Retry
public Future getSalutation() {
   ...
   return future;
}

@Bulkhead

Ограничаване на броя на едновременните заявки

@Bulkhead(5)
public void fiveConcurrent() {
   makeRemoteCall(); //...
}

@CircuitBreaker

Умерено управление на отказите и възстановяване след откази

@CircuitBreaker(delay=500   // milliseconds
   failureRatio = .75,
   requestVolumeThreshold = 20,
   successThreshold = 5)
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

@Fallback

Извикване на алтернативна логика при отказ

@Timeout(500) // milliseconds
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

public String fallback() {
   return "hello";
}

Retry

Повтор при отказ на заявката

@Retry(maxRetries=3)
public String getSalutation() {
   makeRemoteCall(); //...
}

Timeout

Контролно време за изчакване при отказ

@Timeout(value = 500)   // milliseconds
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

Проверка на услугите (Service Health)

Платформите Kubernetes следят за състоянието на контейнерите чрез специализирани услуги. За да може долната платформа да мониторира услугите, разработчиците на Spring обикновено използват конфигурируеми HealthIndicator и Spring Boot Actuator. В Quarkus това може да се направи чрез MicroProfile Health, което по подразбиране изпълнява проверка на работоспособността (liveness check), но може да бъде настроено и за едновременна проверка на работоспособността и готовността. Примери за използване на поддържаните MicroProfile Health API са посочени в таблица 6, а допълнителна информация е представена в ръководството Quarkus. Health Guide.

Таблица 6. Примери за използване на поддържаните API интерфейси на MicroProfile Health.

Функции на MicroProfile Health
Описание
Примери

@Liveness

Платформата извършва перезареждане на повредени контейнеризирани приложения.
Endpoint:
host:8080/health/live

@Liveness
public class MyHC implements HealthCheck {
  public HealthCheckResponse call() {

   ...
   return HealthCheckResponse
     .named("myHCProbe")
     .status(ready ? true:false)
     .withData("mydata", data)
     .build();  
}

@Readiness

Платформата няма да изпраща трафик към контейнеризирани приложения, когато те не са готови
Endpoint:
host:8080/health/ready

@Readiness
public class MyHC implements HealthCheck {
  public HealthCheckResponse call() {

   ...
   return HealthCheckResponse
     .named("myHCProbe")
     .status(live ? true:false)
     .withData("mydata", data)
     .build();  
}

Метрики

Приложенията предоставят метрики или за оперативни цели (за контрол на SLA-показатели за производителност), или за неоперативни (бизнес показатели на SLA). Разработчиците на Spring предоставят метрики с помощта на Spring Boot Actuator и Micrometer. От своя страна, Quarkus използва MicroProfile Metrics за предоставяне на основни метрики (JVM и операционна система), вендорски метрики (Quarkus) и метрики на приложенията. MicroProfile Metrics изисква реализацията да поддържа изходни формати JSON и OpenMetrics (Prometheus). Примери за използване на MicroProfile Metrics API са представени в таблица 7.

В в проекта от нашия пример MicroProfile Metrics се използват за предоставяне на метрики на приложението. Допълнителна информация може да се намери в ръководството на Quarkus Ръководство за метрики.

Таблица 7. Примери за използване на API интерфейси на MicroProfile Metrics.

Функции на MicroProfile Metrics
Описание
Примери

@Counted

Означава counter-счетчик, който отчитат броя на извикванията на анотирания обект

@Counted(name = "fallbackCounter", 
  displayName = "Fallback Counter", 
  description = "Fallback Counter")
public String salutationFallback() {
   return fallbackSalutation;
}

@ConcurrentGauge

Означава gauge-датчик, който отчитат броя на паралелните извиквания на анотирания обект

@ConcurrentGuage(
  name = "fallbackConcurrentGauge", 
  displayName="Fallback Concurrent", 
  description="Fallback Concurrent")
public String salutationFallback() {
   return fallbackSalutation;
}

@Gauge

Означава gauge-датчик, който мери стойността на анотирания обект

@Metered(name = "FallbackGauge",
   displayName="Fallback Gauge",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

@Metered

Означава meter-датчик, който следи честотата на извикванията на анотирания обект

@Metered(name = "MeteredFallback",
   displayName="Metered Fallback",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

Метрика

Анотация, съдържаща информация за метаданни, при получаване на заявка за въвеждане или производство на метрика

@Metric
@Metered(name = "MeteredFallback",
   displayName="Metered Fallback",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

Тайминг

Означава таймер, който следи продължителността на анотирания обект

@Timed(name = "TimedFallback",
   displayName="Timed Fallback",
   description="Fallback delay")
public String salutationFallback() {
   return fallbackSalutation;
}

Метрики крайни точки (Metrics Endpoints)

Метрики на приложения localhost:8080/metrics/application
Основни метрики localhost:8080/metrics/base
Метрики на доставчици localhost:8080/metrics/vendor
Всички метрики localhost:8080/metrics

Rest клиент MicroProfile

Микросервизите често предлагат RESTful крайни точки, за работа с които са необходими съответните клиентски API. За да използват RESTful крайни точки, разработчиците на Spring обикновено използват RestTemplate. Quarkus предлага API интерфейси MicroProfile Rest Client, примери за използване на които са предоставени в таблица 8.

В в проекта от нашия пример използването на RESTful крайни точки се осъществява чрез MicroProfile Rest Client. Допълнителни сведения и примери по темата могат да бъдат намерени в ръководството на Quarkus. Ръководство за Rest клиента.

Таблица 8. Примери на използване на API интерфейсите MicroProfile Rest Client.

Функции на MicroProfile Rest Client
Описание
Примери

@RegisterRestClient

Регистрира типизиран Java интерфейс като REST клиент

@RegisterRestClient
@Path("/")
public interface MyRestClient {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getSalutation();
}

@RestClient

Отбелязва внедряването на екземпляр от типизирания интерфейс REST клиент

@Autowired // or @Inject
@RestClient
MyRestClient restClient;

Извикване

Извиква REST крайна точка

System.out.println(
   restClient.getSalutation());

mp-rest/url

Задава REST крайна точка

application.properties:
org.example.MyRestClient/mp-rest/url=
   http://localhost:8081/myendpoint

Итог

В този блог, който ще бъде полезен главно на разработчиците на Spring, ние накратко разгледахме как да използваме API интерфейсите на Spring заедно с тези на MicroProfile в Quarkus, за да разработим Java микросервизи и след това да ги компилираме в роден двоичен код, който спестява стотици мегабайти оперативна памет и се стартира за секунди.

Както вече разбрахте, допълнителна информация относно поддръжката на API интерфейсите на Spring и MicroProfile, както и много друга полезна информация можете да намерите в ръководствата на Quarkus.

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