Implementing a hexagonal architecture

Bertil Muth - May 24 '19 - - Dev Community

A hexagonal architecture simplifies deferring or changing technology decisions. You want to change to a different framework? Write a new adapter. You want to use a database, instead of storing data in files? Again, write an adapter for it.

Draw a boundary around the business logic. The hexagon. Anything inside the hexagon must be free from technology concerns.
The outside of the hexagon talks with the inside only by using interfaces, called ports. Same the other way around. By changing the implementation of a port, you change the technology.

Isolating business logic inside the hexagon has another benefit. It enables writing fast, stable tests for the business logic. They do not depend on web technology to drive them, for example.

Here's an example diagram. It shows Spring MVC technology as boxes with dotted lines, ports and adapters as solid boxes, and the hexagon without its internals:

poem-springboot hexagon

An adapter translates between a specific technology and a technology free port. The PoemController adapter on the left receives requests and sends commands to the IReactToCommands port. The PoemController is a regular Spring MVC Controller. Because it actively uses the port, it's called a driver adapter.

IReactToCommands is called a driver port. Its implementation is inside the hexagon. It's not shown on the diagram.

On the right side, the SpringMvcPublisher adapter implements the IWriteLines port. This time, the hexagon calls the adapter through the port. That's why SpringMvcPublisher is called a driven adapter. And IWriteLines is called a driven port.

I show you how to implement that application. We go all the way from a user story to a domain model inside the hexagon. We start with a simple version of the application that prints to the console. Then we switch to Spring Boot and Spring MVC.

From a user story to ports & adapters

The company FooBars.io decides to build a Poetry App. The product owner and the developers agree on the following user story:

As a reader
I want to read at least one poem each day
So that I thrive as a human being

As acceptance criteria, the team agrees on:

  • When the user asks for a poem in a specific language, the system displays a random poem in that language in the console
  • It's ok to "simulate" the user at first, i.e. no real user interaction. (This will change in future versions.)
  • Supported languages: English, German

The developers meet and draw the following diagram:

poem-hexagon

So the SimulatedUser sends commands to the IReactToCommands port. It asks for poems in English and German. Here's the code, it's available on Github.

poem/simple/driver_adapter/SimulatedUser.java

public class SimulatedUser {
    private IReactToCommands driverPort;

    public SimulatedUser(IReactToCommands driverPort) {
        this.driverPort = driverPort;
    }

    public void run() {
        driverPort.reactTo(new AskForPoem("en"));
        driverPort.reactTo(new AskForPoem("de"));
    }
}
Enter fullscreen mode Exit fullscreen mode

The IReactToCommands port has only one method to receive any kind of command.

poem/boundary/driver_port/IReactToCommands.java

public interface IReactToCommands{
    void reactTo(Object command);
}
Enter fullscreen mode Exit fullscreen mode

AskForPoem is the command. Instances are simple, immutable POJOs. They carry the language of the requested poem.

poem/command/AskForPoem.java

public class AskForPoem {
    private String language;

    public AskForPoem(String language) {
        this.language = language;
    }

    public String getLanguage() {
        return language;
    }
}
Enter fullscreen mode Exit fullscreen mode

And that's it for the left, driver side of the hexagon. On to the right, driven side.

poem-hexagon: driven side up next

When the SimulatedUser asks the IReactToCommands port for a poem, the hexagon:

  1. Contacts the IObtainPoems port for a collection of poems
  2. Picks a random poem from the collection
  3. Tells the IWriteLines port to write the poem to the output device

You can't see Step 2 yet. It happens inside the hexagon, in the domain model. That's the business logic of the example. So we focus on Step 1 and Step 3 first.

In Step 1, the collection of poems is a language dependent, hard coded array. It's provided by the HardcodedPoemLibrary adapter that implements the IObtainPoems port.

poem/boundary/driven_port/IObtainPoems.java

public interface IObtainPoems {
    String[] getMePoems(String language);
}
Enter fullscreen mode Exit fullscreen mode

poem/simple/driven_adapter/HardcodedPoemLibrary.java

public class HardcodedPoemLibrary implements IObtainPoems {
    public String[] getMePoems(String language) {
        if ("de".equals(language)) {
            return new String[] { /* Omitted for brevity */ };
        } else { 
            return new String[] { /* Omitted for brevity */ };
        }
    }
}
Enter fullscreen mode Exit fullscreen mode

In Step 3, the ConsoleWriter adapter writes the lines of the poems to the output device, i.e. the console.

poem/boundary/driven_port/IWriteLines.java

public interface IWriteLines {
    void writeLines(String[] strings);
}
Enter fullscreen mode Exit fullscreen mode

poem/simple/driven_adapter/ConsoleWriter.java

public class ConsoleWriter implements IWriteLines {
    public void writeLines(String[] lines) {
        Objects.requireNonNull(lines);
        for (String line : lines) {
            System.out.println(line);
        }
        System.out.println("");
    }
}
Enter fullscreen mode Exit fullscreen mode

We have created all the ports, and a simple implementation of all the adapters. So far, the inside of the hexagon remained a mystery. It's up next.

poem-hexagon: inside up next

Command handlers (inside the hexagon)

When a user asks for a poem, the system displays a random poem.
Similar in the code: when the IReactToCommands port receives an AskForPoemcommand, the hexagon calls a DisplayRandomPoem command handler.

The DisplayRandomPoem command handler obtains a list of poems, picks a random one and writes it to the output device. This is exactly the list of steps we talked about in the last clause.

poem/boundary/internal/command_handler/DisplayRandomPoem.java

public class DisplayRandomPoem implements Consumer<AskForPoem> {
        /* Omitted for brevity */

    @Override
    public void accept(AskForPoem askForPoem) {
        List<Poem> poems = obtainPoems(askForPoem);
        Optional<Poem> poem = pickRandomPoem(poems);
        writeLines(poem);   
    }

        /* Rest of class omitted for brevity */
}
Enter fullscreen mode Exit fullscreen mode

It's also the job of the command handler to translate between the domain model data and the data used in the port interfaces.

Tying commands to command handlers

In my implementation of a hexagonal architecture, there is only a single driver port, IReactToCommands. It reacts to all types of commands.

public interface IReactToCommands{
    void reactTo(Object command);
}
Enter fullscreen mode Exit fullscreen mode

The Boundary class is the implementation of the IReactToCommands port.
It creates a behavior model using a library. The behavior model maps each command type to a command handler.
Then, a behavior dispatches the commands based on the behavior model.

poem/boundary/Boundary.java

public class Boundary implements IReactToCommands, BehaviorModel {
  private final IObtainPoems poemObtainer;
  private final IWriteLines lineWriter;
  private final StatelessBehavior behavior;

  private static final Class<AskForPoem> asksForPoem = AskForPoem.class;

  public Boundary(IObtainPoems poemObtainer, IWriteLines lineWriter) {
    this.poemObtainer = poemObtainer;
    this.lineWriter = lineWriter;
    this.behavior = StatelessBehavior.of(this);
  }

  @Override
  public Model model() {
    return Model.builder()
        .user(asksForPoem).system(displaysRandomPoem())
        .build();
  }

  @Override
  public void reactTo(Object commandObject) {
    behavior.reactTo(commandObject);
  }

  private Consumer<AskForPoem> displaysRandomPoem() {
    return new DisplayRandomPoem(poemObtainer, lineWriter);
  }
}
Enter fullscreen mode Exit fullscreen mode

The domain model

The domain model of the example doesn’t have very interesting functionality. The RandomPoemPicker picks a random poem from a list.

A Poem has a constructor that takes a String containing line separators, and splits it into verses.

The really interesting bit about the example domain model: it doesn’t refer to a database or any other technology, not even by interface!

That means that you can test the domain model with plain unit tests. You don’t need to mock anything.

Such a pure domain model is not a necessary property of an application implementing a hexagonal architecture. But I like the decoupling and testability it provides.

Plug adapters into ports, and that's it

A final step remains to make the application work. The application needs a main class that creates the driven adapters. It injects them into the boundary.
It then creates the driver adapter, for the boundary, and runs it.

poem/simple/Main.java

public class Main {
    public static void main(String[] args) {
        new Main().startApplication();
    }

    private void startApplication() {
        // Instantiate driven, right-side adapters
        HardcodedPoemLibrary poemLibrary = new HardcodedPoemLibrary();
        ConsoleWriter consoleWriter = new ConsoleWriter();

        // Inject driven adapters into boundary
        Boundary boundary = new Boundary(poemLibrary, consoleWriter);

        // Start the driver adapter for the application
        new SimulatedUser(boundary).run();
    }
}
Enter fullscreen mode Exit fullscreen mode

And that's it! The team shows the result to the product owner. And she's happy with the progress. Time for a little celebration.

hexagon-poem the completed application

Switching to Spring

The team decides to turn the poem app into a web application. And to store poems in a real database. They agree to use the Spring framework to implement it.
Before they start coding, the team meets and draws the following diagram:

poem-springboot hexagon

Instead of a SimulatedUser, there is a PoemController now, that sends commands to the hexagon.

poem/springboot/driver_adapter/PoemController.java

@Controller
public class PoemController {
    private SpringMvcBoundary springMvcBoundary;

    @Autowired
    public PoemController(SpringMvcBoundary springMvcBoundary) {
        this.springMvcBoundary = springMvcBoundary;
    }

    @GetMapping("/askForPoem")
    public String askForPoem(@RequestParam(name = "lang", required = false, defaultValue = "en") String language,
            Model webModel) {
        springMvcBoundary.basedOn(webModel).reactTo(new AskForPoem(language));

        return "poemView";
    }
}
Enter fullscreen mode Exit fullscreen mode

When receiving a command, the PoemController calls springMvcBoundary.basedOn(webModel). This creates a new Boundary instance, based on the webModel of the request:

poem/springboot/boundary/SpringMvcBoundary.java

public class SpringMvcBoundary {
    private final IObtainPoems poemObtainer;

    public SpringMvcBoundary(IObtainPoems poemObtainer) {
        this.poemObtainer = poemObtainer;
    }

    public IReactToCommands basedOn(Model webModel) {
        SpringMvcPublisher webPublisher = new SpringMvcPublisher(webModel);
        IReactToCommands boundary = new Boundary(poemObtainer, webPublisher);
        return boundary;
    }
}
Enter fullscreen mode Exit fullscreen mode

The call to reactTo() sends the command to the boundary, as before.
On the right side of the hexagon, the SpringMvcPublisher adds an attribute lines to the Spring MVC model. That's the value Thymeleaf uses to insert the lines into the web page.

poem/springboot/driven_adapter/SpringMvcPublisher.java

public class SpringMvcPublisher implements IWriteLines {
    static final String LINES_ATTRIBUTE = "lines";

    private Model webModel;

    public SpringMvcPublisher(Model webModel) {
        this.webModel = webModel;
    }

    public void writeLines(String[] lines) {
        Objects.requireNonNull(lines);
        webModel.addAttribute(LINES_ATTRIBUTE, lines);
    }
}
Enter fullscreen mode Exit fullscreen mode

The team also implements a PoemRepositoryAdapter to access the PoemRepository. The adapter gets the Poem objects from the database. It returns the texts of all poems as a String array.

poem/springboot/driven_adapter/PoemRepositoryAdapter.java

public class PoemRepositoryAdapter implements IObtainPoems {
    private PoemRepository poemRepository;

    public PoemRepositoryAdapter(PoemRepository poemRepository) {
        this.poemRepository = poemRepository;
    }

    @Override
    public String[] getMePoems(String language) {
        Collection<Poem> poems = poemRepository.findByLanguage(language);
        final String[] poemsArray = poems.stream()
            .map(p -> p.getText())
            .collect(Collectors.toList())
            .toArray(new String[0]);
        return poemsArray;
    }
}
Enter fullscreen mode Exit fullscreen mode

Finally, the team implements the Application class that sets up an example repository and plugs the adapters into the ports.

And that's it. The switch to Spring is complete.

Conclusion

There are many ways to implement a hexagonal architecture. I showed you a straightforward approach that provides an easy to use, command driven API for the hexagon. It reduces the number of interfaces you need to implement. And it leads to a pure domain model.

If you want to get more information on the topic, read Alistair Cockburn’s original article on the subject.

The example in this article is inspired by a three part series of talks by Alistair Cockburn on the subject.

Last updated on 30 July 2021. Do you have a question? Chat with me on Gitter. If you want to keep up with what I’m doing or drop me a note, follow me on dev.to, LinkedIn or Twitter. Or visit my GitHub project.

Image
7 Simple Changes That Will Make The Difference With Your Internal Injury Lawyer Near Me
Image
System Design 02 - Caching: The Art of Keeping Users Happy Without Breaking a Sweat

systemdesign, cache, basic
Image
7 Simple Tricks To Totally You Into Bifold Door Seal Repair
Image
Kanapy Marzeń: Stwórz Idealną Przestrzeń do Wypoczynku!
Image
Mastering Automated Image Optimization in Production: A Journey Beyond Uploads
Image
What Is Head Injury Settlement Amounts And How To Utilize It
Image
24 Hours To Improving Head Injury Compensation Claim
Image
Ten Apps To Help Manage Your Internal Injury Law Firm
Image
3 Permainan Judi Online Terunggul Dengan Keuntungan Besar
Image
Hukum Taruhan Permainan Online
Image
Why Install a Double Glazing Cat Flap?
Image
apa permainan slots online itu beri keuntungan?
Image
10 Things People Hate About Bifold Door Seal Repair
Image
Five People You Should Know In The Best Wall Mounted Electric Fireplaces Industry
Image
The 10 Scariest Things About Asbestos Exposure Attorney
Image
10 Things We Hate About Wall Electric Fire Place
Image
Variasi faedah Dari Judi Online yang Mesti Anda Tahu.
Image
There's Enough! 15 Things About Bifold Door Repair We're Sick Of Hearing
Image
Why Adding A Bi Fold Repairs To Your Life's Journey Will Make The Difference
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .