Porjeto Java com Spring Boot, Jpa/Hibernate

Sobre o projeto

Ainda em andamento. Esse é uma projeto web services, com Spring Boot, JPA/Hibernate e Heroku construída em um dos cusros do professor Dr.Nelio Alves DevSuperior.

Futuramente será implementado testes unitários e uma descrição detalhada de cada parte do projeto.

Objetivos

• Criar projeto Spring Boot Java
• Implementar modelo de domínio
• Estruturar camadas lógicas: resource, service, repository
• Configurar banco de dados
• Povoar o banco de dados
• CRUD - Create, Retrieve, Update, Delete
• Tratamento de exceções

Modelo conceitual

Tecnologias Backend utilizadas

• Java
• Spring Boot
• JPA / Hibernate
• Maven
• Hekoku
• PostgreSQL
• Postman
• H2 Database

Detalhes do código

Na criação de entidades e recursos, segui os seguintes passos:

• Atributos básicos, Ex.: Id, Nome.
• Associações (instanciando as coleções)
• Construtores
• Getters & Setters (Coleções: somente o get)
• hashCode & equals
• Serializable

Para a camada de repositórios apenas extendi o org.springframework.data.jpa.repository.JpaRepository para cada serviço e a classe OrdemItem.

Quem irá ter acesso ao repositório e manter a lógica de negócio é a camada de serviço, que, por sua vez, é chamada na camada de recursos. Os recursos recebem a requisição, enviam pra camada de serviço que processa ou envia para o repositório, dai então o resultado é retornado para a camada de recursos e enviada de volta para a aplicação.

Na classe TestConfig na pasta Config, está o povoamento do banco de dados para o profile de test.

Como executar o projeto

Pré-requisitos

• Java 17
• Postgresql
• Postman
• Heroku
• Git bash

# clonar repositório
git clone git@github.com:BotRajj/workshop-springboot3-jpa.git

Profiles

Nessa aplicação, utilizamos dois bancos de dados, H2 database (para o ambiente de testes) e o Postgresql (para o desenvolvimento, na máquina local, e de produção, com um servidor rodando no Heroku). O profile pode ser alterados no arquivo application.properties, campo:

spring.profiles.active= test/prod/dev

Test

Utilizei o banco de dados H2, que não persiste os dados após a interrução da aplicação. A vizualição do banco de dados só é possível após a execução da aplicação e no caminho no navegador http://localhost:8080/h2-console. Os campos que aparecerão devem ser preenchidos de acordo com o arquivo application-test.properties.

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=sa
spring.datasource.password=

Dev

Com o banco de dados Postgresql, os dados persistem após a interrupção da aplicação. Antes da execução, crie um database no Postgresql com o nome "spring-jpa-course". Altere os campos username e password no arquivo application-dev.properties de acordo com os do seu Postgresql.

spring.datasource.url=jdbc:postgresql://localhost:5432/spring-jpa-course
spring.datasource.username=postgres
spring.datasource.password=12345678

Prod

Já na implementação Heroku, uma hospedagem paga que os dados serão enviados para um deploy online, você precisa criar um app na plataforma e adicionar no dashbord o Postgres.

• Faça o login no Heroku
• Crie o app, na opção new -> create app
• Provisionando PostgreSQL
  • App dashboard -> Resources
  • Procure "postgres" -> Selecione "Heroku Postgres"

Após isso, na aba deploy do app, estará disponível o comando que será utilizado para fazer o doploy utilizando git, algo como:

$ git heroku git:remote -a nome-do-servidor

Ao final será disponibilizado um link para as requisições.

End points:

Utilizando o Postman, seguimos para as requisições.

Esse projeto já está implementado no Heroku, sendo possível fazer as requisições com o caminho:

• https://coure-javasb3-e46136a3d1e0.herokuapp.com

Exemplo: https://coure-javasb3-e46136a3d1e0.herokuapp.com/endpoint

Ou utilize o caminho da sua implementação, caso já tenha.

E para execução local, os profile test e dev utiliza o caminho padrão:

• http://localhost:8080

Exemplo: http://localhost:8080/endpoint

Retornando todos os recursos.

/users, /product, /order, /category

Enviando com o método GET, essa requisição retorna todos os recurso de cada.

Retornando um recurso específico

/users/id, /product/id, /order/id, category/id

Enviando com o método GET, essa requisição retorna apenas um recurso espeficicado.

No caso do recurso não encontrado, o tratamento de exceções irá retorna 404 - Not found, a mensagem "Resource not found. Id + id" e um objeto de exceção manualmente tratado.

Classes envolvidas no tratamento de exceções

• services.exceptions.ResourceNotFoundException
• resources.exceptions.StandardError
• resources.exceptions.ResourceExceptionHandler
• ClasseServiceDoRecurso

Criando um recurso

###/Users

Para inserção de usuários, com o método POST e no Body, subaba raw, formato JSON, enviamos os seguintes campos para inserção. Nessa requisição o esperado é o 201 Created, indicando que foi criado com sucesso.

{
"name": "Nome",
"email": "Email@email.com",
"phone": "1234-1234",
"password": "Senha"
}

Será implementada a criação dos demais recursos.

Deletando um recurso

###/Users/Id

Para deletação de usuários, com o método DELETE, essa requisição irá deletar o usuário espeficiado. Nessa requisição o esperado são os retornos:

• 204 No Content, indicando que foi possível a deleção do usuário.
• 400 Bad Request, não sendo possível a deleção por conta da integridade referencial ou outro problema.

No caso do recurso não encontrado, o tratamento de exceções irá retorna 404 - Not found e um objeto de exceção manualmente tratado.

Classes envolvidas

• services.exceptions.DatabaseException
• ResourceExceptionHandler
• UserService
  • EmptyResultDataAccessException
  • DataIntegrityViolationException

Será implementada a deleção dos demais recursos.

Atualizando um recurso

/Users Para atualização de usuários, com o método PUT e no Body, subaba raw, formato JSON, enviamos os seguintes campos para atualização. Nessa requisição o esperado é o 200 OK, onde foi possível a atualização do usuário.

{
"name": "Nome",
"email": "Email@email.com",
"phone": "1234-1234"
}

No caso do recurso não encontrado, o tratamento de exceções irá retorna 404 - Not found e um objeto de exceção manualmente tratado.

Classes envolvidas

• UserService
• UserResource

Será implementada a atualização dos demais recursos.

Autor

Vitor Silva Machado

https://www.linkedin.com/in/vitor-silva-0a23302a1/