Scaffolding of Clean Architecture

Gradle plugin to create a java application based on Clean Architecture following our best practices!

Plugin Implementation

To use the plugin you need Gradle version 5.6 or later, to start add the following section into your build.gradle file.

plugins {
 id "co.com.bancolombia.cleanArchitecture" version "1.6.7"
}

Tasks

The Scaffolding Clean Architecture plugin will allow you run 8 tasks :

1 The cleanArchitecture | ca task will generate a clean architecture structure in your project, this task has four optional parameters; package , type, name and coverage.

• package = <package.we.need>: You can specify the main or default package of your project. Default Value = co.com.bancolombia

• type = <imperative | reactive>: With this parameter the task will generate a POO project. Default Value = imperative

• name = NameProject: This parameter is going to specify the name of the project. Default Value = cleanArchitecture

• coverage = <jacoco | cobertura>: This parameter is going to specify the coverage tool for the project. Default Value = jacoco

gradle cleanArchitecture --package=co.com.bancolombia --type=imperative --name=NameProject --coverage=JACOCO
gradle ca --package=co.com.bancolombia --type=imperative --name=NameProject --coverage=JACOCO

The structure will look like this:

📦NameProject
 ┣ 📂applications
 ┃ ┗ 📂app-service
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┣ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂config
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜[configs and beans]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜MainApplication.java
 ┃ ┃ ┃ ┃ ┗ 📂resources
 ┃ ┃ ┃ ┃ ┃ ┣ 📜[properties]
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┗ 📜build.gradle
 ┣ 📂deployment
 ┃ ┣ 📜[Dockerfile, Pipelines as a code]
 ┣ 📂domain
 ┃ ┣ 📂model
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┗ 📜build.gradle
 ┃ ┗ 📂usecase
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usecase
 ┃ ┃ ┗ 📜build.gradle
 ┣ 📂infrastructure
 ┃ ┣ 📂driven-adapters
 ┃ ┣ 📂entry-points
 ┃ ┗ 📂helpers
 ┣ 📜.gitignore
 ┣ 📜build.gradle
 ┣ 📜gradle.properties
 ┣ 📜lombok.config
 ┣ 📜main.gradle
 ┣ 📜README.md
 ┗ 📜settings.gradle

2 The generateModel | gm task will generate a class and interface in model layer, this task has one required parameter name.

gradle generateModel --name=[modelName]
gradle gm --name [modelName]

This task will generate something like that:

📦domain
 ┣ 📂model
 ┃ ┣ 📂src
 ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┗ 📂model
 ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂gateways
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜ModelRepository.java
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜Model.java
 ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┗ 📂model
 ┃ ┗ 📜build.gradle

3 The generateUseCase | guc task will generate a class in model layer, this task has one required parameter name.

gradle generateUseCase --name=[useCaseName]
gradle guc --name [useCaseName]

This task will generate something like that:

📦domain
 ┗ 📂usecase
 ┃ ┣ 📂src
 ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┗ 📂usecase
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂business
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜BusinessUseCase.java
 ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┗ 📂usecase
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂business
 ┃ ┗ 📜build.gradle

4 The generateDrivenAdapter | gda task will generate a class in Infrastructure layer, this task has one required parameter type. Whether you'll use generic one also parameter name is required.

gradle generateDrivenAdapter --type=[drivenAdapterType]
gradle gda --type [drivenAdapterType]

When use MONGODB type please be sure that property 'reactive' is set correctly in gradle.properties

• For reactive projects should be:

reactive=true

• For imperative projects should be:

reactive=false

Reference for drivenAdapterType	Name	Additional Options
GENERIC	Empty Driven Adapter	--name [name]
JPA	JPA Repository	--secret [true-false]
MONGODB	Mongo Repository	--secret [true-false]
ASYNCEVENTBUS	Async Event Bus

This task will generate something like that:

📦infrastructure
 ┣ 📂driven-adapters
 ┃ ┗ 📂jpa-repository
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂jpa
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂config
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜DBSecret.java
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂helper
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜AdapterOperations.java
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜JPARepository.java
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜JPARepositoryAdapter.java
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂jpa
 ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂helper
 ┃ ┃ ┗ 📜build.gradle

5 The generateEntryPoint | gep task will generate a class in Infrastructure layer, this task has one required parameter type. Whether you'll use generic one also parameter name is required.

gradle generateEntryPoint --type=[entryPointType]
gradle gep --type [entryPointType]

Reference for entryPointType	Name	Additional Options
GENERIC	Empty Entry Point	--name [name]
RESTMVC	API REST (Spring Boot Starter Web)
WEBFLUX	API REST (Spring Boot Starter WebFlux)

This task will generate something like that:

📦infrastructure
 ┣ 📂entry-points
 ┃ ┗ 📂generic
 ┃ ┃ ┣ 📂src
 ┃ ┃ ┃ ┣ 📂main
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂generic
 ┃ ┃ ┃ ┗ 📂test
 ┃ ┃ ┃ ┃ ┗ 📂java
 ┃ ┃ ┃ ┃ ┃ ┗ 📂[package]
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂generic
 ┃ ┃ ┗ 📜build.gradle

6 The validateStructure | vs Validate that project references aren't violated.

gradle validateStructure  
gradle vs

7 The generatePipeline | gpl task will generate CI pipeline inside the folder "./deployment/", this task has one required parameter type.

gradle generatePipeline --type=[pipelineType]
gradle gpl --type=[pipelineType]

Reference for pipelineType	Name
AZURE	Azure Pipeline

8 The deleteModule | dm task will delete a sub project, this task has one required parameter module.

gradle deleteModule --module=[name]
gradle dm --module=[name]

How can I help?

Review the issues, we hear new ideas. Read more Contributing

Whats Next?

Read more About Clean Architecure