java spring boot project with source code

Make sure that everything (including your entry point) lives in a well-named package.

While allowing you a lot of freedom, there are some basic rules worth following then laying out your source code. If you are publishing your library to open-source, providing a Spring Boot configuration will greatly ease the adoption for thousands of users. It is easier to maintain a single auto-configuration than multiple bespoke configurations, all slightly different. This task is more involved, so you need to consider when the benefits are worth the investment.

If you are working in an organization that relies heavily on Spring Boot and you have common concerns that need to be solved, you can create your own auto-configuration. One more from Josh Long (Spring Advocate, this one is for power users. Consider creating your own auto-configuration for common organizational concerns You may even discover some new integrations that you were not aware exist. This best practice comes from Josh Long (Spring Advocate, Initializr ( ) gives you a dead easy way to start a new Spring Boot project and load it with the dependencies you may need.Ĭreating your application with the Initializr ensures that you are picking up the tested and approved dependencies that will work well with Spring auto-configuration. Use Spring Initializr for starting new Spring Boot projects Official documentation on Auto-configuration can be found here. It is possible to exclude some classes from the Auto-configuration, by using the following annotation property: but you should do it only if absolutely necessary. This helps to avoid the dreaded Jar Hell (nice article linked). If you want to work with MongoDB, you have:Īnd so on… By relying on these starters, you are relying on a tested and proven configuration that is going to work well together. So, if you want to interact with Redis, you can start by including: The simplest way to make use of it is to rely on the Spring Boot Starters. It gets activated when a particular jar file is detected on the classpath. This is the part of Spring Boot that makes your code simply work. One of the flagship features of Spring Boot is its use of Auto-configuration. The following best practices are listed in no particular order. If you want to learn about the Java best practices, I recommend “Effective Java” which I review in a separate article. In this article, I focus on practices specific to Spring Boot (most of the time, also applicable to Spring projects). I base these on my personal experience and writings of recognized Spring Boot experts. In this article, I will share with you the best practices for working with Spring Boot that I have gathered by using it in professional development since 2016.

Spring Boot is the most popular Java framework for developing microservices.

Java spring boot project with source code