Создание нового микросервиса

Примечание

Для создания микросервиса используется Spring Boot

Результат описанных ниже инструкций можно посмотреть здесь: Citeck/ecos-webapp-sample

Для создания нового микросервиса Citeck нужно создать новый maven spring-boot проект и в pom.xml добавить в качестве родителя один из следующих pom файлов:

Артефакт	Описание
ru.citeck.ecos.webapp:ecos-webapp-spring-base-parent	Базовый родитель для spring-boot микросервисов, где требуется ручная настройка плагинов для сборки. Этот проект является родительским для всех остальных в этой таблице.
ru.citeck.ecos.webapp:ecos-webapp-spring-hibernate-parent	Родитель для spring-boot микросервисов, в которых предполагается использование hibernate. Настройка плагинов для сборки не требуется.
ru.citeck.ecos.webapp:ecos-webapp-spring-simple-parent	Родитель для spring-boot микросервисов без состояния или микросервисов, которые работают с БД через jdbc или ecos-data.

Актуальная версия родительских pom файлов: 3.3.3 (версия Java не ниже 21)

Все родительские pom файлы импортируют spring-boot зависимости, общие библиотеки Citeck и дополнительные библиотеки для тестирования (rabbitmq мок, zookeeper мок и тд.)

Пример настроенного pom файла:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>ru.citeck.ecos.webapp.sample</groupId>
    <artifactId>minimal-sample</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <parent>
        <groupId>ru.citeck.ecos.webapp</groupId>
        <artifactId>ecos-webapp-spring-simple-parent</artifactId>
        <version>3.3.3</version>
    </parent>

    <repositories>
        <repository>
            <id>citeck-public</id>
            <url>https://nexus.citeck.ru/repository/maven-public</url>
        </repository>
    </repositories>

</project>

Следующим шагом нужно создать главный класс для запуска spring-boot приложения по следующему пути:

src/main/java/ru/citeck/ecos/webapp/sample/minimal/MinimalWebAppSample.java

ru/citeck/ecos/webapp/sample/minimal - java пакет для нашего приложения, который может быть произвольным;
MinimalWebAppSample.java - файл с основным классом для запуска приложения. Может быть произвольным. Есть поддержка как Kotlin так и Java файлов.

Содержимое основного класса:

package ru.citeck.ecos.webapp.sample.minimal;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import ru.citeck.ecos.webapp.lib.spring.EcosSpringApplication;

@SpringBootApplication
@EnableDiscoveryClient
public class MinimalWebAppSample {

    public static final String NAME = "minimal-webapp";

    public static void main(String[] args) {
        new EcosSpringApplication(MinimalWebAppSample.class).run(args);
    }
}

где

public static final String NAME = "minimal-webapp"; - имя приложения (app name). Оно должно быть уникально в пределах всех остальных микросервисов. На этом имени основано много механизмов:
- Распределенный кэш hazelcast формируется между микросервисами с одним именем;
- Commands API работает на базе этого имени. При отправке команды мы указываем имя приложения и сообщение уходит в персональную очередь для этого приложения;
- Records API работает на базе этого имени. Имя приложения используется при поиске и указывается в sourceId до символа “/» (напр. emodel/person). Ссылки на сущности формируются с учетом имени приложения (напр. emodel/person@admin);
- Service discovery механизм работает на основе имени приложения.
EcosSpringApplication - наше расширение штатного SpringApplication. Для корректной работы микросервиса нужно использовать EcosSpringApplication.

Создать файл с настройками по пути (опционально):

src/main/resources/config/application.yml

Содержимое файла:

---
server:
  port: 8686 # указываем порт, на котором будет развернут микросервис

В этом файле можно разместить настройки приложения.

Добавить файл для настройки логирования:

src/main/resources/logback-spring.xml

со следующим содержимым:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <include resource="ecos/logback-base.xml" />
</configuration>

Для запуска микросервиса локально использовать команду:

mvn spring-boot:run

Или стандартные механизмы IDE для запуска spring-boot приложений

Далее описаны шаги для тестирования микросервиса

Создать файл с настройками логирования для тестов (опционально):

src/test/resources/logback-test.xml

с содержимым:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <include resource="ecos/logback-base.xml" />
</configuration>

Создать файл с настройками для автотестов (опционально):

src/main/resources/config/application-test.yml

В этом файле можно разместить настройки, которые будут использованы только во время авто-тестов.

Создать файл для тестирования микросервиса:

src/test/java/ru/citeck/ecos/webapp/sample/minimal/MinimalWebAppSampleTest.java

где

ru/citeck/ecos/webapp/sample/minimal- java пакет с тестами. Может быть любым, но крайне желательно размещать тесты в том же пакете или подпакетах, что и основной класс из п.2;
MinimalWebAppSampleTest.java - имя файла с тестами. Может быть любым.

Содержимое файла:

package ru.citeck.ecos.webapp.sample.minimal;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.boot.test.context.SpringBootTest;
import ru.citeck.ecos.webapp.lib.spring.test.extension.EcosSpringExtension;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;

@ExtendWith(EcosSpringExtension.class)
@SpringBootTest(classes = { MinimalWebAppSample.class })
public class MinimalWebAppSampleTest {

    @Test
    public void test() {
        assertThat(1 + 1).isEqualTo(2);
    }
}

где

EcosSpringExtension - расширения Citeck для SpringExtension, которое позволяет запускать в автотестах полноценный spring-context с in-memory БД (если для неё заданы настройки подключения в application.yml);
MinimalWebAppSample.class - класс из п.2

Для запуска автотестов нужно выполнить следующую команду:

mvn clean test

Для сборки docker образа с микросервисом выполнить следующую команду:

mvn clean package jib:dockerBuild -Djib.docker.image.tag=1.0.0-snapshot