Style Guide for Object Design
Style Guide for Object Design
About the Book
Note: this book is no longer available via Leanpub. It has been republished by Manning Publications: https://www.manning.com/books/object-design-style-guide Manning also offers a print edition, which will be shipped at the end of the early access program.
This book is right in the middle between learning how to write code and learning how to apply design principles and patterns. Using lots of code samples it teaches you the basics of object design. It provides you with simple rules to follow when defining your classes, methods, properties and interfaces.
After the fundamentals, this book provides you with a discussion of object design related topics that are worth investigating.
About the Author
Table of Contents
-
- Foreword
-
Introduction
- Who is this book for?
- Design rules for this book
- Conventions
- Overview of the contents
- Acknowledgments
-
The lifecycle of an object
-
1. Creating services
-
1.1 Inject dependencies and configuration values as constructor arguments
- Keeping together configuration values that belong together
- 1.2 Inject what you need, not where you can get it from
- 1.3 All constructor arguments should be required
- 1.4 Only use constructor injection
- 1.5 There’s no such thing as an optional dependency
-
1.6 Make all dependencies explicit
- Turn static dependencies into object dependencies
- Turn complicated functions into object dependencies
- Make system calls explicit
- 1.7 Data relevant for the task should be passed as method arguments instead of constructor arguments
- 1.8 Don’t allow the behavior of a service to change after it has been instantiated
- 1.9 Do nothing inside a constructor, only assign properties
- 1.10 Throw an exception when an argument is invalid
- 1.11 Define services as an immutable object graph with only a few entry points
- 1.12 Summary
-
1.1 Inject dependencies and configuration values as constructor arguments
-
2. Creating other objects
- 2.1 Require the minimum amount of data needed to behave consistently
- 2.2 Require data that is meaningful
- 2.3 Don’t use custom exception classes for invalid argument exceptions
- 2.4 Extract new objects to prevent domain invariants from being verified in multiple places
- 2.5 Extract new objects to represent composite values
- 2.6 Use assertions to validate constructor arguments
- 2.7 Don’t inject dependencies, optionally pass them as method arguments
-
2.8 Use named constructors
- Create from primitive type values
-
Don’t immediately add
toString(),toInt(), etc. - Introduce a domain-specific concept
- Optionally use the private constructor to enforce constraints
- 2.9 Don’t use property fillers
- 2.10 Don’t put anything more into an object than it needs
- 2.11 Don’t test constructors
-
2.12 The exception to the rule: Data transfer objects {#the-exception-to-the-rules:-data-transfer-objects}
- Use public properties
- Don’t throw exceptions, collect validation errors
- Use property fillers when needed
- 2.13 Summary
-
3. Manipulating objects
-
- Entities: identifiable objects which track changes and record events
- Value objects: replaceable, anonymous, and immutable values
- Data transfer objects: simple objects with fewer design rules
-
3.1 Prefer immutable objects
- Replace values instead of modifying them
- 3.2 A modifier on an immutable object should return a modified copy
- 3.3 On a mutable object, modifier methods should be command methods
- 3.4 On an immutable object, modifier methods should have declarative names
- 3.5 Compare whole objects
- 3.6 When comparing immutable objects, assert equality, not sameness
- 3.7 Calling a modifier method should always result in a valid object
- 3.8 A modifier method should verify that the requested state change is valid
- 3.9 Use internally recorded events to verify changes on mutable objects
- 3.10 Don’t implement fluent interfaces on mutable objects
- 3.11 Summary
-
-
1. Creating services
-
Using objects
-
4. A template for implementing methods
- 4.1 Pre-condition checks
- 4.2 Failure scenarios
- 4.3 Happy path
- 4.4 Post-condition checks
- 4.5 Return value
-
4.6 Some rules for exceptions
- Use custom exception classes only if needed
- Naming invalid argument or logic exception classes
- Naming runtime exception classes
- Use named constructors to indicate reasons for failure
- Add detailed messages
- 4.7 Summary
-
5. Retrieving information
- 5.1 Use query methods for information retrieval
- 5.2 Query methods should have single-type return values
- 5.3 Avoid query methods that expose internal state
- 5.4 Define specific methods and return types for the queries you want to make
- 5.5 Define an abstraction for queries that cross system boundaries
- 5.6 Use stubs for test doubles with query methods
- 5.7 Query methods should use other query methods, no command methods
- 5.8 Summary
-
6. Performing tasks
- 6.1 Use command methods with a name in the imperative form
- 6.2 Limit the scope of a command method, use events to perform secondary tasks
- 6.3 Make services immutable from the outside as well as on the inside
- 6.4 When something goes wrong, throw an exception
- 6.5 Use queries to collect information, commands to take the next steps
- 6.6 Define an abstraction for commands that cross system boundaries
- 6.7 Only verify calls to command methods with a mock
- 6.8 Summary
-
7. Dividing responsibilities
- 7.1 Separate write models from read models
-
7.2 Create read models that are specific for their use cases
- Create read models directly from their data source
- Build read models from domain events
- 7.3 Summary
-
4. A template for implementing methods
-
Changing the behavior of objects
-
8. Changing the behavior of services
- 8.1 Introduce constructor arguments to make behavior configurable
- 8.2 Introduce constructor arguments to make behavior replaceable
- 8.3 Compose abstractions to achieve more complicated behavior
- 8.4 Decorate existing behavior
- 8.5 Use notification objects or event listeners for additional behavior
- 8.6 Don’t use inheritance to change an object’s behavior
- 8.7 Mark classes as final by default
- 8.8 Mark methods and properties private by default
- 8.9 Summary
-
8. Changing the behavior of services
-
A field guide to objects
- 9. Controllers
- 10. Application services
- 11. Write model repositories
- 12. Entities
- 13. Value objects
- 14. Event listeners
- 15. Read models and read model repositories
- 16. Abstractions, concretions, layers, and dependencies
- 17. Summary
-
Epilogue
- 18. Architectural patterns
-
19. Testing
- 19.1 Class testing versus object testing
- 19.2 Top down feature development
- 20. Domain-Driven Design
- 21. Conclusion
-
Changelog
- 6/3/2019
- Notes
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$10,589,243writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #2
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #3
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
- #4
CCIE SP v5.0
Łukasz Bromirski, Piotr Jablonski, and Nicholas RussoAre you striving to prepare to and pass CCIE SP lab exam? Take the opportunity and get this workbook! With the attached initial cfg files you will prepare yourself for the CCIE SP exam as well as learn SP technologies applicable to all kinds of today modern networks! This workbook covers blueprint topics and provides challenging examples.
- #5
C++20 - The Complete Guide
Nicolai M. JosuttisAll the new language and library features of C++20 (for those who know previous versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #6
Composing Software
Eric ElliottAll software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
- #7
Concurrency with Modern C++
Rainer GrimmC++11 is the first C++ standard that deals with concurrency. The story goes on with C++17, C++20, and will continue with C++23.
I'll give you a detailed insight into the current and the upcoming concurrency in C++. This insight includes the theory and a lot of practice.
- #8
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Alexander GolovnevThis book supplements the DM for CS Specialization at Coursera and contains many interactive puzzles, autograded quizzes, and code snippets. They are intended to help you to discover important ideas in discrete mathematics on your own. By purchasing the book, you will get all updates of the book free of charge when they are released.
- #9
Practical FP in Scala: A hands-on approach
Gabriel VolpeA practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
- #10
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java and a Kotlin team member comes a book that breaks concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA! Full support at www.AtomicKotlin.com.
- #11
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #12
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #13
Learning Algorithms Through Programming and Puzzle Solving
Alexander S. Kulikov and Pavel PevznerThis book powers our MicroMasters program on edX and specialization on Coursera, one of the ten most popular computer science courses on Coursera. Over half a million students have tried to solve many programming challenges and algorithmic puzzles described in this book. We invite you to join them! See the webpage of the book for more details.
- #14
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #15
Advanced Web Application Architecture
Matthias NobackThe missing manual for making your web applications future-proof
- #16
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #17
Thinking with Types
Sandy MaguireThis book aims to be the comprehensive manual for type-level programming. It's about getting you from here to there---from a competent Haskell programmer to one who convinces the compiler to do their work for them.
- #18
The Technological Future of Medical Specialties - 2021 Edition
Dr. Bertalan MeskoHow will the appearance of AI, sensors, wearables, VR/AR or robots affect each medical specialty? How can physicians of the various professions successfully prepare for the sweeping changes coming with the waves of technology? Read the eBook to find out
45-day Money-back guarantee: If you're not satisfied, simply return the book & get a full refund
- #19
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #20
CCDE Practice Design Scenarios
Marwan AlshawiCreated by the author of the official 'CCDE Study Guide' book, and reviewed by CCDE Experts
By purchasing this book here, you will be entitled to all the updates and new additions to this book. These updates and additions are going to be very frequent to keep this book always as an interesting and valuable resource.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #3
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #4
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #6
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity... - #8
9 Books-Bundle: Shut Up and Code!
9 Books
"Shut up and code." Laughter in the audience. The hacker had just plugged in his notebook and started sharing his screen to present his super-smart Python script. "Shut up and code" The letters written in a white literal coding font on black background was the hackers' home screen background mantra. At the time, I was a first-year computer...
