Introdução

Neste tutorial, você aprenderá como desenvolver aplicações Java utilizando o Spring Boot, especificamente focando na construção de APIs RESTful. O Spring Boot é um dos frameworks mais populares para o desenvolvimento de aplicações Java, permitindo que desenvolvedores construam serviços eficientes e escaláveis com facilidade. Durante este guia, abordaremos a configuração inicial do projeto, a implementação de uma estrutura de dados utilizando JPA (Java Persistence API) e a gestão de dependências com Maven. Abordaremos também a criação de uma API que interage com um banco de dados em memória H2, cobrindo o ciclo completo de desenvolvimento, incluindo a criação de testes unitários e a utilização de ferramentas como Postman para testar a API. Ao final deste tutorial, você estará apto a criar e gerenciar sua própria API RESTful usando as práticas recomendadas do setor, aproveitando tudo o que o Spring Boot e a JPA têm a oferecer.

Etapas

  1. Configuração do Ambiente de Desenvolvimento

    Para começar, certifique-se de que você possui o JDK (Java Development Kit) e o Maven instalados. Utilize os comandos abaixo para verificar se as ferramentas estão corretamente instaladas. Caso contrário, siga as instruções nos sites oficiais.

    commands
    # Verifique as versões instaladas do JDK e do Maven
    java -version
    mvn -version

  2. Criação do Projeto Spring Boot

    Agora, utilizaremos o Spring Initializr para gerar um novo projeto Spring Boot. Selecione as seguintes opções: Project: Maven, Language: Java, Spring Boot: última versão estável, Packaging: Jar, Java: 11 ou superior. Adicione as dependências ‘Spring Web’, ‘Spring Data JPA’, e ‘H2 Database’. Após configurar, baixe o arquivo zip, extraia e abra o projeto na sua IDE favorita.

    pom.xml
    <?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>api-restful</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>api-restful</name>
  <description>API RESTful com Spring Boot</description>
  <properties>
    <java.version>11</java.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

  3. Configuração do Banco de Dados H2

    Para configurar o banco de dados H2, você precisa editar o arquivo `application.properties` e definir as propriedades para a conexão com o banco de dados, além de habilitar o console web para visualização dos dados.

    application.properties
    spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.hibernate.ddl-auto=update

  4. Criação da Entidade `Produto`

    Implemente a classe modelo `Produto`, que representará os produtos em nossa aplicação. Utilize anotações JPA para mapear a classe à tabela correspondente no banco de dados.

    Produto.java
    package com.example.apirestful.model;

import javax.persistence.*;

@Entity
@Table(name = "produtos")
public class Produto {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(nullable = false)
    private String nome;

    @Column(nullable = false)
    private Double preco;

    // Getters e Setters
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getNome() {
        return nome;
    }

    public void setNome(String nome) {
        this.nome = nome;
    }

    public Double getPreco() {
        return preco;
    }

    public void setPreco(Double preco) {
        this.preco = preco;
    }
}

  5. Criação do Repositório `ProdutoRepository`

    Implemente a interface `ProdutoRepository` que estende `JpaRepository`, fornecendo métodos CRUD para a entidade Produto.

    ProdutoRepository.java
    package com.example.apirestful.repository;

import com.example.apirestful.model.Produto;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface ProdutoRepository extends JpaRepository<Produto, Long> {
    // Métodos personalizados podem ser definidos aqui
}

  6. Implementação do Serviço `ProdutoService`

    Crie a classe `ProdutoService` que conterá a lógica de negócios e que utiliza o `ProdutoRepository` para interagir com o banco de dados.

    ProdutoService.java
    package com.example.apirestful.service;

import com.example.apirestful.model.Produto;
import com.example.apirestful.repository.ProdutoRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
public class ProdutoService {
    @Autowired
    private ProdutoRepository produtoRepository;

    public List<Produto> findAll() {
        return produtoRepository.findAll();
    }

    public Optional<Produto> findById(Long id) {
        return produtoRepository.findById(id);
    }

    public Produto save(Produto produto) {
        return produtoRepository.save(produto);
    }

    public Produto update(Long id, Produto produtoDetails) {
        Produto produto = produtoRepository.findById(id).orElseThrow(() -> new RuntimeException("Produto não encontrado"));
        produto.setNome(produtoDetails.getNome());
        produto.setPreco(produtoDetails.getPreco());
        return produtoRepository.save(produto);
    }

    public void deleteById(Long id) {
        produtoRepository.deleteById(id);
    }
}

  7. Implementação do Controlador `ProdutoController`

    Crie a classe `ProdutoController` para expor os endpoints da API, permitindo operações CRUD com os produtos.

    ProdutoController.java
    package com.example.apirestful.controller;

import com.example.apirestful.model.Produto;
import com.example.apirestful.service.ProdutoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/produtos")
public class ProdutoController {
    @Autowired
    private ProdutoService produtoService;

    @GetMapping
    public List<Produto> getAllProdutos() {
        return produtoService.findAll();
    }

    @GetMapping("/{id}")
    public ResponseEntity<Produto> getProdutoById(@PathVariable Long id) {
        return produtoService.findById(id)
                .map(ResponseEntity::ok)
                .orElse(ResponseEntity.notFound().build());
    }

    @PostMapping
    public Produto createProduto(@RequestBody Produto produto) {
        return produtoService.save(produto);
    }

    @PutMapping("/{id}")
    public ResponseEntity<Produto> updateProduto(@PathVariable Long id, @RequestBody Produto produtoDetails) {
        return ResponseEntity.ok(produtoService.update(id, produtoDetails));
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteProduto(@PathVariable Long id) {
        produtoService.deleteById(id);
        return ResponseEntity.noContent().build();
    }
}

  8. Implementação de Testes Unitários

    Crie a classe de testes `ProdutoServiceTest` para validar a lógica de negócios e operações CRUD da aplicação utilizando JUnit e Mockito.

    ProdutoServiceTest.java
    package com.example.apirestful.service;

import com.example.apirestful.model.Produto;
import com.example.apirestful.repository.ProdutoRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.util.Arrays;
import java.util.List;
import java.util.Optional;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

public class ProdutoServiceTest {
    @InjectMocks
    private ProdutoService produtoService;

    @Mock
    private ProdutoRepository produtoRepository;

    @BeforeEach
    public void init() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    public void testFindAll() {
        Produto produto1 = new Produto();
        produto1.setId(1L);
        produto1.setNome("Produto 1");
        produto1.setPreco(10.0);

        Produto produto2 = new Produto();
        produto2.setId(2L);
        produto2.setNome("Produto 2");
        produto2.setPreco(20.0);

        when(produtoRepository.findAll()).thenReturn(Arrays.asList(produto1, produto2));

        List<Produto> produtos = produtoService.findAll();
        assertEquals(2, produtos.size());
        verify(produtoRepository, times(1)).findAll();
    }

    // Testes adicionais para os métodos findById, save, update e deleteById
}

  9. Executando a Aplicação e Testes

    Para compilar e executar a aplicação, use o Maven. Após a inicialização, você pode testar os endpoints utilizando Postman ou cURL. Exemplos de comandos cURL para testar a API estão listados abaixo.

    commands
    # Compilar e executar a aplicação
    mvn spring-boot:run
    # Executar os testes unitários
    mvn test

    curl_examples
    # Listar todos os produtos
    curl -X GET http://localhost:8080/api/produtos
    # Criar um novo produto
    curl -X POST -H "Content-Type: application/json" -d '{"nome":"Novo Produto", "preco":99.99}' http://localhost:8080/api/produtos

Conclusão

Neste tutorial, você aprendeu a desenvolver uma API RESTful completa utilizando Spring Boot, indo da configuração do ambiente até a implementação de testes unitários. Cobrir todas essas etapas é fundamental para criar uma aplicação robusta e escalável. O conhecimento adquirido aqui pode ser a base para projetos mais complexos e a exploração de outras funcionalidades que o Spring Boot oferece. Com as ferramentas e práticas discutidas, você está pronto para levar suas habilidades em Java e desenvolvimento de APIs para o próximo nível.

Hashtags

#Java #SpringBoot #APIs #JPA #Maven #DesenvolvimentoDeSoftware