Book Review: Framework Design Guidelines
Framework Design Guidelines
Having a common framework is quite important to reduce code reuse. But designing that framework properly and consistently is a huge challenge. Even though we are living in a RESTful world now, I think having a framework or a set of common libraries for personal or commercial projects is still relevant. A well-designed well-tested framework would significantly improve any application built on top of it.
I had referred to this book partially before but this time decided to read it from cover to cover and make sure I “digest” all. It contains countless gems that every developer should know. Anyone developing even small libraries can benefit from this book a lot. You don’t need to design the .NET framework (like the authors). Also it comes with a DVD full of presentations of authors.
Unfortunately I lost my DVD. Probably it’s inside one of the many CD cake boxes. I was hoping to check it out as I went along the book. But luckily I found out that it is freely available from the publisher. Check you the download link in the resources section. One thing to beware about the download is that you can come across another link in the Brad Abrams’s blog here. The download works fine but one of the presentations inside it is corrupted so I suggest you download each section separately from the site in the resources.
The book is full of gems and very useful tips. Here are just a few:
- Keep it simple: “You can always add, you cannot ever remove”
- There is no perfect design: You always have to make some sacrifices and consider the trade-offs
- Well-designed frameworks are consistent
- Scenario-driven design: Imagine scenarios to visualize the real-world use of the API When in doubt leave the feature out, add it later. Conduct usability studies to get developers’ opinions
- Keep type initialization as simple as possible. It lowers the barrier of entry.
- Throw exceptions to communicate the proper usage of API. It makes the API self-documenting and supports the learning-by-doing approach.
- Going overboard with abstractions may deteriorate the performance and usability of the framework.
Even though it’s been a few years since this books was released it is still a very helpful resource.