Introduction to refactoring
8 likes1,475 views
The document discusses refactoring in software development, highlighting its importance in maintaining and improving code quality while managing complexity over time. It covers concepts such as design principles, common code 'smells' that indicate the need for refactoring, and practical techniques and tools for restructuring code without altering its observable behavior. Key principles include programming to interfaces, favoring object composition, and the significance of unit testing during the refactoring process.
![Should this be “refactored”?
class
Base
{
public
Base()
{
foo();
}
public
void
foo()
{
System.out.println("In
Base's
foo
");
}
}
class
Derived
extends
Base
{
public
Derived()
{
i
=
new
Integer(10);
}
public
void
foo()
{
System.out.println("In
Derived's
foo
"
+
i.toString()
);
}
private
Integer
i;
}
class
Test
{
public
staHc
void
main(String
[]
s)
{
new
Derived();
}
}
Crashes by throwing a
NullPointerException
It’s a bug! Fix it - its not called refactoring](https://image.slidesharecdn.com/introductiontorefactoring-150929124037-lva1-app6892/85/Introduction-to-refactoring-7-320.jpg)
![What’s that smell?
switch'(transferType)'{'
case'DataBuffer.TYPE_BYTE:'
byte'bdata[]'='(byte[])inData;'
pixel'='bdata[0]'&'0xff;'
length'='bdata.length;'
break;'
case'DataBuffer.TYPE_USHORT:'
short'sdata[]'='(short[])inData;'
pixel'='sdata[0]'&'0xffff;'
length'='sdata.length;'
break;'
case'DataBuffer.TYPE_INT:'
int'idata[]'='(int[])inData;'
pixel'='idata[0];'
length'='idata.length;'
break;'
default:'
throw' new' UnsupportedOperaQonExcepQon("This' method' has' not' been' "+' "implemented'
for'transferType'"'+'transferType);'
}'](https://image.slidesharecdn.com/introductiontorefactoring-150929124037-lva1-app6892/85/Introduction-to-refactoring-77-320.jpg)
inData;(
pixel(=(bdata[0](&(0xff;(
length(=(bdata.length;(
break;(
case(DataBuffer.TYPE_USHORT:(
short(sdata[](=((short[])inData;(
pixel(=(sdata[0](&(0xffff;(
length(=(sdata.length;(
break;(
case(DataBuffer.TYPE_INT:(
int(idata[](=((int[])inData;(
pixel(=(idata[0];(
length(=(idata.length;(
break;(
default:(
throw( new( UnsupportedOperaRonExcepRon("This( method(
has( not( been( "+( "implemented( for( transferType( "( +(
transferType);(
}!](https://image.slidesharecdn.com/introductiontorefactoring-150929124037-lva1-app6892/85/Introduction-to-refactoring-78-320.jpg)
![Refactoring with Lambdas
File[] files = new File(".").listFiles(
new FileFilter() {
public boolean accept(File f) { return f.isFile(); }
}
);
for(File file: files) {
System.out.println(file);
}
Arrays.stream(new File(“.”)
.listFiles(file -> file.isFile()))
.forEach(System.out::println);](https://image.slidesharecdn.com/introductiontorefactoring-150929124037-lva1-app6892/85/Introduction-to-refactoring-99-320.jpg)
![Refactoring APIs
public'class'Throwable'{'
//'following'method'is'available'from'Java'1.0'version.''
//'Prints'the'stack'trace'as'a'string'to'standard'output''
//'for'processing'a'stack'trace,''
//'we'need'to'write'regular'expressions''
public'void'printStackTrace();''''''
//'other'methods'omiEed'
}!
public'class'Throwable'{'
public'void'printStackTrace();''''''
'''''''''''''public'StackTraceElement[]'getStackTrace();'//'Since'1.4'
'''''''''''''//'other'methods'omiEed'
}!
public'final'class'StackTraceElement'{'
public'String'getFileName();'
public'int'getLineNumber();'
public'String'getClassName();'
public'String'getMethodName();'
public'boolean'isNaQveMethod();'
}!](https://image.slidesharecdn.com/introductiontorefactoring-150929124037-lva1-app6892/85/Introduction-to-refactoring-101-320.jpg)
Introduction to refactoring
- 2. “Applying design principles is the key to creating high-quality software!” Architectural principles: Axis, symmetry, rhythm, datum, hierarchy, transformation
- 3. For architects: design is the key!
- 4. Agenda • Refactoring Foundations • Refactoring - Principles • Refactoring Bad Smells • Refactoring Tools
- 5. Why care about refactoring? As an evolving program is continually changed, its complexity, reflecting deteriorating structure, increases unless work is done to maintain or reduce it - Lehman's law of Increasing Complexity
- 6. What is refactoring? Refactoring (noun): a change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behavior Refactor (verb): to restructure software by applying a series of refactorings without changing its observable behavior
- 7. Should this be “refactored”? class Base { public Base() { foo(); } public void foo() { System.out.println("In Base's foo "); } } class Derived extends Base { public Derived() { i = new Integer(10); } public void foo() { System.out.println("In Derived's foo " + i.toString() ); } private Integer i; } class Test { public staHc void main(String [] s) { new Derived(); } } Crashes by throwing a NullPointerException It’s a bug! Fix it - its not called refactoring
- 8. Should this be “refactored”? Calendar calendar = new Calendar.Builder() .set(YEAR, 2003) .set(MONTH, APRIL) .set(DATE, 6) .set(HOUR, 15) .set(MINUTE, 45) .set(SECOND, 22) .setTimeZone(TimeZone.getDefault()) .build(); System.out.println(calendar); Does this have “long message chains” smell? No - it’s a feature (use of builder pattern)!
- 9. Should this be “refactored”?
- 10. Smells approach to refactoring
- 13. Agenda • Refactoring Foundations • Refactoring - Principles • Refactoring Bad Smells • Refactoring Tools
- 14. 3 principles behind patterns Program to an interface, not to an implementation Favor object composition over inheritance Encapsulate what varies
- 15. SOLID principles • There&should&never&be&more&than&one&reason&for&a&class&to& change&& Single'Responsibility' Principle'(SRP)' • So6ware&en88es&(classes,&modules,&func8ons,&etc.)&should& be&open&for&extension,&but&closed&for&modifica8on& Open'Closed'Principle' (OCP)' • Pointers&or&references&to&base&classes&must&be&able&to&use& objects&of&derived&classes&without&knowing&it& Liskov’s'Subs<tu<on' Principle'(LSP)' • Depend&on&abstrac8ons,¬&on&concre8ons& Dependency'Inversion' Principle'(DIP)' • Many&clientGspecific&interfaces&are&beHer&than&one& generalGpurpose&interface& Interface'Segrega<on' Principle'(ISP)'
- 16. “When you find you have to add a feature to a program, and the program's code is not structured in a convenient way to add the feature, first refactor the program to make it easy to add the feature, then add the feature.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 17. “Refactoring changes the programs in small steps. If you make a mistake, it is easy to find the bug.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 18. “Don't publish interfaces prematurely. Modify your code ownership policies to smooth refactoring.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 19. “When you get a bug report, start by writing a unit test that exposes the bug.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 20. “Before you start refactoring, check that you have a solid suite of tests.” “Make sure all tests are fully automatic and that they check their own results.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 21. “It is better to write and run incomplete tests than not to run complete tests.” Source: Refactoring, Martin Fowler, Addison Wesley, 2003
- 23. Refactoring: Practical concerns “Fear of breaking working code” Is management buy-in necessary for refactoring? How to refactor code in legacy projects (no automated tests, difficulty in understanding, lack of motivation, …)? Where do I have time for refactoring?
- 24. Agenda • Refactoring Foundations • Refactoring - Principles • Refactoring Bad Smells • Refactoring Tools
- 25. Fowler’s bad smells Alternative Classes with Different Interfaces Comments Data Class Data Clumps Divergent Change Duplicated Code Feature Envy Inappropriate Intimacy Incomplete Library Class Large Class Lazy Class Long Method Long Parameter List Message Chains Middle Man Parallel Inheritance Hierarchies Primitive Obsession Refused Bequest Shotgun Surgery Speculative Generality Switch Statements Temporary Field
- 26. What’s that smell? “Large class” smell
- 27. Refactoring with “extract class”
- 28. What’s that smell? “Refused bequest” smell
- 30. What’s that smell? class%GraphicsDevice% %public%void%setFullScreenWindow(Window%w)%{% %%%%%%%%if%(w%!=%null)%{% %%%%%%%%%%%%if%(w.getShape()%!=%null)%{%w.setShape(null);%}% %%%%%%%%%%%%if%(w.getOpacity()%<%1.0f)%{%w.setOpacity(1.0f);%}% %%%%%%%%%%%%if%(!w.isOpaque())%{% %%%%%%%%%%%%%%%%Color%bgColor%=%w.getBackground();% %%%%%%%%%%%%%%%%bgColor%=%new%Color(bgColor.getRed(),% % %% %bgColor.getGreen(), % %%%% %bgColor.getBlue(),%255);% %%%%%%%%%%%%%%%%w.setBackground(bgColor);% %%%%%%%%%%%%}% %%%%%%%%}% …% }% This%code%in% GraphicsDevice%uses% more%methods%of% Window%than%calling% its%own%methods!% “Feature envy” smell
- 33. What’s that smell? Results in “Inappropriate intimacy” smell
- 34. What’s that smell? Results in “Inappropriate intimacy” smell
- 37. Duplicated Code
- 40. How to deal with duplication?
- 47. How about this refactoring?
- 48. How about this refactoring?
- 52. Refactoring
- 54. Liskov’s Substitution Principle (LSP) It#should#be#possible#to#replace# objects#of#supertype#with# objects#of#subtypes#without# altering#the#desired#behavior#of# the#program# Barbara#Liskov#
- 57. Refactoring for Date Replace inheritance with delegation
- 61. Refactoring
- 63. Refactoring
- 65. Refactoring
- 68. Refactoring
- 69. Refactoring
- 74. Refactoring
- 75. How about multiple interface inheritance?
- 76. Case study
- 77. What’s that smell? switch'(transferType)'{' case'DataBuffer.TYPE_BYTE:' byte'bdata[]'='(byte[])inData;' pixel'='bdata[0]'&'0xff;' length'='bdata.length;' break;' case'DataBuffer.TYPE_USHORT:' short'sdata[]'='(short[])inData;' pixel'='sdata[0]'&'0xffff;' length'='sdata.length;' break;' case'DataBuffer.TYPE_INT:' int'idata[]'='(int[])inData;' pixel'='idata[0];' length'='idata.length;' break;' default:' throw' new' UnsupportedOperaQonExcepQon("This' method' has' not' been' "+' "implemented' for'transferType'"'+'transferType);' }'
- 78. Replace conditional with polymorphism protected(int(transferType;! protected(DataBuffer(dataBuffer;! pixel(=(dataBuffer.getPixel();( length(=(dataBuffer.getSize();! switch((transferType)({( case(DataBuffer.TYPE_BYTE:( byte(bdata[](=((byte[])inData;( pixel(=(bdata[0](&(0xff;( length(=(bdata.length;( break;( case(DataBuffer.TYPE_USHORT:( short(sdata[](=((short[])inData;( pixel(=(sdata[0](&(0xffff;( length(=(sdata.length;( break;( case(DataBuffer.TYPE_INT:( int(idata[](=((int[])inData;( pixel(=(idata[0];( length(=(idata.length;( break;( default:( throw( new( UnsupportedOperaRonExcepRon("This( method( has( not( been( "+( "implemented( for( transferType( "( +( transferType);( }!
- 79. Scenario enum ColorScheme { RGB, HSB, HLS, CMYK } class Color { private float red, green, blue; // for supporting RGB scheme private float hue1, saturation1, brightness1; // for supporting HSB scheme private float hue2, lightness2, saturation2; // for supporting HLS scheme public Color(float arg1, float arg2, float arg3, ColorScheme cs) { switch (cs) { // initialize arg1, arg2, and arg3 based on ColorScheme value } } } • Assume that you need to support different Color schemes in your software • RGB (Red, Green, Blue), HSB (Hue, Saturation, Brightness), and HLS (Hue, Lightness, and Saturation) schemes • Overloading constructors and differentiating them using enums can become confusing • What could be a better design?
- 80. Hands-on exercise ❖ Refactor Color.java ❖ Hint: Use “factory method” design pattern
- 81. A solution using factory method pattern Color + GetRGBColor() + GetHSBColor() + GetHLSColor() RGBColor - red : float - green : float - blue : float HSBColor - hue : float - saturation : float - brightness : float HLSColor - hue : float - lightness : float - saturation : float
- 82. Factory method pattern: Discussion ❖ A class cannot anticipate the class of objects it must create ❖ A class wants its subclasses to specify the objects it creates Define an interface for creating an object, but let subclasses decide which class to instantiate. Factory method lets a class defer instantiation to subclasses. ❖ Delegate the responsibility to one of the several helper subclasses ❖ Also, localize the knowledge of which subclass is the delegate
- 83. Factory method: Java library example Logger logger = Logger.getLogger(TestFileLogger.class.getName());
- 84. Scenario ❖ Consider a Route class in an application like Google Maps ❖ For finding shortest path from source to destination, many algorithms can be used ❖ The problem is that these algorithms get embedded into Route class and cannot be reused easily (smell!) Route + Route(String, String) + getShortestPathJohnsons() + getShortestDijkstras() + getShortestBellmanFords() + … How will you refactor such that a) Support for shortest path algorithm can be added easily? b) Separate path finding logic from dealing with location information.
- 85. How about this solution? ShortestPathAlgos + FindPath() JohnsonsAlgo DijkstrasAlgo Route + SetRoute(Locati on, Location) + ShortestPath() + …
- 86. You’re right: Its Strategy pattern! Source: “Design Patterns: Elements of Reusable Object-Oriented Software”, Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides, Addison-Wesley,1994
- 87. Strategy pattern: Discussion ❖ Useful when there is a set of related algorithms and a client object needs to be able to dynamically pick and choose an algorithm that suits its current need Defines a family of algorithms, encapsulates each one, and makes them interchangeable. Strategy lets the algorithm vary independently from clients that use it ❖ The implementation of each of the algorithms is kept in a separate class referred to as a strategy. ❖ An object that uses a Strategy object is referred to as a context object. ❖ Changing the behavior of a Context object is a matter of changing its Strategy object to the one that implements the required algorithm
- 88. Scenario How to separate: a) code generation logic from node types? b) how to support different target types? class Plus extends Expr { private Expr left, right; public Plus(Expr arg1, Expr arg2) { left = arg1; right = arg2; } public void genCode() { left.genCode(); right.genCode(); if(t == Target.JVM) { System.out.println("iadd"); } else { // DOTNET System.out.println("add"); } } }
- 89. A solution using Visitor pattern class Plus extends Expr { private Expr left, right; public Plus(Expr arg1, Expr arg2) { left = arg1; right = arg2; } public Expr getLeft() { return left; } public Expr getRight() { return right; } public void accept(Visitor v) { v.visit(this); } } class DOTNETVisitor extends Visitor { public void visit(Constant arg) { System.out.println("ldarg " + arg.getVal()); } public void visit(Plus plus) { genCode(plus.getLeft()); genCode(plus.getRight()); System.out.println("add"); } public void visit(Sub sub) { genCode(sub.getLeft()); genCode(sub.getRight()); System.out.println("sub"); } public void genCode(Expr expr) { expr.accept(this); } }
- 90. Visitor pattern: structure Source: “Design Patterns: Elements of Reusable Object-Oriented Software”, Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides, Addison-Wesley,1994
- 91. Visitor pattern: call sequence Source: “Design Patterns: Elements of Reusable Object-Oriented Software”, Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides, Addison-Wesley,1994
- 92. Visitor pattern: Discussion ❖ Many distinct and unrelated operations need to be performed on objects in an object structure, and you want to avoid “polluting” their classes with these operations Represent an operation to be performed on the elements of an object structure. Visitor lets you define a new operation without changing the classes of the elements on which it operations ❖ Create two class hierarchies: ❖ One for the elements being operated on ❖ One for the visitors that define operations on the elements
- 95. Refactoring “incomplete library classes” smell min/max' open/close' create/destroy' get/set' read/write' print/scan' first/last' begin/end' start/stop' lock/unlock' show/hide' up/down' source/target' insert/delete' first/last' push/pull' enable/disable' acquire/release' le:/right' on/off'
- 98. Refactoring using Bridge structure
- 99. Refactoring with Lambdas File[] files = new File(".").listFiles( new FileFilter() { public boolean accept(File f) { return f.isFile(); } } ); for(File file: files) { System.out.println(file); } Arrays.stream(new File(“.”) .listFiles(file -> file.isFile())) .forEach(System.out::println);
- 100. Refactoring APIs public class Throwable { // following method is available from Java 1.0 version. // Prints the stack trace as a string to standard output // for processing a stack trace, // we need to write regular expressions public void printStackTrace(); // other methods omiEed }
- 102. Smells tend to “co-occur”
- 103. Amplification
- 104. Architecture smells
- 105. Agenda • Refactoring Foundations • Refactoring - Principles • Refactoring Bad Smells • Refactoring Tools
- 106. Structural Analysis for Java (stan4j)
- 107. JArchitect
- 108. InFusion
- 109. PMD CPD
- 110. SotoArc
- 111. CodeCity
- 112. Understand
- 113. Eclipse IDE
- 114. Books to read
- 120. “Applying design principles is the key to creating high-quality software!” Architectural principles: Axis, symmetry, rhythm, datum, hierarchy, transformation
- 121. Image credits ❖ http://en.wikipedia.org/wiki/Fear_of_missing_out ❖ http://lesliejanemoran.blogspot.in/2010_05_01_archive.html ❖ http://javra.eu/wp-content/uploads/2013/07/angry_laptop2.jpg ❖ https://www.youtube.com/watch?v=5R8XHrfJkeg ❖ http://womenworld.org/image/052013/31/113745161.jpg ❖ http://www.fantom-xp.com/wallpapers/33/I'm_not_sure.jpg ❖ https://www.flickr.com/photos/31457017@N00/453784086 ❖ https://www.gradtouch.com/uploads/images/question3.jpg ❖ http://gurujohn.files.wordpress.com/2008/06/bookcover0001.jpg ❖ http://upload.wikimedia.org/wikipedia/commons/d/d5/Martin_Fowler_-_Swipe_Conference_2012.jpg ❖ http://www.codeproject.com/KB/architecture/csdespat_2/dpcs_br.gif ❖ http://upload.wikimedia.org/wikipedia/commons/thumb/2/28/Bertrand_Meyer_IMG_2481.jpg/440px- Bertrand_Meyer_IMG_2481.jpg ❖ http://takeji-soft.up.n.seesaa.net/takeji-soft/image/GOF-OOPLSA-94-Color-75.jpg?d=a0 ❖ https://developer.apple.com/library/ios/documentation/cocoa/Conceptual/OOP_ObjC/Art/watchcalls_35.gif ❖ http://www.pluspack.com/files/billeder/Newsletter/25/takeaway_bag.png ❖ http://cdn1.tnwcdn.com/wp-content/blogs.dir/1/files/2013/03/design.jpg