Microservice Best Practice - Build an Archetype


Image


In this article, we focus on learning why creating proper archetypes is important for successful microservices architecture.

What you will learn

  • What is an archetype?
  • Why do you want to build microservices quickly?
  • How does an archetype help?
  • How can you use an archetype?
  • How can you build an archetype of your own?

Free Courses - Learn in 10 Steps

Best Practices with Cloud and Microservices

This is the fifth article in a series of six articles on best practices with cloud and microservices:

Why Do We Need Archetypes?

In microservices architectures, we have a number of microservices interacting with each other. And, we keep adding microservices as we evolve.

image info

A few questions arise:

  • How do you ensure that the microservices are consistent i.e. similarly built and deployed? This will ensure that a developer moving from one microservice to another will not have a great deal of learning to do!
  • How do you ensure that you are able to setup a new microservice quickly?
  • How do you ensure that the new microservice is consistent with older microservices?

With microservices architectures, while the functionality of each microservice is different, you want a bit of consistency in how they are built and deployed

  • Programming Language used
  • Frameworks used
  • The way unit tests are written
  • Deployment and Monitoring processes
  • QA & Automation Testing Approaches
  • Integration with Infrastructure components like Naming Server, API Gateways etc

This is where the reference architecture for your microservices comes into the picture. Having a good reference architecture ensures that your microservices are uniform.

How do you ensure that the reference architecture is properly implemented?

Enter Archetypes

Creating an archetype standardizes the reference architecture. An archetype is a piece of component code that can create the initial setup of microservice, adhering to the reference architecture.

What would the output of an archetype look like?

It would consist of an example microservice with

  • Framework Integration
  • Configuration of common external components
  • Multiple layer Setup
  • Initial Security Configuration - For Authentication and Authorization
  • Sample Automation Tests for Unit Testing and Integration Testing
  • Infrastructure setup for communication with other microservices

Once you generate a component using the archetype, you can focus on adding business features to your microservice.

Reference Archetype Example

We have created a reference archetype for a Spring Boot Microservice. Github repo for the project is https://github.com/in28minutes/microservice-reference-archetype.

Using the archetype to create a new project

Steps are detailed below:

Download or Clone the github repository

You can start with cloning the repository - https://github.com/in28minutes/microservice-reference-archetype. Other option is to download the repository as a zip file using this link - https://github.com/in28minutes/microservice-reference-archetype/archive/master.zip

Install the archetype
  • cd to the root of the project and run
mvn clean install
  • This will install the archetype to your local repository
[INFO] Installing /in28Minutes/git/microservice-archetype/microservice-archetype/target/project-name-archetype-0.0.2-SNAPSHOT.jar to /Users/rangaraokaranam/.m2/repository/com/organization/project/project-name-archetype/0.0.2-SNAPSHOT/project-name-archetype-0.0.2-SNAPSHOT.jar
Create a new project using the archetype
  • Create a new folder on your hard drive. Let’s call it first-project

  • Execute the following commands

cd first-project
mvn archetype:generate -DarchetypeCatalog=local
  • archetype plugin asks for a groupId and artifactId as shown below
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): : 1
Define value for property 'groupId': com.first
Define value for property 'artifactId': first-project
Define value for property 'version' 1.0-SNAPSHOT: : 
Define value for property 'package' com.first: : 
Confirm properties configuration:
groupId: com.first
artifactId: first-project
version: 1.0-SNAPSHOT
package: com.first
 Y: : Y
  • When the archetype plugin executes successfully, you should see the message shown below:
[INFO] Project created from Archetype in dir: /in28Minutes/git/microservice-archetype/first-project
Verify the new project

You can do a mvn clean install on the new project in first-project to check it everything is good.

This is a Spring Boot Project with a couple of controllers and unit/integration tests.

Creating Your Own Reference Archetype

You can also create a reference archetype of your own. The first thing you need to do is to create a reference project - which would serve as the base for creating your archetype.

Setting up Reference Project

  • We have our reference microservice in the folder microservice-reference. This is a Spring Boot Project with a couple of controllers and unit/integration tests. We use this as the reference project to reverse engineer an archetype.
  • When we create a new project using a maven archetype, the two important inputs are groupId and artifactId. In the reference project we would need to make sure that everything that needs to customized based on these inputs should be using similar values. In the microservice-reference, we use the following as the standard:
    • groupId - com.organization.project
    • artifactId - project-name
  • You would need to customize the reference-project to meet your needs or you can create a new reference-project.
  • Ensure that you configure the latest version of maven-archetype-plugin in your microservice-reference
	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<artifactId>maven-archetype-plugin</artifactId>
					<version>3.0.1</version>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

Reverse Engineering an Archetype from microservice-reference

  • In the command prompt cd to the folder containing this project
cd microservice-reference
mvn archetype:create-from-project
  • You will see the following statements in the log
[INFO] Setting default groupId: com.organization.project
[INFO] Setting default artifactId: project-name
[INFO] Setting default version: 0.0.2-SNAPSHOT
[INFO] Setting default package: com.organization.project

Archetype project is created in microservice-reference/target/generated-sources/archetype

Copy the created archetype to the microservice-archetype project

  • Copy the archetype project created in earlier step to the folder microservice-archetype

Do check out our video on this:

image info

Summary

In this article, we talked about the need for an archetype in microservices architecture. Archetype serves a starting point for creating new projects and ensure uniformity across microservices. We looked at an example archetype and got an overview of how to create an archetype.

Best Selling Udemy Courses

Image
Image Image Image Image Image Image Image Image Image

Join 450,000 Learners and 30+ Amazing Courses

350,000 Learners are learning everyday with our Best Selling Courses : Spring Boot Microservices, Spring, Spring Boot, Web Services, Hibernate, Full Stack React, Full Stack Angular, Python, Spring Interview Guide, Java Interview, Java Functional Programming, AWS, Docker, Kubernetes, PCF, AWS Fargate and Azure


Do not know where to start your learning journey? Check out our amazing learning paths:
Learning Path 01 - Spring and Spring Boot Web Applications and API Developer,
Learning Path 02 - Full Stack Developer with Spring Boot, React & Angular,
Learning Path 03 - Cloud Microservices Developer with Docker and Kubernetes,
Learning Path 04 - Learn Cloud with Spring Boot, AWS, Azure and PCF and
Learning Path 05 - Learn AWS with Microservices, Docker and Kubernetes


Subscribe

FREE COURSES



Related Posts

Writing Integration Tests for Rest Services with Spring Boot

Setting up a basic REST Service with Spring Boot is a cake walk. We will go one step further and add great integration tests!

Integrating Spring Boot and Spring JDBC with H2 and Starter JDBC

Learn using Spring Boot Starter JDBC to connect Spring Boot to H2 (in memory database) using Spring JDBC. You will create a simple project with Spring Boot. You will add code to the project to connect to a database using Spring JDBC. You will learn to implement the basic CRUD methods.

JUnit Tutorial for Beginners in 5 Steps

JUnit Tutorial for Beginners in 5 Steps. Setting up a basic JUnit example and understanding the basics of junit.

JPA and Hibernate Tutorial For Beginners - 10 Steps with Spring Boot and H2

JPA and Hibernate in 10 Steps with H2 - Setting up a basic project example with Spring Boot and in memory database H2. Its a cake walk.

Spring Boot Tutorial For Beginners in 10 Steps

Introduction to Spring Boot in 10 Steps. Learn the basics of Spring Boot setting up a basic project example with Spring Boot.

Spring Framework Tutorial for Beginners - Your First 10 Steps

Learn the basics of Spring Framework setting up a very simple example.

JPA and Hibernate Tutorial using Spring Boot Data JPA

Complete journey starting from JDBC to JPA to Spring Data JPA using an example with Spring Boot Data JPA starter project. We use Hibernate as the JPA Implementation.

Creating a Web Application with Spring Boot with JSP

Setting up a basic web application with Spring Boot is a cake walk. We will create a simple web application using Spring Initializr and add JSP features to it.

What is Spring Boot Auto Configuration?

Auto Configuration is the most important feature in Spring Boot. In this tutorial, we will learn important concepts about Auto Configuration with a couple of examples.

Unit Testing Rest Services with Spring Boot and JUnit

Setting up a Basic REST Service with Spring Boot is a cake walk. We will go one step further and add great unit tests to our RESTful Service.


Search