Refactoring Smell Code

SCAI S.p.A. 1Project & Delivery Area

Refactoring e Code Smellsdi

Alessandro Graps

Bologna, 22/11/2013

SCAI S.p.A. 2

Indice

TeoricoIntroduzioneIngegneria del softwareRefactoringCode SmellCasi d’usoConclusioni

WorkshopProva finale

Project & Delivery Area

Ingegneria del Software

Cos’e’

L’Ingegneria del Sw (Software Engineering) è una disciplina metodologica,cioè studia i metodi di produzione, le teorie alla base dei metodi, e gli strumenti di sviluppo e misura della qualità dei sistemi software.

Cos’e’

L’Ingegneria del Sw (Software Engineering) è una disciplina metodologica,cioè studia i metodi di produzione, le teorie alla base dei metodi, e gli strumenti di sviluppo e misura della qualità dei sistemi software.

È anche una disciplina empirica, cioè basata sull’esperienza e sulla storia dei progetti passati.

La produttività dell’industria sw è bassa

Da un’analisi di 13.522 progetti di costruzione sw: (Standish Report 2003)

66% di tutti i progetti falliscono (non hanno risultato utile).

82% dei progetti superano i tempi previsti.

48% dei progetti producono sistemi senza le funzioni richieste dai clienti.

55 miliardi $ di spreco considerando solo i progetti USA.

Perche’ falliscono i progetti sw: I rischi

Quali sono i rischi principali di chi sviluppa software?

Turnover dello staff.

Realizzare funzioni non richieste.

Ritardi nella consegna.

Superare il budget di progetto.

Realizzare un sistema inusabile.

Realizzare un sistema incapace di funzionare insieme con altri sistemi esistenti.

In che contesto

Nello scorso workshop abbiamo parlato di metodologie di sviluppo.

In che contesto

L'obiettivo generale dell’ ingegneria del software è quello di creare software di alta qualità in modo efficiente.

In che contesto

L'obiettivo generale dell’ ingegneria del software è quello di creare software di alta qualità in modo efficiente.

Perche’ non lo faccio? Ci sono sempre pressioni e ragioni per scrivere software di basso livello.

Perche’ scriviamo codice non efficiente e di bassa qualita’?

I requisiti che cambiano nel tempo rendono difficile l’aggiornamento del codice.

Tempo e denaro possono ci possono fare scrivere codice di bassa qualita’.

Impariamo un modo migliore.

Due domande

Come possiamo fixare il codice?1

Due domande

Come possiamo sapere se il

Nostro codice e’ scritto male..

Se l’applicazione funziona bene?

Refactoring

Definizione: Il refactoring e’ la modificha del codice per migliorare la leggibilità, la manutenibilita’ e la sua estendibilita’ senza cambiare il suo reale funzionamento.

Refactoring

Comportamento esterno non cambia.

Refactoring

Comportamento esterno non cambia.

La struttura interna e’ migliorata.

Refactoring

Refactoring è il processo per modificare un sistema software in modo tale da migliorare la struttura interna del codice

senza alterarne il comportamento esterno.

M. Fowler

Refactoring:Un semplice esempio

Move a method:

Motivazione: Un metodo e’ utilizzato o sara’ utilizzato da altre classi che la classe in cui e’ definito.

Move a method:

Motivazione: Un metodo e’ utilizzato o sara’ utilizzato da altre classi che la classe in cui e’ definito.

Tecnica: Creare un nuovo metodo con le stesse firme nella classe comune. Si elimina la chiamata al vecchio metodo e si rimuove del tutto il metodo.

Refactoring:Pericolo!

Refactoring può introdurre ulteriori problemi, perché ogni volta che si modifica il software si può introdurre un bug!

Prima di farlo:

Il refactoring aggiunge rischio!

Prima di farlo:

E 'costoso - stiamo spendendo tempo in fase di sviluppo, ma non "vediamo" nessuna differenze esterne?

Prima di farlo:

Possiamo ripetere i test?

Prima di farlo:

Possiamo ripetere i test?

Perché stiamo facendo questo?

Refactoring:Motivazioni

Scrivere codice corretto la prima volta e’ difficile, dal refactoring otteniamo i seguentibenefici:

Riduzione delle dimensioni del codice.

Semplificazione del codice.

Miglioramento notevole della mantenibilita’: E’ imporante in un mondo dove i requisiti cambiano spesso.

Refactoring:Quali problemi risolve?

Per correggere un bug ci vuole troppo tempo!

Aggiungere una nuova funzionalità è... un’impresa difficile e rischiosa!!!

E’ diventato impossibile stimare tempi e costi degli interventi richiesti dal cliente???

I clienti continuano a chiedere modifiche, il programma è a “fine corsa”, nessuno ha il coraggio di rifarlo.

Refactoring:Esempio codice

Introduzione di un Null Object

Motivazione: Ci sono molti controlli per i null object

Tecnica: Gestiamo il valore null nel nostro codice.

Customer c = findCustomer(...); ...

if (customer == null) { name = “occupant”

} else { name = customer.getName()

} if (customer == null) { …

public class NullCustomer extends Customer {public String getName() {return “occupant”

}---------------------------------------------------------Customer c = findCustomer()name = c.getName()

Abbiamo completamente eliminato l'istruzione if, sostituendo i controlli per nullcon un oggetto nullo che gestisce i valori "NULL".

Refactoring:Altro esempio

Sostituzione delle condizioni con il polimorfismo

Motivazione: Abbiamo nel nostro codice una serie di condizioni che gestiscono un comportamento diverso a seconda del tipo dell’oggetto.

Tecnica: Ogni condizione verra’ gestita con l’ovveride di una sottoclasse astraendo il metodo originale.

double getSpeed() { switch (_type) {

case EUROPEAN: return getBaseSpeed();

case AFRICAN: return getBaseSpeed() - getLoadFactor() *

_numberOfCoconuts; case NORWEGIAN_BLUE:

return (_isNailed) ? 0 : getBaseSpeed(_voltage); } throw new RuntimeException ("Should be unreachable"); }

Refactoring:Quando lo faccio?

Quando si aggiunge una nuova funzionalita’:

Prima di aggiungere una nuova funzionalita’, bisogna assicurarsi che il codice attuale sia pulito. Quando ci aiutera’ a scrivere la nuova funzionalita’ in maniera piu’ snella.

Quando devo correggere bugs.

Quando si esegue una code review.

Refactoring:Come identifico codice da rifattorizzare?

Martin Fowler usa “Code smells” per identificare quando rifattorizzare.

Code Smell sono parti cattive nel codice, un po’ come i pattern difettosi nel codice.

Molte persone legano il code smell per specificare una rifattorizzazione per fixare lo smell.

Code Smell

Code Smell:Codice duplicato

Male perche’ rischiamo di introdurre un bug se modifichiamo una sola istanza del codice dimenticando le altre.

Cerchiamo di creare un unico metodo in un punto comune al progetto.

Code Smell:Metodi lunghi

Sono difficili da capire.

Problemi di prestazioni.

Frammentiamo

Code Smell:Classi larghe

Le classi cercano di fare tutto e troppo.

Dividiamo in piu’ classi

Code Smell:Liste parametri troppo lunghe

Difficili da capire. Possono essereinconsistenti.

Utilizzare oggetti per lo scambio diparametri.

Code Smell:Cambi di divergenze

Relativi alla coesione: sintomi: un cambiamento richiede la modifica di diversi metodi; un altro cambiamento richiede la modifica di un altro sottoinsieme.

Non esiste un singolo punto dove operare per eseguire una modifica

Code Smell:Eccessivo uso delle primitive

Sfruttare gli oggetti

Code Smell:Modifiche a cascata

Una modifica ne provoca molte altre a cascata

Regressione

Code Smell:Campi temporanei

Difficili da gestire

Code Smell:Data Class

Adatte solo nei primi stati di progettazione.

Code Smell:Ambiente errato

Spostare il metodo nella classe corretta

Code Smell:Commenti

I commenti sono a volte utilizzati per nascondere cattivo codice.

Sono spesso utilizzati come deodorante.

Code Smell:Commenti

/**Restituisce l’area di un rettangolo*param w larghezza del rettangolo*param h altezza del rettangolo*return area del rettangolo*/public float GetA(float w, float h) {

//Calcolo area float res = w*h;//Restituzione risultatoreturn res;

public float GetArea(float width, float height) {return width * height;}

Code Smell:Altro

Many more smells at:

http://c2.com/cgi/wiki?CodeSmell

Come ripulire il codice

http://wiki.java.net/bin/view/People/SmellsToRefactorings

Perche’ lo facciamo?

Code Smell e Refactoring sono tecniche per aiutarci a scoprire i problemi nella progettazione e realizzazione di software e di applicare soluzioni note per non rincorrere in questi problemi.

Dovrebbero essere utilizzati per tutto il tempo? Si deve pensare sempre a loro, ma si applicano solo quando hanno un senso. A volte e’ necessario un «metodo lungo…»

Ma pensate sempre se questa e’ la soluzione migliore.

Perche’ lo facciamo?

Ricordate sempre che queste modifiche possono introdurre bugs nel codice.

Riduciamo il rischio.

È necessario verificare costantemente -con test automatizzati ove possibile.

Utilizzare i modelli di refactoring – ne ho mostrati due ... ma ne esistono di più .. molti di più!

http://www.refactoring.com/catalog/index.html

Utilizzare strumenti per velocizzare.

Rispondiamo al capo!

"Il refactoring è un'attività in prioritaria - Sono pagato per scrivere nuove funzioni e sistemare quelle esistenti."

Ricordiamoci

Strumenti/tecnologie sono ora disponibili per consentire il refactoring in modo rapido e relativamente indolore.

Esperienze riportate da alcuni programmatori object-orientedsuggeriscono che il sovraccarico di refactoring è più che compensato da sforzi ridotti e intervalli in altre fasi di sviluppo del programma.

Conclusioni

Il Refactoring migliora la progettazione di software.

Conclusioni

Il Refactoring crea software facile da capire

La struttura e’ migliorata, il codice duplicato viene eliminato, etc.

Conclusioni

Il Refactoring aiuta a scovare i bugs

Il refactoring aiuta a comprendere il codice e questo aiuta lo sviluppatore a trovare I bug e anticipando potenziali bug.

Conclusioni

Il Refactoring aiuta a programmare velocemente

Perche’ un buon design permette di compiere progressi veloci.

Riferimenti

http://www.irregularwebcomic.net/cgi-bin/comic.pl?comic=687

http://www.refactoring.com/catalog/index.html

http://www.cs.colorado.edu/~kena/classes/6448/s05/lectures/lecture18.pdf

http://www.codeproject.com/KB/architecture/practicalexp.aspx

Workshop

Refactoring Smell Code

Technology

Refactoring with Eclipse - UVic.cawebhome.cs.uvic.ca/~hausi/SENG371/labs/SENG371-Bassam-Lab8-… · Code Refactoring ! Code refactoring is a disciplined way to restructure code. [wikipedia]

Using Python to Facilitate Python Facilitating Code Refactoring · 2014-02-02 · Code Refactoring Using Python to Facilitate Code Refactoring 1 1 Ben Christenson Associate Scientist

Code Refactoring - 3.0

Refactoring Legacy Code - Alvaro Garciaalvarogarcia7.github.io/blog/uploads/refactoring-legacy... · 2020-04-04 · with Legacy Code, ISBN-13: 007-6092025986. Amazon [Refactoring]:

Object Oriented Design Patterns - I - Agile Programmingretis.sssup.it/~lipari/courses/oosd2011-1/17.agile_refactoring.pdf · 3 Refactoring 4 Duplicate Code smell Extract Method Replace

Code Smell

Clean Code & Refactoring

Code Refactoring using rails

Refactoring - improving the smell of your code

Refactoring to SOLID Code

Tech talks#6: Code Refactoring

Using Code Metrics for Targeted Code Refactoring

User Interface Design Smell: Automatic Detection and ...people.irisa.fr/Arnaud.Blouin/talks/blobListeners.pdf · User Interface Design Smell: Automatic Detection and Refactoring of

Big code refactoring with agility

B-Refactoring: Automatic Test Code Refactoring to Improve Dynamic

Code refactoring using eclipse

Code refactoring with symfony2

Refactoring Overview What is refactoring? What are four good reasons to refactor? When should you refactor? What is a bad smell (relative to refactoring

Spaghetti code refactoring

Refactoring code in .net