Dev Day

Spring Boot Gradle Mybatis REST API 서버 만들기

지금 제가 진행하고 있는 프로젝트의 API 서버가 Spring Boot 기반으로 되어 있기 때문에 복습도 할 겸 Spring Boot에 대한 내용도 글을 써보려 합니다.

사실 지금 진행하는 프로젝트를 JPA로 하고 싶었으나 저의 JPA에 대한 미비한 실력과 자신감도 없기 때문에 그나마 많이 해본 Mybatis로 진행을 하고 있습니다.

나중에는 JPA로 converting 하거나 Node.js로 만들 예정입니다.

빌드 툴은 Gradle로 설정을 했습니다. Maven보다 늦게 나온 Gradle은 설정들을 좀 더 간결하게 가능하고 Maven의 장점들만 뽑아왔기 때문에 Gradle을 선택하지 않을 이유가 없습니다.

(추후 Maven과 Gradle을 비교하는 글도 올려야겠네요)

 

IntelliJ 프로젝트 생성하기

File -> New -> Project를 통해 새 프로젝트를 생성합니다.

Spring Initializr를 선택합니다. 저는 자바 SDK 1.8을 사용하고 있기 때문에 1.8을 기준으로 하겠습니다. 이후 Next

프로젝트 세팅을 합니다. 타입은 Gradle, 언어는 Java, 패키징은 이후 톰캣에 배포 예정이라면 War를 선택하면 됩니다만 이 설정은 추후 추가가 가능하기 때문에 일단은 Jar로 진행하겠습니다. Java 버전은 8 버전을 사용하고 있기 때문에 8을 기준으로 하겠습니다.

 

Dependency를 선택합니다. 프로젝트 생성을 위한 아주 최소한만 선택했습니다.

사실 Spring Web이나 Lombok 또한 빼셔도 상관은 없습니다만, Lombok은 제가 Spring Boot로 작업할 때 너무 편하게 사용 중이라 어떤 프로젝트를 진행해도 항상 넣습니다. 그리고 Spring Web은 초기에 프로젝트 설정을 완료하면 테스트 웹페이지를 보여줄 용도로 사용할 예정이라 빼셔도 됩니다.

프로젝트 네임을 설정 후 Finish

이후 새 프로젝트가 완성됩니다.

초기 프로젝트 디렉토리 구조입니다.

초기 build.gradle 파일입니다. 아까 추가했던 dependency들을 확인할 수 있습니다.

이제 MySQL 설정을 추가하도록 하겠습니다. resources 하위에 application.properties 파일을 수정하겠습니다.

저는 .yml로 바꿔서 진행하여서 application.yml을 기준으로 진행하겠습니다.

username은 그냥 root로 해놨는데 혹시나 변경하셨다면 바꾸시면 됩니다.

이렇게 설정하고 Application을 실행시켜보면 정상적으로 실행이 되는 것을 확인할 수 있습니다.

현재 프로젝트에 controller pakage를 추가해주시고 TestController파일을 생성해줍니다.

파일 생성 후 아래와 같이 입력해줍니다.

package com.example.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
	@RequestMapping(value = "/", method = RequestMethod.GET)
	public Object test() {
		return "Hello World!";
	}
}

@RestController는 @Controller + ResponseBody라고 생각하시면 됩니다.

@RequestMapping 은 요청이 들어왔을 때 매핑시켜주는 어노테이션 정도로 일단은 생각해두시면 편할 것 같고, value는 매핑시킬 url패턴이라고 생각하면 됩니다. 지금은 "/" 라고 해놨으니 기본 localhost:8084로 호출을 했을 때 매핑됩니다.

 

어노테이션에 대한 자세한 설명들은 추후에 글로 작성하도록 하겠습니다.

지금은 따라 하기 정도로 생각하시고 붙여주시면 됩니다.

 

이렇게 작성 후 Application을 실행시켜줍니다.

간단히 인터넷 브라우저 URL에 http://localhost:8084로 접속하면 Hello World를 보실 수 있습니다.

지금까지는 간단히 프로젝트 생성 후 잘 돌아가는지 확인만 해봤습니다.

다음 글에서는 Service 등의 패키지를 추가하여 MySQL의 데이터로 API를 호출하는 것까지 진행해보겠습니다.