[SpringBoot] 실행 시 오류 : Failed to configure a DataSource 해결방법

SpringBoot 프로젝트에 JPA  의존성을 추가하고 나서 프로젝트를 기동을 하는데 다음과 같은 에러가 발생했다.  새로운 프로젝트를 설정하고 실행할 때 여러 에러들을 만나게 되는데,  그 중 '데이터 소스 구성 실패' 오류의 원인과 해결 방법에 대해 정리합니다.

---

문제상황

스프링 부트 3.1.2 + Java 17 + ORM로 개인 프로젝트를 시작했다.

프로젝트에 필요한 의존성을 설정하고  IntelliJ에서 Gradle import 시킨 후 애플리케이션을 실행했다.

기동을 하다가 다음 오류 메시지와 함께 실행이 되지 않았다.

 

 

build.gradle

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.1.2'
	id 'io.spring.dependency-management' version '1.1.2'
}

group = 'com.yunjin'
version = '0.0.1-SNAPSHOT'

java {
	sourceCompatibility = '17'
}

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa' 
	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test' 
}

tasks.named('test') {
	useJUnitPlatform()
}

Console

2023-08-15T21:43:39.364+09:00  WARN 5160 --- [           main] ConfigServletWebServerApplicationContext : Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'dataSourceScriptDatabaseInitializer' defined in class path resource [org/springframework/boot/autoconfigure/sql/init/DataSourceInitializationConfiguration.class]: Unsatisfied dependency expressed through method 'dataSourceScriptDatabaseInitializer' parameter 0: Error creating bean with name 'dataSource' defined in class path resource [org/springframework/boot/autoconfigure/jdbc/DataSourceConfiguration$Hikari.class]: Failed to instantiate [com.zaxxer.hikari.HikariDataSource]: Factory method 'dataSource' threw exception with message: Failed to determine a suitable driver class
2023-08-15T21:43:39.367+09:00  INFO 5160 --- [           main] o.apache.catalina.core.StandardService   : Stopping service [Tomcat]
2023-08-15T21:43:39.387+09:00  INFO 5160 --- [           main] .s.b.a.l.ConditionEvaluationReportLogger : 

Error starting ApplicationContext. To display the condition evaluation report re-run your application with 'debug' enabled.
2023-08-15T21:43:39.418+09:00 ERROR 5160 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   : 

***************************
APPLICATION FAILED TO START
***************************

Description:

Failed to configure a DataSource: 'url' attribute is not specified and no embedded datasource could be configured.

Reason: Failed to determine a suitable driver class


Action:

Consider the following:
	If you want an embedded database (H2, HSQL or Derby), please put it on the classpath.
	If you have database settings to be loaded from a particular profile you may need to activate it (no profiles are currently active).


Process finished with exit code 1

 

원인

오류 내용을 파파고로 번역하면 아래와 같다. 

설명:

데이터 소스를 구성하지 못했습니다. 'url' 특성이 지정되지 않았으며 내장된 데이터 소스를 구성할 수 없습니다.
이유: 적합한 드라이버 클래스를 결정하지 못했습니다.


작업:

다음 사항을 고려합니다:
내장된 데이터베이스(H2, HSQL 또는 Derby)를 원하는 경우 클래스 경로에 배치하십시오.
특정 프로파일에서 로드할 데이터베이스 설정이 있는 경우 활성화해야 할 수 있습니다(현재 활성화된 프로파일이 없음).

 

내용을 확인하고 다음과 같은 궁금증이 생겼습니다. 

왜 때문에 JPA는 추가적인 데이터 소스를 구성해야 하는 것일까? 

이 문제의 해결책으로 정리해논 여러 글을 읽어본 후 이해할 수 있었다. 답은 JPA에 있었다. 

 

기본적으로 Spring Boot는 애플리케이션을 기동 할 때 설정된 정보를 바탕으로 빈을 자동으로 구성하려고 시도합니다.

프로젝트에 설정된 JPA 종속성(dependency)을 확인하며, JPA는 내부적으로 JDBC API를 사용하기 때문에 JPA DataSource의 자동 구성을 수행하는데 필요한 JDBC 연결 속성 정보를 Spring에 제공하지 않았다는 것입니다.

MySQL 및 MSSQL/Oracle 등 외부 데이터베이스로 작업을 할 때는 무조건 데이터베이스 설정을 해줘야 하며, 반면에 H2와 같은 인메모리 데이터베이스는 외부 연결 정보 없이 데이터 소스를 생성할 수 있으므로 의존성만 추가해 줘도 애플리케이션 실행은 됩니다.

 

요약하면 DataSource 구성에 필요한 데이터베이스가 설정되지 않아 발생하는 문제로 사용자가 원하는 데이터베이스 라이브러리 및 드라이버 설치 등 JDBC 설정을 해야 합니다.

 

해결책

1.  데이터 소스 정의

데이터베이스 연결이 누락되어 문제가 발생했으므로, 의존성 및 설정 정보를 추가하여 문제를 해결할 수 있습니다.

저의 경우 인메모리 데이터베이스 H2 DB를 사용합니다. 먼저 프로젝트의 build.gradle에 h2 의존성을 추가해 줍니다. 

(Gradle Refresh 꼭 진행해 주세요. 의존성을 추가 또는 수정하면 build.gradle에서 🐘 버튼이 자동으로 나타납니다. 클릭~)

dependencies {
	... 생략
	runtimeOnly 'com.h2database:h2'
}

프로젝트가 생성될 때 src/main/resources 폴더 경로에 appliction.properties 빈파일이 자동 생성됩니다. 해당 파일에 데이터베이스 설정 정보를 기입하셔도 되고 application.yml 파일을 추가하여 설정 하셔도 됩니다.  (저는 application.yml 사용)

spring:
  jpa:
    show-sql: true
    properties:
      hibernate:
        format_sql: true
    defer-datasource-initialization: true
  datasource:
    url: jdbc:h2:mem:testdb
  h2:
    console:
      enabled: true

위와 같이 데이터 소스 속성을 정의하여 문제를 해결할 수 있습니다.

 

2. DataSourceAutoConfiguration 제외

아직 데이터 소스를 정의할 준비가 되지 않은 상황이 있을 수도 있습니다.

즉,  어떤 데이터베이스를 사용할지 결정하지 않았으면 당장 JDBC 설정이 필요 없는 경우로 Spring Boot가 데이터 소스를 자동으로 구성하는 것을 방지하면 됩니다.

 

2.1 @SpringBootApplication 

스프링부트 메인 클래스에 @SpringBootApplication 애노테이션의 exclude 속성을 사용하여 자동 구성을 비활성화합니다.

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class})
public class SpringbootBlogApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootBlogApplication.class, args);
	}
}

DataSourceAutoConfiguration 클래스는 데이터 소스를 구성하기 위한 기본 클래스로 다른 빈을 자동 구성하는 데  영향을 미치지 않는다고 합니다.

 

2.2  application.yml

application.yml 파일을 사용하여 동일한 작업을 수행할 수 있습니다.

spring:
  autoconfigure:
    exclude:
    - org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

 

2.1/2.2 두 가지 방법 중 하나를 사용하여 스프링 부트의 DataSource의 자동 구성을 비활성화할 수 있습니다.

 

마무리

스프링 부트 실행 시 '데이터 소스 구성 실패' 오류의 원인을 살펴보았습니다.

데이터 소스를 정의하여 문제를 해결할 수도 있고, 정의를 하지 않고 코드로 자동 구성을 비활성화하여 문제를 해결하는 방법에 대해 알아봤습니다.  저는 데이터 소스를 정의해서 문제를 해결했습니다.  각자 프로젝트 상황에 맞게 해결해주세요!

오류 해결에 도움이 되길 바라며 이상 코딩하는 지니였습니다. 

 

 

참고

https://lemontia.tistory.com/586