Pišemo fleksibilan kod koristeći SOLID

Pišemo fleksibilan kod koristeći SOLID

Od prevoditelja: objavili smo za vas članak Severina Pereza o primeni SOLID principa u programiranju. Informacije iz članka će biti korisne kako početnicima, tako i iskusnim programerima.

Ako se bavite razvojem, verovatno ste čuli za SOLID principe. Oni omogućavaju programerima da pišu čist, dobro strukturiran i lako održavan kod. Važno je napomenuti da u programiranju postoji nekoliko pristupa kako pravilno izvršavati razne zadatke. Različiti stručnjaci imaju različite ideje i razumevanje "pravog puta", sve zavisi od iskustva svakog pojedinca. Ipak, ideje iznesene u SOLID-u prihvaćene su od strane gotovo svih članova IT zajednice. Postale su polazna tačka za pojavu i razvoj mnogih dobrih metoda upravljanja razvojem.

Hajde da istražimo šta su SOLID principi i kako nam pomažu.

Skillbox preporučuje: Praktični kurs „Mobilni developer PRO“.

Podsećamo: za sve čitaoce „Habra“ — popust od 10.000 rubalja prilikom upisa na bilo koji kurs Skillbox uz promo kod „Habr“.

Šta je SOLID?

Ovaj pojam je akronim, svako slovo označava naziv određenog principa:

Princip jedinstvene odgovornosti

 
Načelo jedinstvene odgovornosti (SRP) kaže da svaka klasa ili modul u programu treba biti odgovoran samo za jedan deo funkcionalnosti tog programa. Pored toga, elementi te odgovornosti treba da budu vezani za svoju klasu, a ne raspodeljeni po nepovezanim klasama. Razvijač i glavni evangelista SRP-a, Robert C. Martin, opisuje odgovornost kao uzrok promena. On je prvi put predložio ovaj termin kao jedan od elemenata svog rada 'Principi objektno-orijentisanog dizajna'. U koncept je ušlo mnoge od zakonitosti povezanosti, koja je prethodno definisana od strane Toma Demarka.

Takođe, u koncept su ušla neka pojma koja je formulirao David Parnas. Dva osnovna — enkapsulacija i skrivanje informacija. Parnas je tvrdio da deljenje sistema na pojedinačne module ne bi trebalo da se temelji na analizi blok-diagrama ili tokova izvršavanja. Bilo koji od modula treba da sadrži određeno rešenje koje pruža minimum informacija klijentima.

Usput, Martin je naveo zanimljiv primer sa višim menadžerima kompanije (COO, CTO, CFO), od kojih svaki koristi specifičan poslovni softver sa različitom namenom. U konačnici, bilo koji od njih može uvoditi promene u softveru, a da ne utiče na interese drugih menadžera.

Božanska klasa

Kao i obično, najbolji način da se prouči SRP je da se vidi sve u akciji. Pogledajmo deo programa koji NE odgovara načelu jedinstvene odgovornosti. Ovo je Ruby kod koji opisuje ponašanje i atribute svemirske stanice.

Proučite primer i pokušajte da identifikujete sledeće:
Obaveze onih objekata koji su proglašeni u klasi SpaceStation.
Onih koji bi mogli biti zainteresovani za rad svemirske stanice.

class SpaceStation
  def initialize
    @supplies = {}
    @fuel = 0
  end
 
  def run_sensors
    puts "----- Akcija senzora -----"
    puts "Pokretanje senzora!"
  end
 
  def load_supplies(type, quantity)
    puts "----- Akcija snabdevanja -----"
    puts "Učitavanje #{quantity} jedinica #{type} u skladište."
    
    if @supplies[type]
      @supplies[type] += quantity
    else
      @supplies[type] = quantity
    end
  end
 
  def use_supplies(type, quantity)
    puts "----- Akcija snabdevanja -----"
    if @supplies[type] != nil && @supplies[type] > quantity
      puts "Koristim #{quantity} jedinica #{type} iz skladišta."
      @supplies[type] -= quantity
    else
      puts "Greška u snabdevanju: Nedovoljno #{type} u skladištu."
    end
  end
 
  def report_supplies
    puts "----- Izveštaj o snabdevanju -----"
    if @supplies.keys.length > 0
      @supplies.each do |type, quantity|
        puts "#{type} dostupno: #{quantity} jedinica"
      end
    else
      puts "Skladište je prazno."
    end
  end
 
  def load_fuel(quantity)
    puts "----- Akcija goriva -----"
    puts "Učitavanje #{quantity} jedinica goriva u rezervoar."
    @fuel += quantity
  end
 
  def report_fuel
    puts "----- Izveštaj o gorivu -----"
    puts "#{@fuel} jedinica goriva dostupno."
  end
 
  def activate_thrusters
    puts "----- Akcija ubrzivača -----"
    if @fuel >= 10
      puts "Uspešna akcija ubrzivača."
      @fuel -= 10
    else
      puts "Greška ubrzivača: Nedovoljno goriva dostupno."
    end
  end
end

Naša svemirska stanica zapravo nije funkcionalna (ne verujem da ću primiti poziv od NASA-e u bliskoj budućnosti), ali ima mnogo toga što se može analizirati.

Dakle, klasa SpaceStation ima nekoliko različitih odgovornosti (ili zadataka). Sve se one mogu podeliti po tipovima:

  • senzori;
  • snabdevanje (potrepštine);
  • gorivo;
  • ubrzivači.

Iako niko od zaposlenih na stanici nije definisan u klasi, lako možemo zamisliti ko je za šta odgovoran. Verovatno naučnik kontroliše senzore, logističar se brine o snabdevanju, inženjer se brine o zalihama goriva, a pilot upravlja ubrzivačima.

Možemo li reći da ovaj program ne poštuje SRP? Da, naravno. Ali klasa SpaceStation je tipični "božanski objekt" koji zna sve i radi sve. To je osnovni antišablon u objektno-orijentisanom programiranju. Za početnika, takvi objekti su izuzetno teški za održavanje. Trenutno je program vrlo jednostavan, da, ali zamislite šta će se desiti ako dodamo nove funkcije. Možda će našoj svemirskoj stanici biti potrebna medicinska pomoć ili sala za sastanke. Što više funkcija doda, to će SpaceStation više rasti. A pošto će ovaj objekt biti povezan s drugim, održavanje celokupnog sistema će postati još složenije. Na kraju, možemo dovesti do problema, na primer, sa akceleratorima. Ako naučni saradnik zatraži izmene u radu sa senzorima, to može uticati na komunikacione sisteme stanice.

Kršenje SRP načela može doneti kratkoročne taktičke pobede, ali na kraju ćemo "izgubiti rat", održavanje takvog čudovišta u budućnosti postaneće veoma komplikovano. Najbolje je podeliti program na odvojene delove koda, od kojih svaki odgovara za izvršenje određene operacije. Razumevajući to, hajde da promenimo klasu SpaceStation.

Podelimo odgovornost

Gore smo definisali četiri tipa operacija koje kontroliše klasa SpaceStation. Prilikom refaktorisanja, imat ćemo to na umu. Ažurirani kod bolje odgovara SRP-u.

class SpaceStation
  attr_reader :sensors, :supply_hold, :fuel_tank, :thrusters
 
  def initialize
    @supply_hold = SupplyHold.new
    @sensors = Sensors.new
    @fuel_tank = FuelTank.new
    @thrusters = Thrusters.new(@fuel_tank)
  end
end
 
class Sensors
  def run_sensors
    puts "----- Sensor Action -----"
    puts "Running sensors!"
  end
end
 
class SupplyHold
  attr_accessor :supplies
 
  def initialize
    @supplies = {}
  end
 
  def load_supplies(type, quantity)
    puts "----- Supply Action -----"
    puts "Loading #{quantity} units of #{type} in the supply hold."
    
    if @supplies[type]
      @supplies[type] += quantity
    else
      @supplies[type] = quantity
    end
  end
 
  def use_supplies(type, quantity)
    puts "----- Supply Action -----"
    if @supplies[type] != nil && @supplies[type] > quantity
      puts "Using #{quantity} of #{type} from the supply hold."
      @supplies[type] -= quantity
    else
      puts "Supply Error: Insufficient #{type} in the supply hold."
    end
  end
 
  def report_supplies
    puts "----- Supply Report -----"
    if @supplies.keys.length > 0
      @supplies.each do |type, quantity|
        puts "#{type} available: #{quantity} units"
      end
    else
      puts "Supply hold is empty."
    end
  end
end
 
class FuelTank
  attr_accessor :fuel
 
  def initialize
    @fuel = 0
  end
 
  def get_fuel_levels
    @fuel
  end
 
  def load_fuel(quantity)
    puts "----- Fuel Action -----"
    puts "Loading #{quantity} units of fuel in the tank."
    @fuel += quantity
  end
 
  def use_fuel(quantity)
    puts "----- Fuel Action -----"
    puts "Using #{quantity} units of fuel from the tank."
    @fuel -= quantity
  end
 
  def report_fuel
    puts "----- Fuel Report -----"
    puts "#{@fuel} units of fuel available."
  end
end
 
class Thrusters
  def initialize(fuel_tank)
    @linked_fuel_tank = fuel_tank
  end
 
  def activate_thrusters
    puts "----- Thruster Action -----"
    if @linked_fuel_tank.get_fuel_levels >= 10
      puts "Thrusting action successful."
      @linked_fuel_tank.use_fuel(10)
    else
      puts "Thruster Error: Insufficient fuel available."
    end
  end
end

Puno je promena, program sada izgleda mnogo bolje. Naš razred SpaceStation sada je više kontejner u kojem se iniciraju operacije za deo povezane komponente, uključujući set senzora, sistem za snabdevanje potrošnim materijalima, rezervoar za gorivo i potisnike.

Sada za svaku od varijabli postoji odgovarajući razred: Sensors; SupplyHold; FuelTank; Thrusters.

Ova verzija koda sadrži nekoliko važnih izmjena. Naime, pojedinačne funkcije nisu samo inkapsulirane u vlastite klase, već su organizirane tako da postanu predvidljive i dosljedne. Grupiramo slične funkcionalnosti radi poštivanja načela kohezije. Sada, ako budemo morali promijeniti princip rada sustava, prelazeći s hash strukture na niz, jednostavno ćemo koristiti klasu SupplyHold, ne dirajući ostale module. Tako, ako službenik odgovoran za logistiku nešto promijeni u svojoj sekciji, ostali elementi stanice ostat će netaknuti. Pri tome klasa SpaceStation čak neće biti upoznata s tim promjenama.

Naši službenici koji rade na svemirskoj stanici vjerojatno su zadovoljni promjenama, jer mogu tražiti ono što im je potrebno. Obratite pažnju da u kodu postoje metode kao što su report_supplies i report_fuel, koje se nalaze u klasama SupplyHold i FuelTank. Što će se dogoditi ako Zemlja zatraži promjenu načina oblikovanja izvještaja? Moraćemo promijeniti obje klase, SupplyHold i FuelTank. A što ako bude potrebno promijeniti način dostave goriva i potrošnog materijala? Vjerojatno ćemo opet morati promijeniti sve iste klase. A to je već kršenje SRP načela. Hajde da to ispravimo.

class SpaceStation
  attr_reader :sensors, :supply_hold, :supply_reporter,
              :fuel_tank, :fuel_reporter, :thrusters
 
  def initialize
    @sensors = Sensors.new
    @supply_hold = SupplyHold.new
    @supply_reporter = SupplyReporter.new(@supply_hold)
    @fuel_tank = FuelTank.new
    @fuel_reporter = FuelReporter.new(@fuel_tank)
    @thrusters = Thrusters.new(@fuel_tank)
  end
end
 
class Sensors
  def run_sensors
    puts "----- Sensor Action -----"
    puts "Running sensors!"
  end
end
 
class SupplyHold
  attr_accessor :supplies
  attr_reader :reporter
 
  def initialize
    @supplies = {}
  end
 
  def get_supplies
    @supplies
  end
 
  def load_supplies(type, quantity)
    puts "----- Supply Action -----"
    puts "Loading #{quantity} units of #{type} in the supply hold."
    
    if @supplies[type]
      @supplies[type] += quantity
    else
      @supplies[type] = quantity
    end
  end
 
  def use_supplies(type, quantity)
    puts "----- Supply Action -----"
    if @supplies[type] != nil && @supplies[type] > quantity
      puts "Using #{quantity} of #{type} from the supply hold."
      @supplies[type] -= quantity
    else
      puts "Supply Error: Insufficient #{type} in the supply hold."
    end
  end
end
 
class FuelTank
  attr_accessor :fuel
  attr_reader :reporter
 
  def initialize
    @fuel = 0
  end
 
  def get_fuel_levels
    @fuel
  end
 
  def load_fuel(quantity)
    puts "----- Fuel Action -----"
    puts "Loading #{quantity} units of fuel in the tank."
    @fuel += quantity
  end
 
  def use_fuel(quantity)
    puts "----- Fuel Action -----"
    puts "Using #{quantity} units of fuel from the tank."
    @fuel -= quantity
  end
end
 
class Thrusters
  FUEL_PER_THRUST = 10
 
  def initialize(fuel_tank)
    @linked_fuel_tank = fuel_tank
  end
 
  def activate_thrusters
    puts "----- Thruster Action -----"
    
    if @linked_fuel_tank.get_fuel_levels >= FUEL_PER_THRUST
      puts "Thrusting action successful."
      @linked_fuel_tank.use_fuel(FUEL_PER_THRUST)
    else
      puts "Thruster Error: Insufficient fuel available."
    end
  end
end
 
class Reporter
  def initialize(item, type)
    @linked_item = item
    @type = type
  end
 
  def report
    puts "----- #{@type.capitalize} Report -----"
  end
end
 
class FuelReporter < Reporter
  def initialize(item)
    super(item, "fuel")
  end
 
  def report
    super
    puts "#{@linked_item.get_fuel_levels} units of fuel available."
  end
end
 
class SupplyReporter  0
      @linked_item.get_supplies.each do |type, quantity|
        puts "#{type} available: #{quantity} units"
      end
    else
      puts "Supply hold is empty."
    end
  end
end
 
iss = SpaceStation.new
 
iss.sensors.run_sensors
  # ----- Sensor Action -----
  # Running sensors!
 
iss.supply_hold.use_supplies("parts", 2)
  # ----- Supply Action -----
  # Supply Error: Insufficient parts in the supply hold.
iss.supply_hold.load_supplies("parts", 10)
  # ----- Supply Action -----
  # Loading 10 units of parts in the supply hold.
iss.supply_hold.use_supplies("parts", 2)
  # ----- Supply Action -----
  # Using 2 of parts from the supply hold.
iss.supply_reporter.report
  # ----- Supply Report -----
  # parts available: 8 units
 
iss.thrusters.activate_thrusters
  # ----- Thruster Action -----
  # Thruster Error: Insufficient fuel available.
iss.fuel_tank.load_fuel(100)
  # ----- Fuel Action -----
  # Loading 100 units of fuel in the tank.
iss.thrusters.activate_thrusters
  # ----- Thruster Action -----
  # Thrusting action successful.
  # ----- Fuel Action -----
  # Using 10 units of fuel from the tank.
iss.fuel_reporter.report
  # ----- Fuel Report -----
# 90 units of fuel available.

U ovoj, posljednjoj verziji programa, obaveze su podeljene u dvije nove klase, FuelReporter i SupplyReporter. Obje su podklase klase Reporter. Takođe, dodali smo instance varijable klasi SpaceStation da bismo po potrebi inicijalizovali odgovarajuću podklasu. Sada, ako Zemlja odluči da promeni nešto, izmene ćemo uneti u podklase, a ne u osnovnu klasu.

Naravno, neki od klasa još uvijek zavise jedni od drugih. Na primjer, objekat SupplyReporter zavisi od SupplyHold, dok FuelReporter zavisi od FuelTank. Očigledno, akceleratori moraju biti povezani s rezervoarom za gorivo. No, sada je sve logično, a unosi u promene neće biti naročito teški — uređivanje koda jednog objekta neće previše uticati na drugi.

Tako smo stvorili modularni kod, gdje su obaveze svakog objekta/klase tačno određene. Raditi s takvim kodom nije problem, njegovo održavanje će biti jednostavan zadatak. Celi "božanski objekat" transformisali smo u SRP.

Skillbox preporučuje:

Izvor: habr.com

Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere 🔥 Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere | ProHoster