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

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

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

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

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

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

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

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

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

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

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

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

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

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

Балансировка на натоварването
Ribbon (на клиентска страна)
Служба, 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 за Spring DI API, за да осигурят съвместимост с Spring DI. Примери за използване на поддържаните Spring DI API са представени в таблица 2.

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

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

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

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

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

Инжектиране на поле
Autowired
Value

@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

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

   public String getPrefix() {
      return message;
   }
}

Уеб рамка

На потребителите на MicroProfile ще им хареса, че Quarkus поддържа JAX-RS, MicroProfile Rest Client, JSON-P и JSON-B като основен модел за уеб програмиране. Разработчиците на Spring ще бъдат приятно изненадани от наскорошната поддръжка на Spring Web API в Quarkus, по-специално интерфейсите, отговарящи за REST. Подобно на DI в Spring, основната цел на поддръжката на 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);
}

Repository Fragments

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-breaker-и за отказоустойчивост Hystrix. Въпреки това Hystrix отдавна не е актуализиран, а MicroProfile Fault Tolerance в момента активно се развива и вече има няколко години опит в продукцията. Затова, за повишаване на надеждността на услугите в Quarkus, се препоръчва да се използват API интерфейсите на MicroProfile Fault Tolerance, примери за тяхното използване са предоставени в таблица 5. Допълнителна информация относно това може да бъде намерена в ръководството на Quarkus Ръководство за отказоустойчивост.

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

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

@Asynchronous

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

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

@Bulkhead

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

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

@CircuitBreaker

Умна обработка на сблъсъци и възстановяване след грешки

@CircuitBreaker(delay=500   // милисекунди
   failureRatio = .75,
   requestVolumeThreshold = 20,
   successThreshold = 5)
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

@Fallback

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

@Timeout(500) // милисекунди
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

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

Retry

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

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

Timeout

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

@Timeout(value = 500 )   // милисекунди
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

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

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

Таблица 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

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

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

@ConcurrentGauge

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

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

@Gauge

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

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

@Metered

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

@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
Vendor метрики 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 Client.

Таблица 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, накратко разгледахме как в Quarkus да се използват API интерфейси на Spring заедно с API интерфейси на MicroProfile, за да се разработват Java микросервиси и след това да се компилират в нативен двоичен код, който спестява стотици мегабайти оперативна памет и се стартира за секунди.

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

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