Kódduplikáció

A kódduplikáció (duplicate code) egy programozási kifejezés azon esetre, mikor a forráskód egyes részei többször (duplikálva) fordulnak elő, akár ugyanabban a programban, akár ugyanazon fejlesztő(csoport) által készített vagy fenntartott, különböző programokban. A kódduplikáció több okból is nemkívánatos.

Ahhoz, hogy egy kódot duplikáltnak – és ne véletlenül hasonlónak – lehessen tekinteni, általában meg kell feleljen bizonyos követelményeknek (például adott kódmennyiség egyezése). A duplikált kódok szekvenciáit néha kódklónoknak vagy egyszerűen klónoknak nevezik, és a kódduplikációk automatikus felderítését klónészlelésnek (clone detection) nevezik.

A kódduplikáció nem feltétlenül jelenti azt, hogy két vagy több kódrészlet karakterenként azonos (beleértve például a változók elnevezését). Olyan részletek is egymás duplikátumainak tekinthetőek, melyek pusztán funkcionálisan azonosak.

Felbukkanása

Kódduplikációt eredményeztetnek a következők:

• Másol-beillesztéses programozás (copy-paste), amely akadémiai körülmények között plagizálásnak is tekinthető
• Kódlopás (scrounging), amikor egy kódrészletet azért másolnak be, „mert működik”. Sok esetben ez a művelet a klónozott kód enyhe módosítását vonja maga után, mint például a változók átnevezése vagy részletek beillesztése, törlése. A programozási nyelv szinte mindig lehetővé teszi, hogy a kód egy példányát különböző helyekről hívják meg, de ehelyett a programozó létrehoz egy duplikátumot, valószínűleg mert:
  • nem ismeri megfelelően a nyelvet
  • nincs ideje tisztességesen megcsinálni
  • nem érdekli a megnövekedett szoftverrothadás

Előfordulhat az is, hogy olyan új funkcióra van szükség, amely nagyon hasonló a program egy másik részében létezőtől, így egy fejlesztő egy olyan kódot ír, mely nagyon hasonlít egy más által létrehozott, már meglévő kódrészlethez. A tanulmányok szerint ilyen esetekben az újonnan írt kód általában szintaktikailag nem hasonló.

Egy másik oka lehet a kódduplikációnak az automatikus kódgenerálás, ahol a kódismétlést arra használják, hogy a fejlesztést megkönnyítsék vagy annak sebességét növeljék. A tényleges generátor nem tartalmaz kódismétlést a forráskódjában, csak az általa előállított kimenet ilyen.

Javítása

Az ismétlődő kód javításának legjobb példája a kód függvénybe ágyazása

A kódismétlést általában úgy javítják, hogy a kérdéses kódrészletet saját egységbe (függvénybe vagy metódusba) helyezik, és ezt az egységet hívják meg az összes olyan helyről, ahol eredetileg használva volt. Segíthet egy nyílt forráskódú fejlesztési stílus használata, amelyben az összetevők központosított helyen vannak.

Hátrányok és esetleges előnyök

A duplikált funkcionalitásokat tartalmazó kódot nehezebb fenntartani, mert:

• hosszabb
• ha frissítésre szorul, fennáll annak a veszélye, hogy a kód egyik helyen frissül, a többieken pedig nem

Másrészt, ha a kód egyik példányát különböző célokra használják, és nincs megfelelően dokumentálva, fennáll annak a veszélye, hogy egy adott célját szem előtt tartva frissítik, de ez nem lesz szükséges vagy megfelelő a többi használati célra.

A fenti szempontok nem relevánsak az automatikusan létrehozott kódok esetében, mivel ott a funkcionalitásnak csak egy példánya található a forráskódban.

A régi időkben, amikor kis memóriaterület állt rendelkezésre, a kódismétlés további hátránya volt, hogy szükségtelenül foglalta a memóriát.

Ha egy szoftveres sebezhetőséggel rendelkező kódot másolnak, és a fejlesztő nincs tudatában ennek, a biztonsági rés továbbra is fennállhat a duplikátumban. Egy duplikátum refaktorálása sok szoftvermutatón javíthat, például a kódhossz, ciklomatikus komplexitás és csatolás. Ez rövidebb kompilálási időket, alacsonyabb kognitív terhelést, kevesebb emberi hibát és kevesebb ottfelejtett vagy figyelmen kívül hagyott kódrészletet eredményezhet. Azonban nem minden duplikátumot lehet refaktorálni.

A duplikátumok hatékony megoldások lehetnek, ha a programozási nyelv túl bonyolult vagy alkalmatlan absztrakciókat biztosít, különösen ha a felhasználói felület technikákkal, például szimultán szerkesztéssel támogatja ezeket. Ezenkívül a refaktorálás alatt a kódba programhibák kerülhetnek, és ez a kockázat felülmúlhatja a karbantartási előnyöket. Wagner, Abdulkhaleq és Kaya tanulmánya arra a következtetésre jutott, hogy bár emelkedett munka szükséges a duplikátumok szinkronban tartása érdekében, ezek nem okoznak lényegesen több problémát mint egy duplikátum-mentes kód, feltéve hogy az érintett fejlesztők tisztában vannak velük. 

Klónészlelés

Számos különböző algoritmust javasoltak a duplikált kód felderítésére. Például:

• Baker algoritmusa
• Rabin–Karp karakterlánc-kereső algoritmus
• Absztrakt szintaxisfák használata
• Vizuális klónészlelés
• Count Matrix Clone Detection
• Helyfüggő hash
• Anti-unifikáció

Példa funkcionalitást ismétlő kódra

Tekintsük az alábbi kódrészletet egy egészeket tároló tömb átlagának kiszámításához.

extern int tomb1[];
extern int tomb2[];
 
int osszeg1 = 0;

for (int i = 0; i < 4; i++)
  osszeg1 += tomb1[i];

int atlag1 = osszeg1 / 4;
 
int osszeg2 = 0;

for (int i = 0; i < 4; i++)
  osszeg2 += tomb2[i];

int atlag2 = osszeg2 / 4;

A két "for" ciklus átírható egyetlen funkcióvá:

int atlagszamitas(int* tomb)
{
   int osszeg = 0;
   for (int i = 0; i < 4; i++)
       osszeg += tomb[i];

   return osszeg / 4;
}

vagy – általában előnyben részesített – a tömbben lévő elemek számának paraméterezésével.

A fenti függvény használatával olyan forráskódot kapunk, amely nem rendelkezik a ciklus ismétlésével:

extern int tomb1[];
extern int tomb2[];

int atlag1 = atlagszamitas(tomb1);
int atlag2 = atlagszamitas(tomb2);

Megjegyzés: Ebben az esetben a fordító dönthet úgy, hogy mindkét hívást beilleszti a függvénybe (inline expansion), és a kapott gépi kód megegyezik a duplikált és nem duplikált esetekben. Ha ez az optimizáció nem történik meg, akkor a függvényhívások költsége miatt a kód valószínűleg lassabb lesz. Elméletileg számíthat a megnőtt futási idő.

Fordítás

Ez a szócikk részben vagy egészben a Duplicate code című angol Wikipédia-szócikk ezen változatának fordításán alapul. Az eredeti cikk szerkesztőit annak laptörténete sorolja fel. Ez a jelzés csupán a megfogalmazás eredetét és a szerzői jogokat jelzi, nem szolgál a cikkben szereplő információk forrásmegjelöléseként.

További információk

• A Birminghami Alabamai Egyetem: Kódklónok irodalma
• Ismétlődő kód keresése a C #, VB könyvtárban
• Net, ASPX, Ruby, Python, Java, C, C ++, ActionScript vagy XAML

Kapcsolódó szócikkek

• Absztrakciós elv (számítógép-programozás)
• Antiminta
• Ne ismételd önmagad