SlideShare une entreprise Scribd logo
1  sur  77
Télécharger pour lire hors ligne
ThoughtWorks


      the productive
programmer: practice
   10 ways to improve
            your code
             NEAL FORD        software architect / meme wrangler



                       ThoughtWorks
          nford@thoughtworks.com
          3003 Summit Boulevard, Atlanta, GA 30319
          www.nealford.com
          www.thoughtworks.com
          memeagora.blogspot.com
from whence?

         2 parts:

          mechanics

          practices
          practices
1   composed method
composed method
Divide your program into methods that
perform one identifiable task.


Keep all of the operations in a method at the
same level of abstraction.


This will naturally result in programs with many
small methods, each a few lines long.
refactoring to
composed method
BoundaryBase
getDatabaseConnection()




           PartDb
populate()
getDatabaseConnection()
getDatabaseConnection()
createResultSet()
addPartToListFromResultSet()
BoundaryBase
 getDatabaseConnection()




             PartDb
populate()

createResultSet()
createResultSet()
addPartToListFromResultSet()
BoundaryBase




         PartDb
BoundaryBase
 getDatabaseConnection()
 getSqlForEntity()
 createResultSet()




             PartDb
populate()

getSqlForEntity()
addPartToListFromResultSet()
BoundaryBase                    BoundaryBase
 getDatabaseConnection()       getDatabaseConnection()
 getSqlForEntity()             getSqlForEntity()
 createResultSet()             createResultSet()
                               addEntityToListFromResultSet()
                               populate()



             PartDb                        PartDb
populate()
                               addEntityToListFromResultSet()
getSqlForEntity()              getSqlForEntity()
addPartToListFromResultSet()   addPartToListFromResultSet()
BoundaryBase
PartDb
benefits of composed
        method
shorter methods easier to test

method names become documentation

large number of very cohesive methods

discover reusable assets that you didn’t know
were there
2
     test-driven
    development
test-driven design
design benefits of tdd

first consumer


think about how the rest of the world uses this
class


creates consumption awareness
design benefits of tdd
forces mocking of dependent objects


naturally creates composed method


cleaner metrics
3
    static analysis
byte-code analysis:
     findbugs
bug categories
correctness
   probable bug


bad practice
   violation of recommended & essential
   coding practice

dodgy
  confusing, anomalous, written poorly
4   good citizenship
static methods


Math.sqrt(25)

                 Math.sqrt()
mixing static + state
singleton
singleton is bad because:

   mixes responsibilities

   untestable

   the object version of global variables
avoiding singletons
1. create a pojo for the business behavior

   simple

   testable!

2. create a factory to create the pojo

   also testable
5   yagni
    you ain’t gonna need it
discourages gold plating
build the simplest thing that we need right now

don’t indulge in speculative development

   increases software entropy

   only saves time if you can guarantee you
   won’t have to change it later

   leads to frameworks
This is just
what they need!
changeability

anticipatory
  design



                                refactorable




               rate of change

   lower                          higher
corporate code smells
6. We have an Architect who reviews all code pre-
checkin and decides whether or not to allow it
into version control.
7. We can’t use any open source code because
our lawyers say we can’t.
8. We use WebSphere because...(I always stop
listening at this point)
9. We bought the entire tool suite (even though
we only needed about 10% of it) because it was
cheaper than buying the individual tools.
10. We invented our own web/persistence/
messaging/caching framework because none of
the existing ones was good enough.
1. There is a reason that WSAD isn’t called
WHAPPY.
2. The initial estimate must be within 15% of the
final cost, the post-analysis estimate must be
within 10%, and the post-design estimate must be
with 5%
3. We don’t have time to write unit tests (we’re
spending too much time debugging)
4. We keep all of our business logic in stored
procedures...for performance reasons.
5. The only JavaDoc is the Eclipse message
explaining how to change your default JavaDoc
template.
6   question authority
angry monkeys
test names
testUpdateCacheAndVerifyThatItemExists() {

}

test_Update_cache_and_verify_that_item_exists() {

}
non-intuitive
pair programming
        studies




after adjusting, pairs produced code 15%
      more slowly than individuals...
pair programming
      studies




 ...with 15% fewer defects
7      slap

   single level of
abstraction principle
slap
keep all lines of code in a method at the same
level of abstraction
jumping abstraction layers makes code hard to
understand

composed method => slap

refactor to slap

even if it means single-line methods
8
polyglot


    	

	

 	

 	

 	

 	

 	


	

 	

 	

 	

 	

 	

 programming
leveraging existing
platforms with languages
   targeted at specific
       problems and
        applications
looming problems/
       opportunities
massively parallel threading

   use a functional language: jaskell, scala

schedule pressure

   jruby on rails, grails
looming problems/
       opportunities

writing more declarative code via dsls

build fluent interfaces
swiby: jruby + swing
9   every nuance
java’s back alleys
reflection


   “reflection is slow”


   no longer true


elegant solutions to problems
regular expressions &
learn the nuances of
         java...
 ...then tell the other
people on your project
10   anti-objects
collaborative diffusion
“The metaphor of objects can go too far by making
us try to create objects that are too much inspired
by the real world. “


“...an antiobject is a kind of object that appears to
essentially do the opposite of what we generally
think the object should be doing.”
ThoughtWorks




                         questions?
   please fill out the session evaluations
slides & samples available at nealford.com


                                                         NEAL FORD        software architect / meme wrangler



                                                                   ThoughtWorks
 This work is licensed under the Creative Commons     nford@thoughtworks.com
                                                      3003 Summit Boulevard, Atlanta, GA 30319
 Attribution-Noncommercial-Share Alike 2.5 License.   www.nealford.com
                                                      www.thoughtworks.com
  http://creativecommons.org/licenses/by-nc-sa/2.5/   memeagora.blogspot.com
resources
An Initial Investigation of Test Driven Development in Industry -
Laurie Williams, Boby George
http://collaboration.csc.ncsu.edu/laurie/Papers/TDDpaperv8.pdf

findbugs
http://findbugs.sourceforge.net/

pmd/cpd
http://pmd.sourceforge.net/

The legend of the leaning tower
http://physicsworld.com/cws/article/print/16806

AntiPatterns Catalog
http://c2.com/cgi/wiki?AntiPatternsCatalog
resources
Smalltalk Best Practice Patterns Kent Beck
Prentice Hall PTR (October 13, 1996)
ISBN-10: 013476904X


Polyglot Programming
http://memeagora.blogspot.com/2006/12/polyglot-programming.html


Optical Illusions
http://en.wikipedia.org/wiki/Optical_illusion


Collaborative Diffusion: Programming
Anti-objects - A Repenning
http://www.cs.colorado.edu/~ralex/papers/PDF/OOPSLA06antiobjects.pdf
resources
       pair programming
http://c2.com/cgi/wiki?PairProgramming

http://www.xprogramming.com/Practices/PracPairs.html

http://collaboration.csc.ncsu.edu/laurie/Papers/
XPSardinia.PDF

http://www.cs.utah.edu/~lwilliam/Papers/
ieeeSoftware.PDF

Contenu connexe

Tendances

Clean Code II - Dependency Injection
Clean Code II - Dependency InjectionClean Code II - Dependency Injection
Clean Code II - Dependency Injection
Theo Jungeblut
 

Tendances (20)

C# conventions & good practices
C# conventions & good practicesC# conventions & good practices
C# conventions & good practices
 
Top 20 basic java interview questions for SDET
Top 20 basic java interview questions for SDETTop 20 basic java interview questions for SDET
Top 20 basic java interview questions for SDET
 
Contract First Development with Microsoft Code Contracts and Microsoft Pex at...
Contract First Development with Microsoft Code Contracts and Microsoft Pex at...Contract First Development with Microsoft Code Contracts and Microsoft Pex at...
Contract First Development with Microsoft Code Contracts and Microsoft Pex at...
 
Clean code & design patterns
Clean code & design patternsClean code & design patterns
Clean code & design patterns
 
Refactoring
RefactoringRefactoring
Refactoring
 
Object-oriented Basics
Object-oriented BasicsObject-oriented Basics
Object-oriented Basics
 
Java mcq
Java mcqJava mcq
Java mcq
 
Lego For Engineers - Dependency Injection for LIDNUG (2011-06-03)
Lego For Engineers - Dependency Injection for LIDNUG (2011-06-03)Lego For Engineers - Dependency Injection for LIDNUG (2011-06-03)
Lego For Engineers - Dependency Injection for LIDNUG (2011-06-03)
 
Java Notes
Java Notes Java Notes
Java Notes
 
Java 例外處理壞味道與重構技術
Java 例外處理壞味道與重構技術Java 例外處理壞味道與重構技術
Java 例外處理壞味道與重構技術
 
Journey's diary developing a framework using tdd
Journey's diary   developing a framework using tddJourney's diary   developing a framework using tdd
Journey's diary developing a framework using tdd
 
Lego for Software Engineers at Silicon Valley Code Camp 2011 (2010-10-10)
Lego for Software Engineers at Silicon Valley Code Camp 2011 (2010-10-10)Lego for Software Engineers at Silicon Valley Code Camp 2011 (2010-10-10)
Lego for Software Engineers at Silicon Valley Code Camp 2011 (2010-10-10)
 
Java & J2EE Coding Conventions
Java & J2EE Coding ConventionsJava & J2EE Coding Conventions
Java & J2EE Coding Conventions
 
Clean Code V2
Clean Code V2Clean Code V2
Clean Code V2
 
Clean Code II - Dependency Injection
Clean Code II - Dependency InjectionClean Code II - Dependency Injection
Clean Code II - Dependency Injection
 
Java SE 8 best practices
Java SE 8 best practicesJava SE 8 best practices
Java SE 8 best practices
 
Exceptional Naming
Exceptional NamingExceptional Naming
Exceptional Naming
 
Design attern in php
Design attern in phpDesign attern in php
Design attern in php
 
Creational Design Patterns
Creational Design PatternsCreational Design Patterns
Creational Design Patterns
 
Developing android apps with java 8
Developing android apps with java 8Developing android apps with java 8
Developing android apps with java 8
 

Similaire à 10 Ways To Improve Your Code( Neal Ford)

Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
ThoughtWorks Studios
 
Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
Thoughtworks
 
Kelly potvin nosurprises_odtug_oow12
Kelly potvin nosurprises_odtug_oow12Kelly potvin nosurprises_odtug_oow12
Kelly potvin nosurprises_odtug_oow12
Enkitec
 
Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
Thoughtworks
 
Passing The Joel Test In The PHP World
Passing The Joel Test In The PHP WorldPassing The Joel Test In The PHP World
Passing The Joel Test In The PHP World
Lorna Mitchell
 
Amplify your stack - Jsfoo pune 2012
Amplify your stack - Jsfoo pune 2012Amplify your stack - Jsfoo pune 2012
Amplify your stack - Jsfoo pune 2012
threepointone
 

Similaire à 10 Ways To Improve Your Code( Neal Ford) (20)

10 Ways To Improve Your Code
10 Ways To Improve Your Code10 Ways To Improve Your Code
10 Ways To Improve Your Code
 
Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
 
Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
 
Workshop - The Little Pattern That Could.pdf
Workshop - The Little Pattern That Could.pdfWorkshop - The Little Pattern That Could.pdf
Workshop - The Little Pattern That Could.pdf
 
Lunch and learn as3_frameworks
Lunch and learn as3_frameworksLunch and learn as3_frameworks
Lunch and learn as3_frameworks
 
Fed Up Of Framework Hype Dcphp
Fed Up Of Framework Hype DcphpFed Up Of Framework Hype Dcphp
Fed Up Of Framework Hype Dcphp
 
Rails in the Large - Neal Ford
Rails in the Large - Neal FordRails in the Large - Neal Ford
Rails in the Large - Neal Ford
 
Why test with flex unit
Why test with flex unitWhy test with flex unit
Why test with flex unit
 
Kelly potvin nosurprises_odtug_oow12
Kelly potvin nosurprises_odtug_oow12Kelly potvin nosurprises_odtug_oow12
Kelly potvin nosurprises_odtug_oow12
 
The Art Of Performance Tuning - with presenter notes!
The Art Of Performance Tuning - with presenter notes!The Art Of Performance Tuning - with presenter notes!
The Art Of Performance Tuning - with presenter notes!
 
So You Just Inherited a $Legacy Application...
So You Just Inherited a $Legacy Application...So You Just Inherited a $Legacy Application...
So You Just Inherited a $Legacy Application...
 
What Web Framework To Use?
What Web Framework To Use?What Web Framework To Use?
What Web Framework To Use?
 
Neal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary ArchitectureNeal Ford Emergent Design And Evolutionary Architecture
Neal Ford Emergent Design And Evolutionary Architecture
 
Javaland 2017: "You´ll do microservices now". Now what?
Javaland 2017: "You´ll do microservices now". Now what?Javaland 2017: "You´ll do microservices now". Now what?
Javaland 2017: "You´ll do microservices now". Now what?
 
Refactoring 2 The Max
Refactoring 2 The MaxRefactoring 2 The Max
Refactoring 2 The Max
 
Passing The Joel Test In The PHP World
Passing The Joel Test In The PHP WorldPassing The Joel Test In The PHP World
Passing The Joel Test In The PHP World
 
So You Just Inherited a $Legacy Application… NomadPHP July 2016
So You Just Inherited a $Legacy Application… NomadPHP July 2016So You Just Inherited a $Legacy Application… NomadPHP July 2016
So You Just Inherited a $Legacy Application… NomadPHP July 2016
 
Lessons Learned in a Continuously Developing Service-Oriented Architecture
Lessons Learned in a Continuously Developing Service-Oriented ArchitectureLessons Learned in a Continuously Developing Service-Oriented Architecture
Lessons Learned in a Continuously Developing Service-Oriented Architecture
 
Agile Development From A Developers Perspective
Agile Development From A Developers PerspectiveAgile Development From A Developers Perspective
Agile Development From A Developers Perspective
 
Amplify your stack - Jsfoo pune 2012
Amplify your stack - Jsfoo pune 2012Amplify your stack - Jsfoo pune 2012
Amplify your stack - Jsfoo pune 2012
 

10 Ways To Improve Your Code( Neal Ford)

  • 1. ThoughtWorks the productive programmer: practice 10 ways to improve your code NEAL FORD software architect / meme wrangler ThoughtWorks nford@thoughtworks.com 3003 Summit Boulevard, Atlanta, GA 30319 www.nealford.com www.thoughtworks.com memeagora.blogspot.com
  • 2.
  • 3. from whence? 2 parts: mechanics practices practices
  • 4. 1 composed method
  • 5.
  • 6. composed method Divide your program into methods that perform one identifiable task. Keep all of the operations in a method at the same level of abstraction. This will naturally result in programs with many small methods, each a few lines long.
  • 8.
  • 9.
  • 10. BoundaryBase getDatabaseConnection() PartDb populate() getDatabaseConnection() getDatabaseConnection() createResultSet() addPartToListFromResultSet()
  • 11. BoundaryBase getDatabaseConnection() PartDb populate() createResultSet() createResultSet() addPartToListFromResultSet()
  • 12. BoundaryBase PartDb
  • 13. BoundaryBase getDatabaseConnection() getSqlForEntity() createResultSet() PartDb populate() getSqlForEntity() addPartToListFromResultSet()
  • 14.
  • 15.
  • 16. BoundaryBase BoundaryBase getDatabaseConnection() getDatabaseConnection() getSqlForEntity() getSqlForEntity() createResultSet() createResultSet() addEntityToListFromResultSet() populate() PartDb PartDb populate() addEntityToListFromResultSet() getSqlForEntity() getSqlForEntity() addPartToListFromResultSet() addPartToListFromResultSet()
  • 19. benefits of composed method shorter methods easier to test method names become documentation large number of very cohesive methods discover reusable assets that you didn’t know were there
  • 20. 2 test-driven development test-driven design
  • 21. design benefits of tdd first consumer think about how the rest of the world uses this class creates consumption awareness
  • 22. design benefits of tdd forces mocking of dependent objects naturally creates composed method cleaner metrics
  • 23. 3 static analysis
  • 24. byte-code analysis: findbugs
  • 25. bug categories correctness probable bug bad practice violation of recommended & essential coding practice dodgy confusing, anomalous, written poorly
  • 26.
  • 27.
  • 28. 4 good citizenship
  • 30. mixing static + state singleton singleton is bad because: mixes responsibilities untestable the object version of global variables
  • 31. avoiding singletons 1. create a pojo for the business behavior simple testable! 2. create a factory to create the pojo also testable
  • 32.
  • 33.
  • 34.
  • 35.
  • 36. 5 yagni you ain’t gonna need it
  • 37. discourages gold plating build the simplest thing that we need right now don’t indulge in speculative development increases software entropy only saves time if you can guarantee you won’t have to change it later leads to frameworks
  • 38.
  • 39. This is just what they need!
  • 40.
  • 41. changeability anticipatory design refactorable rate of change lower higher
  • 43. 6. We have an Architect who reviews all code pre- checkin and decides whether or not to allow it into version control. 7. We can’t use any open source code because our lawyers say we can’t. 8. We use WebSphere because...(I always stop listening at this point) 9. We bought the entire tool suite (even though we only needed about 10% of it) because it was cheaper than buying the individual tools. 10. We invented our own web/persistence/ messaging/caching framework because none of the existing ones was good enough.
  • 44. 1. There is a reason that WSAD isn’t called WHAPPY. 2. The initial estimate must be within 15% of the final cost, the post-analysis estimate must be within 10%, and the post-design estimate must be with 5% 3. We don’t have time to write unit tests (we’re spending too much time debugging) 4. We keep all of our business logic in stored procedures...for performance reasons. 5. The only JavaDoc is the Eclipse message explaining how to change your default JavaDoc template.
  • 45. 6 question authority
  • 49.
  • 50. pair programming studies after adjusting, pairs produced code 15% more slowly than individuals...
  • 51. pair programming studies ...with 15% fewer defects
  • 52. 7 slap single level of abstraction principle
  • 53. slap keep all lines of code in a method at the same level of abstraction jumping abstraction layers makes code hard to understand composed method => slap refactor to slap even if it means single-line methods
  • 54.
  • 55.
  • 56. 8 polyglot programming
  • 57. leveraging existing platforms with languages targeted at specific problems and applications
  • 58. looming problems/ opportunities massively parallel threading use a functional language: jaskell, scala schedule pressure jruby on rails, grails
  • 59. looming problems/ opportunities writing more declarative code via dsls build fluent interfaces
  • 60. swiby: jruby + swing
  • 61.
  • 62. 9 every nuance
  • 63. java’s back alleys reflection “reflection is slow” no longer true elegant solutions to problems
  • 64.
  • 65.
  • 66.
  • 68.
  • 69. learn the nuances of java... ...then tell the other people on your project
  • 70. 10 anti-objects
  • 71. collaborative diffusion “The metaphor of objects can go too far by making us try to create objects that are too much inspired by the real world. “ “...an antiobject is a kind of object that appears to essentially do the opposite of what we generally think the object should be doing.”
  • 72.
  • 73.
  • 74. ThoughtWorks questions? please fill out the session evaluations slides & samples available at nealford.com NEAL FORD software architect / meme wrangler ThoughtWorks This work is licensed under the Creative Commons nford@thoughtworks.com 3003 Summit Boulevard, Atlanta, GA 30319 Attribution-Noncommercial-Share Alike 2.5 License. www.nealford.com www.thoughtworks.com http://creativecommons.org/licenses/by-nc-sa/2.5/ memeagora.blogspot.com
  • 75. resources An Initial Investigation of Test Driven Development in Industry - Laurie Williams, Boby George http://collaboration.csc.ncsu.edu/laurie/Papers/TDDpaperv8.pdf findbugs http://findbugs.sourceforge.net/ pmd/cpd http://pmd.sourceforge.net/ The legend of the leaning tower http://physicsworld.com/cws/article/print/16806 AntiPatterns Catalog http://c2.com/cgi/wiki?AntiPatternsCatalog
  • 76. resources Smalltalk Best Practice Patterns Kent Beck Prentice Hall PTR (October 13, 1996) ISBN-10: 013476904X Polyglot Programming http://memeagora.blogspot.com/2006/12/polyglot-programming.html Optical Illusions http://en.wikipedia.org/wiki/Optical_illusion Collaborative Diffusion: Programming Anti-objects - A Repenning http://www.cs.colorado.edu/~ralex/papers/PDF/OOPSLA06antiobjects.pdf
  • 77. resources pair programming http://c2.com/cgi/wiki?PairProgramming http://www.xprogramming.com/Practices/PracPairs.html http://collaboration.csc.ncsu.edu/laurie/Papers/ XPSardinia.PDF http://www.cs.utah.edu/~lwilliam/Papers/ ieeeSoftware.PDF