Spring Boot JPA Auditing

Spring Boot'ta JPA Auditing, bir varlığın kim tarafından ve ne zaman oluşturulduğunu veya değiştirildiğini otomatik olarak izlemenizi sağlar. Bu, denetim kayıtları, geçmiş izleme ve hata ayıklama için oldukça kullanışlıdır.

🌟 Neden JPA Auditing Kullanmalıyım?

📅 createdDate, lastModifiedDate alanlarını otomatik takip edin
👤 createdBy, modifiedBy bilgilerini kaydedin
🧼 Alanları manuel ayarlamadan kaçınarak temiz kod yazın

🛠️ Bağımlılıkları Ekleyin

Projenize aşağıdaki bağımlılıkları ekleyin:

Maven:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

Gradle:

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

📋 JPA Auditing Özelliğini Etkinleştirme

Ana sınıfınıza veya yapılandırma sınıfınıza @EnableJpaAuditing ekleyin.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

@SpringBootApplication
@EnableJpaAuditing(auditorAwareRef = "auditorProvider")
public class DemoApplication {
  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
import org.springframework.data.jpa.repository.config.EnableJpaAuditing

@SpringBootApplication
@EnableJpaAuditing(auditorAwareRef = "auditorProvider")
class DemoApplication

fun main(args: Array<String>) {
    runApplication<DemoApplication>(*args)
}

👤 AuditorAware Bean'i Oluşturun

Bu bean, Spring'e geçerli kullanıcıyı bildirir. Statik bir kullanıcı örneği aşağıda:

@Configuration
public class AuditingConfig {

  @Bean
  public AuditorAware<String> auditorProvider() {
    return () -> Optional.of("Şuayb");
  }
}

@Configuration
class AuditingConfig {

  @Bean
  fun auditorProvider(): AuditorAware<String> = AuditorAware { Optional.of("Şuayb") }
}

📖 Entity Sınıfına Anotasyonları Ekle

Aşağıdaki gibi denetim anotasyonlarını kullanın: @CreatedDate, @LastModifiedDate, vb.

@Entity
@EntityListeners(AuditingEntityListener.class)
public class Article {

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  private String title;

  @CreatedDate
  private LocalDateTime createdDate;

  @LastModifiedDate
  private LocalDateTime lastModifiedDate;

  @CreatedBy
  private String createdBy;

  @LastModifiedBy
  private String lastModifiedBy;

  // getter & setter
}

@Entity
@EntityListeners(AuditingEntityListener::class)
data class Article(
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  val id: Long? = null,

  var title: String? = null,

  @CreatedDate
  var createdDate: LocalDateTime? = null,

  @LastModifiedDate
  var lastModifiedDate: LocalDateTime? = null,

  @CreatedBy
  var createdBy: String? = null,

  @LastModifiedBy
  var lastModifiedBy: String? = null
)

▶️ Uygulamayı Çalıştırma

Artık bir entityi JpaRepository ile kaydettiğinizde, denetim alanları otomatik olarak doldurulacaktır.

🧪 Test Etme

Bir entity kaydederek denetim alanlarının otomatik olarak doldurulup doldurulmadığını test edebilirsiniz.

@SpringBootTest
@AutoConfigureTestDatabase
@Transactional
class ArticleRepositoryTest {

  @Autowired
  private ArticleRepository articleRepository;

  @Test
  void testAuditFieldsAreSet() {
    Article article = new Article();
    article.setTitle("Test Başlığı");

    Article saved = articleRepository.save(article);

    assertNotNull(saved.getCreatedDate());
    assertNotNull(saved.getLastModifiedDate());
    assertEquals("Şuayb", saved.getCreatedBy());
    assertEquals("Şuayb", saved.getLastModifiedBy());
  }
}

@SpringBootTest
@AutoConfigureTestDatabase
@Transactional
class ArticleRepositoryTest {

  @Autowired
  lateinit var articleRepository: ArticleRepository

  @Test
  fun `denetim alanları ayarlanmalı`() {
    val article = Article().apply {
      title = "Test Başlığı"
    }

    val saved = articleRepository.save(article)

    assertNotNull(saved.createdDate)
    assertNotNull(saved.lastModifiedDate)
    assertEquals("Şuayb", saved.createdBy)
    assertEquals("Şuayb", saved.lastModifiedBy)
  }
}

Testlerin doğru Spring bağlamıyla çalıştığından ve denetlemenin testler sırasında etkin olduğundan emin olun. Gerçek kullanıcıyı kullanıyorsanız SecurityContext'i mock'lamak gerekebilir.

JPA Auditing özelliği, kodunuzu kirletmeden veri geçmişini izlemek için harika bir yoldur. Keyifli kodlamalar! 🎯