Table of contents


Given problem

Normally, in an small application, we write everything such as creating UI in some Swing components, event handler for each component, … Assuming that we have a ListBox component to display data from database, in event handler of the specific button, we will use JDBC to load them and paste to ListBox component.

It makes our logic code, and persistence code that is embbeded into the presentation code.

When we have the huge number of components, we will encounter some problems:

  • Our code becomes mess.
  • It is not easy to maintain.
  • The duplicated code increases.

Therefore, how do we deal with it?


Solution of Layered architecture pattern

  1. Introduction to Layered architecture pattern

    To overcome the above drawbacks, we will use layered architecture pattern. It uses Seperation of Concerns principle to implement.

    According to this principle, we have:

     Don't write your program as one solid block, instead, break up the code into chunks that are finalized tiny pieces of the system each able to complete a simple distinct job.
    

    So, below is the common three layered pattern that interacts between web services.

    The functionalities of each layer:

    • Web layer

      It is used to receive all requests from Users. In this layer, we will process Http request to get body data, or request parameters.

    • Domain

      This layer will contain all business logic of our application, and domain objects - is centric things that we need to take care.

    • Persistence

      If we interact with some database, it will contain entities that map with tables based on some JPA providers.

      Also, if we want to touch with other persistence systems such as Redis, Memcache, Apache Solr, … we will use domain objects to work with it.

  2. The rule in Layered architecture pattern

    In a layered system, each layer:

    • depends on the layers beneath it.
    • is independent of the layers on top of it, having no knowledge of the layers using it.

    If we applied this rule strictly, it means that a layer only knows about the layer directly beneath it, it makes us to create multiple proxy classes in the intermediate layers and the performance of our system decreases when we need to go though a bunch of unneccessary layers.

    To deal with it, we can use the soft rule: a layer can access any layer beneath it. But it has some problems when using this soft rule.

    • If we allow the Web layer access directly to the Persistence layer, then modifications by using SQL query within the Persistence layer would influence both the Domain layer and the Web layer. Then it produces tightly coupled application with lots of interdependencies between components.

    So, we have some concepts to reduce the above problems.

    • Layers of isolation

      The layers of isolation means that changes made in one layer of the architecture generally do not impact or affect components in other layers.

      It also means that each layer is independent of the other layers, thereby having little or no knowledge of the inner workings of other layers in the architecture.

    • Closed layer

      A closed layer means that as a request moves from layer to layer, it must go through the layer right below it to get the next layer below that one.

    • Opened layer

      A opened layer means that requests are allowed to by pass this layer and go directly to the layer below it.

    To make document about the layered architecture pattern, we need to use these concepts to define the relationship between layers and request flows, helps people to understand the various layer access restrictions.


When to use

  • When we want to develop an immediate application.

  • When we want to develop parallel between multiple teams.


Benefits and Drawbacks

  1. Benefits

    • Creating an application quickly.
    • Easy to understand the functionality of each layer.
  2. Drawbacks

    • Degrade performance of system when we have so many layers.

    • When the business logic of system increases quickly, it makes us creating multiple packages for each layer. So it’s difficult to control it.

    • In the layered architecture pattern, sometimes, we use the soft rule to implement, so it can cause that our business logic can be scattered throughout the layers. Then, it is difficult to code when we need to add a new functionality.

      Normally, we want to run all the business logic on the server because it is the best choice for ease of maintainance, upgrade and fix. In the desktop applications, we do not worry about deployment to many desktop and keeping them all in sync with the server. But the drawback of this solution is the cost of roundtrip network between client and server.

      Somtimes, to reduce the roundtrip problem and improve responsiveness, reduce the number of disconnected case , we can embedded the business logic into the presentation layer. Its drawback is difficult to maintain.


Some best practices for Layered architecture

In the section Solution of Layered architecture pattern, we will look at that image. Our current context is that we only want to work with web service project, it means that we will interact with the other systems through Restful APIs, or SOAP, or gRPC.

In the web layer’s source code, we will define multiple controllers to receive requests from other systems. Belows are some good rules for controllers.

  • Controllers should not do anything remotely related to the business logic, and directly access data stores.
  • The controller’s only purpose is to receive a request and return a response. Everything that goes in between is not its responsibility.

    It means that we need all validations, business logic to the Domain service of Domain layer. In the Controller classes, only call that services.

  • Controllers should be super thin.


Wrapping up

  • Understanding the Seperation of Concerns principle to apply into Layered architecture pattern.


Refer:

Software architecture pattern

Patterns of Enterprise Application Architecture of Martin Fowler

Learning modular programming

https://herbertograca.com/2017/08/03/layered-architecture/

https://medium.com/swlh/your-controllers-are-doing-too-much-this-is-how-to-simplify-them-7f7d0ea0a810