Skip to content

Latest commit

 

History

History
238 lines (176 loc) · 8.6 KB

README.md

File metadata and controls

238 lines (176 loc) · 8.6 KB

ZenWave SDK - JPA BaseLine

ZenWave SDK - JPA BaseLine

Table of Contents

  1. Getting Started
    1. Prerequisites
  2. Technologies
    1. Prerequisites
  3. Project Structure
    1. Clean/Hexagonal Architecture
    2. 3-Tier Architecture
    3. Simple Domain Packaging
  4. API First
    1. OpenAPI / SwaggerUI
      1. Customization
    2. AsyncAPI / ZenWave SDK
  5. Domain Modeling and Code Generation with ZenWave SDK
    1. Installing ZenWave SDK
    2. Modeling and Generating Code
  6. Testing
    1. Rules of thumb for Testing
  7. Code Formatting

Getting Started

After cloning the project, you can start the project with the following command:

docker-compose up -d
mvn spring-boot:run -Dspring-boot.run.profiles=local

Prerequisites

  • Java 17+
  • Maven 3.6+
  • Docker/Docker Compose
  • Git and Git-Bash
  • JBang and ZenWave SDK
  • SDKMAN! (optional but highly recommended)

Technologies

  • Spring Boot 3.3.x
  • Spring Data JPA or MongoDB
  • Spring Data Elasticsearch
  • Spring Cloud Streams for Kafka, RabbitMQ, or other Message Brokers
  • Spring Security
  • KarateDSL for API Testing
  • ZenWave SDK for Domain Modeling and Code Generation

Project Structure

This project is a blank canvas, you can follow a Clean/Hexagonal Architecture, Traditional 3-Tier Architecture, or a Simple Domain Packaging.

Clean/Hexagonal Architecture

📦 <basePackage>
   📦 adapters
       └─ web
       |  └─ RestControllers (spring mvc)
       └─ events
          └─ *EventListeners (spring-cloud-streams)
   📦 core
       ├─ 📦 domain
       |     └─ (entities and aggregates)
       ├─ 📦 inbound
       |     ├─ dtos/
       |     └─ ServiceInterface (inbound service interface)
       ├─ 📦 outbound
       |     ├─ mongodb
       |     |  └─ *RepositoryInterface (spring-data interface)
       |     └─ jpa
       |        └─ *RepositoryInterface (spring-data interface)
       └─ 📦 implementation
             ├─ mappers/
             └─ ServiceImplementation (inbound service implementation)
   📦 infrastructure
     ├─ mongodb
     |  └─ CustomRepositoryImpl (spring-data custom implementation)
     └─ jpa
        └─ CustomRepositoryImpl (spring-data custom implementation)

Traditional 3-Tier Architecture

📦 <basePackage>
   📦 web
       └─ RestControllers (spring mvc)
   📦 events
       └─ *EventListeners (spring-cloud-streams)
   📦 domain/model
       └─ (entities and aggregates)
   📦 service
       ├─ dtos/
       └─ ServiceInterface (inbound service interface)
       └─ 📦 implementation
           ├─ mappers/
           └─ ServiceImplementation (inbound service implementation)
   📦 repositories
       ├─ mongodb
       |   └─ CustomRepositoryImpl (spring-data custom implementation)
       └─ jpa
           └─ CustomRepositoryImpl (spring-data custom implementation)

Simple Domain Packaging

Use a simple domain packaging for small projects with just one entity or aggregate, where you plan to have just one service, one repository, and one controller. Also useful for modular monoliths where each module follows a simple domain packaging.

📦 <basePackage>
   📦 domain/model (entities or aggregate)
   📦 dtos
   📦 mappers
   └─ RestController (spring mvc)
   └─ EventListener (spring-cloud-streams)
   └─ ServiceInterface (inbound service interface)
   └─ ServiceImplementation (inbound service implementation)
   └─ CustomRepositoryImpl (spring-data custom implementation)

API First

OpenAPI / SwaggerUI

The project uses openapi-generator-maven-plugin (see pom.xml) to generate SpringMVC interfaces and DTOs from the src/main/resources/public/apis/openapi.yml file.

Generated sources are placed in target/generated-sources/openapi which becomes a source folder for the project. To implement the API, you can create a new @RestController and implement the generated interface.

Customization

You can customize generated code with this properties in pom.xml or directly in the plugin openapi-generator-maven-plugin:

<openApiApiPackage>${basePackage}.adapters.web</openApiApiPackage>
<openApiModelPackage>${basePackage}.adapters.web.model</openApiModelPackage>

SwaggerUI is available at http://localhost:8080/swagger-ui/index.html. If you need to add more OpenAPI files, you can customize SwaggerUI in application.yml:

springdoc.swagger-ui.urls:
   - name: ${projectName}
     url: /apis/openapi.yml

URL is relative to 'src/main/resources/public'.

AsyncAPI / ZenWave SDK

This project also uses zenwave-sdk-maven-plugin to generate interfaces, DTOs and producers/consumers using Spring Cloud Streams from the src/main/resources/public/apis/asyncapi.yml file.

If this file does not exist, code generation is skipped. Generated sources are placed in target/generated-sources/zenwave which becomes a source folder for the project.

Customization

You can customize generated code with this properties in pom.xml or directly in the plugin zenwave-sdk-maven-plugin:

<asyncApiModelPackage>${basePackage}.events.dtos</asyncApiModelPackage>
<asyncApiProducerApiPackage>${basePackage}.events.producer</asyncApiProducerApiPackage>
<asyncApiConsumerApiPackage>${basePackage}.events.consumer</asyncApiConsumerApiPackage>

See https://www.zenwave360.io/zenwave-sdk/plugins/asyncapi-spring-cloud-streams3/ for more information about API-First with AsyncAPI and ZenWave SDK.

Domain Modeling and Code Generation with ZenWave SDK

ZenWave SDK allows you to focus on Domain Modeling and Analysis using a Domain Specific Language (ZenWave Domain Language or ZDL) to define your domain model.

Then you can use ZenWave SDK command line or IntelliJ IDEA plugin to generate code from your analysed domain model.

Installing ZenWave SDK

Use JBang to install a self-updating evergreen version of ZenWave SDK Command Line.

jbang alias add --fresh --force --name=zw release@zenwave360/zenwave-sdk

This will give you access to the jbang zw command line tool. You can use jbang zw --help to see all available commands.

jbang zw --help list

Install ZenWave Domain Editor for IntelliJ IDEA from the marketplace.

See https://www.zenwave360.io/docs/getting-started/ for more information about ZenWave SDK.

Modeling and Generating Code

The base project comes with to files:

  • zenwave-scripts.zdl: sample scripts you can use from IntelliJ to run ZenWave commands and generate different software artifacts.
  • zenwave-model.zdl: sample model you can use to generate a sample application and use it as a reference for your own modeling and analysis.

Testing

  • JUnit5
  • SpringWebTestClient for API Testing in Java
  • KarateDSL for API Testing
  • SpringBootTest for Integration Testing
  • TestContainers with DockerComposeContainer for Integration Testing
  • InMemory implementations of external Interfaces (Repositories) for Unit Testing (generated w/ ZenWave SDK)
  • WireMock + OpenAPI Examples for Mocking external APIs
  • Mockito as a last resort for Mocking external Dependencies. Whenever possible, please favor WireMock and InMemory Repositories.

Rules of thumb for Testing:

  • Favor functional Vertical Testing (Acceptance Testing) over unit testing where every dependency is mocked.
    • Use @SpringBootTests for the most important use cases.
    • Use InMemory dependencies for all use cases.
  • Interfaces that connect to external resources MUST be tested using DockerComposeContainer, even if this does not contribute to code coverage metrics.

Code Formating

This project is configured to use Spring Java Format as code formatter. You can apply code formatting from the command line with the following command:

mvn spring-javaformat:apply

You can also configure your IDE for code automatic code formating with the following plugins:

Keep a consistent code style from the beginning of the project.

Happy Coding!! 🚀🚀🚀