Home > Store

Clean Code: A Handbook of Agile Software Craftsmanship

eBook (Watermarked)

  • Your Price: $38.39
  • List Price: $47.99
  • Includes EPUB and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    Adobe Reader PDF The popular standard, used most often with the free Acrobat® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.

Also available in other formats.

Register your product to gain access to bonus material or receive a coupon.

Description

  • Copyright 2009
  • Pages: 464
  • Edition: 1st
  • eBook (Watermarked)
  • ISBN-10: 0-13-263940-8
  • ISBN-13: 978-0-13-263940-8

Even bad code can function. But if code isn’t clean, it can bring a development organization to its knees. Every year, countless hours and significant resources are lost because of poorly written code. But it doesn’t have to be that way.

Noted software expert Robert C. Martin presents a revolutionary paradigm with Clean Code: A Handbook of Agile Software Craftsmanship. Martin has teamed up with his colleagues from Object Mentor to distill their best agile practice of cleaning code “on the fly” into a book that will instill within you the values of a software craftsman and make you a better programmer–but only if you work at it.

What kind of work will you be doing? You’ll be reading code–lots of code. And you will be challenged to think about what’s right about that code, and what’s wrong with it. More importantly, you will be challenged to reassess your professional values and your commitment to your craft.

Clean Code is divided into three parts. The first describes the principles, patterns, and practices of writing clean code. The second part consists of several case studies of increasing complexity. Each case study is an exercise in cleaning up code–of transforming a code base that has some problems into one that is sound and efficient. The third part is the payoff: a single chapter containing a list of heuristics and “smells” gathered while creating the case studies. The result is a knowledge base that describes the way we think when we write, read, and clean code.

Readers will come away from this book understanding

  • How to tell the difference between good and bad code
  • How to write good code and how to transform bad code into good code
  • How to create good names, good functions, good objects, and good classes
  • How to format code for maximum readability
  • How to implement complete error handling without obscuring code logic
  • How to unit test and practice test-driven development
This book is a must for any developer, software engineer, project manager, team lead, or systems analyst with an interest in producing better code.

Sample Content

Table of Contents

Foreword                      xix
Introduction              xxv
On the Cover                     xxix


Chapter 1: Clean Code                    1
There Will Be Code                        2
Bad Code                           3
The Total Cost of Owning a Mess                 4
Schools of Thought                        12
We Are Authors                      13
The Boy Scout Rule                     14
Prequel and Principles                   15
Conclusion                        15
Bibliography                  15

Chapter 2: Meaningful Names                     17
Introduction               17
Use Intention-Revealing Names                     18
Avoid Disinformation                         19
Make Meaningful Distinctions                20
Use Pronounceable Names                            21
Use Searchable Names                                22
Avoid Encodings                          23
Avoid Mental Mapping                    25
Class Names                    25
Method Names                              25
Don’t Be Cute                    26
Pick One Word per Concept                 26
Don’t Pun                    26
Use Solution Domain Names                    27
Use Problem Domain Names                   27
Add Meaningful Context                       27
Don’t Add Gratuitous Context                    29
Final Words                        30

Chapter 3: Functions                                           31
Small!                               34
Do One Thing                         35
One Level of Abstraction per Function                           36
Switch Statements                     37
Use Descriptive Names                      39
Function Arguments                          40
Have No Side Effects                          44
Command Query Separation                           45
Prefer Exceptions to Returning Error Codes              46
Don’t Repeat Yourself                          48
Structured Programming                   48
How Do You Write Functions Like This?                49
Conclusion                          49
SetupTeardownIncluder                        50
Bibliography                                       52

Chapter 4: Comments                                                  53
Comments Do Not Make Up for Bad Code                   55
Explain Yourself in Code                        55
Good Comments                              55
Bad Comments                          59
Bibliography                          74

Chapter 5: Formatting                                           75
The Purpose of Formatting                     76
Vertical Formatting                         76
Horizontal Formatting                         85
Team Rules                      90
Uncle Bob’s Formatting Rules                  90
Chapter 6: Objects and Data Structures                      93
Data Abstraction                     93
Data/Object Anti-Symmetry                        95
The Law of Demeter                         97
Data Transfer Objects                     100
Conclusion                       101
Bibliography                           101

Chapter 7: Error Handling                           103
Use Exceptions Rather Than Return Codes                  104
Write Your Try-Catch-Finally Statement First                    105
Use Unchecked Exceptions                         106
Provide Context with Exceptions                      107
Define Exception Classes in Terms of a Caller’s Needs                107
Define the Normal Flow                  109
Don’t Return Null                        110
Don’t Pass Null                       111
Conclusion                           112
Bibliography                                 112

Chapter 8: Boundaries                                                            113
Using Third-Party Code                               114
Exploring and Learning Boundaries                      116
Learning log4j                         116
Learning Tests Are Better Than Free                      118
Using Code That Does Not Yet Exist                     118
Clean Boundaries                           120
Bibliography                           120

Chapter 9: Unit Tests                                    121
The Three Laws of TDD                   122
Keeping Tests Clean                          123
Clean Tests                        124
One Assert per Test                        130
F.I.R.S.T.                      132
Conclusion                       133
Bibliography                        133

Chapter 10: Classes                         135
Class Organization                  136
Classes Should Be Small!                 136
Organizing for Change                   147
Bibliography                     151

Chapter 11: Systems                                                  153
How Would You Build a City?                     154
Separate Constructing a System from Using It                      154
Scaling Up                            157
Java Proxies                        161
Pure Java AOP Frameworks                     163
AspectJ Aspects                     166
Test Drive the System Architecture                      166
Optimize Decision Making                       167
Use Standards Wisely, When They Add Demonstrable Value                168
Systems Need Domain-Specific Languages                   168
Conclusion                    169
Bibliography                      169

Chapter 12: Emergence                        171
Getting Clean via Emergent Design                171
Simple Design Rule 1: Runs All the Tests                  172
Simple Design Rules 2–4: Refactoring                        172
No Duplication                      173
Expressive                        175
Minimal Classes and Methods               176
Conclusion                   176
Bibliography                     176

Chapter 13: Concurrency                         177
Why Concurrency?                    178
Challenges                        180
Concurrency Defense Principles                   180
Know Your Library                    182
Know Your Execution Models                       183
Beware Dependencies Between Synchronized Methods            185
Keep Synchronized Sections Small                  185
Writing Correct Shut-Down Code Is Hard                 186
Testing Threaded Code                     186
Conclusion                      190
Bibliography                         191

Chapter 14: Successive Refinement                     193
Args Implementation                          194
Args: The Rough Draft                       201
String Arguments                   214
Conclusion                       250

Chapter 15: JUnit Internals                                    251
The JUnit Framework                    252
Conclusion                 265

Chapter 16: Refactoring SerialDate                         267
First, Make It Work                     268
Then Make It Right                    270
Conclusion                      284
Bibliography                     284

Chapter 17: Smells and Heuristics                         285
Comments                           286
Environment                       287
Functions                            288
General                               288
Java                                     307
Names                                 309
Tests                                    313
Conclusion                         314
Bibliography                      315

Appendix A: Concurrency II                              317
Client/Server Example                           317
Possible Paths of Execution                    321
Knowing Your Library                      326
Dependencies Between Methods Can Break Concurrent Code         329
Increasing Throughput                  333
Deadlock                    335
Testing Multithreaded Code                   339
Tool Support for Testing Thread-Based Code                    342
Conclusion                    342
Tutorial: Full Code Examples                    343

Appendix B: org.jfree.date.SerialDate                             349

Appendix C: Cross References of Heuristics                  409

Epilogue                           411
Index                                  413


Updates

Errata

We've made every effort to ensure the accuracy of this book and its companion content. Any errors that have been confirmed since this book was published can be downloaded below.

Download the errata (46 KB .doc)

Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020