스프링 부트 백엔드 개발 강좌, main 디렉터리 구성하기

스프링 부트(SPRING BOOT)는 자바 기반의 프레임워크로, 개발자가 복잡한 설정 없이도 쉽게 응용 프로그램을 구축할 수 있도록 돕는 도구입니다. 이 강좌에서는 스프링 부트 프로젝트의 main 디렉터리를 어떻게 구성할 것인지에 대한 내용을 다룰 것입니다. 이 디렉터리는 자바 애플리케이션의 시작점이자 중요한 비즈니스 로직을 구현하는 곳입니다.

스프링 부트 프로젝트 구조

스프링 부트 프로젝트는 미리 정의된 구조를 따릅니다. IDE에서 스프링 부트 프로젝트를 생성하면 다음과 같은 기본 구조가 만들어집니다.

src
├── main
│   ├── java
│   │   └── com
│   │       └── example
│   │           └── demo
│   │               ├── DemoApplication.java
│   │               └── controller
│   │               └── service
│   │               └── repository
│   └── resources
│       ├── application.properties
│       └── static
│       └── templates
└── test
    └── java

1. src/main/java 디렉터리

src/main/java 디렉터리는 실제 자바 소스 코드가 위치하는 장소로, 각 패키지와 클래스 파일이 이곳에 보관됩니다. 스프링 부트에서는 일반적으로 com.example.demo와 같은 형식으로 패키지를 구성합니다.

1.1 주 애플리케이션 클래스

DemoApplication.java 파일은 스프링 부트 애플리케이션의 시작점입니다. 이 클래스는 @SpringBootApplication 애너테이션이 부여되며, 이 애너테이션은 다음과 같은 3가지 기능을 포함합니다:

  • @Configuration: 자바 기반의 구성 클래스입니다.
  • @EnableAutoConfiguration: 스프링 부트의 자동 설정 기능을 활성화합니다.
  • @ComponentScan: 지정한 패키지를 탐색하여 스프링 컴포넌트를 자동으로 검색합니다.

아래는 주 애플리케이션 클래스의 예시입니다.

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

1.2 패키지 구조

소스 파일이 많은 경우, 적절한 패키지 구조를 정의하는 것이 중요합니다. 일반적으로 controller, service, repository와 같은 패키지를 정의합니다.

Controller 패키지

controller 패키지는 요청을 처리하고 응답을 반환하는 메소드를 포함합니다. RESTful API에서는 주로 @RestController 어노테이션을 사용하여 REST API 서버를 구성합니다.

package com.example.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

Service 패키지

service 패키지는 비즈니스 로직을 처리하는 클래스를 포함합니다. 이곳의 클래스는 @Service 애너테이션을 사용하여 스프링 컨텍스트에 등록됩니다.

package com.example.demo.service;

import org.springframework.stereotype.Service;

@Service
public class HelloService {
    public String getGreeting() {
        return "Hello from Service!";
    }
}

Repository 패키지

repository 패키지는 데이터베이스와의 상호작용을 맡습니다. 보통 JpaRepository를 상속받아 CRUD 기능을 제공합니다.

package com.example.demo.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import com.example.demo.model.User;

@Repository
public interface UserRepository extends JpaRepository {
}

2. src/main/resources 디렉터리

src/main/resources 디렉터리는 애플리케이션에서 사용하는 정적 파일, 템플릿, 설정 파일 등이 위치하는 곳입니다. 이곳의 주요 파일 및 디렉터리는 다음과 같습니다.

2.1 application.properties

설정 파일인 application.properties는 애플리케이션의 환경 설정을 담당합니다. 데이터베이스 설정, 포트 번호, 로그 레벨 등을 여기서 설정할 수 있습니다.

spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=password
server.port=8080
logging.level.org.springframework=DEBUG

2.2 static 디렉터리

static 디렉터리는 CSS, JavaScript, 이미지 파일 등 정적 리소스를 보관하는 곳입니다. 스프링 부트는 이 디렉터리의 모든 파일을 자동으로 서빙합니다.

2.3 templates 디렉터리

templates 디렉터리는 Thymeleaf와 같은 템플릿 엔진을 사용하여 동적으로 HTML 파일을 생성하는 데 사용됩니다. 여기서는 HTML 파일을 만들고 동적인 데이터를 주입할 수 있습니다.





    Welcome


    

Welcome Message

3. src/test/java 디렉터리

src/test/java 디렉터리는 애플리케이션의 테스트 관련 소스를 포함합니다. JUnit이나 Mockito와 같은 테스트 프레임워크를 사용하여 유닛 테스트와 통합 테스트를 수행합니다.

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class DemoApplicationTests {
    
    @Autowired
    private HelloService helloService;

    @Test
    void contextLoads() {
        assertNotNull(helloService);
    }
}

결론

이번 강좌에서는 스프링 부트 프로젝트의 main 디렉터리의 구성 방법에 대해 자세히 알아보았습니다. 프로젝트 구조를 이해하고 올바르게 구성함으로써, 개발자는 더 효율적이고 관리 가능한 코드를 작성할 수 있습니다. 이 구조는 앞으로의 유지보수와 협업에서 큰 도움이 될 것입니다. 성공적인 스프링 부트 백엔드 개발을 기원합니다.