Warz's Studying

JPA 란?

스프링부트는 JPA(Java Persistence API)를 사용하여 데이터베이스를 처리한다. JPA는 자바 진영에서 ORM(Object-Relational Mapping)의 기술 표준으로 사용하는 인터페이스의 모음이다.

JPA는 인터페이스이다. 따라서 인터페이스를 구현하는 실제 클래스가 필요하다. JPA를 구현한 대표적인 실제 클래스에는 하이버네이트(Hibernate)가 있다. 보통 JPA + 하이버네이트 조합을 사용한다.

H2 데이터베이스

JPA를 사용하기 전에 데이터를 저장할 데이터베이스를 설치해 보자. 개발시에는 Oracle, MSSQL 등의 굵직한 데이터베이스 보다는 설치도 쉽고 사용도 편리한 H2 데이터베이스를 많이 사용한다.

H2 데이터베이스는 주로 개발용이나 소규모 프로젝트에서 사용되는 파일 기반의 경량 데이터베이스이다. 개발시에는 H2를 사용하여 빠르게 개발하고 실제 운영시스템은 좀 더 규모있는 DB를 사용하는 것이 일반적인 개발 패턴이다.

H2 데이터베이스를 사용하기 위해, dependencies에 runtimeOnly 'com.h2database:h2' 코드를 추가해준다.

runtimeOnly

build.gradle 파일의 runtimeOnly는 해당 라이브러리가 런타임(Runtime)시에만 필요한 경우에 사용한다. 컴파일(Compile)시에만 필요한 경우에는 runtimeOnly 대신 compileOnly를 사용한다.

H2 데이터베이스를 설치했다고 바로 사용 가능할 것이라고 생각했다면 오산이다. application.properties 파일을 다음과 같이 수정해주어야만 비로소 사용할 수 있다.

각각의 항목에 대해서 알아보자.

• spring.h2.console.enabled - H2 콘솔의 접속을 허용할지의 여부이다. true로 설정한다. false로 설정하면 접속 안된다.
• spring.h2.console.path - 콘솔 접속을 위한 URL 경로이다. 즉, http://localhost:8080/h2-console 주소로 접속한다.
• spring.datasource.url - 데이터베이스 접속을 위한 경로이다.
• spring.datasource.driverClassName - 데이터베이스 접속시 사용하는 드라이버이다.
• spring.datasource.username - 데이터베이스의 사용자명이다. (사용자명은 기본 값인 sa로 설정한다.)
• spring.datasource.password - 데이터베이스의 패스워드이다. 로컬 개발 용도로만 사용하기 때문에 패스워드는 없어도 무방하다.

그리고 spring.datasource.url에 설정한 경로에 해당하는 데이터베이스 파일을 만들어야 한다. 위에서 spring.datasource.url을 jdbc:h2:~/local 로 설정했기 때문에 사용자의 홈디렉터리(~ 에 해당하는 경로) 밑에 local.mv.db 라는 파일을 생성해야 한다. 만약 jdbc:h2:~/test라고 설정했다면 test.mv.db 라는 파일을 생성해야 한다.

사용자의 홈디렉터리는 윈도우의 경우에는 C:\Users\(사용자명) 이고 맥OS의 경우에는 /Users/(사용자명) 이다. 본인이 사용하는 OS에 맞는 홈디렉터리에 local.mv.db 파일을 생성하자. 파일은 내용 없이 빈파일로 생성한다. 필자는 윈도우를 쓰기 때문에  C:\Users\(사용자명)에 local.mv.db 파일을 생성해주었다.

참고로 파일이 생성되지 않았을 때는 아무리 연결을 시도해도 연결되지 않는다.

파일이 다 생성되었다는 전제 하에,

http://localhost:8080/h2-console 주소로 접속하면, 다음과 같은 화면이 뜰 것이다(한국어 설정은 따로 해야한다)

여기서, 위 화면과 같이 JDBC URL 경로를 application.properties 파일에 설정한 jdbc:h2:~/local로 변경하고 "연결" 버튼을 눌러보자.(처음에는 local이 아니라 test로 되어있을 것이다. 변경 후에 연결 시험 누르지 말고 바로 연결 누르자)

그러면 위와 같은 화면이 나타날 것이다(반드시 선행 과정을 잘 따라와야 한다. 하나라도 잘못되면 위 화면을 보기 힘들 것이다) 옆의 ANSWER과 QUESTION은 나중에 설명할 것이니 우선은 넘어가자.

자, 이제 H2 데이터베이스를 사용할 준비는 다 완료되었다. 이제 자바 프로그램에서 H2 데이터베이스를 사용할 수 있게 해야한다. 자바 프로그램에서 데이터베이스에 데이터를 저장하거나 조회하려면 JPA를 사용해야 한다. 이 과정은 다음 포스팅에서 설명하도록 하겠다.

이전 게시글 가장 마지막에 간략하게 소개했는데, 자세한 설명이 필요할 것 같아 새로운 포스트를 작성하게 되었다.

질문 답변 게시판을 만든다고 가정해보다. 질문이나 답변을 작성하면 데이터가 생성된다. 그러므로 데이터를 저장하거나 조회하거나 수정하는 등의 기능을 구현해야 한다. 웹 서비스는 데이터를 처리할 때 대부분 데이터베이스를 사용한다.

그런데 데이터베이스를 사용하려면 SQL 쿼리(query)라는 구조화된 질의를 작성하고 실행하는 등의 복잡한 과정이 필요하다. 이때 ORM(object relational mapping)을 이용하면 자바 문법만으로도 데이터베이스를 다룰 수 있다. 즉, ORM을 이용하면 개발자가 쿼리를 직접 작성하지 않아도 데이터베이스의 데이터를 처리할 수 있다.

코드에서 Question은 자바 클래스이며, 이처럼 데이터를 관리하는 데 사용하는 ORM 클래스를 엔티티(Entity)라고 한다. ORM을 사용하면 내부에서 SQL 쿼리를 자동으로 생성해 주므로 직접 작성하지 않아도 된다. 즉, 자바만 알아도 데이터베이스에 질의할 수 있다. 이 외에,  ORM을 이용하면 데이터베이스 종류에 상관 없이 일관된 코드를 유지할 수 있어서 프로그램을 유지·보수하기가 편리하며, 내부에서 안전한 SQL 쿼리를 자동으로 생성해 주므로 개발자가 달라도 통일된 쿼리를 작성할 수 있고 오류 발생률도 줄일 수 있다는 장점이 있다.

이것을 스프링부트에서는 JPA(Java Persistence API)를 사용하여 데이터베이스를 처리한다. JPA는 자바 진영에서 ORM(Object-Relational Mapping)의 기술 표준으로 사용하는 인터페이스의 모음이다. 다음 포스팅에서 본격적으로 JPA에 대해 알아보자.

※본 게시글은 점프 투 스프링부트 교재를 기반으로 작성되었음.

로컬서버를 구동하고, localhost:8080/hello 페이지를 요청했을 때,

이렇게 나오는 경우가 있다. 이 오류의 원인은 스프링부트 서버가 http://localhost:8080/hello 라는 요청을 해석할 수 없기 때문이다. 이 오류를 해결하기 위해서는, 컨트롤러를 작성하고 hello/ URL에 대한 매핑을 추가하면 된다. 페이지 요청이 발생하면 스프링부트는 가장 먼저 컨트롤러에 요청된 페이지의 URL 매핑이 있는지를 조사한다.

위와 같이, HelloController 클래스에 @Controller 애너테이션을 적용하면 HelloController 클래스는 스프링부트의 컨트롤러가 된다. 그리고 메서드의 @GetMapping 애너테이션은 요청된 URL과의 매핑을 담당한다. 서버에 요청이 발생하면 스프링부트는 요청 페이지와 매핑되는 메서드를 컨트롤러를 대상으로 찾는다. 즉, 스프링부트는 http://localhost:8080/hello 요청이 발생하면 /hello URL과 매핑되는 index 메서드를 HelloController 클래스에서 찾아 실행한다.

@GetMapping에 http://localhost:8080 과 같은 도메인명과 포트는 적지 않는다. 왜냐하면 도메인명과 포트는 서버 설정에 따라 변하기 때문이다. /~~ 부분만 적으면 된다.

GetMapping을 적용해도 위 노란색 표시가 되어 있는 코드가 입력되지 않으면 404가 아닌 500으로 새로운 오류가 나타나게 된다. URL과 매핑된 함수는 결괏값을 리턴해야 하는데 아무런 값도 리턴하지 않기 때문에 오류가 발생한 것이다. 오류를 해결하려면 클라이언트(브라우저)로 응답을 리턴해야 한다. 그 역할을 하는 것이 @ResponseBody 애너테이션이다.

@ResponseBody 애너테이션은 URL 요청에 대한 응답으로 문자열을 리턴하라는 의미이다.

필자는 이런식으로 코드를 작성하였고, 로컬 서버 구동 후 페이지를 다시 호출하면.

위와 같이 올바르게 출력된 것을 확인할 수 있다!

요약을 해 보면,

@Controller -> JSP, HTML과 같은 View를 전달할 때 주로 쓰임 

@RestController = @ResponseBody + @Controller -> Data를 전송할 때 (JSON형식으로 프론트에게 API 제공)

추가적으로, 매핑의 종류에는 다음과 같은 것들이 있다.

@RequestMapping(value = ”url”, method = RequestMethod.GET)

@GetMapping(“url”)

@PostMapping

@DeleteMapping

@PutMapping

매핑을 도식화한 그림이다. 참고가 되었으면 한다.

※본 게시글은 '점프 투 스프링부트' 교재를 참고함.

src/main/java 디렉터리

src/main/java 디렉터리의 com.gdsc.webboard 패키지는 자바 파일을 작성하는 공간. 처음 접했을 때 이 디렉터리를 찾지 못해 잠깐 해멨었다. 스프링부트의 컨트롤러, 폼, DTO, 데이터베이스 처리를 위한 엔티티, 서비스 파일 등 핵심 코드를 작성하는 디렉터리니 반드시 꼭 알아둘 것.

WebBoardApplication 파일

스프링부트 애플리케이션의 시작을 담담하는 파일이다.

WebBoardApplication 클래스에는 위와 같이 반드시 @SpringBootApplication 애너테이션이 적용되어 있어야 한다. @SpringBootApplication 애너테이션을 통해 스프링부트의 모든 설정이 관리된다.

src/main/resources 디렉터리

src/main/resources 디렉터리는 자바 파일을 제외한 HTML, CSS, Javascript, 환경파일 등을 작성하는 공간이다.

templates 디렉터리

src/main/resources 디렉터리의 하위 디렉터리인 templates 디렉터리에는 템플릿 파일을 저장한다. 템플릿 파일은 HTML 파일 형태로 자바 객체와 연동되는 파일이다. templates 디렉터리에는 SBB의 질문 목록, 질문 상세 등의 HTML 파일을 저장한다.

static 디렉터리

static 디렉터리는 SBB 프로젝트의 스타일시트(.css), 자바스크립트(.js) 그리고 이미지 파일(.jpg, .png) 등을 저장하는 공간이다.

application.properties 파일

application.properties 파일은 SBB 프로젝트의 환경을 설정한다. SBB 프로젝트의 환경, 데이터베이스 등의 설정을 이 파일에 저장한다.

src/test/java 디렉터리

src/test/java 디렉터리는 SBB 프로젝트에서 작성한 파일을 테스트하기 위한 테스트 코드를 작성하는 공간이다. JUnit과 스프링부트의 테스팅 도구를 사용하여 서버를 실행하지 않은 상태에서 src/main/java 디렉터리에 작성한 코드를 테스트할 수 있다.

build.gradle 파일

그레이들(Gradle)이 사용하는 환경 파일이다. 그레이들은 그루비(Groovy)를 기반으로 한 빌드 도구로 Ant, Maven과 같은 이전 세대 빌드 도구의 단점을 보완하고 장점을 취합하여 만든 빌드 도구이다. build.gradle 파일에는 프로젝트를 위해 필요한 플러그인과 라이브러리 등을 기술한다.

스프링부트의 개략적인 구조는 이러하다. 클라이언트-서버 간은 API, 서버-DB 간은 SQL를 통해 서로 통신한다.

스프링부트는 서버(컨트롤러, 서비스, 리포지토리, JPA, DTO, Model...) 역할에 해당한다.