PROJETO CRIADO PARA FINS DE ESTUDO 📒

Este projeto, desenvolvido no decorrer de um grupo de estudos, tem como objetivo demonstrar alguns conceitos e tecnologias que eventualmente irão auxiliar na implementação do desafio proposto.

As tecnologias apresentadas aqui são direcionadas ao Java e Spring Framework.

Não estão sendo abordadas melhores práticas de desenvolvimento ou o aprofundamento das tecnologias e conceitos sendo recomendado o estudo e prática dos tópicos abordados.

E-commerce 🚚

Desafio Proposto 🕹

O desafio consiste, com base em um escopo definido parcialmente (incompleto), na criação de um sistema E-commerce que deverá ser corrigido, caso haja necessidade, e evoluído a critério da pessoa que está implementando. Avalie também a necessidade de construção de outros Microservices, além dos mapeados aqui.

Também fica a critério a escolha das tecnologias e arquitetura que serão utilizadas.

Contextualização do Projeto 📚

---

• Sistema de E-commerce responsável pelo cadastro de vestuário, venda online e entrega.

🔎 Qual tipo de vestuário?

---

https://pt.wikipedia.org/wiki/Categoria:Vestu%C3%A1rio

Resposta: camisetas.

• Sistema de E-commerce responsável pelo cadastro de camisetas, venda online e entrega.

🔎 Qualquer pessoa pode comprar?

---

Resposta: somente usuários cadastrados no sistema.

• Sistema de E-commerce responsável pelo cadastro de camisetas, venda online para usuários cadastrados e entrega.

🔎 Delimitação do Contexto

---

• Produto
• Venda
• Usuário
• Entrega

🔎 Linguagem Ubíqua x Técnica

---

Representação do Negócio

• O sistema deverá suportar as operações de inserção, consulta, atualização e remoção de camisetas
• Será possível realizar a consulta de camisetas por modelo
• Será possível realizar a consulta camisetas por valor
• Será possível realizar a consulta camisetas por cor
• Será possível realizar a consulta camisetas por tamanho

Representação Técnica

• CRUD (Create, Read, Update e Delete) de venda de camisetas
• Endpoint de consulta de camisetas por modelo
• Endpoint de consulta de camisetas por valor
• Endpoint de consulta de camisetas por cor
• Endpoint de consulta de camisetas por tamanho

📁 Requisitos Funcionais

---

💻 Cadastro de Produto

CREATE

• Para criação de um produto deverá obrigatoriamente ser informado:
  • Nome
  • Valor
  • Nome da cor
  • Modelagem
    • Modelos disponíveis:
      • Masculina Gola Olímpica
      • Feminina Gola U
      • Feminina Gola Olímpica
  • Tamanho
    • Tamanhos disponíveis:
      • P
      • M
      • G
      • GG
      • 2GG
      • 3GG
      • 4GG
  • Descrição do produto (campo livre)
  • Total

Regras de Negócio

• Não deverão existir cores com o mesmo nome
• O total de cada produto em estoque não deverá ultrapassar 100 unidades por modelo
• O total dos produtos disponível deverá ser atualizado mediante vendas efetivadas

Critério de Aceite

• O produto deverá ser inserido no Banco de Dados de acordo com as regras de negócio

Bônus

• Adicionar campo livre para que o usuário avalie o produto assim que a venda for entregue
• O campo de avaliação deverá constar na consulta de produtos

Implementação

• Crie um Microservice de Produto com o endpoint correspondente (CREATE)

Sugestão

• Adicionar novas regras de negócio
• Identifique a necessidade de implementação das demais operações de CRUD

💻 Cadastro de Usuário

CREATE

• Para cadastro de um usuário deverá obrigatoriamente ser informado:
  • Nome completo
  • Data de nascimento
  • RG
  • CPF
  • CEP
  • Número da residência
  • Telefone celular
  • E-mail

Regras de Negócio

• Não será permitido o cadastro de um usuário menor de 18 anos
• RG e CPF devem ser números válidos e únicos por usuário
• O E-mail informado deverá ser válido e único por usuário
• Se ao informar o CEP e caso o endereço (logradouro, bairro, cidade) não seja localizado na base externa o registro deverá ser atualizado manualmente

Critério de Aceite

• O usuário deverá ser inserido no Banco de Dados de acordo com as regras de negócio

READ

• Consulta por nome
• Consulta por e-mail
• Consulta por nome e e-mail
• Consulta por endereço

Regras de Negócio

• RFG1 (Requisito Funcional Geral)

Implementação

• Crie um Microservice de Usuário com os endpoints correspondentes (CREATE / READ)

Sugestão

• Adicionar novas regras de negócio
• Identifique a necessidade de implementação das demais operações de CRUD

💻 Cadastro de Venda

CREATE

• Para criação de uma venda obrigatoriamente deverá ser informado:
  • Código do usuário
  • Produto
    • Código
    • Modelo
    • Tamanho
    • Total de unidades

Regras de Negócio

• A quantidade vendida não poderá ultrapassar o total de 50 unidades de um mesmo código de produto por usuário na mesma venda
• Deverá ser retornado ao usuário o valor total da venda (valor unitário do produto * total de unidades a serem compradas)
• O total a pagar deverá ser a soma do total da venda e o valor do frete
• A venda somente será efetivada caso o usuário realize o pagamento
• A venda somente será concluída assim que a entrega for finalizada

Critério de Aceite

• A venda deverá ser inserida no Banco de Dados de acordo com as regras de negócio

Implementação

• Crie um Microservice de Venda com o endpoint correspondente (CREATE)

Sugestão

• Adicionar novas regras de negócio
• Identifique a necessidade de implementação das demais operações de CRUD

💻 Cadastro de Entrega

CREATE

• Para cadastro de uma entrega deverá obrigatoriamente ser informado:
  • Código da venda

Critério de Aceite

• Deverá ser informado ao usuário o valor do frete e o prazo de entrega
• A entrega deverá ser inserida no Banco de Dados de acordo com as regras de negócio

Implementação

• Crie um Microservice de Entrega com o endpoint correspondente (CREATE)

Sugestão

• Adicionar novas regras de negócio
• Identifique a necessidade de implementação das demais operações de CRUD

📁 Requisito Funcional Geral - RFG1

• As consultas deverão ser paginadas de 15 em 15 registros e caso nenhum registro corresponda ao critério de busca deverá ser retornada uma lista vazia

📁 Requisitos Não Funcionais

---

Sugestão de tecnologias para desenvolvimento inicial:

• Linguagem de Programação
  • Java 11
• Gerenciador de dependências
  • Maven
• Framework
  • Spring
• Banco de Dados
  • H2
• Documentação API
  • OpenAPI

💡 Evolução dos Requisitos Não Funcionais

---

Algumas sugestões de evolução:

• Banco de Dados
  • Postgres
• Spring Cloud

Referência

• https://www.udemy.com/course/microsservicos-java-spring-cloud

• Autenticação

  • Keycloak

• Autorização

Disponibilização da Aplicação

• Docker
• Heroku

Evoluções Adicionais

• Auditoria Banco de Dados
• Normalização dos dados
• Consulta com filtros utilizando Specification ou QueryDSL
• Liquibase como controle de versão da Base de Dados

CI/CD

• Travis CI ou GitHub Actions

Referências complementares:

• https://medium.com/codigorefinado/code-review-revis%C3%A3o-de-c%C3%B3digo-pode-ser-automatizada-ba5f25882774
• https://medium.com/thiagobarradas/an%C3%A1lise-cont%C3%ADnua-de-qualidade-do-software-bb7b03518bcc
• https://imasters.com.br/cloud/spring-boot-na-nuvem-de-graca-e-com-as-melhores-praticas

Cobertura de Código

• Codecov

Testes Unitários

• JUnit 5

Observabilidade

• Prometheus
• Grafana
• Loki
• Jaeger
• ELK

Referência:

• https://github.com/liliannss/observabilidade

💡 Guia Inicial de Implementação

---

• Inicialização do projeto

  • https://start.spring.io/

• Estrutura básica de pacotes (Arquitetura em Camadas)

  • Controllers
    • Requisições (request / response)
  • Models
    • Modelos de domínio
  • Services
    • Classes de serviços
  • Repositories
    • Camada de manipulação de dados

Fundamentos - Tecnologias - Ferramentas

Fundamentos, Tecnologias / Implementações e Ferramentas básicos abordados no decorrer dos encontros e recomendados para estudo.

---

💾 Fundamentos

✅ API

✅ Rest

Principais conceitos:

• Métodos HTTP
• Códigos de Status HTTP

✅ Classe Embeddable

✅ DTO (Data transfer object)

💾 Tecnologias / Implementações

✅ Spring Framework

Principais módulos:

• Boot
  • Web
  • Data
  • Validation

Algumas das principais implementações:

• Arquivo de configuração (application.properties)
• ResponseStatus x ResponseEntity
• Validações com Spring utilizando Bean Validation
• Customização de atributos com Jackson utilizando a anotação @JsonProperty
• Variáveis com Spring utilizando a anotação @Value

✅ Banco de Dados H2

Projeto Base

• http://localhost:8081/ecommerce/h2-console

Referência

• https://howtodoinjava.com/spring-boot2/h2-database-example/

✅ @Log4j2

✅ ModelMapper

✅ Anotações Lombok

✅ Documentação com Swagger

Projeto Base

• http://localhost:8081/ecommerce/swagger-ui.html

Referência

• https://springdoc.org/faq.html

✅ Versionamento de API

Projeto Base

• /v1/users

✅ Context Path

Projeto Base

• /ecommerce

✅ Exception Handler

✅ Consultas

• Query Methods
• JPQL
• Query Nativa
• Consulta paginada

Referências

• https://www.baeldung.com/spring-data-jpa-query
• https://www.javaguides.net/2018/11/spring-data-jpa-creating-database-queries-using-query-annotation.html

✅ Consumo de WebService

• Feign
• WebClient
• RestTemplate

Referência

• https://dev.to/daienelima/como-consumir-uma-api-na-sua-aplicacao-spring-boot-3p3a

✅ Arquivo data.sql

Nota

• A nomenclatura do arquivo deve ser data.sql

✅ Flyway

Notas

• Boas práticas:
  • V01__criar_e_registrar_categorias.sql
  • Iniciar com V maiúsculo;
  • Dois caracteres para versionamento (boa prática para manter a ordenação);
  • Separar por dois underscores (obrigatório);
  • Escrever o que a migração faz separando por um underscore.

Referência

• https://medium.com/cwi-software/versionar-sua-base-de-dados-com-spring-boot-e-flyway-be4081ddc7e5

✅ Comandos básicos do Maven

Referência

• https://gist.github.com/erkobridee/3287943

✅ Arquivo Readme

✅ Mocks

Referências

• https://www.4devs.com.br/
• https://www.mockaroo.com/

💾 Ferramentas

✅ IDE IntelliJ

✅ Comandos básicos do Git

✅ Comandos básicos do GitHub

✅ Requisições utilizando o cURL

✅ Requisições / Collections Postman

🔨 Melhorias

---

Sugestão de melhorias:

• Implementação de Testes Unitários
• Utilizar versão mais recente do Spring e corrigir possíveis erros de dependências