SOLID प्रयोग गरेर लचिलो कोड लेख्दै

अनुवादकबाट: तपाईंको लागि प्रकाशित सेभेरिन पेरेज द्वारा लेख प्रोग्रामिङमा ठोस सिद्धान्तहरू प्रयोग गर्ने बारे। लेखबाट जानकारी शुरुवात र अनुभवी प्रोग्रामरहरू दुवैको लागि उपयोगी हुनेछ।

यदि तपाईं विकासमा हुनुहुन्छ भने, तपाईंले प्रायः SOLID सिद्धान्तहरू सुन्नु भएको छ। तिनीहरूले प्रोग्रामरलाई सफा, राम्रो-संरचित र सजिलैसँग मर्मत योग्य कोड लेख्न सक्षम पार्छन्। यो ध्यान दिन लायक छ कि प्रोग्रामिङमा त्यहाँ एक विशेष काम कसरी सही रूपमा प्रदर्शन गर्न धेरै दृष्टिकोणहरू छन्। विभिन्न विशेषज्ञहरूसँग "सही मार्ग" को बारेमा फरक विचार र बुझाइ हुन्छ; यो सबै प्रत्येक व्यक्तिको अनुभवमा निर्भर गर्दछ। यद्यपि, SOLID मा घोषणा गरिएका विचारहरू IT समुदायका लगभग सबै प्रतिनिधिहरूले स्वीकार गरेका छन्। तिनीहरू धेरै राम्रो विकास व्यवस्थापन अभ्यासहरूको उदय र विकासको लागि सुरूवात बिन्दु बने।

SOLID सिद्धान्तहरू के हुन् र तिनीहरूले हामीलाई कसरी मद्दत गर्छन् भनी बुझौं।

Skillbox सिफारिस गर्दछ: व्यावहारिक पाठ्यक्रम "मोबाइल विकासकर्ता प्रो".

हामी सम्झाउँछौं: सबै Habr पाठकहरूका लागि - Habr प्रोमो कोड प्रयोग गरी कुनै पनि Skillbox पाठ्यक्रममा भर्ना गर्दा १०,००० रूबल छुट।

SOLID भनेको के हो?

यो शब्द एक संक्षिप्त नाम हो, शब्द को प्रत्येक अक्षर एक विशिष्ट सिद्धान्त को नाम को शुरुवात हो:

• Sएकीकृत जिम्मेवारी सिद्धान्त। मोड्युलमा परिवर्तनको एउटै कारण हुन सक्छ।
• यो Oकलम / बन्द सिद्धान्त (खुला/बन्द सिद्धान्त)। कक्षाहरू र अन्य तत्वहरू विस्तारको लागि खुला हुनुपर्छ, तर परिमार्जनको लागि बन्द।
•  यो Liskov प्रतिस्थापन सिद्धान्त (Liskov प्रतिस्थापन सिद्धान्त)। आधार प्रकार प्रयोग गर्ने कार्यहरूले आधार प्रकारको उपप्रकारहरू प्रयोग गर्न सक्षम हुनुपर्दछ यो जान्न।
• यो Iइन्टरफेस विभाजन सिद्धान्त  (इन्टरफेस विभाजन सिद्धान्त)। सफ्टवेयर संस्थाहरूले तिनीहरूले प्रयोग नगर्ने विधिहरूमा निर्भर हुनु हुँदैन।
• यो Dनिर्भरता उल्टो सिद्धान्त (निर्भरता उल्टो सिद्धान्त)। उच्च स्तरहरूमा मोड्युलहरू तल्लो तहहरूमा मोड्युलहरूमा निर्भर हुनु हुँदैन।

एकल उत्तरदायित्व सिद्धान्त

 
एकल उत्तरदायित्व सिद्धान्त (SRP) ले बताउँछ कि कार्यक्रमको प्रत्येक वर्ग वा मोड्युल त्यो कार्यक्रमको कार्यक्षमताको एक भागको लागि मात्र जिम्मेवार हुनुपर्छ। थप रूपमा, यस जिम्मेवारीका तत्वहरू असम्बन्धित वर्गहरूमा छरपष्ट हुनुको सट्टा आफ्नै वर्गलाई तोक्नुपर्छ। SRP का विकासकर्ता र प्रमुख प्रचारक, रोबर्ट एस. मार्टिनले जवाफदेहितालाई परिवर्तनको कारण बताउँछन्। उनले मूल रूपमा यो शब्दलाई आफ्नो काम "वस्तु-उन्मुख डिजाइनका सिद्धान्तहरू" को एक तत्वको रूपमा प्रस्ताव गरे। अवधारणाले धेरै कनेक्टिविटी ढाँचा समावेश गर्दछ जुन पहिले टम डेमार्को द्वारा परिभाषित गरिएको थियो।

यस अवधारणामा डेभिड पर्नास द्वारा बनाईएको धेरै अवधारणाहरू पनि समावेश थिए। दुई मुख्य कुराहरू इन्क्याप्सुलेशन र जानकारी लुकाउने हुन्। पर्नासले तर्क गरे कि प्रणालीलाई छुट्टै मोड्युलमा विभाजन गर्नु ब्लक रेखाचित्र वा कार्यान्वयन प्रवाहको विश्लेषणमा आधारित हुनु हुँदैन। कुनै पनि मोड्युलले ग्राहकहरूलाई न्यूनतम जानकारी प्रदान गर्ने विशेष समाधान समावेश गर्नुपर्छ।

वैसे, मार्टिनले कम्पनीका वरिष्ठ प्रबन्धकहरू (COO, CTO, CFO) सँग एक रोचक उदाहरण दिए, जसमध्ये प्रत्येकले विभिन्न उद्देश्यका लागि विशिष्ट व्यापार सफ्टवेयर प्रयोग गर्दछ। नतिजाको रूपमा, तिनीहरू मध्ये कुनै पनि अन्य प्रबन्धकहरूको चासोलाई असर नगरी सफ्टवेयरमा परिवर्तनहरू लागू गर्न सक्छ।

दिव्य वस्तु

सधैं जस्तै, SRP सिक्ने उत्तम तरिका यसलाई कार्यमा हेर्नु हो। कार्यक्रमको एउटा खण्डलाई हेरौं जसले एकल जिम्मेवारी सिद्धान्तलाई पालना गर्दैन। यो रुबी कोड हो जसले स्पेस स्टेशनको व्यवहार र विशेषताहरू वर्णन गर्दछ।

उदाहरणको समीक्षा गर्नुहोस् र निम्न निर्धारण गर्ने प्रयास गर्नुहोस्:
SpaceStation क्लासमा घोषणा गरिएका ती वस्तुहरूको जिम्मेवारीहरू।
जो स्पेस स्टेशन को सञ्चालन मा रुचि हुन सक्छ।

class SpaceStation
  def initialize
    @supplies = {}
    @fuel = 0
  end
 
  def run_sensors
    puts "----- Sensor Action -----"
    puts "Running sensors!"
  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} avalilable: #{quantity} units"
      end
    else
      puts "Supply hold is empty."
    end
  end
 
  def load_fuel(quantity)
    puts "----- Fuel Action -----"
    puts "Loading #{quantity} units of fuel in the tank."
    @fuel += quantity
  end
 
  def report_fuel
    puts "----- Fuel Report -----"
    puts "#{@fuel} units of fuel available."
  end
 
  def activate_thrusters
    puts "----- Thruster Action -----"
    if @fuel >= 10
      puts "Thrusting action successful."
      @fuel -= 10
    else
      puts "Thruster Error: Insufficient fuel available."
    end
  end
end

वास्तवमा, हाम्रो अन्तरिक्ष स्टेशन बेकार छ (मलाई लाग्दैन कि म NASA बाट कुनै पनि समयमा कल प्राप्त गर्नेछु), तर यहाँ विश्लेषण गर्न केहि छ।

यसैले, SpaceStation वर्गसँग धेरै फरक जिम्मेवारीहरू (वा कार्यहरू) छन्। ती सबै प्रकार मा विभाजित गर्न सकिन्छ:

• सेन्सरहरू;
• आपूर्ति (उपभोग्य वस्तुहरू);
• इन्धन;
• गतिवर्धकहरू।

स्टेसनका कुनै पनि कर्मचारीलाई कक्षा तोकिएको छैन, हामी सजिलै कल्पना गर्न सक्छौं कि कसको जिम्मेवारी के छ। सम्भवतः, वैज्ञानिकले सेन्सरहरू नियन्त्रण गर्दछ, रसद स्रोतहरू आपूर्ति गर्न जिम्मेवार छ, इन्जिनियर इन्धन आपूर्तिको लागि जिम्मेवार छ, र पायलटले बूस्टरहरू नियन्त्रण गर्दछ।

के हामी यो कार्यक्रम SRP अनुरूप छैन भन्न सक्छौं? हो, पक्का। तर SpaceStation वर्ग एक विशिष्ट "भगवान वस्तु" हो जसले सबै कुरा जान्दछन् र सबै कुरा गर्छ। यो वस्तु-उन्मुख प्रोग्रामिङ मा एक प्रमुख विरोधी ढाँचा हो। एक शुरुवातको लागि, त्यस्ता वस्तुहरू मर्मत गर्न धेरै गाह्रो हुन्छ। अहिलेसम्म कार्यक्रम धेरै सरल छ, हो, तर हामीले नयाँ सुविधाहरू थप्यौं भने के हुन्छ कल्पना गर्नुहोस्। सायद हाम्रो स्पेस स्टेशनलाई मेडिकल स्टेशन वा बैठक कोठा चाहिन्छ। र त्यहाँ जति धेरै प्रकार्यहरू छन्, थप स्पेस स्टेशन बढ्नेछ। खैर, यो सुविधा अरूसँग जोडिने भएकोले, सम्पूर्ण कम्प्लेक्सको सेवा दिन अझ गाह्रो हुनेछ। नतिजाको रूपमा, हामी, उदाहरण को लागी, गतिवर्धक को सञ्चालन बाधक गर्न सक्छौं। यदि एक शोधकर्ताले सेन्सरहरूमा परिवर्तन गर्न अनुरोध गर्दछ भने, यसले स्टेशनको सञ्चार प्रणालीलाई राम्रोसँग असर गर्न सक्छ।

SRP सिद्धान्त उल्लङ्घन गर्दा छोटो अवधिको रणनीतिक जीत हुन सक्छ, तर अन्तमा हामी "युद्ध हार्नेछौं", र भविष्यमा यस्तो राक्षसलाई कायम राख्न धेरै गाह्रो हुनेछ। यो प्रोग्रामलाई कोडको अलग-अलग खण्डहरूमा विभाजन गर्न उत्तम हुन्छ, जसमध्ये प्रत्येक एक विशेष सञ्चालन गर्न जिम्मेवार हुन्छ। यो बुझेर, स्पेस स्टेशन क्लास परिवर्तन गरौं।

जिम्मेवारी बाँडफाँड गरौं

माथि हामीले स्पेसस्टेशन क्लासद्वारा नियन्त्रित चार प्रकारका अपरेसनहरू परिभाषित गरेका छौं। रिफ्याक्टर गर्दा हामी तिनीहरूलाई दिमागमा राख्नेछौं। अपडेट गरिएको कोड SRP सँग राम्रोसँग मेल खान्छ।

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} avalilable: #{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

त्यहाँ धेरै परिवर्तनहरू छन्, कार्यक्रम निश्चित रूपमा अब राम्रो देखिन्छ। अब हाम्रो स्पेस स्टेशन क्लास एक कन्टेनर भएको छ जसमा सेन्सरहरूको सेट, उपभोग्य आपूर्ति प्रणाली, इन्धन ट्याङ्की र बूस्टरहरू सहित निर्भर भागहरूका लागि सञ्चालनहरू सुरु गरिन्छ।

कुनै पनि चरका लागि अब एक समान वर्ग छ: सेन्सर; आपूर्ति होल्ड; इन्धन ट्याङ्की; थ्रस्टरहरू।

कोडको यस संस्करणमा धेरै महत्त्वपूर्ण परिवर्तनहरू छन्। बिन्दु यो हो कि व्यक्तिगत प्रकार्यहरू तिनीहरूको आफ्नै कक्षाहरूमा मात्र समेटिएका छैनन्, तिनीहरू भविष्यवाणी गर्न योग्य र सुसंगत हुने तरिकामा व्यवस्थित छन्। हामी समानताको सिद्धान्तलाई पछ्याउन समान कार्यक्षमता भएका तत्वहरूलाई समूहबद्ध गर्छौं। अब, यदि हामीले प्रणालीको काम गर्ने तरिका परिवर्तन गर्न आवश्यक छ, ह्यास संरचनाबाट एरेमा सर्दै, केवल सप्लाइहोल्ड क्लास प्रयोग गर्नुहोस्; हामीले अन्य मोड्युलहरू छुनु पर्दैन। यसरी, यदि रसद अधिकारीले आफ्नो खण्डमा केहि परिवर्तन गर्दछ भने, बाँकी स्टेशन अक्षुण्ण रहनेछ। यस अवस्थामा, SpaceStation क्लासले पनि परिवर्तनहरू बारे सचेत हुनेछैन।

अन्तरिक्ष स्टेशनमा काम गर्ने हाम्रा अधिकारीहरू परिवर्तनहरूबाट खुसी छन् किनभने उनीहरूले आफूलाई आवश्यक पर्ने अनुरोध गर्न सक्छन्। ध्यान दिनुहोस् कि कोडमा विधिहरू छन् जस्तै रिपोर्ट_सप्लाइहरू र रिपोर्ट_ईन्धनहरू आपूर्तिहोल्ड र फ्युलट्याङ्क कक्षाहरूमा समावेश छन्। यदि पृथ्वीले रिपोर्ट गर्ने तरिका परिवर्तन गर्न भन्यो भने के हुन्छ? दुबै वर्गहरू, सप्लाईहोल्ड र फ्युलट्याङ्क, परिवर्तन गर्न आवश्यक हुनेछ। यदि तपाईंलाई इन्धन र उपभोग्य वस्तुहरू डेलिभरी गर्ने तरिका परिवर्तन गर्न आवश्यक छ भने के हुन्छ? तपाईंले सायद सबै एउटै कक्षाहरू फेरि परिवर्तन गर्नुपर्नेछ। र यो पहिले नै SRP सिद्धान्तको उल्लङ्घन हो। यसलाई ठीक गरौं।

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 < Reporter
  def initialize(item)
    super(item, "supply")
  end
 
  def report
    super
    if @linked_item.get_supplies.keys.length > 0
      @linked_item.get_supplies.each do |type, quantity|
        puts "#{type} avalilable: #{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 avalilable: 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.

कार्यक्रमको यो नवीनतम संस्करणमा, जिम्मेवारीहरूलाई दुई नयाँ कक्षाहरू, FuelReporter र SupplyReporter मा विभाजन गरिएको छ। उनीहरु दुवै रिपोर्टर कक्षाका सन्तान हुन् । थप रूपमा, हामीले स्पेसस्टेशन क्लासमा उदाहरण चरहरू थप्यौं ताकि आवश्यक भएमा वांछित उपवर्ग प्रारम्भ गर्न सकिन्छ। अब, यदि पृथ्वीले अरू केहि परिवर्तन गर्ने निर्णय गर्छ भने, हामी उपवर्गहरूमा परिवर्तन गर्नेछौं, मुख्य वर्गमा होइन।

अवश्य पनि, हाम्रा केही वर्गहरू अझै पनि एकअर्कामा निर्भर छन्। यसरी, SupplyReporter वस्तु SupplyHold मा निर्भर गर्दछ, र FuelReporter FuelTank मा निर्भर गर्दछ। निस्सन्देह, बूस्टरहरू इन्धन ट्याङ्कीमा जोडिएको हुनुपर्छ। तर यहाँ सबै कुरा पहिले नै तार्किक देखिन्छ, र परिवर्तन गर्न विशेष गरी गाह्रो हुनेछैन - एउटा वस्तुको कोड सम्पादन गर्दा अर्कोलाई धेरै असर गर्दैन।

यसरी, हामीले एक मोड्युलर कोड सिर्जना गरेका छौं जहाँ प्रत्येक वस्तु/वर्गको जिम्मेवारीहरू ठीकसँग परिभाषित गरिएको छ। यस्तो कोडको साथ काम गर्न कुनै समस्या छैन, यसलाई कायम राख्न एक सरल कार्य हुनेछ। हामीले सम्पूर्ण "दैवी वस्तु" लाई SRP मा परिणत गरेका छौं।

Skillbox सिफारिस गर्दछ:

• दुई वर्षे व्यावहारिक पाठ्यक्रम "म एक प्रो वेब विकासकर्ता हुँ".
• अनलाइन कोर्स "0 बाट C# विकासकर्ता".
• एक वर्षको व्यावहारिक पाठ्यक्रम "0 देखि PRO मा PHP विकासकर्ता".

स्रोत: www.habr.com