Как Quarkus съчетава MicroProfile и Spring

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

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

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

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

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

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

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

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

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

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

функционален
Традиционен пролетен ботуш
Kubernetes

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

Конфигурация
Spring Cloud Config
Конфигуриране на карти/тайни

Балансиране на натоварването
Лента (от страната на клиента)
Услуга, контролер за репликация (от страната на сървъра)

Компилиране и изпълнение на кода от примера

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

API на Spring Framework

Инжектиране на зависимост

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

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

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

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

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

public PersonSpringController(
   PersonSpringRepository personRepository,  // injected      
   PersonSpringMPService personService) {    // injected
      this.personRepository = personRepository;
      this.personService = personService;
}

Полева инжекция
Автоматично окабеляване
Стойност

@Autowired
@RestClient
SalutationRestClient salutationRestClient;

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

Боб
@ Конфигурация

@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;
   }
}

Уеб рамка

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

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

Поддържани пролетни уеб функции
Примеры

@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) {
   ...
   ...
   ...
}

Пролетни данни JPA

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

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

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

CrudRepository

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

хранилище
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

Толерантност към грешки

Конструкциите за толерантност към грешки са много важни за предотвратяване на каскадни повреди и създаване на надеждни микросервизни архитектури. Разработчиците на Spring използват прекъсвачи за отказоустойчивост от много години. Хистрикс. Hystrix обаче не е актуализиран от дълго време, но MicroProfile's Fault Tolerance вече се развива активно и има няколко години производствена употреба зад гърба си. Ето защо, за да се подобри надеждността на услугите в Quarkus, се препоръчва да се използват API за толерантност към грешки на MicroProfile, примери за които са използвани в таблица 5. За повече информация относно това вижте ръководството на Quarkus Ръководство за толерантност към грешки.

Таблица 5. Примери за използване на поддържани API за толерантност към грешки на MicroProfile.

Функции за устойчивост на грешки на MicroProfile
описание
Примеры

@Асинхронно

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

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

@Преграда

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

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

@Прекъсвач

Интелигентно справяне с повреди и възстановяване от повреди

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

@резервен

Извикване на алтернативна логика в случай на повреда

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

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

Опитайте отново

Повторен опит при неуспешна заявка

@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, който по подразбиране извършва проверка на жизнеспособността, но може да бъде конфигуриран да проверява едновременно жизнеспособността и готовността. Примери за това как да използвате поддържаните API на MicroProfile Health са предоставени в таблица 6, а допълнителна информация е предоставена в ръководството на Quarkus Здравен наръчник.

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

Характеристики на MicroProfile Health
описание
Примеры

@Живост

Платформата рестартира неуспешни контейнеризирани приложения
крайна точка:
хост:8080/здраве/на живо

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

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

@Готовност

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

@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). Примери за използване на API на MicroProfile Metrics са дадени в таблица 7.

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

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

Характеристики на показателите на MicroProfile
описание
Примеры

@Преброено

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

@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

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

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

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

Метрики на приложението Localhost:8080/метрика/приложение
Основни показатели Localhost:8080/метрика/база
Показатели на доставчика Localhost:8080/метрика/доставчик
Всички показатели Localhost:8080/метрика

MicroProfile Rest Client

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

В проект от нашия пример използването на RESTful крайни точки се извършва с помощта на MicroProfile Rest Client. Повече информация и примери по тази тема можете да намерите в ръководството на Quarkus Rest Client Guide.

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

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

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