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.
Ansible for KubernetesJeff Geerling
Ansible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
Practical FP in Scala: A hands-on approachGabriel Volpe
A 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.
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Production HaskellMatt Parsons
Are you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
Tame your Work FlowSteve Tendon and Daniel Doiron
Do you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
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.
Machine Learning EngineeringAndriy Burkov
"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Composing SoftwareEric Elliott
All 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.
El Manual del ManagerKeyvan Akbary, Félix López, and Álvaro Salazar
¿Has deseado alguna vez el haber tenido una buena introducción al rol del Engineering Manager? En este libro aprenderás lo necesario para ejercer el rol de una manera efectiva: Expectativas y Responsabilidades del Rol, 1-1s, Ayudar a Crecer, Objetivos, Planes de Carrera, Cultura, Feedback, Contratación, Cultura de Producto y mucho más.
The Tester's Library
8 BooksThe Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other...
11 BooksIn this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people.
WTFlop 6M + HU - Beta Bundle
Marionette.js A to Z
Build A Better Backbone App
3 BooksThe best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
General Systems Thinker Bundle
5 BooksThe General Systems Thinker Bundle is just that: a bundle of five books to advance the reader one giant step toward improved thinking, based on General Systems principles. Four of the books are the complete General Systems Series. The fifth is fictional piece which shows some general systems thinkers in action. It's a mystery in which a group of...
Experiential Learning Bundle
4 BooksThis bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately.
2 BooksAfter getting up and running with Ansible in Jeff Geerling's Ansible for DevOps, strengthen your skills managing tens to thousands of instances and services in Amazon's AWS cloud with Yan Kurniawan's Ansible for AWS.
Learn ECMAScript 6 inside and out
2 BooksFor any technology, it helps to get multiple points of view on the functionality to get the best possible understanding. For ECMAScript 6/2015, no two resources are recommended more frequently thanExploring ES6by Dr. Axel Rauschmayer andUnderstanding ECMAScript 6by Nicholas C. Zakas. These two points of view, investigating the specification and...
Software architecture, for systems old and new
2 BooksThis bundle includes books about hands-on software architecture.