Principles of Package Design
Principles of Package Design
Preparing your code for reuse
About the Book
In Principles of Package Design Matthias Noback tells you everything about designing software components, also known as packages. In the first part you'll revisit the SOLID principles of class design. They will help you prepare your classes for use in packages. The second part covers the important, yet lesser known package design principles. When you've finished this book, you'll be ready to design packages that have high cohesion, low coupling and are at the same time user- and maintainer-friendly.
This book has been revised and then republished by Apress. From now on you can order it from them: https://www.apress.com/us/book/9781484241189
- The situation
- Overview of the contents
- Notes about the code samples
- Thank you
- SOLID principles
- Why follow the principles?
- Prepare for change
The Single responsibility principle
- A class with too many responsibilities
- Responsibilities are reasons to change
- Refactoring: using collaborator classes
- Advantages of having a single responsibility
- A small peek ahead: common closure
The Open/closed principle
- A class that is closed for extension
- Refactoring: abstract factory
- Refactoring: making the abstract factory open for extension
- Refactoring: polymorphism
- Packages need classes that are open for extension
The Liskov substitution principle
- Violation: a derived class does not have an implementation for all methods
- Violation: different substitutes return things of different types
- Violation: a derived class is less permissive with regard to method arguments
- Violation: secretly programming a more specific type
The Interface segregation principle
Violation: leaky abstractions
Refactoring: create separate interfaces and use multiple inheritance
- What did we do?
- Refactoring: create separate interfaces and use multiple inheritance
Violation: multiple use cases
- Refactoring: separate interfaces and multiple inheritance
Violation: no interface, just a class
- Implicit changes in the implicit interface
- Refactoring: add header and role interfaces
- Violation: leaky abstractions
The Dependency inversion principle
Example of dependency inversion: the FizzBuzz generator
FizzBuzzclass open for extension
Removing the specificness from the
- Making the
Violation: a high-level class depends upon a low-level class
- Refactoring: abstractions and concretions both depend on abstractions
Violation: a class depends upon a class from another package
- Solution: add an abstraction and remove the dependency using composition
- Peeking ahead: abstract dependencies
- Example of dependency inversion: the FizzBuzz generator
Principles of cohesion
- Becoming a programmer
- The hardest part
- Class design principles benefit cohesion
- Package design principles, part I: Cohesion
The Release/reuse equivalence principle
- Keep your package under version control
- Add a package definition file
Use semantic versioning
Design for backward compatibility
Rules of thumb
- Don’t throw anything away
- When you rename something, add a proxy
- Only add parameters at the end and with a default value
- Methods should not have side effects
- Dependency versions should be permissive
- Use objects instead of primitive values
- Use private object properties and methods for information hiding
- Use object factories
- And so on
- Rules of thumb
- Design for backward compatibility
Add meta files
- Installation and configuration
- Extension points
- Limitations (optional)
- Change log
- Quality from the user’s point of view
What the package maintainer needs to do
- Add tests
The Common reuse principle
Signs that the principle is being violated
- Obvious stratification
- Obfuscated stratification
Classes that can only be used when … is installed
- Suggested refactoring
- A package should be “linkable”
- Cleaner releases
- Suggested refactoring
- Feature strata
- Guiding questions
- When to apply the principle
- When to violate the principle
- Why not to violate the principle
- Signs that the principle is being violated
The Common closure principle
A change in one of the dependencies
A change in an application layer
A change in the business
- The tension triangle of cohesion principles
- A change in one of the dependencies
Principles of coupling
The Acyclic dependencies principle
Coupling: discovering dependencies
Different ways of package coupling
- Not to be considered: global state
- Visualizing dependencies
- Different ways of package coupling
The Acyclic dependencies principle
- Nasty cycles
Cycles in a package dependency graph
- Dependency resolution
- Release management
- Is it all that bad?
Solutions for breaking the cycles
- Some pseudo-cycles and their dissolution
Some real cycles and their dissolution
- Dependency inversion
Inversion of control
- Chain of responsibility
- Mediator and chain of responsibility combined: an event system
- Coupling: discovering dependencies
The Stable dependencies principle
- Not every package can be highly stable
- Unstable packages should only depend on more stable packages
- Measuring stability
- Decreasing instability, increasing stability
Violation: your stable package depends on a third-party unstable package
- Solution: use dependency inversion
- A package can be both responsible and irresponsible
The Stable abstractions principle
- Stability and abstractness
How to determine if a package is abstract
- Abstract things belong in stable packages
- Abstractness increases with stability
- The main sequence
Types of packages
- Concrete, instable packages
- Abstract, stable packages
- Strange packages
Creating packages is hard
- Embracing software diversity
- Component reuse is possible, but requires more work
Creating packages is doable
- Reducing the impact of the first rule of three
- Reducing the impact of the second rule of three
- Creating packages is easy?
- Creating packages is hard
- Principles of cohesion
Appendix I: The full
- Appendix I: The full
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
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.
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Digital-First EventsJoep Piscaer and Jana Boruta
The only resource you will ever need to launch your digital events program.
node-opcua by exampleEtienne Rossignon
Get the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.
Cloud StrategyGregor Hohpe
“Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud can transform your organization, but it shouldn’t be driven by wishes. This book tells you how to develop a sound strategy guided by frameworks and decision models without being overly abstract nor getting lost in product details.
R Programming for Data ScienceRoger D. Peng
This 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.
C++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.
The book is almost daily updated. These incremental updates ease my interaction with the proofreaders.
Sockets and PipesType Classes
Sockets and Pipes is not an introduction to Haskell; it is an introduction to writing software in Haskell. Using a handful of everyday Haskell libraries, this book walks through reading the HTTP specification and implementing it to create a web server.
Atomic KotlinBruce Eckel and Svetlana Isakova
For both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
Ansible for DevOpsJeff Geerling
Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Introducing EventStormingAlberto Brandolini
The deepest tutorial and explanation about EventStorming, straight from the inventor.
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...
Django for Beginners/APIs/Professionals
CCIE Service Provider Ultimate Study Bundle
2 BooksPiotr 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...
Cisco CCNA 200-301 Complet
4 BooksCe lot comprend les quatre volumes du guide préparation à l'examen de certification Cisco CCNA 200-301.
Modern Management Made Easy
3 BooksRead all three Modern Management Made Easy books. Learn to manage yourself, lead and serve others, and lead the organization.
Linux Administration Complet
4 BooksCe lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité...
CCDE Practical Studies (All labs)
3 BooksCCDE lab
All the Books of The Medical Futurist
6 BooksWe 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...
Cloud Architect: Transform Technology and Organization
2 BooksArchitects don't just recite product names and features. They understand the options, decisions, and trade-offs behind them. They earn credibility and maintain authenticity by connecting the penthouse with the engine room. Get two essential books that redefine the role of the software and IT architect at one low price:37 Things One Architect...
2 BooksDocker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!