Clean coding practices ensure that your Spring Boot applications are maintainable, readable, and scalable. This guide provides essential tips and code examples to help you write cleaner and more efficient code in both Java and Kotlin.
Clean coding practices ensure that your Spring Boot applications are maintainable, readable, and scalable. This guide provides essential tips and code examples to help you write cleaner and more efficient code in both Java and Kotlin.
Adopting clean coding principles helps to:
📋 Ensure you have the following:
Organize your Spring Boot project for better clarity:
This structure keeps layers separated and makes future refactoring safer as the project grows.
src/main/java/com/example/cleanproject ├── controller ├── service ├── repository ├── entity └── dto
Lombok reduces boilerplate code in Java, making your classes more concise and readable. Here's how to use Lombok effectively:
Start by adding Lombok to your build so annotations are resolved correctly before refactoring your entities and DTOs.
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>provided</scope> </dependency>
provided 'org.projectlombok:lombok' annotationProcessor 'org.projectlombok:lombok'
The following example gives practical context for Example: Entity with Lombok and can be applied directly.
package com.example.cleanproject.entity; import jakarta.persistence.*; import lombok.Data; import lombok.NoArgsConstructor; import lombok.AllArgsConstructor; @Data @NoArgsConstructor @AllArgsConstructor @Entity public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; private String email; }
Benefits:
@Data generates getters, setters, equals, hashCode, and toString methods.@NoArgsConstructor and @AllArgsConstructor create constructors.Kotlin offers modern features that naturally lead to cleaner code:
The following example gives practical context for Example: Entity in Kotlin and can be applied directly.
package com.example.cleanproject.entity import jakarta.persistence.* @Entity data class User( @Id @GeneratedValue(strategy = GenerationType.IDENTITY) val id: Long = 0, var name: String, var email: String )
Advantages of Kotlin:
data class automatically generates toString, equals, and hashCode methods.val) ensure better stability.Use dependency injection to decouple components and improve testability.
The following example gives practical context for Example: Service Layer with DI and can be applied directly.
Data Transfer Objects (DTOs) separate your domain and API layers, promoting better encapsulation.
The following example gives practical context for Example: DTO for User and can be applied directly.
Implement a controller to handle HTTP requests and interact with the service layer.
Run the application using the following command:
./mvnw spring-boot:run
Test endpoints using a tool like Postman or cURL.
You can test the API using the following cURL command:
curl -X GET http://localhost:8080/api/users
You now have a practical Clean Coding Practices in Spring Boot implementation with a clear, production-friendly Spring Boot structure. As a next step, adapt configuration and tests to your own domain, then validate behavior under realistic traffic and failure scenarios.
package com.example.cleanproject.service; import com.example.cleanproject.entity.User; import com.example.cleanproject.repository.UserRepository; import lombok.RequiredArgsConstructor; import org.springframework.stereotype.Service; import java.util.List; @Service @RequiredArgsConstructor public class UserService { private final UserRepository userRepository; public List<User> getAllUsers() { return userRepository.findAll(); } }
package com.example.cleanproject.service import com.example.cleanproject.entity.User import com.example.cleanproject.repository.UserRepository import org.springframework.stereotype.Service @Service class UserService( private val userRepository: UserRepository ) { fun getAllUsers(): List<User> = userRepository.findAll() }
package com.example.cleanproject.dto; import lombok.Data; @Data public class UserDTO { private String name; private String email; }
package com.example.cleanproject.dto data class UserDTO( val name: String, val email: String )
package com.example.cleanproject.controller; import com.example.cleanproject.dto.UserDTO; import com.example.cleanproject.service.UserService; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.*; import java.util.List; @RestController @RequestMapping("/api/users") @RequiredArgsConstructor public class UserController { private final UserService userService; @GetMapping public List<UserDTO> getAllUsers() { return userService.getAllUsers(); } }
package com.example.cleanproject.controller import com.example.cleanproject.dto.UserDTO import com.example.cleanproject.service.UserService import org.springframework.web.bind.annotation.* @RestController @RequestMapping("/api/users") class UserController( private val userService: UserService ) { @GetMapping fun getAllUsers(): List<UserDTO> = userService.getAllUsers() }