Spring Boot 실전 프로젝트 완벽 가이드

Spring Boot로 실전 프로젝트를 만들기 위한 핵심 개념과 실무 패턴을 다룹니다. REST API부터 데이터베이스 연동, 예외 처리까지 초급 개발자가 꼭 알아야 할 내용을 단계별로 학습합니다.

---

---

들어가며

이 글에서는 Spring Boot 실전 프로젝트 완벽 가이드에 대해 상세히 알아보겠습니다. 총 12가지 주요 개념을 다루며, 각각의 개념에 대한 설명과 실제 코드 예제를 함께 제공합니다.

목차

1. Spring Boot 프로젝트 시작하기
2. REST Controller 만들기
3. Entity 클래스 정의
4. Repository 인터페이스 생성
5. Service 계층 구현
6. POST 요청 처리하기
7. 예외 처리하기
8. application.properties 설정
9. DTO 패턴 활용하기
10. 페이징 처리하기
11. 유효성 검사 추가하기
12. 트랜잭션 관리하기

---

1. Spring Boot 프로젝트 시작하기

개요

@SpringBootApplication 어노테이션으로 Spring Boot 애플리케이션을 시작합니다. 자동 설정과 컴포넌트 스캔이 자동으로 실행됩니다.

코드 예제

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

설명

@SpringBootApplication은 자동 설정, 컴포넌트 스캔, 설정 파일 읽기를 한 번에 처리하는 핵심 어노테이션입니다.

---

2. REST Controller 만들기

개요

@RestController로 REST API 엔드포인트를 쉽게 생성할 수 있습니다. JSON 형태로 자동 변환됩니다.

코드 예제

@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return new User(id, "홍길동", "hong@email.com");
    }
}

설명

@RestController는 모든 메서드의 반환값을 JSON으로 변환하며, @GetMapping으로 HTTP GET 요청을 처리합니다.

---

3. Entity 클래스 정의

개요

@Entity 어노테이션으로 데이터베이스 테이블과 매핑되는 클래스를 만듭니다. JPA가 자동으로 테이블을 생성합니다.

코드 예제

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;
}

설명

@Id는 기본 키를 지정하고, @GeneratedValue는 자동으로 ID를 증가시켜 데이터베이스에 저장합니다.

---

4. Repository 인터페이스 생성

개요

JpaRepository를 상속받으면 기본적인 CRUD 메서드를 자동으로 사용할 수 있습니다. 직접 구현할 필요가 없습니다.

코드 예제

@Repository
public interface UserRepository
    extends JpaRepository<User, Long> {

    List<User> findByName(String name);
    Optional<User> findByEmail(String email);
}

설명

JpaRepository를 상속하면 save, findById, findAll 등의 메서드가 자동 제공되며, 메서드 이름으로 쿼리를 자동 생성합니다.

---

5. Service 계층 구현

개요

@Service로 비즈니스 로직을 처리하는 계층을 만듭니다. Controller와 Repository 사이에서 중간 역할을 합니다.

코드 예제

@Service
@RequiredArgsConstructor
public class UserService {
    private final UserRepository userRepository;

    public User createUser(User user) {
        return userRepository.save(user);
    }
}

설명

@RequiredArgsConstructor는 final 필드를 자동으로 주입하고, Service는 비즈니스 로직을 담당하는 계층입니다.

---

6. POST 요청 처리하기

개요

@PostMapping과 @RequestBody로 클라이언트에서 전송한 JSON 데이터를 받아 새로운 리소스를 생성합니다.

코드 예제

@PostMapping
public ResponseEntity<User> createUser(
    @RequestBody User user) {
    User saved = userService.createUser(user);
    return ResponseEntity.ok(saved);
}

설명

@RequestBody는 JSON을 Java 객체로 자동 변환하고, ResponseEntity로 HTTP 상태 코드와 함께 응답을 보냅니다.

---

7. 예외 처리하기

개요

@ControllerAdvice와 @ExceptionHandler로 전역 예외 처리를 구현합니다. 모든 컨트롤러에서 발생하는 예외를 한 곳에서 관리합니다.

코드 예제

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleNotFound() {
        return ResponseEntity.status(404)
            .body("사용자를 찾을 수 없습니다");
    }
}

설명

@ControllerAdvice는 모든 컨트롤러에 적용되며, 특정 예외 발생 시 자동으로 처리하여 일관된 에러 응답을 제공합니다.

---

8. application.properties 설정

개요

application.properties 파일로 데이터베이스 연결, 포트 번호 등 애플리케이션 설정을 관리합니다.

코드 예제

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=sa
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
server.port=8080

설명

데이터베이스 연결 정보와 JPA 설정을 외부 파일로 관리하여 코드 수정 없이 환경별 설정을 변경할 수 있습니다.

---

9. DTO 패턴 활용하기

개요

DTO(Data Transfer Object)를 사용하여 Entity를 직접 노출하지 않고 필요한 데이터만 전달합니다.

코드 예제

@Data
public class UserDTO {
    private String name;
    private String email;

    public User toEntity() {
        return new User(null, name, email);
    }
}

설명

DTO를 사용하면 보안성이 높아지고, API 응답 구조를 Entity와 독립적으로 관리할 수 있습니다.

---

10. 페이징 처리하기

개요

Pageable 인터페이스를 사용하여 대량의 데이터를 페이지 단위로 조회합니다. 성능 최적화에 필수적입니다.

코드 예제

@GetMapping
public Page<User> getUsers(Pageable pageable) {
    return userRepository.findAll(pageable);
}

// 호출: /api/users?page=0&size=10

설명

Spring Data JPA의 Pageable을 사용하면 쿼리 파라미터로 페이지 번호와 크기를 받아 자동으로 페이징 처리됩니다.

---

11. 유효성 검사 추가하기

개요

@Valid와 Validation 어노테이션으로 입력 데이터의 유효성을 자동으로 검사합니다.

코드 예제

public class UserDTO {
    @NotBlank(message = "이름은 필수입니다")
    private String name;

    @Email(message = "이메일 형식이 올바르지 않습니다")
    private String email;
}

설명

@NotBlank, @Email 등의 어노테이션으로 간단하게 유효성 검사를 구현하고, 잘못된 데이터는 자동으로 거부됩니다.

---

12. 트랜잭션 관리하기

개요

@Transactional 어노테이션으로 여러 데이터베이스 작업을 하나의 단위로 묶어 안전하게 처리합니다.

코드 예제

@Service
public class UserService {
    @Transactional
    public void updateUserInfo(Long id, String name) {
        User user = userRepository.findById(id)
            .orElseThrow();
        user.setName(name);
    }
}

설명

@Transactional은 메서드 실행 중 오류가 발생하면 모든 변경사항을 자동으로 롤백하여 데이터 일관성을 보장합니다.

---

마치며

이번 글에서는 Spring Boot 실전 프로젝트 완벽 가이드에 대해 알아보았습니다. 총 12가지 개념을 다루었으며, 각각의 사용법과 예제를 살펴보았습니다.

관련 태그

#Spring Boot #REST API #JPA #Controller #Service