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
About the Author
Table of Contents
-
Introduction
- The situation
- Overview of the contents
- Notes about the code samples
- Thank you
-
Class design
-
Introduction
- 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
-
Conclusion
- 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
- Conclusion
-
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
-
Making the
FizzBuzzclass open for extension -
Removing the specificness from the
FizzBuzzclass
-
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
-
Conclusion
- Peeking ahead: abstract dependencies
-
Example of dependency inversion: the FizzBuzz generator
-
Introduction
-
Package design
-
Principles of cohesion
-
- Becoming a programmer
- The hardest part
-
Cohesion
- 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
-
READMEand documentation- Installation and configuration
- Usage
- Extension points
- Limitations (optional)
- License
- Change log
-
-
Quality control
- Quality from the user’s point of view
-
What the package maintainer needs to do
- Add tests
- Conclusion
-
The Common reuse principle
-
Signs that the principle is being violated
-
Feature strata
- Obvious stratification
- Obfuscated stratification
-
Classes that can only be used when … is installed
- Suggested refactoring
- A package should be “linkable”
- Cleaner releases
-
Bonus features
- Suggested refactoring
- Sub-packages
-
Feature strata
-
Conclusion
- 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
- Assetic
-
A change in an application layer
- FOSUserBundle
-
A change in the business
- Sylius
- The tension triangle of cohesion principles
-
A change in one of the dependencies
-
Principles of coupling
- Coupling
-
The Acyclic dependencies principle
-
Coupling: discovering dependencies
-
Different ways of package coupling
- Composition
- Inheritance
- Implementation
- Usage
- Creation
- Functions
- 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
- Mediator
- Chain of responsibility
- Mediator and chain of responsibility combined: an event system
- Conclusion
-
Coupling: discovering dependencies
-
The Stable dependencies principle
- Stability
- 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
- Conclusion
-
The Stable abstractions principle
- Stability and abstractness
-
How to determine if a package is abstract
-
The
Ametric
-
The
- Abstract things belong in stable packages
- Abstractness increases with stability
- The main sequence
-
Types of packages
- Concrete, instable packages
- Abstract, stable packages
- Strange packages
- Conclusion
-
Conclusion
-
Creating packages is hard
- Reuse-in-the-small
- Reuse-in-the-large
- 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
-
Appendices
-
Appendix I: The full
Pageclass
-
Appendix I: The full
Authors have earned$9,690,775writing, 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
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.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Ansible for Kubernetes
Jeff GeerlingAnsible 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.
- #2
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.
- #3
Functional Design and Architecture
Alexander GraninSoftware 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.
- #4
Production Haskell
Matt ParsonsAre 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.
- #5
Tame your Work Flow
Steve Tendon and Daniel DoironDo 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!
- #6
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.
- #7
Machine Learning Engineering
Andriy 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
- #8
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #9
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.
- #10
El Manual del Manager
Keyvan 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.
Top Bundles
- #1
The Tester's Library
8 Books
The 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... - #2
agile
11 Books
In 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. - #3
WTFlop 6M + HU - Beta Bundle
6 Books
- #4
Marionette.js A to Z
3 Books
Marionette.js has become a popular Backbone-based javascript library, because it helps you avoid boiler-plate code and focus on what makes your app special. But how do you get started?Whether you want to finally get started with dynamic client-side programming (like one reader did), or are an experienced front-end dev who has inherited a... - #5
Build A Better Backbone App
3 Books
The 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... - #6
General Systems Thinker Bundle
5 Books
The 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... - #7
Experiential Learning Bundle
4 Books
This bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately. - #8
Ansible Bundle
2 Books
After 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. - #9
Learn ECMAScript 6 inside and out
2 Books
For 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... - #10
Software architecture, for systems old and new
2 Books
This bundle includes books about hands-on software architecture.
