UnB - Universidade de Brasilia
FGA - Faculdade do Gama
TPPE - Técnicas de Programação para Plataformas Emergentes
Aluno | Matrícula |
---|---|
Kess Jhones Gomes Tavares | 180124498 |
Pedro de Miranda Haick | 180129147 |
Rafael berto pereira | 180108344 |
Rodrigo Balbino Azevedo de Brito | 190048221 |
Victor Hugo Carvalho Silva | 190038969 |
Enunciado do trabalho
Qualidade do projeto de código -- um breve resumo:
Projeto de software não é simplesmente uma especificação feita antes da atividade de codificação e que posteriormente deve ser seguida à risca. A construção do código é também vista como uma atividade de projeto. Não há uma atividade de projeto, não há um time de projetistas: são os programadores quem constantemente refinam e estendem o projeto ao refinar e estender o código. Caso especial: TDD é uma técnica que realiza verificações de projetos antes mesmo do código ter sido escrito.
Elementos que são projetados por nós, em diferentes níveis:
-
Arquitetura de sistema: projetamos o sistema como um todo, identificamos os principais subsistemas e como é realizada a comunicação entre eles. Esse projeto tem alto impacto em atributos de qualidade como desempenho e baixo impacto em linhas de código.
-
Módulos e Componentes: cada subsistema é decomposto em módulos menores e mais compreensíveis e, a depender da linguagem/framework utilizado, são compostos de pacotes (Java), namespace, bibliotecas reutilizáveis, hierarquias de classes, etc... Para tais módulos geralmente são publicadas interfaces que posteriormente são difíceis de serem alteradas (Refactoring de interfaces publicadas é sempre mais complicado de se realizar comparado a interfaces públicas).
-
Classes e tipos de dados: cada módulo, por sua vez, é decomposto em classes e tipos de dados. Nesse estágio o projeto tende a ser mais informal e mais fácil de ser alterado (principalmente por meio de refatorações, em que o comportamento externamente observável do código é preservado - ou pelo menos deveria ser). Nesse nível realiza-se micro-projetos em tempo de programação.
-
Funções: menor nível de projeto, mas ainda assim é realizada atividade de projeto. Funções devem ser cuidadosamente projetadas pois terão impacto no sistema. Uma vez criadas, deve-se definir como tais funções funcionam internamente.
O desafio é criar um bom projeto que seja mais fácil de ser modificado, de ser entendido, de ser consertado, mais resiliente a mudanças (acomoda futuras extensões e modificações) e menos suscetíveis a erros.
Não há projeto errado e projeto certo, há mau e bom projeto. Bons projetos possuem as seguintes características:
- Simplicidade;
- Elegância;
- Modularidade (baixo acoplamento e alta coesão);
- Boas interfaces;
- Extensibilidade;
- Ausência de duplicidades;
- Portabilidade;
- "Idiomático" (idioma da linguagem) e,
- Boa documentação.
Fonte: Code Craft : The Practice of Writing Excellent Code, No Starch Press, Incorporated, 2006. ProQuest Ebook Central, https://ebookcentral.proquest.com/lib/univbrasilia-ebooks/detail.action?docID=273481.
As características de um bom projeto de software apresentadas acima estão, de certo modo, associadas aos maus-cheiros de código apresentados por Martin Fowler em seu catálogo de refatorações e relacionados às operações que tratam tais maus-cheiros. De acordo com a definição do próprio Martin Fowler, refatoração é uma maneira de aperfeiçoar o projeto de código existente sem alterar o seu comportamento externamente observável.
Para esse trabalho o grupo deverá escolher 5 características dentre as 9 características de um bom projeto de software apresentadas acima e, para cada uma delas, apresentar:
- uma descrição da característica, mostrando claramente quais são os seus efeitos no código (em termo de estrutura, claridade, coesão, acoplamento dentre outros efeitos aplicáveis);
- uma relação da característica com os maus-cheiros de código definidos por Fowler. Uma descrição dos maus cheiros está disponível nos slides sobre o conteúdo de refatoração;
- pelo menos uma operação de refatoração capaz de levar o projeto de código a ter a característica em análise.
Valor do trabalho: 30 pontos, 6 pontos cada característica.
Prazo de entrega: 19 de julho de 2023, 23:59:59hs. Entrega através do repositório do grupo de alunos.