Colin's Blog
spring database 예제

Spring Framework는 자바 기반의 웹 애플리케이션 개발을 돕는 오픈소스 프레임워크로, 데이터베이스에 접근하기 위한 다양한 기능을 제공합니다. 이번 예제에서는 Spring Framework를 사용하여 데이터베이스에 접근하는 방법을 간단히 알아보겠습니다.

1. 의존성 설정하기

먼저, 프로젝트에 필요한 의존성을 설정해야 합니다. Maven을 사용한다면 pom.xml 파일에 다음과 같이 의존성을 추가해주세요.

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 이 외에도 필요한 의존성이 있다면 추가해주세요 -->
</dependencies>

Gradle을 사용한다면 build.gradle 파일에 다음과 같이 의존성을 추가해주세요.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    // 이 외에도 필요한 의존성이 있다면 추가해주세요
}

의존성이 설정되었다면, Maven이나 Gradle을 통해 의존성을 다운로드 및 설치해주세요.

2. 데이터베이스 설정하기

Spring Framework에서는 데이터베이스 접속 정보를 application.properties 또는 application.yml 파일에 설정합니다. 예를 들어, MySQL 데이터베이스에 접속하기 위한 설정은 다음과 같이 작성할 수 있습니다.

application.properties 파일에 다음과 같이 설정해주세요.

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=myusername
spring.datasource.password=mypassword

spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

프로젝트에 사용하는 데이터베이스에 따라 URL 및 사용자 이름, 암호를 변경해주세요. 또한, Hibernate 설정을 통해 데이터베이스의 스키마 자동 생성여부 및 SQL 로깅 설정을 할 수 있습니다.

3. Repository 생성하기

Spring Framework에서는 데이터베이스 접근을 위한 Repository 인터페이스를 생성하여 사용합니다. 예를 들어, User 엔티티와 관련된 Repository를 생성하려면 다음과 같이 작성할 수 있습니다.

public interface UserRepository extends JpaRepository<User, Long> {
    // 사용자 관련 추가적인 메서드 선언
}

위 예제에서 UserRepository는 JpaRepository를 상속받아 작성된 인터페이스입니다. 사용자 관련 추가적인 메서드를 선언할 수 있습니다. User는 데이터베이스와 매핑되는 엔티티 클래스입니다.

4. 데이터베이스에 접근하기

Spring Framework에서는 Repository 인터페이스를 주입받아 데이터베이스에 접근할 수 있습니다. 예를 들어, UserRepository를 사용하여 사용자 정보를 조회하거나 저장하려면 다음과 같이 작성할 수 있습니다.

@Service
public class UserService {
    private final UserRepository userRepository;
    
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
    
    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }
    
    public void saveUser(User user) {
        userRepository.save(user);
    }
}

위 예시에서 UserService는 UserRepository를 주입받아 데이터베이스에 접근할 수 있습니다. getUserById 메서드는 주어진 ID에 해당하는 사용자 정보를 조회하고, saveUser 메서드는 사용자 정보를 저장합니다.

5. Controller 작성하기

마지막으로, 데이터베이스에 접근하는 기능을 외부 요청에 응답하기 위해 Controller를 작성해야 합니다. 예를 들어, 사용자 정보를 조회하고 저장하는 API를 작성하려면 다음과 같이 작성할 수 있습니다.

@RestController
@RequestMapping("/users")
public class UserController {
    private final UserService userService;
    
    public UserController(UserService userService) {
        this.userService = userService;
    }
    
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.getUserById(id);
    }
    
    @PostMapping
    public void saveUser(@RequestBody User user) {
        userService.saveUser(user);
    }
}

위 예시에서 UserController는 /users 엔드포인트에서 동작하는 API를 정의합니다. getUser 메서드는 주어진 ID에 해당하는 사용자 정보를 조회하고, saveUser 메서드는 받은 사용자 정보를 저장합니다.

이제, Spring Framework를 사용하여 데이터베이스에 접근하는 예제 코드를 작성해보았습니다. 이 예제를 바탕으로 원하는 데이터베이스 접근 기능을 구현할 수 있습니다. 추가적으로 스프링 데이터 JPA, Hibernate 등의 공식 문서와 예제를 참고하면 더욱 자세한 내용을 학습할 수 있습니다.

#SpringFramework #DatabaseAccess 예제

© 2018 Colin. All rights reserved.