Kirjat
Python
Luku 5. Hyvät ohjelmointikäytännöt
Koodin refaktorointi

Python:
Koodin refaktorointi

Miten:

Kuvitellaan, että sinulla on koodinpätkä, joka laskee ja tulostaa suorakulmion pinta-alan ja piirin annettujen pituus- ja leveysmittojen perusteella. Se toimii, mutta se on toistuvaa ja hieman sotkuista.

# Alkuperäinen versio
pituus = 4
leveys = 3

# Laske pinta-ala ja piiri
pinta_ala = pituus * leveys
piiri = 2 * (pituus + leveys)

print("Pinta-ala:", pinta_ala)
print("Piiri:", piiri)

Voimme refaktoroida tämän kapseloimalla toiminnallisuuden funktioihin, mikä tekee koodista järjestäytyneemmän ja uudelleenkäytettävän:

# Refaktoroitu versio

def laske_pinta_ala(pituus, leveys):
    return pituus * leveys

def laske_piiri(pituus, leveys):
    return 2 * (pituus + leveys)

# käyttö
pituus = 4
leveys = 3

print("Pinta-ala:", laske_pinta_ala(pituus, leveys))
print("Piiri:", laske_piiri(pituus, leveys))

Molemmat pätkät tulostavat saman tuloksen:

Pinta-ala: 12
Piiri: 14

Mutta refaktoroitu versio on siistimpi ja erottaa huolenaiheet toisistaan, mikä tekee yhden laskelman päivittämisestä helpompaa vaikuttamatta toiseen.

Syväsukellus

Refaktoroinnin juuret ovat ohjelmistosuunnittelun alkuaikoina, kun ohjelmoijat ymmärsivät, että koodia voitiin—ja pitäisi—parantaa, vaikka se jo “toimisi”. Martin Fowlerin merkittävä kirja “Refactoring: Improving the Design of Existing Code” artikuloi monet ydintekniikat ja -periaatteet. Hän sanoi kuuluisasti, “Kuka tahansa hölmö voi kirjoittaa koodia, jonka tietokone ymmärtää. Hyvät ohjelmoijat kirjoittavat koodia, jonka ihmiset voivat ymmärtää.”

Vaihtoehtoja refaktoroinnille voisi sisältää koodin uudelleenkirjoittamisen alusta tai pienet säädöt ilman systemaattista parantamista. Kuitenkin refaktorointi on yleensä kustannustehokkaampi kuin uudelleenkirjoitus ja vähemmän riskialtis kuin ad-hoc-muutokset. Toteutuksen yksityiskohdat voivat olla erityisiä kullekin ohjelmointiparadigmalle; kuitenkin objektiivinen ohjelmointi soveltuu erityisen hyvin refaktorointiin, erityisesti tekniikoilla kuten metodien eriyttäminen (kuten laske_pinta_ala ja laske_piiri funktiot), sisäänrakentaminen, ominaisuuksien siirtäminen objektien välillä ja metodien tai muuttujien uudelleennimeäminen selkeyden vuoksi.

Pythonissa refaktorointiin käytetään usein työkaluja kuten PyCharm, jossa on sisäänrakennettuja refaktorointiominaisuuksia, tai rope, Python-kirjasto erityisesti refaktorointia varten. Varovaisuus versionhallinnan, kuten git, käytössä refaktoroinnin aikana on erittäin suositeltavaa muutosten inkrementelliseen seurantaan.

Katso myös

Lisätietoa kaipaaville, sukella seuraaviin resursseihin:

Koodin järjestäminen funktioihin