Walace Wilker

Arquitetura Limpa

A arquitetura limpa é um conjunto de práticas e princípios de design de software que visam criar sistemas de software robustos, escaláveis e fáceis de manter. Ela é baseada em conceitos de design de software como separação de responsabilidades, coesão e baixo acoplamento.

Objetivo

O objetivo deste projeto é estudar e aplicar os princípios da arquitetura limpa em um projeto de software real. Vamos criar um aplicativo web simples que permita aos usuários criar, editar e excluir notas. O aplicativo será construído com Next.js, Tailwind CSS e Upstash.

Princípios da Arquitetura Limpa

A arquitetura limpa é baseada em quatro princípios fundamentais:

Independência de Frameworks: O código de negócio deve ser independente de frameworks e bibliotecas externas. Isso facilita a manutenção e evolução do sistema, pois permite substituir ou atualizar frameworks sem afetar o código de negócio.
Testabilidade: O código deve ser testável. Isso significa que devemos ser capazes de escrever testes automatizados para validar o comportamento do sistema. Testes automatizados nos dão confiança para fazer mudanças no código sem introduzir regressões.
Independência de UI: O código de negócio deve ser independente da interface do usuário. Isso significa que devemos separar a lógica de negócio da interface do usuário. Isso facilita a reutilização do código de negócio em diferentes interfaces de usuário, como aplicativos web, móveis e desktop.
Independência de Banco de Dados: O código de negócio deve ser independente do banco de dados. Isso significa que devemos separar a lógica de negócio da camada de acesso a dados. Isso facilita a substituição ou atualização do banco de dados sem afetar o código de negócio.

Esses princípios nos ajudam a criar sistemas de software flexíveis, fáceis de manter e evoluir. Eles nos permitem adaptar o sistema a novos requisitos e tecnologias sem comprometer a qualidade do código.

Estrutura do Projeto

O projeto é dividido em camadas que representam diferentes responsabilidades do sistema. As camadas são organizadas de acordo com os princípios da arquitetura limpa. Aqui está a estrutura do projeto:

Camada de Apresentação: Esta camada é responsável pela interface do usuário. Ela contém os componentes React que compõem a interface do aplicativo.
Camada de Aplicação: Esta camada é responsável pela lógica de aplicação. Ela contém os casos de uso que implementam as funcionalidades do sistema.
Camada de Domínio: Esta camada é responsável pela lógica de negócio. Ela contém as entidades e os objetos de valor que representam o domínio do sistema.
Camada de Infraestrutura: Esta camada é responsável pela infraestrutura do sistema. Ela contém os adaptadores que conectam o sistema a recursos externos, como o banco de dados.

A seguir, vamos explorar cada camada em mais detalhes e ver como elas se relacionam entre si.

Camada de Apresentação

A camada de apresentação é responsável pela interface do usuário. Ela contém os componentes React que compõem a interface do aplicativo. Aqui está a estrutura da camada de apresentação:

presentation/
├── components/
│   ├── Layout.js
│   ├── NoteForm.js
│   ├── NoteList.js
├── pages/
│   ├── index.js

Camada de Aplicação

A camada de aplicação é responsável pela lógica de aplicação. Ela contém os casos de uso que implementam as funcionalidades do sistema. Aqui está a estrutura da camada de aplicação:

application/
├── useCases/
│   ├── createNote.js
│   ├── deleteNote.js
│   ├── getNotes.js
│   ├── updateNote.js

Camada de Domínio

A camada de domínio é responsável pela lógica de negócio. Ela contém as entidades e os objetos de valor que representam o domínio do sistema. Aqui está a estrutura da camada de domínio:

domain/
├── entities/
│   ├── Note.js
├── valueObjects/
│   ├── NoteId.js

Camada de Infraestrutura

A camada de infraestrutura é responsável pela infraestrutura do sistema. Ela contém os adaptadores que conectam o sistema a recursos externos, como o banco de dados. Aqui está a estrutura da camada de infraestrutura:

infrastructure/
├── adapters/
│   ├── api.js
│   ├── database.js

Tecnologias Utilizadas

O projeto é construído com as seguintes tecnologias:

Next.js: Um framework React para construção de aplicativos web.
Tailwind CSS: Uma biblioteca de estilos CSS utilitários.
Upstash: Um banco de dados Redis como serviço.
Vercel: Uma plataforma de hospedagem para aplicativos web.

Essas tecnologias nos permitem criar um aplicativo web moderno e escalável. Elas nos ajudam a focar no desenvolvimento de funcionalidades e na qualidade do código, sem se preocupar com a infraestrutura e a configuração do ambiente de desenvolvimento.

Como Executar o Projeto

Para executar o projeto em sua máquina local, siga estas etapas:

Clone o repositório:

git clone

Instale as dependências:

npm install

Configure as variáveis de ambiente:

Crie um arquivo .env.local na raiz do projeto e adicione as seguintes variáveis de ambiente:

NEXT_PUBLIC_API_URL=https://api.upstash.com
NEXT_PUBLIC_API_KEY=your-api-key

Substitua your-api-key pelo seu token de acesso do Upstash.

Execute o projeto:

npm run dev

O projeto será executado em http://localhost:3000. Você poderá acessar o aplicativo web e interagir com as funcionalidades de criação, edição e exclusão de notas.

Próximos Passos

Este projeto é apenas o começo de uma jornada de aprendizado sobre a arquitetura limpa. Nos próximos passos, pretendo explorar mais a fundo os princípios e práticas da arquitetura limpa, aplicando-os em projetos mais complexos e desafiadores.

Alguns dos próximos passos são:

Explorar técnicas avançadas de testes automatizados, como testes de integração e testes de unidade.
Implementar funcionalidades avançadas, como autenticação de usuários e controle de acesso.
Explorar padrões de design e boas práticas de programação para criar sistemas de software de alta qualidade.

Conclusão

A arquitetura limpa é uma abordagem poderosa para projetar sistemas de software robustos e escaláveis. Ela nos ajuda a criar sistemas flexíveis, fáceis de manter e evoluir. Ao seguir os princípios da arquitetura limpa, podemos criar sistemas de software de alta qualidade que atendam às necessidades dos usuários e dos negócios.

Se você deseja aprender mais sobre a arquitetura limpa, recomendo a leitura do livro "Clean Architecture: A Craftsman's Guide to Software Structure and Design" de Robert C. Martin. Este livro é uma referência essencial para qualquer desenvolvedor que deseja criar sistemas de software de alta qualidade.

Espero que este projeto tenha sido útil e inspirador para você. Se você tiver alguma dúvida ou sugestão, fique à vontade para entrar em contato. Ficarei feliz em ajudar e aprender com você!