Etapa de Projeto (Design)

É nessa etapa que vamos projetar! Essa fase é crucial para o desenvolvimento, pois é nela que definimos como o sistema será estruturado e implementado. É nessa etapa que vamos traduzir os levantamentos de requisitos e analisados feita nas etapas anteriores em uma arquitetura concreta. Essa fase pode ser dividida em várias etapas que incluem desde a definição da arquitetura, banco de dados até o design detalhado dos componentes. Seus principais aspectos são: Ao final desses processos, teremos a Especificação de Documento de Design (DDS), também conhecido como Especificação Técnica. Esse documento é técnico e detalha a arquitetura, componentes, interfaces e outros aspectos técnicos de um software que serve como guia para os desenvolvedores durante a etapa de implementação e também como uma referência para futuros aprimoramentos ou manutenção do sistema. 1. Definição de Arquitetura do Sistema Definir a arquitetura do sistema envolve estruturas a aplicação de forma organizada, garantindo escalabilidade, manutencão e desempenho adequado. Existem diversas formas e metodologias para definir a arquitetura de um software, a seguir são uns dos passos fundamentais. Levantamento de Requisitos Antes de definir a arquitetura, precisamos entender o que o sistema deve fazer. Você pode utilizar o documento de requisitos de software (SRS) para fazer essa etapa. ✅ Funcionais: O que o sistema faz? (Exemplo: Upload de planilha, validação, exportação de XML). ✅Não funcionais: Requisitos técnicos (Exemplo: Segurança, escalabilidade, tempo de resposta). Escolha do Estilo Arquitetural A escolha do estilo arquitetural é uma das decisões mais importantes no desenvolvimento de um sistema. Ele define como os componentes interagem, como os dados fluem e como as regras de negócios são implementadas. Nesse caso o conhecimento técnico do desenvolvedor é importantissimo, a compreensão acerca dos estilos arquiteturais aumenta o leque de possibilidades de combinações e conceitos, deixando o software mais rico arquitetonicamente falando. A seguir exemplificando com alguns dos principais estilos arquiteturais. Estilo Arquitetural Descrição Aplicação no Seu Caso? Monolítica Todo o código está centralizado em um único projeto. ❌ Não ideal se o sistema crescer, mas pode ser um primeiro passo. Camadas (Layered Architecture) Separação em camadas como API, serviço e repositório. ✅ Boa opção inicial para organizar código e facilitar manutenção. Hexagonal (Ports & Adapters) Divide a lógica de negócio de dependências externas (como banco e APIs). ✅ Útil se quiser flexibilidade para mudar fontes de dados. Eventos (Event-Driven Architecture) Baseado em eventos assíncronos (Kafka, RabbitMQ). ❌ Muito complexo para este projeto. Microsserviços Cada funcionalidade é um serviço separado. ❌ Desnecessário para um MVP, mas válido para escalabilidade futura. Para o nosso exemplo a escolha recomendada foi Arquitetura em Camadas (Layered Architecture) ou Hexagonal para modularidade. Definir os Componentes do Sistema Agora que estabelecemos a arquitetura geral, precisamos detalhar quais os componentes do sistema e sua organização dentro das camadas definidas. Esses componentes garantirão modularidade, testabilidade e facilidade de manutenção. Como exemplo, vou usar a o estilo arquitetural “Arquitetura em Camadas”. Vale ressaltar que a construção das camadas variam de acordo com o projeto, não existe uma regra ou padronização específica. 1️⃣ Camada de Apresentação (API/Web API) Exposição de endpoints REST. Autenticação e autorização (JWT). Validação de requisições. 2️⃣ Camada de Serviço (Business Logic Layer) Processamento de arquivos. Validação dos dados conforme regras da EFD-Reinf. Geração do XML. 3️⃣ Camada de Infraestrutura (Persistence/Data Layer) Se armazenar informações, usará SQL Server ou PostgreSQL. Pode ser stateless se não houver armazenamento. 4️⃣ Camada Externa (Integrações) Bibliotecas para manipular Excel (EPPlus, OpenXML). Geração de XML (System.Xml, XmlSerializer). Segurança e Controle de Acesso Segurança e Controle de acesso são aspectos fundamentais em qualquer sistema, principalmente onde exista dados sensíveis como informações do usuários, documentos ou transações financeiras. Implementar essa etapa exige um conhecimento técnico do desenvolvedor sobre segurança e controle de acesso e é necessário um levantamento eficiente do que deve ser implementado. A seguir, um exemplo simples:

Feb 26, 2025 - 02:17

É nessa etapa que vamos projetar! Essa fase é crucial para o desenvolvimento, pois é nela que definimos como o sistema será estruturado e implementado. É nessa etapa que vamos traduzir os levantamentos de requisitos e analisados feita nas etapas anteriores em uma arquitetura concreta.

Essa fase pode ser dividida em várias etapas que incluem desde a definição da arquitetura, banco de dados até o design detalhado dos componentes. Seus principais aspectos são:

Ao final desses processos, teremos a Especificação de Documento de Design (DDS), também conhecido como Especificação Técnica. Esse documento é técnico e detalha a arquitetura, componentes, interfaces e outros aspectos técnicos de um software que serve como guia para os desenvolvedores durante a etapa de implementação e também como uma referência para futuros aprimoramentos ou manutenção do sistema.

1. Definição de Arquitetura do Sistema

Definir a arquitetura do sistema envolve estruturas a aplicação de forma organizada, garantindo escalabilidade, manutencão e desempenho adequado. Existem diversas formas e metodologias para definir a arquitetura de um software, a seguir são uns dos passos fundamentais.

Levantamento de Requisitos

Antes de definir a arquitetura, precisamos entender o que o sistema deve fazer. Você pode utilizar o documento de requisitos de software (SRS) para fazer essa etapa.

✅ Funcionais: O que o sistema faz? (Exemplo: Upload de planilha, validação, exportação de XML).

✅Não funcionais: Requisitos técnicos (Exemplo: Segurança, escalabilidade, tempo de resposta).

Escolha do Estilo Arquitetural

A escolha do estilo arquitetural é uma das decisões mais importantes no desenvolvimento de um sistema. Ele define como os componentes interagem, como os dados fluem e como as regras de negócios são implementadas. Nesse caso o conhecimento técnico do desenvolvedor é importantissimo, a compreensão acerca dos estilos arquiteturais aumenta o leque de possibilidades de combinações e conceitos, deixando o software mais rico arquitetonicamente falando.

A seguir exemplificando com alguns dos principais estilos arquiteturais.

Estilo Arquitetural	Descrição	Aplicação no Seu Caso?
Monolítica	Todo o código está centralizado em um único projeto.	❌ Não ideal se o sistema crescer, mas pode ser um primeiro passo.
Camadas (Layered Architecture)	Separação em camadas como API, serviço e repositório.	✅ Boa opção inicial para organizar código e facilitar manutenção.
Hexagonal (Ports & Adapters)	Divide a lógica de negócio de dependências externas (como banco e APIs).	✅ Útil se quiser flexibilidade para mudar fontes de dados.
Eventos (Event-Driven Architecture)	Baseado em eventos assíncronos (Kafka, RabbitMQ).	❌ Muito complexo para este projeto.
Microsserviços	Cada funcionalidade é um serviço separado.	❌ Desnecessário para um MVP, mas válido para escalabilidade futura.

Para o nosso exemplo a escolha recomendada foi Arquitetura em Camadas (Layered Architecture) ou Hexagonal para modularidade.

Definir os Componentes do Sistema

Agora que estabelecemos a arquitetura geral, precisamos detalhar quais os componentes do sistema e sua organização dentro das camadas definidas. Esses componentes garantirão modularidade, testabilidade e facilidade de manutenção.

Como exemplo, vou usar a o estilo arquitetural “Arquitetura em Camadas”. Vale ressaltar que a construção das camadas variam de acordo com o projeto, não existe uma regra ou padronização específica.

1️⃣ Camada de Apresentação (API/Web API)

Exposição de endpoints REST.
Autenticação e autorização (JWT).
Validação de requisições.

2️⃣ Camada de Serviço (Business Logic Layer)

Processamento de arquivos.
Validação dos dados conforme regras da EFD-Reinf.
Geração do XML.

3️⃣ Camada de Infraestrutura (Persistence/Data Layer)

Se armazenar informações, usará SQL Server ou PostgreSQL.
Pode ser stateless se não houver armazenamento.

4️⃣ Camada Externa (Integrações)

Bibliotecas para manipular Excel (EPPlus, OpenXML).
Geração de XML (System.Xml, XmlSerializer).

Segurança e Controle de Acesso

Segurança e Controle de acesso são aspectos fundamentais em qualquer sistema, principalmente onde exista dados sensíveis como informações do usuários, documentos ou transações financeiras.

Implementar essa etapa exige um conhecimento técnico do desenvolvedor sobre segurança e controle de acesso e é necessário um levantamento eficiente do que deve ser implementado. A seguir, um exemplo simples: