search

rfasioli / SpringBootstrapApplication

Aplicação com exemplos do spring
0 stars 0 forks source link

readme

Bootstrap Application

Aplicação bootstrap para implementações básicas do Spring boot. Seu objetivo é ser uma referência para estudo de implementações e boas práticas.

Dependências

Dependência Versão
Java 21
Kotlin 1.9.22
Spring Boot 3.3
Spring Cloud 2023.0.1

Integrações

Software Versão Portas Observações
PostgreSQL 11.3 5432 user/pass: admin/root
PGAdmin 4.7 5050 user/pass: admin@admin.com/root
RabbitMQ 3.8.14 5672
15672		 user/pass: admin/root
Wiremock 2.32.0 8082

Estrutura do projeto

Este projeto apresenta uma aplicação Bootstrap consumindo serviços externos, mockados por uma aplicação em wiremock.

C4Context
    Person(customerA, "Usuário", "Um usuário do sistema.")
    System(SystemBootstrap, "Spring Bootstrap App", "Implementações básicas do Spring boot.")
    System_Ext(SystemWiremock, "Wiremock App", "Mock para serviços externos.")
    Rel(customerA, SystemBootstrap, "Uses")
    Rel(SystemBootstrap, SystemWiremock, "", "Rest API")

Sendo um projeto multi-módulos que contempla duas aplicações de um mesmo contexto. Os módulos são:

C4Container
Person(customerA, "Usuário", "Um usuário do sistema.")

    Container_Boundary(c1, "Spring Bootstrap App") {
        Container(api, "BootstrapAPI", "Kotlin, Springboot", "Atende requisições rest do sistema")
        ContainerQueue(rabbit, "Queues", "RabbitMQ", "Filas para processamento assincrono")
        Container(messaging, "Web Application", "Kotlin, Springboot", "Processa mensagens assincronas do sistema")
        ContainerDb(database, "Database", "Postgres Database", "Armazena informações do sistema")
    }

    System_Ext(SystemWiremock, "Wiremock App", "Mock para serviços externos.")

    Rel(customerA, api, "Requisição da API [REST]")
    Rel(api, database, "Manipula dados [Spring Data]")
    Rel(api, SystemWiremock, "Requisição da API [REST]")
    Rel(api, rabbit, "Publica Evento [Spring Cloud]")
    Rel_Back(rabbit, messaging, "Consome Evento [Spring Cloud]")
    Rel(messaging, SystemWiremock, "Requisição da API [REST]")
    Rel(messaging, database, "Manipula dados [Spring Data]")

Cada módulo tem seus pacotes representando a estrutura da arquitetura hexagonal:

Arquitetura Hexagonal

Configurando o ambiente

Após baixar o repositório, você pode configurar o ambiente utilizando o SDKMan!, caso não tenha instalado basta seguir as instruções em SDKMan Installation.

sdk env install

Dica: você também pode habilitar o sdkman_auto_env=true editando as configurações pelo comando sdk config. Isso fará com que o ambiente seja configurado automaticamente ao entrar em uma pasta que contenha o arquivo .sdkmanrc.

para saber mais sobre como utilizar o SDKMan! veja seu guia de uso.

Desenvolvendo a aplicação localmente

Executando o ambiente localmente

Para execução do sistema em ambiente local, utilizamos containeres docker estes contêineres podem ser iniciados pelo docker-compose, configurado na raiz deste projeto.

# configurando ambiente docker e executando contêineres
docker-compose up -d

# iniciando contêineres (necessário ter configurado os contêineres anteriormente)
docker-compose start

# parando contêineres
docker-compose stop

# parando reiniciando
docker-compose restart

# removendo componentes configurados pelo compose
docker-compose down

Configurando o PGAdmin

Para configurar o PGAdmin, primeiro você precisará obter o endereço ip que o postgres está sendo executado, para isso digite o comando:

docker inspect $(docker ps -f name=bootstrap_postgres -q) | grep IPAddress

Tendo como resultado algo similiar:

resultado

Com este endereço, basta ir para a página principal do PGAdmin, clicar em "Add New Server" e configurar os dados da conexão utilizando o ip encontrado pelo comando anterior: Configuração PGAdmin

Db Migration

A criação da estrutura do banco de dados é feita pelo Flyway Migrate. Para executar o migration dos scripts basta executar o comando:

DB_URL=jdbc:postgresql://localhost:5432/postgres DB_USER=admin DB_PASSWORD=root ./gradlew flywayMigrate

Executando a aplicação

# Executar módulo API
./gradlew api:bootRun

Imagem docker

### Gerar imagem
./gradlew docker

### Executar
docker run -p 8080:8080 -it bootstrap

Referências