User Tools

Site Tools


principles:encapsulate_the_concept_that_varies

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
principles:encapsulate_the_concept_that_varies [2021-09-02 12:26]
65.21.179.175 old revision restored (2021-05-19 11:22)
principles:encapsulate_the_concept_that_varies [2021-09-02 19:36]
65.21.179.175 old revision restored (2021-05-11 21:52)
Line 14: Line 14:
  
 ===== Description ===== ===== Description =====
- 
-This principle has two aspects that roughly correspond to the two sub-principles [[Single Responsibility Principle|SRP]] and [[Open-Closed Principle|OCP]]. The first one is about making changes local. Everything which is supposed to change in the future should be encapsulated in a single module. This means [[glossary:cross-cutting concerns]] are avoided as much as possible. This is not completely possible but in many cases it is. 
- 
-The second aspect is about introducing abstractions. Sometime the varying concept is one which varies at runtime rather than by maintenance. So at runtime it is decided upon a certain variation or there can be even several variations at the same time. In this case there has to be an abstract base class or an interface which encapsulates the varying concept. Several concrete descendant classes then specify the concrete variation. 
- 
-The difference between the two aspects is whether the varying concept is one that changes over time during maintenance or one that may change at runtime. Nevertheless the advice is the same: encapsulate the concept that varies. 
  
  
 ===== Rationale ===== ===== Rationale =====
- 
-There are two reasons for this principle. The first reason is locality. When a varying concept is properly encapsulated in a single module, only this module is affected in case of a change. This reduces maintenance effort and [[glossary:ripple effects]]. 
- 
-The second reason comes to play when the varying concept is implemented as an abstract class or interface. In this case a variation can be introduced without changing existing and tested code. This reduces testing effort (as already tested code does not need to be retested as it is not changed) as well as ripple effects (as the enhancement is done simply by adding a class. Note that for this rationale to work, the [[Liskov Substitution Principle]] also has to be adhered to. 
  
  
 ===== Strategies ===== ===== Strategies =====
  
-  * Introduce a separate module for the concept that may change in the future. In that way the future change will only affect that particular module. If the varying concept is properly encapsulated, only this module will have to change. 
-  * Introduce an interface encapsulating the varying concept. The interface may be implemented differently by several classes and code that only relies on the interface can handle any class implementing the interface. In case of another variation, just another class has to be introduced and this class has to implement the interface. If the abstraction is done properly, no module has to change. 
-  * Introduce an abstract base class encapsulating the varying concept. This is basically the same as introducing an interface. But here, implementation can also be inherited. So common parts can remain in the abstract base class whereas only the actual variations are defined in the subclasses. By means of method overriding, the implementation of the base class methods can be changed without touching the base class directly. 
-  * Use design patterns. Several design patterns use the above techniques to encapsulate varying concepts. For example: 
-    * Abstract Factory: A family of objects changes. 
-    * Factory Method: The exact type of an object to create changes. 
-    * Adapter: The interface of a module changes. 
-    * Bridge: A concept varies in more than one aspect. 
-    * Decorator: The behavior of certain methods may need to be enhanced. 
-    * Iterator: The traversal algorithm of a structure changes. Or the structure itself changes resulting in the need for a different traversal algorithm. 
-    * Observer: The objects interested in a certain event may change. 
-    * State: The behavior in a certain state or the state machine (states and transitions) of a certain module changes. 
-    * Strategy: An algorithm changes. 
-    * Template Method: The concrete steps in an algorithms change. 
-    * Visitor: New operations have to be added to a given more or less static inheritance structure of classes. 
-    * ... 
  
 ===== Origin ===== ===== Origin =====
  
-Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides: //[[wp>Design Patterns|Design Patterns: Elements of Reusable Object-Oriented Software]]// ("GoF book"), p. 29 
  
 ===== Evidence ===== ===== Evidence =====
 /* Comment out what is not applicable and explain the rest: */ /* Comment out what is not applicable and explain the rest: */
-/*  * [[wiki:Proposed]] */ +/* 
- +  * [[wiki:Proposed]] 
-  * [[wiki:Accepted]]: This principle was popularly described in the GoF book and can thus be regarded accepted. +  * [[wiki:Examined]] 
-  * [[wiki:Examined]]: Many of the patterns in the GoF book are precisely about encapsulating varying concepts. See strategies section. +  * [[wiki:Accepted]] 
- +  * [[wiki:Questioned]] 
-/*  * [[wiki:Questioned]]*/+*/
  
 ===== Relations to Other Principles ===== ===== Relations to Other Principles =====
Line 65: Line 38:
 ==== Generalizations ==== ==== Generalizations ====
  
-  * [[Generalization Principle]] (GP): Encapsulating a varying concept typically results in a more generally applicable solution. This is especially true when an abstract concept is encapsulated by introducing an interface or an abstract class.+  * [[Generalization Principle]] 
 +  * [[Open-Closed Principle]] 
  
 ==== Specializations ==== ==== Specializations ====
  
-  * [[Single Responsibility Principle]] (SRP): A responsibility in the sense of SRP is defined as "a reason for change". This is a concept that varies over time. SRP tells that each module should have exactly one responsibility, i.e. the concept/responsibility should be encapsulated in that module. +  * [[Single Responsibility Principle]] (SRP): 
-  * [[Open-Closed Principle]] (OCP): The OCP demands encapsulating abstract concepts in base classes (or interfaces) in order to be able to enhance the module by subclassing which is possible without changing the previously written code. In this case several variations of a concept may exist in the code at the same time. There is always the abstract base class plus one or usually more concrete subclasses. So the OCP is about encapsulating abstract concepts that vary "in space".+
  
 ==== Contrary Principles ==== ==== Contrary Principles ====
  
-  * **[[More Is More Complex]] (MIMC)**: ECV demands adding a new class for a new varying concept.+  * [[More Is More Complex]] (MIMC): ECV demands adding a new class for a new varying concept.
   * [[Model Principle]] (MP): ECV sometimes results in classes which do not correspond top a real-world concept in the sense of MP. A "concept that varies" can also be a technical concept.   * [[Model Principle]] (MP): ECV sometimes results in classes which do not correspond top a real-world concept in the sense of MP. A "concept that varies" can also be a technical concept.
  
Line 80: Line 54:
  
   * [[Dependency Inversion Principle]] (DIP): ECV may result in the creation of abstract classes (i.e. the concepts) and descendant concrete classes (i.e. the variations). DIP now tells that other classes should only depend on the abstractions.   * [[Dependency Inversion Principle]] (DIP): ECV may result in the creation of abstract classes (i.e. the concepts) and descendant concrete classes (i.e. the variations). DIP now tells that other classes should only depend on the abstractions.
-  * [[Liskov Substitution Principle]] (LSP): ECV may result in the introduction of an abstract base class. Here it is important to get the abstraction right. Otherwise LSP may be violated. 
  
  
Line 86: Line 59:
  
 {{page>collections:OOD Principle Language#Box}} {{page>collections:OOD Principle Language#Box}}
 +{{page>collections:SOLID#Box}} 
 +{{page>collections:Principles in "Object-Oriented Software Construction"#Box}}
  
 ===== Example ===== ===== Example =====
Line 93: Line 67:
 ===== Description Status ===== ===== Description Status =====
 /* Choose one of the following and comment out the rest: */ /* Choose one of the following and comment out the rest: */
-/*[[wiki:Stub]]*/ +[[wiki:Stub]] 
-[[wiki:Incomplete]]+/*[[wiki:Incomplete]]*/
 /*[[wiki:Complete]]*/ /*[[wiki:Complete]]*/
  
Line 100: Line 74:
  
   * Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides: //[[wp>Design Patterns|Design Patterns:   * Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides: //[[wp>Design Patterns|Design Patterns:
- Elements of Reusable Object-Oriented Software]]// + Elements of Reusable Object-Oriented Software]]//, p. 29 
-  * [[Single Responsibility Principle]] +  * Bertrand Meyer: //[[wp>Object-Oriented Software Construction]]//, p. 57pp. 
-  * [[Open-Closed Principle]]+  * Robert C. Martin: //Agile Software Development, Principles, Patterns, and Practices//, p. 99pp. 
 +  * [[http://www.butunclebob.com/ArticleS.UncleBob.PrinciplesOfOod|ButUncleBob: Principles of OOD]]
principles/encapsulate_the_concept_that_varies.txt · Last modified: 2021-10-18 21:31 by christian