프로젝트를 진행하면서 처음보는 오류를 발견하였다. 🙄

LazyInitializationException

같은 백엔드 팀원분과 서칭해서 반나절만에 해결할 수 있었다. 

환경 : AWS ec2 인스턴스에서 서버 배포 + Spring Data JPA(hibernate) + MySQL

어떤 오류?

2022-09-02 06:59:34.637 ERROR 35806 --- [nio-8080-exec-1] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: com.lucky7.stackoverflow.question.entity.Question.comment, could not initialize proxy - no Session] with root cause

org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: com.lucky7.stackoverflow.question.entity.Question.comment, could not initialize proxy - no Session
        at org.hibernate.collection.internal.AbstractPersistentCollection.throwLazyInitializationException(AbstractPersistentCollection.java:614) ~[hibernate-core-5.6.10.Final.jar!/:5.6.10.Final]

요약하자면 Lazy(지연) Initialization(초기화) 오류이다.

프록시를 초기화할 수 없다고 나오며 no Session이라고 세션이 없다는 로그가 보인다.

오류가 발생하는 이유?

일단 Spring Data JPA의 Lazy 전략에 대한 이해가 부족하였고 영속성 컨텍스트의 생명주기에 대해 알지 못하여서 발생하는 문제였다.

간단하게 정리해보자면 이렇다.

• 서비스 단에 @Transactional을 붙여놓은 상태여서 메서드가 종료되면 Hibernate의 Session도 함께 종료되어 영속성 컨텍스트에서 사라진다.
• 영속성 컨텍스트는 보통 트랜잭션과 생명주기를 같이한다. → service 호출 끝나고 controller로 돌아가면 영속성 상태가 끝난다.
• jpa의 효율 문제 때문에 엔티티가 List나 객체로 참조하고있는 부분을 전부 쿼리문을 날려서 채워놓진 않고 일단 프록시 객체로 채워놓은 이후 나중에 getter를 사용하면 쿼리를 보내서 실제 데이터로 채운다.
• Question에 조회하는 요청 시 owner나 comment, answer 에 실제 데이터를 쿼리를 날려서 저장하는 것이 아닌 프록시 객체로 채워진다.(stub 데이터라고 보면 됨) -> 프록시 객체로 채워진 상태에서 Service 메서드 호출이 끝나면 영속성 컨텍스트의 관리대상에서 제외되기 때문에 이후엔 gatter를 사용해도 쿼리문을 날려서 해당 객체를 실제 데이터로 채우지 않는다.
• QuestionService에 @Transactional 애너테이션 붙어있음 → controller에서 service의 메서드 호출한 순간부터 트랜젝션 생성 → 서비스 메서드 끝나면서 트랜젝션 종료됨 → mapper에서 question객체를 dto 객체로 변환시켜주면서 owner, comment, answer 객체를 불러오는 쿼리 보냄 → 영속성 컨텍스트에 존재하지 않아서 프록시 객체를 실제 객체로 채우지 못함 → LazyInitializationException !

참고 자료 : https://cantcoding.tistory.com/78

해결 방법

mapper에서 entity 객체에 gatter 메서드를 호출하는 부분까지 트랜잭션 안으로 포함시켜주면 해결할 수 있다.

-> controller 에 @Transactional 애너테이션 붙여서 mapper 사용하는 부분까지 전부 하나의 트랜잭션으로 포함시켜 주었다.

이렇게 하면 http 요청이 와서 컨트롤러에 메서드가 호출하는 시점부터 트랜잭션이 생성되고 서비스에서 저장이나 삭제를 처리하고 다시 컨트롤러로 돌아와서 매퍼를 호출할 때까지도 트랜잭션이 유지되기 때문에 영속성 컨텍스트에서 관리하는 상태가 된다.

그리고 컨트롤러에서 응답을 보내게 되면(return) 메서드 호출이 끝나므로 트랜잭션이 종료된다.

아직은 이해가 깊지 않아 이게 가장 좋은 방법인지는 모르겠다.

하지만 해결법이 간단하고 성능상의 문제 없이 해결할 수 있었고 Spring Data JPA라는 녀석에 대해서 한걸음 더 이해할 수 있었다.

Rest Docs 기능 활성을 위해 build.gradle 파일에 코드를 추가하고 build 하니까 자꾸만 찾을 수 없다고 떠서 이번 기회에 build.gradle 에 추가해야 하는 코드를 정리해 놓으려고 한다.

버전 정보는 바뀔 수 있으므로 불러오기에 실패할 경우 버전을 체크하자.

plugins {
	id 'org.springframework.boot' version '2.7.2'
	id 'io.spring.dependency-management' version '1.0.12.RELEASE'
	id 'org.asciidoctor.jvm.convert' version '3.3.2'
	id 'java'
}

group = 'com.wisejade'		// initializr에서 프로젝트 생성시 설정한 group이 자동으로 들어감
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

repositories {
	mavenCentral()
}


ext {
	set('snippetsDir', file("build/generated-snippets"))	// 추가해야하는 코드
}

configurations {
	asciidoctorExtensions		// asciidoctorExtensions를 사용하기 위해 추가
}

dependencies {
	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'	// mockmvc 사용을 위해 추가
	asciidoctorExtensions 'org.springframework.restdocs:spring-restdocs-asciidoctor'	// asciidoctor
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'	// Spring data jpa 사용을 위해 추가
	implementation 'org.springframework.boot:spring-boot-starter-validation'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	implementation 'org.mapstruct:mapstruct:1.5.2.Final'					// mapstruct 사용을 위해 추가
	annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.1.Final'		// mapstruct 사용을 위해 추가
	implementation 'org.springframework.boot:spring-boot-starter-mail'

	implementation 'com.google.code.gson:gson'	// gson은 Json을 String으로 쉽게 바꿔줌
}

tasks.named('test') {	// 추가해야하는 코드
	outputs.dir snippetsDir
	useJUnitPlatform()
}

tasks.named('asciidoctor') {	// 추가해야하는 코드
	configurations "asciidoctorExtensions"
	inputs.dir snippetsDir
	dependsOn test
}

task copyDocument(type: Copy) {	// 생성된 rest docs를 static/docs로 자동으로 copy
	dependsOn asciidoctor
	from file("${asciidoctor.outputDir}")
	into file("src/main/resources/static/docs")
}

build {	// task build 할 때마다 copy
	dependsOn copyDocument
}

bootJar {
	dependsOn copyDocument
	from("${asciidoctor.outputDir}") {
		into 'static/docs'
	}
}

SpringBoot에서 JPA를 사용할 때

application.yml 또는 application.properties 파일에서 설정을 해주어야 한다.

ddl-auto는 JPA 설정중에 빌드시 JPA가 어떻게 자동으로 테이블을 생성해줄지에 대한 설정을 지정한다.

➤ ddl-auto 옵션 종류

• create: 기존테이블 삭제 후 다시 생성 (DROP + CREATE)
• create-drop: 테이블 생성 후 종료시점에 테이블 DROP
• update: 변경분만 반영(운영DB에서는 사용하면 안됨)
• validate: 엔티티와 테이블이 정상 매핑되었는지만 확인
• none: 사용하지 않음(사실상 없는 값이지만 관례상 none이라고 한다.)

⚠️ 주의사항

• 운영 장비에서는 절대 crate, create-drop, update를 사용하면 안된다.
• create는 로컬환경에서만 사용한다
• 개발 초기 단계에는 create 또는 update 를 사용한다.
• 테스트 서버는 update 또는 validate 를 사용한다.
• 스테이징과 운영 서버는 validate 또는 none 을 사용한다.

출처 : https://smpark1020.tistory.com/140

✔️ 오류가 난 환경

운영체제 : MAC

Gradle 기반의 Spring Boot 프로젝트 내의 .jar 파일을 터미널에서 build 하는 과정에서

zsh: ./gradlew: Permission denied

✔️ 해결

실행권한이 없어서 실행 거부된 거라서

실행권한을 부여해주면 된다.

아래 명령어를 터미널에 입력하면 해결된다.

chmod +x gradlew

'chmod' 명령어에 대한 이전 포스팅

2022.05.03 - [TIL(Today I Learned)] - 5/2 (월) Linux 기초2

'+x' : 실행 권한을 부여(+) 해준다.

권한을 부여해주고 다시 실행해보면 정상적으로 실행된다.

감사합니다.

도움이 되셨길 바랍니다. 😄