Temiz kodlama pratikleri, Spring Boot uygulamalarınızın bakımını kolaylaştırır, okunabilirliğini artırır ve geliştirilebilirliğini sağlar. Bu rehber, hem Java hem de Kotlin'de daha temiz ve verimli kod yazmanıza yardımcı olacak temel ipuçları ve kod örneklerini sunar.
Temiz kodlama ilkelerini benimsemek şu faydaları sağlar:
🗌 Aşağıdakilere sahip olduğunuzdan emin olun:
Spring Boot projenizi daha net bir hale getirmek için aşağıdaki gibi organize edin:
Bu klasör yapısı, katmanlar arası sorumlulukları ayırarak bakım ve geliştirme hızını artırır.
src/main/java/com/example/cleanproject ├── controller ├── service ├── repository ├── entity └── dto
Lombok, Java'daki gereksiz kodu azaltarak sınıflarınızı daha kısa ve okunabilir hale getirir. İşte Lombok'u etkili bir şekilde kullanmanın yöntemi:
Önce Lombok bağımlılığını ekleyerek tekrar eden getter/setter ve constructor kodlarını otomatik üretime bırakın.
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>provided</scope> </dependency>
provided 'org.projectlombok:lombok' annotationProcessor 'org.projectlombok:lombok'
Aşağıdaki örnek, Örnek: Lombok ile Entity için pratik bir bağlam sunar ve doğrudan uygulanabilir.
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; }
Faydalar:
@Data, getter, setter, equals, hashCode ve toString metotlarını otomatik olarak oluşturur.@NoArgsConstructor ve @AllArgsConstructor yapıcı metotları oluşturur.Kotlin, modern özellikleri ile doğal olarak daha temiz kod yazılmasını sağlar:
Aşağıdaki örnek, Örnek: Kotlin ile Entity için pratik bir bağlam sunar ve doğrudan uygulanabilir.
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 )
Kotlin'in Avantajları:
data class, toString, equals ve hashCode metotlarını otomatik olarak oluşturur.val) daha iyi stabilite sağlar.Bileşenleri ayırmak ve test edilebilirliği arttırmak için dependency injectionu kullanın.
Aşağıdaki örnek, Örnek: Service Katmanı ile DI için pratik bir bağlam sunar ve doğrudan uygulanabilir.
Data Transfer Object (DTO), domain ve API katmanlarını ayırarak daha iyi kapsülleme sağlar.
Aşağıdaki örnek, Örnek: User İçin DTO için pratik bir bağlam sunar ve doğrudan uygulanabilir.
HTTP isteklerini yönetmek ve service katmanıyla etkileşim sağlamak için bir controller uygulayın.
Uygulamayı aşağıdaki komutla çalıştırın:
./mvnw spring-boot:run
Postman veya cURL gibi bir aracı kullanarak endpoint'leri test edin.
API'yi aşağıdaki cURL komutu ile test edebilirsiniz:
curl -X GET http://localhost:8080/api/users
Artık Spring Boot Temiz Kodlama Pratikleri için üretim odaklı bir Spring Boot temeliniz var. Sonraki adımda ayarları kendi domainine uyarlayıp test ve gözlemlenebilirlik katmanını ekleyerek gerçek trafik altında doğrulayın.
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() }