Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Get Your Hands Dirty on Clean Architecture
Get Your Hands Dirty on Clean Architecture

Get Your Hands Dirty on Clean Architecture: Build 'clean' applications with code examples in Java , Second Edition

eBook
$24.99 $35.99
Paperback
$44.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
Table of content icon View table of contents Preview book icon Preview Book

Get Your Hands Dirty on Clean Architecture

What’s Wrong with Layers?

Chances are that you have developed a layered (web) application in the past. You might even be doing it in your current project right now.

Thinking in layers has been drilled into us in computer science classes, tutorials, and best practices. It has even been taught in books.1

1 Layers as a pattern are, for example, taught in Software Architecture Patterns by Mark Richards, O'Reilly, 2015.

Figure 2.1 – A conventional web application architecture consists of a web layer, a domain layer, and a persistence layer

Figure 2.1 – A conventional web application architecture consists of a web layer, a domain layer, and a persistence layer

Figure 2.1 shows a high-level view of the very common three-layer architecture. We have a web layer that receives requests and routes them to a service in the domain layer.2 The service does some business logic and calls components from the persistence layer to query for or modify the current state of our domain entities in the database.

2 Domain versus business: in this book, I use the terms “domain” and “business” synonymously. The domain layer or business layer is the place in the code that solves the business problems, as opposed to code that solves technical problems, like persisting things in a database or processing web requests.

You know what? Layers are a solid architecture pattern! If we get them right, we’re able to build domain logic that is independent of the web and persistence layers. We can switch out the web or persistence technologies without affecting our domain logic, if the need arises. We can also add new features without affecting existing features.

With a good layered architecture, we’re keeping our options open and are able to quickly adapt to changing requirements and external factors (such as our database vendor doubling their prices overnight). A good layered architecture is maintainable.

So, what’s wrong with layers?

In my experience, a layered architecture is very vulnerable to changes, which makes it hard to maintain. It allows bad dependencies to creep in and make the software increasingly harder to change over time. Layers don’t provide enough guardrails to keep the architecture on track. We need to rely too much on human discipline and diligence to keep it maintainable.

In the following sections, I’ll tell you why.

They promote database-driven design

By its very definition, the foundation of a conventional layered architecture is the database. The web layer depends on the domain layer, which in turn depends on the persistence layer and thus the database. Everything builds on top of the persistence layer. This is problematic for several reasons.

Let’s take a step back and think about what we’re trying to achieve with almost any application we’re building. We’re typically trying to create a model of the rules or “policies” that govern the business in order to make it easier for the users to interact with them.

We’re primarily trying to model behavior, not the state. Yes, the state is an important part of any application, but the behavior is what changes the state and thus drives the business!

So, why are we making the database the foundation of our architecture and not the domain logic?

Think back to the last use cases you implemented in any application. Did you start by implementing the domain logic or the persistence layer? Most likely, you thought about what the database structure would look like and only then moved on to implementing the domain logic on top of it.

This makes sense in a conventional layered architecture since we’re going with the natural flow of dependencies. But it makes absolutely no sense from a business point of view! We should build the domain logic before building anything else! We want to find out whether we have understood the business rules correctly. And only once we know we’re building the right domain logic should we move on to build a persistence and web layer around it.

A driving force in such a database-centric architecture is the use of object-relational mapping (ORM) frameworks. Don’t get me wrong, I love those frameworks and work with them regularly. But if we combine an ORM framework with a layered architecture, we’re easily tempted to mix business rules with persistence aspects.

Figure 2.2 – Using the database entities in the domain layer leads to strong coupling with the persistence layer

Figure 2.2 – Using the database entities in the domain layer leads to strong coupling with the persistence layer

Usually, we have ORM-managed entities as part of the persistence layer, as shown in Figure 2.2. Since a layer may access the layers below it, the domain layer is allowed to access those entities. And if it’s allowed to use them, it will use them at some point.

This creates a strong coupling between the domain layer and the persistence layer. Our business services use the persistence model as their business model and have to deal not only with the domain logic but also with eager versus lazy loading, database transactions, flushing caches, and similar housekeeping tasks.3

3 In his seminal book Refactoring (Pearson, 2018), Martin Fowler calls this symptom “divergent change”: having to change seemingly unrelated parts of the code to implement a single feature. This is a code smell that should trigger a refactoring.

The persistence code is virtually fused into the domain code and thus it’s hard to change one without the other. That’s the opposite of being flexible and keeping options open, which should be the goal of our architecture.

They’re prone to shortcuts

In a conventional layered architecture, the only global rule is that from a certain layer, we can only access components in the same layer or a layer below. There may be other rules that a development team has agreed upon and some of them might even be enforced by tooling, but the layered architecture style itself does not impose those rules on us.

So, if we need access to a certain component in a layer above ours, we can just push the component down a layer and we’re allowed to access it. Problem solved. Doing this once may be OK. But doing it once opens the door for doing it a second time. And if someone else was allowed to do it, so am I, right?

I’m not saying that as developers, we take such shortcuts lightly. But if there is an option to do something, someone will do it, especially in combination with a looming deadline. And if something has been done before, the likelihood of someone doing it again will increase drastically. This is a psychological effect called the Broken Windows Theory – more on this in Chapter 11, Taking Shortcuts Consciously.

Figure 2.3 – Since any layer may access everything in the persistence layer, it tends to grow fat over time

Figure 2.3 – Since any layer may access everything in the persistence layer, it tends to grow fat over time

Over years of development and maintenance of a software project, the persistence layer may very well end up like in Figure 2.3.

The persistence layer (or, in more generic terms, the bottom-most layer) will grow fat as we push components down through the layers. Perfect candidates for this are helper or utility components since they don’t seem to belong to any specific layer.

So, if we want to disable shortcut mode for our architecture, layers are not the best option, at least not without enforcing some kind of additional architecture rules. And by enforcing, I don’t mean a senior developer doing code reviews, but automatically enforced rules that make the build fail when they’re broken.

They grow hard to test

A common evolution within a layered architecture is that layers are skipped. We access the persistence layer directly from the web layer since we’re only manipulating a single field of an entity, and for that, we need not bother the domain layer, right?

Figure 2.4 – Skipping the domain layer tends to scatter domain logic across the code base

Figure 2.4 – Skipping the domain layer tends to scatter domain logic across the code base

Figure 2.4 shows how we’re skipping the domain layer and accessing the persistence layer right from the web layer.

Again, this feels OK the first couple of times, but it has two drawbacks if it happens often (and it will, once someone has made the first step).

First, we’re implementing domain logic in the web layer, even if it’s only manipulating a single field. What if the use case expands in the future? We’re most likely going to add more domain logic to the web layer, mixing responsibilities and spreading essential domain logic across all layers.

Second, in the unit tests of our web layer, we not only have to manage the dependencies on the domain layer but also the dependencies on the persistence layer. If we’re using mocks in our tests, that means we have to create mocks for both layers. This adds complexity to the tests. And a complex test setup is the first step toward no tests at all because we don’t have time for them. As the web component grows over time, it may accumulate a lot of dependencies on different persistence components, adding to the test’s complexity. At some point, it takes more time for us to understand the dependencies and create mocks for them than to actually write test code.

They hide the use cases

As developers, we like to create new code that implements shiny new use cases. But we usually spend much more time changing existing code than we do creating new code. This is not only true for those dreaded legacy projects in which we’re working on a decades-old code base but also for a hot new greenfield project after the initial use cases have been implemented.

Since we’re so often searching for the right place to add or change functionality, our architecture should help us to quickly navigate the code base. How does a layered architecture hold up in this regard?

As already discussed previously, in a layered architecture, it easily happens that domain logic is scattered throughout the layers. It may exist in the web layer if we’re skipping the domain logic for an “easy” use case. And it may exist in the persistence layer if we have pushed a certain component down so it can be accessed from both the domain and persistence layers. This already makes finding the right spot to add new functionality hard.

But there’s more. A layered architecture does not impose rules on the “width” of domain services. Over time, this often leads to very broad services that serve multiple use cases (see Figure 2.5).

Figure 2.5 – “Broad” services make it hard to find a certain use case within the code base

Figure 2.5 – “Broad” services make it hard to find a certain use case within the code base

A broad service has many dependencies on the persistence layer and many components in the web layer depend on it. This not only makes the service hard to test but also makes it hard for us to find the code responsible for the use case we want to work on.

How much easier would it be if we had highly specialized, narrow domain services that each serve a single use case? Instead of searching for the user registration use case in UserService, we would just open up RegisterUserService and start hacking away.

They make parallel work difficult

Management usually expects us to be done with building the software they sponsor on a certain date. Actually, they even expect us to be done within a certain budget as well, but let’s not complicate things here.

Aside from the fact that I have never seen “done” software in my career as a software engineer, to be “done” by a certain date usually implies that multiple people have to work in parallel.

You probably know this famous conclusion from “The Mythical Man-Month,” even if you haven’t read the book: Adding manpower to a late software project makes it later.4

44 The Mythical Man-Month: Essays on Software Engineering by Frederick P. Brooks, Jr., Addison-Wesley, 1995.

This also holds true, to a degree, in software projects that are not (yet) late. You cannot expect a large group of 50 developers to be 5 times faster than a smaller team of 10 developers. If they’re working on a very large application where they can split up into sub-teams and work on separate parts of the software, it may work, but in most contexts, they will step on each other’s feet.

But on a healthy scale, we can certainly expect to be faster with more people on the project. And management is right to expect that of us.

To meet this expectation, our architecture must support parallel work. This is not easy. And a layered architecture doesn’t really help us here.

Imagine we’re adding a new use case to our application. We have three developers available. One can add the needed features to the web layer, one to the domain layer, and the third to the persistence layer, right?

Well, it usually doesn’t work that way in a layered architecture. Since everything builds on top of the persistence layer, the persistence layer must be developed first. Then comes the domain layer and finally the web layer. So only one developer can work on the feature at a time!

“Ah, but the developers can define interfaces first,” you say, “and then each developer can work against these interfaces without having to wait for the actual implementation.”

Sure, this is possible, but only if we haven’t mixed our domain and persistence logic as discussed previously, blocking us from working on each aspect separately.

If we have broad services in our code base, it may even be hard to work on different features in parallel. Working on different use cases will cause the same service to be edited in parallel, which leads to merge conflicts and potentially regressions.

How does this help me build maintainable software?

If you have built layered architectures in the past, you can probably relate to some of the issues discussed in this chapter, and you could maybe even add some more.

If done correctly, and if some additional rules are imposed on it, a layered architecture can be very maintainable and can make changing or adding to the code base a breeze.

However, the discussion shows that a layered architecture allows many things to go wrong. Without good self-discipline, it’s prone to degrading and becoming less maintainable over time. And our self-discipline usually takes a hit each time a team member rotates into or out of the team, or a manager draws a new deadline around the development team.

Keeping the traps of layered architecture in mind will help us the next time we argue against taking a shortcut and for building a more maintainable solution instead – be it in a layered architecture or a different architecture style.

Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • Explore ways to make your software flexible, extensible, and adaptable
  • Learn new concepts that you can easily blend with your own software development style
  • Develop the mindset of making conscious architecture decisions

Description

Building for maintainability is key to keep development costs low (and developers happy). The second edition of "Get Your Hands Dirty on Clean Architecture" is here to equip you with the essential skills and knowledge to build maintainable software. Building upon the success of the first edition, this comprehensive guide explores the drawbacks of conventional layered architecture and highlights the advantages of domain-centric styles such as Robert C. Martin's Clean Architecture and Alistair Cockburn's Hexagonal Architecture. Then, the book dives into hands-on chapters that show you how to manifest a Hexagonal Architecture in actual code. You'll learn in detail about different mapping strategies between the layers of a Hexagonal Architecture and see how to assemble the architecture elements into an application. The later chapters demonstrate how to enforce architecture boundaries, what shortcuts produce what types of technical debt, and how, sometimes, it is a good idea to willingly take on those debts. By the end of this second edition, you'll be armed with a deep understanding of the Hexagonal Architecture style and be ready to create maintainable web applications that save money and time. Whether you're a seasoned developer or a newcomer to the field, "Get Your Hands Dirty on Clean Architecture" will empower you to take your software architecture skills to new heights and build applications that stand the test of time.

Who is this book for?

This book is for you if you care about the architecture of the software you are building. To get the most out of this book, you must have some experience with web development. The code examples in this book are in Java. If you are not a Java programmer but can read object-oriented code in other languages, you will be fine. In the few places where Java or framework specifics are needed, they are thoroughly explained.

What you will learn

  • Identify potential shortcomings of using a layered architecture
  • Apply varied methods to enforce architectural boundaries
  • Discover how potential shortcuts can affect the software architecture
  • Produce arguments for using different styles of architecture
  • Structure your code according to the architecture
  • Run various tests to check each element of the architecture

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jul 14, 2023
Length: 168 pages
Edition : 2nd
Language : English
ISBN-13 : 9781805125914
Vendor :
Salesforce
Category :
Languages :
Tools :

What do you get with eBook?

Product feature icon Instant access to your Digital eBook purchase
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning

Product Details

Publication date : Jul 14, 2023
Length: 168 pages
Edition : 2nd
Language : English
ISBN-13 : 9781805125914
Vendor :
Salesforce
Category :
Languages :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 144.97
Get Your Hands Dirty on Clean Architecture
$44.99
The Ultimate Docker Container Book
$49.99
50 Algorithms Every Programmer Should Know
$49.99
Total $ 144.97 Stars icon

Table of Contents

17 Chapters
Chapter 1: Maintainability Chevron down icon Chevron up icon
Chapter 2: What’s Wrong with Layers? Chevron down icon Chevron up icon
Chapter 3: Inverting Dependencies Chevron down icon Chevron up icon
Chapter 4: Organizing Code Chevron down icon Chevron up icon
Chapter 5: Implementing a Use Case Chevron down icon Chevron up icon
Chapter 6: Implementing a Web Adapter Chevron down icon Chevron up icon
Chapter 7: Implementing a Persistence Adapter Chevron down icon Chevron up icon
Chapter 8: Testing Architecture Elements Chevron down icon Chevron up icon
Chapter 9: Mapping between Boundaries Chevron down icon Chevron up icon
Chapter 10: Assembling the Application Chevron down icon Chevron up icon
Chapter 11: Taking Shortcuts Consciously Chevron down icon Chevron up icon
Chapter 12: Enforcing Architecture Boundaries Chevron down icon Chevron up icon
Chapter 13: Managing Multiple Bounded Contexts Chevron down icon Chevron up icon
Chapter 14: A Component-Based Approach to Software Architecture Chevron down icon Chevron up icon
Chapter 15: Deciding on an Architecture Style Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon
Other Books You May Enjoy Chevron down icon Chevron up icon

Customer reviews

Top Reviews
Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.5
(23 Ratings)
5 star 60.9%
4 star 34.8%
3 star 0%
2 star 0%
1 star 4.3%
Filter icon Filter
Top Reviews

Filter reviews by




Bernhard Schenk Jul 31, 2023
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Ein aus meiner Sicht sehr gutes und wichtiges Buch für jeden (Backend-)Entwickler, aber auch Software-Architekten - besonders, aber nicht nur, im Umfeld von MicroServices.Tom versteht es sehr gut die Leute auf unterschiedlichsten Erfahrungen abzuholen. Nachfolgend schafft er es einem die Vorteile der Clean Architecture (Hexagonale Architektur) näherzubringen, um dann final die praktische Umsetzung zu erläutern und mit Beispielen zu belegen. Auch die Vorraussetzungen und potentiellen Probleme werden sehr ausführlich dargelegt und aufgelöst. Gerade dieses ist aus meiner Sicht eine Stärke dieses Buchs, da es einem nicht mit theoretischem Wissen zurücklässt, sondern sehr viele praktische Lösungsschablonen an die Hand gibt.Sehr positiv auch die Ausblicke in die Sicherstellung der Pattern / Architektur-Constraints, so dass auch hier die Softwareerosion proaktiv vermieden, verzögert werden kann.Wenn ich mir noch was wünschen könnte, dann hätte ich gerne ergänzende Beispiele in einer zweiten Programmiersprache.
Amazon Verified review Amazon
emmanouil fotiadis May 28, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
One of the best books I have ever read. Very helpful to understand the actual structure of a project
Amazon Verified review Amazon
mgustav Dec 09, 2023
Full star icon Full star icon Full star icon Full star icon Full star icon 5
The book offers a treasure trove of practical and theoretical insights into Clean Architecture. The balanced deliberations on the judicious use of shortcuts make it a standout.
Amazon Verified review Amazon
Celil U. Aug 10, 2023
Full star icon Full star icon Full star icon Full star icon Full star icon 5
The author provides detailed explanations on how to create maintainable software. To clarify, he offers a comprehensive description of what maintainable software is and the benefits it offers. Through reading about his experiences in previous projects, readers get the impression that the author has devoted significant time to the development of maintainable software architecture.Using an example software project available on GitHub, he demonstrates the process of creating maintainable software, from layered to hexagonal architecture. In doing so, he delves into two principles of SOLID: Dependency Inversion and Single Responsibility. He also elucidates the significance of Domain Driven Design (DDD) and its relevance in crafting a maintainable architecture.After each chapter, the author succinctly explains why the covered content is essential for a maintainable architecture, allowing readers to effortlessly grasp his reasoning.While the author offers valuable insights on creating maintainable software using a simple example, some readers might yearn for guidance on applying these insights to larger projects, depending on their requirements. Nonetheless, the author concludes his book by emphasizing that these tips can and should be customized and incorporated into each organization's software development projects, always bearing in mind the criteria for maintainable software.In summary, this book serves as an insightful guide on constructing maintainable software, replete with valuable hints, guidelines, and code examples. Although the code examples are written in Java + Spring, they are straightforward and can be understood by anyone familiar with object-oriented programming languages. Moreover, even non-native English speakers will find the author's explanations easy to comprehend.
Amazon Verified review Amazon
Thomas W. Jul 31, 2023
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This book gives you very practical but technology agnostic insights on the Hexagonal Architecture style.I especially liked the discussion on shortcuts and tradeoffs on the different aspects which comes with this architectural style.What I especially liked about the second version of the book are the cross references to maintainability at the end of each chapter. I also find the thoughts on horizontal / vertical layering in chapter 13 very insightful and practical relevant.At the very end the author present a very pragmatic architecture style to enable high modularity in software systems with less complex domain and how to evolve it over time -> this was my personal highlight.What I personally missed are some concrete examples about:* Approaches when integrating multiple external systems in an asynchronous manner (especially on the API design of ports) -> command/query vs reactive* Usage of domain events for cross domain communication, but also reporting purposes* Approaches on how to share some common technical aspects (aka shared kernel) between/inside domains / components (there is always some common code ;-))* How to make modularity measurable -> which metrics would you apply and have been proven as practical relevantBut all in all this is by far the best practical lecture on how to structure code in a modular manner which I have read so far !Following the authors guidelines will enable you to transform your legacy software architecture into an evolutionary one :-)
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

How do I buy and download an eBook? Chevron down icon Chevron up icon

Where there is an eBook version of a title available, you can buy it from the book details for that title. Add either the standalone eBook or the eBook and print book bundle to your shopping cart. Your eBook will show in your cart as a product on its own. After completing checkout and payment in the normal way, you will receive your receipt on the screen containing a link to a personalised PDF download file. This link will remain active for 30 days. You can download backup copies of the file by logging in to your account at any time.

If you already have Adobe reader installed, then clicking on the link will download and open the PDF file directly. If you don't, then save the PDF file on your machine and download the Reader to view it.

Please Note: Packt eBooks are non-returnable and non-refundable.

Packt eBook and Licensing When you buy an eBook from Packt Publishing, completing your purchase means you accept the terms of our licence agreement. Please read the full text of the agreement. In it we have tried to balance the need for the ebook to be usable for you the reader with our needs to protect the rights of us as Publishers and of our authors. In summary, the agreement says:

  • You may make copies of your eBook for your own use onto any machine
  • You may not pass copies of the eBook on to anyone else
How can I make a purchase on your website? Chevron down icon Chevron up icon

If you want to purchase a video course, eBook or Bundle (Print+eBook) please follow below steps:

  1. Register on our website using your email address and the password.
  2. Search for the title by name or ISBN using the search option.
  3. Select the title you want to purchase.
  4. Choose the format you wish to purchase the title in; if you order the Print Book, you get a free eBook copy of the same title. 
  5. Proceed with the checkout process (payment to be made using Credit Card, Debit Cart, or PayPal)
Where can I access support around an eBook? Chevron down icon Chevron up icon
  • If you experience a problem with using or installing Adobe Reader, the contact Adobe directly.
  • To view the errata for the book, see www.packtpub.com/support and view the pages for the title you have.
  • To view your account details or to download a new copy of the book go to www.packtpub.com/account
  • To contact us directly if a problem is not resolved, use www.packtpub.com/contact-us
What eBook formats do Packt support? Chevron down icon Chevron up icon

Our eBooks are currently available in a variety of formats such as PDF and ePubs. In the future, this may well change with trends and development in technology, but please note that our PDFs are not Adobe eBook Reader format, which has greater restrictions on security.

You will need to use Adobe Reader v9 or later in order to read Packt's PDF eBooks.

What are the benefits of eBooks? Chevron down icon Chevron up icon
  • You can get the information you need immediately
  • You can easily take them with you on a laptop
  • You can download them an unlimited number of times
  • You can print them out
  • They are copy-paste enabled
  • They are searchable
  • There is no password protection
  • They are lower price than print
  • They save resources and space
What is an eBook? Chevron down icon Chevron up icon

Packt eBooks are a complete electronic version of the print edition, available in PDF and ePub formats. Every piece of content down to the page numbering is the same. Because we save the costs of printing and shipping the book to you, we are able to offer eBooks at a lower cost than print editions.

When you have purchased an eBook, simply login to your account and click on the link in Your Download Area. We recommend you saving the file to your hard drive before opening it.

For optimal viewing of our eBooks, we recommend you download and install the free Adobe Reader version 9.