Versionamento
| Data | Versão | Descrição | Autor |
|---|---|---|---|
| 27/04/2021 | 1.0 | Criado a estrutura do documento | Lucas Lopes |
| 29/04/2021 | 2.0 | Adicionado introdução e docker | Lucas Lopes |
| 03/04/2021 | 3.0 | Adicionado Frontend | Murilo e Lucas |
| 03/04/2021 | 4.0 | Adicionado reutilização back-end | Matheus Filipe |
Introdução
Reutilização de software trata do uso de software ou conhecimentos de software já existentes para construir novos softwares. Componentes reutilizáveis podem ser tanto software reutilizável quanto conhecimento de software.
A ideia do reuso é evitar retrabalho no desenvolvimento de um novo projeto, sempre levando em consideração trabalhos anteriores, fazendo com que soluções previamente desenvolvidas sejam aproveitadas e implementadas em novos contextos.
Docker
Uma das formas de reutilização no projeto foi por meio da utilização do Docker. O que ocorre na prática é que o docker destaca recursos e usa bibliotecas de kernel em comum. Os itens empacotados — ou até mesmo um ambiente inteiro — são dispostos no container e se tornam portáveis, o que torna o trabalho conjunto mais eficiente. Ao mesmo tempo, a implantação pode ser feita em ambientes não heterogêneos. Ele possui muitos hot spots, e alguns frozen spots, ambos estão sendo utilizados em nossa aplicação. Além disso, foi utilizado o Docker Compose para orquestrar os containers do Docker.
-
Frozen Spots:
-
Formatação do arquivo
- Nome dos arquivos.
Hot Spots:
- Imagem para construir o container;
- Dependências;
- Comandos no dockerfile
- Network no docker compose
- Variáveis de ambiente no dockerfile
Docker Frontend
Para o Frontend, foi configurado um Docker utilizando as tecnologias do Nodejs alpine(uma versão leve do Nodejs) como base. Além disso, Ele também fica responsável em padronizar as versões das bibliotecas utilizadas, impedindo que haja conflitos de desenvolvimento entre a equipe.
Dockerfile
DockerCompose
Docker Backend
Para o Backend, foi configurado um Docker utilizando as tecnologias do NodeJs alpine (uma versão mais leve do NodeJs) como base. Além disso, Ele também fica responsável em padronizar as versões das bibliotecas utilizadas, impedindo que haja conflitos de desenvolvimento entre a equipe. No Docker do backend ele disponibiliza uma porta de saída que é possivel se conectar e trocar dados com o frontend.
Exemplo docker e docker compose
DockerFile
DockerCompose
Frontend
O React é a biblioteca mais popular do JavaScript e é usada para construir uma interface de usuário (IU). Ela oferece uma resposta excelente para o usuário adicionar comandos usando um novo método de renderizar sites.
Frozen Spots
São considerados aqueles pontos que permanecem fixos em todas as instanciações, representa uma arquitetura geral do sistema. No React, foi utilizado alguns frozens spots, como:
- Web Hooks: Permitem reutilizar lógica com estado sem mudar sua hierarquia de componentes.
Web Hooks
- JavaScript XML: Permite escrever HTML no React, tornando fácil a sua adição Ou seja, ao invés de colocar o JavaScript no HTML, colocamos o HTML no JavaScript.
Javascript XML
Hot Spots
São considerados aqueles pontos que são feitos para serem genéricos, dando liberdade ao usuário de modelar como quiser. Representa partes específicas dentro do sistema. No React, está sendo utilizando alguns hot spots.
- Components: Permite reutilizar a estrutura,lógica e estilos de código. No exemplo abaixo, foi utilizado nos itens da loja.
Item Component
Backend
Arquitetura
A reutilização de software é baseada na utilização de conceitos, especificações, arquitetura ou código fonte , previamente acordados ou elaborados para a criação de um novo software.
Como a arquitetura de um sistema é descrita em termos de identificação de seus componentes e de suas relações, ela é uma ponto de partida interessante para a reutilização.
No projeto foi empregada a arquitetura MVC, porém com um nível de abstração Service , responsável pela modelagem das regras de negocio da aplicação. e foi divido em Back-end e Front-end.
Exemplo da reutilização em uma service:
Exemplo de Reutilização nas rotas:
NodeJS
NodeJS é uma plataforma de desenvolvimento e execução back-end de aplicações que executa códigos em JavaScript tendo como interpretador o V8 que utilizado no navegador Google Chrome. O NodeJS nos permite criar aplicações autônomas sem a necessidade de um browser para executá-la.
Frozen Spots
- Funções e objetos pré-estruturados para desenvolvimento de aplicações.
Exemplo:
O objeto Process do NodeJS nos permite ter acesso as variáveis de ambiente do projeto por meio do parâmetro env.
Hot Spots
- Estruturação de pastas
A organização dos diretórios e módulos do projeto em uma estrutura clara consistente facilita o desenvolvimento e a manutenção do mesmo e ainda fornece uma facilidade para aplicação dos diversos padrões de projetos escolhidos para serem implementados.
Mongoose
O Mongoose é uma ferramenta bastante útil para poupar tempo com validações, casting de tipos e lógica de negócios na escrita e organização do banco de dados, optamos por utilizá-lo devido ao curto prazo para o desenvolvimento do projeto e por se apresentar como uma boa escolha para a arquitetura escolhida de um banco de dados não relacional. Também é importante citar que a manipulação de queries em SQL seria pouco produtivo para o cumprimento do escopo do projeto.
Exemplo de criação de uma tabela no Mongoose:
Com poucas linhas de código é possível realizar uma consulta no banco de dados e uma validação.
Exemplo de uma query de busca:
Referências
Software Reuse Research: Status and Future. Disponível em: https://citeseerx.ist.psu.edu/viewdoc/download;jsessionid=F81286E552CB9153A6C3AF0C943DCB08?doi=10.1.1.75.635&rep=rep1&type=pdf. Acesso em: 29/04/2021
Reutilização de Software - Revista Engenharia de Software. Disponível em: https://www.devmedia.com.br/reutilizacao-de-software-revista-engenharia-de-software-magazine-39/21956. Acesso em: 29/04/2021
O que é JSX?. Disponível em: https://www.mundojs.com.br/2020/09/23/o-que-e-jsx/. Acesso em 03/05/2021.