How alanerochaa/quarkus-teste works
Projeto e Propósito
• Trata-se de uma aplicação backend Java usando o framework Quarkus.
• Fornece uma API REST para gerenciar entidades (Usuário, Tarefa, Notificação, etc.) seguindo a arquitetura em camadas (Controller → Service → Repository → Database).
Estrutura de Pastas (Pacotes)
• src/main/java/com/rail/response/system/controller
• src/main/java/com/rail/response/system/service
• src/main/java/com/rail/response/system/repository
• src/main/java/com/rail/response/system/model
• src/main/java/com/rail/response/system/response/system/DTOs
• src/main/java/com/rail/response/system/exception
• src/main/java/com/rail/response/system/security
• src/main/java/com/rail/response/system/util
• src/main/resources (configurações e scripts SQL)
Componentes Principais a Incluir no Diagrama UML
a. Pacotes (packages) que correspondem às pastas do projeto.
b. Classes dentro de cada pacote.
• controller: ContatoController, EquipeController, …, UsuarioController
• service: ContatoService, EquipeService, …, UsuarioService
• repository: ContatoRepository, EquipeRepository, …, UsuarioRepository
• model: BaseEntity, Contato, Equipe, …, Usuario
• DTOs: ContatoDTO, EquipeDTO, …, UsuarioDTO
• exception: BadRequestException, NotFoundException, ExceptionHandler, DTO de erro
• security: MyApiKeyFilter
• util: LoggerUtil, ValidatorUtils
c. Conector externo: Banco de dados SQL (baseado em application.properties e database_script.sql)
Relacionamentos e Interações
• Controllers → Services (dependência “uses”)
• Services → Repositories (dependência “uses”)
• Repositories → Model (mapeamento JPA)
• Controllers ↔ DTOs (conversão de payload)
• ExceptionHandlers (interceptam exceções lançadas em Controllers/Service)
• MyApiKeyFilter (filtra toda requisição HTTP antes de chegar nos Controllers)
• Database (entidade persistida pelos Repositories)
Padrões e Princípios Utilizados
• Arquitetura em camadas (Layered Architecture)
• Inversão de Dependência / Injeção de Dependência (Quarkus CDI)
• Pacotes bem isolados: controllers, services, repositories, models, DTOs, exceptions, util
• Tratamento global de exceções (ExceptionHandler)
• Filtro de segurança (API Key Filter)
Guia para Desenhar o Diagrama UML
b. Crie um pacote (package) para cada pasta do projeto.
c. Dentro de cada pacote, represente cada classe como um retângulo UML com nome e, opcionalmente, principais métodos/atributos.
d. Pinte ou estilize cada pacote com cores distintas (ex.: verde para controller, azul para service, roxo para repository, amarelo para model, laranja para DTOs, vermelho para exception, cinza para util, cinza-escuro para security).
e. Desenhe setas direcionais:
• Das classes Controller para as classes Service (“→” com rótulo «uses»)
• Das classes Service para as classes Repository
• Das classes Repository para as classes Model («maps to»)
• Associação de Controller ↔ DTO (pode ser nota “<request/response>”)
• Banco de dados como entidade externa conectada ao pacote repository («persists to»).
f. Inclua legendas: cores, tipos de relações (uses, maps to, filters).
g. Adicione um pequeno bloco para “Resources” indicando application.properties, log4j2.xml e scripts SQL como artefatos de configuração.
Detalhamento Essencial
• Cada classe nomeada dentro de seu pacote
• Dependências entre camadas bem evidentes
• Componente externo “Database” separado
• Componente “MyApiKeyFilter” interceptando requisIções
• Blocos de exceção mostrando as handlers globais
Com esses passos, você obterá um diagrama UML simples, porém completo, que reflete todas as pastas e classes do projeto Quarkus e a interação entre elas.