SPRING BOOT MULTI MODULE PROJECT

This project is still under development.

This project aims to help the developer to start with spring boot multi-module project quickly. Logging, Exception handling, security are enabled by default. As of now logging and security module are strictly tied to Microsoft azure. All logs and exceptions are continuously tracked in Microsoft Application Insight.

Anyone can take this skeleton, and can start developing Microservice with Spring Boot in no time, since they majorly need to focus on business logic. This project handles major cross-cutting concerns, and these are available under lib folder.

Add your Microservice under application folder. I have added one sample-service under application folder, that can used as a reference.

LIBRARIES

• api-docs
  • documentation
  • code
• file-handler
  • documentation
  • code
• exception
  • documentation
  • code
• logging
  • documentation
  • code
• security
  • documentation
  • code
• utility
  • documentation
  • code

How to bootstrap new Microservice

For Complete implementation, please check sample-service.

• Step 1:Clone this repository

• Step 2:Load Parent pon.xml

• Step 3:Create Maven Module

• Step 4:Replace pom.xml content

<?xml version="1.0" encoding="UTF-8"?>
<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>backend-parent</artifactId>
<groupId>com.app</groupId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>sample-service</artifactId> <!--Change the artificat name, if you want -->
<dependencies>
<!-- Enables basic Swagger UI, by adding @EnableDocs annotation on Main Class. For Advance configuration, check README file -->
<dependency>
<groupId>com.app</groupId>
<artifactId>api-docs</artifactId>
<version>${project.version}</version>
</dependency>
<!-- It contains security, logging and exception dependencies.-->
<dependency>
<groupId>com.app</groupId>
<artifactId>backend-starter</artifactId>
<version>${project.version}</version>
</dependency>
<!-- Check README file for details of this module. -->
<dependency>
<groupId>com.app</groupId>
<artifactId>utility</artifactId>
<version>${project.version}</version>
</dependency>
<!-- Uncomment this section, if you want support for azure blob storage. Check README file for detail usage. --><!-- <dependency> <groupId>com.app</groupId> <artifactId>file-handler</artifactId> <version>${project.version}</version> </dependency>-->
</dependencies>
<build>
<finalName>sample-service</finalName> <!--Change the name of the jar generated by build, if you want -->
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<layers>
<enable>true</enable>
</layers>
</configuration>
</plugin>
</plugins>
</build>
</project>

• Step 5:Add application.yaml file under resource folder

spring:
application:
name: sample-servicedatasource:
url: jdbc:h2:mem:testdbdriver-class-name: org.h2.Driverusername: testpassword: testjpa:
database-platform: org.hibernate.dialect.H2Dialecth2:
console:
enabled: trueautoconfigure:
exclude:
- org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration
- org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfigurationserver:
port: 8080servlet:
session:
cookie:
http-only: truesecure: trueapp:
version: 1.0.0security:
enabled: trueswagger:
enable-auth: falsetitle: Sample Servicedesc: Helps to interact with Backendversion: v1path-mapping: /contact:
name: Backend Teamemail: test@test.comurl: ""license: nulllicense-uri: null

• Step 6:Create Application.java class under root package

packagesample_service;
importapidocs.annotations.EnableDocs;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importsecurity.annotations.EnableSecurity;
@SpringBootApplication@EnableDocs@EnableSecurity// UnComment this, if you want to use Security Module. Please refer README for detailed instructionpublicclassApplication {
publicstaticvoidmain( String[] args ) { SpringApplication.run(Application.class, args);}
}

Library Documentation

This section explains the usage of different modules.

api-docs

Add below dependency to pom.xml

 <dependency>
<groupId>com.app</groupId>
<artifactId>api-docs</artifactId>
<version>${project.version}</version>
</dependency>

Add below content to application.yml file, to modify the default value swagger variables

app:
swagger:
enable-auth: truetitle: Sample Service APIdesc: Helps to interact with Backendversion: v1path-mapping: /oauth:
client-id: '${backend-client-id}'client-key: '${backend-client}'resource: '${backend-resource}'login-endpoint: '${auth-url}'contact:
name: Backend Teamemail: test@test.comurl: ''license: nulllicense-uri: null

Enable swagger by only adding @EnableDocs annotation on Main Class.

packagesample_service;
importapidocs.annotations.EnableDocs;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication@EnableDocspublicclassApplication {
publicstaticvoidmain( String[] args ) { SpringApplication.run(Application.class, args);}
}

URL: http://localhost:8080/swagger-ui/index.html

file-handler

Exceptions will be automatically handled by Exception Module

Add below dependency to pom.xml

<dependency>
<groupId>com.app</groupId>
<artifactId>file-handler</artifactId>
<version>${project.version}</version>
</dependency>

Add below content in application.yml file

azure:
storage:
account-name: ${blob-name} account-key: ${blob-key}container-name: ${container-name}

Import FileUtil from file_handler.util

It has 3 functionality:

• Upload Blob

packagefile_handler;
importfile_handler.util.FileUtil;
publicclassFileHandler {
@AutowiredprivateFileUtilfileUtil;
publicURIuploadBlob(MultipartFilefile, StringblobName) {
returnfileUtil.uploadFile(file, blobName);
}
}

• Delete Blob

packagefile_handler;
importfile_handler.util.FileUtil;
publicclassFileHandler {
@AutowiredprivateFileUtilfileUtil;
publicvoiddelete(Stringurl, StringblobName) {
fileUtil.deleteBlob(url, blobName);
}
}

• Download Blob

packagefile_handler;
importfile_handler.util.FileUtil;
publicclassFileHandler {
@AutowiredprivateFileUtilfileUtil;
publicResponseEntity<Resource> download(Stringurl, StringblobName) {
returnfileUtil.downloadBlob(url, blobName);
}
}

exception

It is already a part of backend starter

 <dependency>
<groupId>com.app</groupId>
<artifactId>backend-starter</artifactId>
<version>${project.version}</version>
</dependency>

If you are not adding backend starter, then it can be added individually as well

 <dependency>
<groupId>com.app</groupId>
<artifactId>exception</artifactId>
<version>${project.version}</version>
</dependency>

Below are the exception that are handled by this module:

System Exception

• ArrayIndexOutOfBoundsException
• IndexOutOfBoundsException
• NumberFormatException
• IllegalArgumentException
• AccessDeniedException
• NullPointerException
• MethodArgumentTypeMismatchException
• DataAccessException
• SQLServerException
• ConstraintViolationException
• HttpRequestMethodNotSupportedException
• HttpMediaTypeNotSupportedException
• MissingPathVariableException
• HttpMessageNotReadableException
• HttpMessageNotWritableException
• MissingServletRequestParameterException
• ConversionNotSupportedException
• TypeMismatchException
• MethodArgumentNotValidException
• MissingServletRequestPartException
• NoHandlerFoundException

Custom Exception

• InvalidStateTransitionException
• DuplicateRecordException
• EntityNotFoundException
• MultipleActionFailedException
• OperationNotAllowedException
• OperationFailedException
• FileHandlingException

logging

It is already a part of backend starter

 <dependency>
<groupId>com.app</groupId>
<artifactId>backend-starter</artifactId>
<version>${project.version}</version>
</dependency>

If you are not adding backend starter, then it can be added individually as well

 <dependency>
<groupId>com.app</groupId>
<artifactId>logging</artifactId>
<version>${project.version}</version>
</dependency>

Out of the box logging for Repository, Service, Controller and Components, once below dependency added to pom.xml, and for all other functions of classes use @Loggable annotation.

packagesample_service.dto.mapper;
importlogging.annotations.Loggable;
importsample_service.dto.model.AppModelDTO;
importsample_service.model.AppModel;
publicclassAppModelMapper {
@LoggablepublicAppModelconvertToModel(AppModelDTOmodelDTO) {
AppModelmodel = newAppModel();
model.setId(modelDTO.getId());
model.setName(modelDTO.getName());
returnmodel;
}
}

@Loggable has 4 optional parameters, that can set, if want to log some different messages.

packagesample_service.dto.mapper;
importlogging.annotations.Loggable;
importsample_service.dto.model.AppModelDTO;
importsample_service.model.AppModel;
publicclassAppModelMapper {
@Loggable(valueAfter = "Value After", valueAfterReturning = "Value After Returning", valueAround = "Value Around", valueBefore = "Value Before")
publicAppModelconvertToModel(AppModelDTOmodelDTO) {
AppModelmodel = newAppModel();
model.setId(modelDTO.getId());
model.setName(modelDTO.getName());
returnmodel;
}
}

It will be capturing following properties:

• class_name: Name of the class to which functions belong.
• method_name: Name of the method which is getting executed.
• parameters: Parameters of function.
• execution_time_in_ms: Time take by a function.
• microservice: Name of the microservice.
• request_id: Unique Id with every request, that will also help to trace logs in Application Insight, if used.
• version: Microservice version.
• message:
  • When function is starting: FUNCTIONNAME function started..
  • When function complete: FUNCTIONNAME function completed..
  • In case of error it will contain error message.
  • When Controller starts: FUNCTIONNAME event started..
  • When Controller completes: FUNCTIONNAME event completed..

In order to send logs to Application Insight, add below content to application.yml

azure:
application-insights:
instrumentation-key: ${appinsight-instrumentation-key}enabled: true

security

As of now it only supports v1 token.

It is already a part of backend starter

 <dependency>
<groupId>com.app</groupId>
<artifactId>backend-starter</artifactId>
<version>${project.version}</version>
</dependency>

If you are not adding backend starter, then it can be added individually as well

 <dependency>
<groupId>com.app</groupId>
<artifactId>security</artifactId>
<version>${project.version}</version>
</dependency>

Enable security by only adding @EnableSecurity annotation on Main Class.

Add below content to application.yaml, if you are enabling security module

spring:
security.oauth2.client.registration.azure:
client-id: '${client-id-dev}'client-secret: '${client-secret-dev}'client-name: Azureazure:
activedirectory:
client-id: '${client-id-dev}'allow-telemetry: trueclient-secret: '${client-secret-dev}'user-group.allowed-groups: TEST_AZURE_AD_GROUPtenant-id: '${tenant-id-dev}'

If you want to disable out of box spring security, then add below content in application.yaml

spring:
autoconfigure:
exclude:
- org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration
- org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration

packagesample_service;
importapidocs.annotations.EnableDocs;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importsecurity.annotations.EnableSecurity;
@SpringBootApplication@EnableDocs@EnableSecuritypublicclassApplication {
publicstaticvoidmain( String[] args ) { SpringApplication.run(Application.class, args);}
}

utility

Add below dependency to pom.xml, in order to add utility module

 <dependency>
<groupId>com.app</groupId>
<artifactId>utility</artifactId>
<version>${project.version}</version>
</dependency>

It has few important component:

• ValidList: Use this when you are adding any validators to an element of List.

packagesample_service.controller.v1.api;
importutility.annotations.ControllerV1;
@ControllerV1publicclassAppController {
@PostMapping(path = "/user")
publicResponseEntity<ResponseDTO> setUsersDetail(@Valid@RequestBodyValidList<AppRequest> request) {
returnnewResponseEntity( ResponseDTO.setResponseDTO(
Messages.setMessage(EntityType.USER, ActionType.CREATED, "")),
HttpStatus.CREATED
);
}}

• ResponseDTO: Use this DTO, for returning response to Users, for POST, PUT, PATCH, DELETE actions. It has a static method setResponseDTO that can be used, to set the message in response, other fields will be set by default.
  • status: HttpStatus (This will be set to CREATED by default)
  • message: String ( Use setResponseDTO method to set this value, this a static method. ResponseDTO.setResponseDTO( Messages.setMessage(EntityType.USER, ActionType.CREATED, ""))).
  • timestamp: Date (This will set to current timestamp by default. It uses "dd-MM-yyyy hh:mm:ss Z" format).
  • requestId: String ( This will be set by default to unique value for every request. e.g. 123e4567-e89b-12d3-a456-556642440000 )
  • detailMessage: List

packagesample_service.controller.v1.api;
importutility.annotations.ControllerV1;
@ControllerV1publicclassAppController {
@PostMapping(path = "/user")
publicResponseEntity<ResponseDTO> setUsersDetail(@Valid@RequestBodyValidList<AppRequest> request) {
returnnewResponseEntity( ResponseDTO.setResponseDTO(
Messages.setMessage(EntityType.USER, ActionType.CREATED, "")),
HttpStatus.CREATED
);
}}