Auditing

Auditing

엔티티의 공통 멤버 변수들을 추상 클래스로 만들고, 해당 추상 클래스를 상속받아 엔티티에 공통적인 기능을 수행하도록 하며 엔티티의 생성과 수정을 감시하는 기법

AuditorAware 인터페이스

• 현재 로그인한 사용자의 정보를 등록자와 수정자로 지정하기 위해서 AuditorAware 인터페이스를 구현한 클래스 생성

public class AuditorAwareImpl implements AuditorAware<String> {
    @Override
    public Optional<String> getCurrentAuditor() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();

        String userId = "";
        if (authentication != null) {
            userId = authentication.getName();
        }
        return Optional.of(userId);
    }

Auditing 기능을 사용하기 위해 AuditConfig 파일 생성

@Configuration
@EnableJpaAuditing
public class AuditConfig {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return new AuditorAwareImpl();
    }
}

• @EnableJpaAuditing → JPA의 Auditing 기능을 활성화
• auditorProvider 이름으로 AuditorAware 을 빈으로 등록

BaseTimeEntity, BaseEntity

• 등록자 및 수정자를 제외한 시간관련 Auditing 기능 수행 Entity

@EntityListeners(value = {AuditingEntityListener.class})
@MappedSuperclass
@Getter
@Setter
public abstract class BaseTimeEntity {

    @CreatedDate
    @Column(updatable = false)
    private LocalDateTime reqTIme;

    @LastModifiedBy
    private LocalDateTime updateTime;
}

• 등록자 및 수정자, 등록/수정 시간을 모두 갖는 Entity
• BaseTimeEntity 상속
• @EntityListeners(value = {AuditingEntityListener.class}) @MappedSuperclass @Getter public abstract class BaseEntity extends BaseTimeEntity { @CreatedBy @Column(updatable = false) private String createdBy; @LastModifiedBy private String modifiedBy; }

테스트

public class Member extends BaseEntity { /**/ }

@SpringBootTest
@Transactional
@TestPropertySource(locations = "classpath:application-test.properties")
class MemberTest {

    @Autowired
    MemberRepository memberRepository;

    @PersistenceContext
    EntityManager entityManager;

    @Test
    @WithMockUser(username = "test", roles = "USER")
    void Auditing_테스트() {
        Member newMember = new Member();
        memberRepository.save(newMember);

        entityManager.flush();
        entityManager.clear();

        Member member = memberRepository.findById(newMember.getId())
                .orElseThrow(EntityNotFoundException::new);

        System.out.println("register time : " + member.getReqTime());
        System.out.println("update time : " + member.getUpdateTime());
        System.out.println("create member : " + member.getCreatedBy());
        System.out.println("modify member : " + member.getModifiedBy());
    }

}