[JPA로 REST API 만들기] DB 연동 및 JPA Repository 사용해 Service 수정

DB연동

build.gradle

mariadb 와 jpa 를 사용할 것이므로 주석처리 해두었던 jpa 를 주석 해제하고 아래처럼 입력한다.

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

	//jpa
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    
      //mariadb
	runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
}

 

수정 후 gradle 을 refresh 해준다.

 

src/main/resources/application.properties

해당 경로의 properties 파일에 db 접속 정보를 추가해준다. 각 설정 정보는 코드 밑에 적어두었다.

spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/todolist
spring.datasource.username=root
spring.datasource.password=1234

#JPA
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

• spring.jpa.hibernate.ddl-auto=update
  • db에 생성되지 않은 테이블, 컬럼을 추가한다.
• spring.jpa.show-sql=true
  • jpa 가 날리는 sql문을 보여준다
• spring.jpa.properties.hibernate.format_sql=true
  • 보여주는 sql 문을 깔끔하게 포매팅해준다.

 

Entity 생성

/todo/model/TodoITem.java

내용을 아래처럼 수정해준다. @Entity 는 자바 객체를 관계형 데이터베이스의 table 과 매핑시킬 수 있도록 jpa의 entity 로 선언하는 어노테이션이다. DB에 테이블을 생성하지 않아도 JPA Hibernate 가 아래 내용을 참고해 create 문을 실행해준다.

id 의 타입을 기본 데이터 타입 long 이 아닌 래퍼 타입인 Long 으로 선언하는 이유는 null 이 가능하기 때문이다. auto_increment 는 id 값이 없을 때 자동으로 넣어주는 옵션인데, long 의 default 값은 0이기 때문에 값이 있다고 보게 된다. Long 의 default 값은 Null 로 정확하게 값이 없다고 판단할 수 있기 때문에 되도록 jpa 에서 pk 는 Nullable 한 데이터 타입을 쓰는 것이 권장된다.

package com.todolist.tutorial.todo.model;

import lombok.*;
import javax.persistence.*;

@Entity                 //jpa entity 로 선언
@Table(name="todos")    //table 정보
@Getter @Setter         //getter, setter 메소드
@NoArgsConstructor      //인자 없는 기본 생성자
@AllArgsConstructor     //모든 인자 가지는 생성자
@Builder                //빌더 패턴으로 생성하게 해줌.
public class TodoItem {
    @Id     //pk 필드. 반드시 필요,
    @Column(name="id", nullable = false)    //테이블 컬럼과 매핑
    @GeneratedValue(strategy = GenerationType.IDENTITY) //auto increment
    private Long id;

    @Column(name="title", nullable = false, length = 100)
    private String title;

    @Column(name="done", nullable = false)
    private boolean done;
}

 

Repository 생성

/todo/model/TodoItemRepository.interface

JpaRepository 의 메소드를 상속받는 인터페이스를 만든다. 몸체를 직접 구현하지 않아도, Hibernate 가 자동으로 만들어주므로 이 한 줄이면 된다.

package com.todolist.tutorial.todo.model;

import org.springframework.data.jpa.repository.JpaRepository;

public interface TodoItemRepository extends JpaRepository<TodoItem, Long> {

}

 

기본적으로 제공되는 Jpa 메소드는 다음과 같다.

method	return	description
findAll()	List<T>	search
findById	Optinal<T>	search
deleteById(T id)	void	delete
save(T entity)	T	insert, update

 

Service 에 Repository 추가

/todo/TodoItemService.java

서비스에 위에서 만든 Repository 를 추가하여 아래와 같이 내용을 변경하자. 참고로, getById() 는 Optional 을 반환하므로 orElseThrow() 를 붙여주었다.  이전에 서비스 인스턴스를 컨트롤러에 추가할 때와 마찬가지로,  Repository 의 의존성을 자동으로 주입받기 위해 @Autowired 어노테이션을 붙여주었다.

Optional 객체는 NullPointerException 를 손쉽게 처리하기 위해 T 타입의 객체들을 감싸주는 Wrapper 클래스다. 복잡한 조건문 없이 orElsethrow 메소드 등으로 null exception 을 처리할 수 있다.

package com.todolist.tutorial.todo;

import com.todolist.tutorial.todo.model.TodoItem;
import com.todolist.tutorial.todo.model.TodoItemRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class TodoItemService {
    @Autowired
    private TodoItemRepository todoRepo;

    public List<TodoItem> getTodos() {
        List<TodoItem> todos = todoRepo.findAll();

        if(!todos.isEmpty()) return todoRepo.findAll();
        else throw new IllegalArgumentException("no such data");
    }

    public TodoItem getTodoById(final Long id) {
        return todoRepo.findById(id).orElseThrow(()-> new IllegalArgumentException("no such data"));
    }

    public TodoItem createTodo(final TodoItem createTodoItem) {
        if(createTodoItem == null) throw new IllegalArgumentException("todo item cannot be null");
        return todoRepo.save(createTodoItem);
    }

    public TodoItem updateTodo(final long id, final TodoItem updateTodoItem) {
        TodoItem todoItem = getTodoById(id);
        todoItem.setTitle(updateTodoItem.getTitle());
        todoItem.setDone(updateTodoItem.isDone());

        return todoRepo.save(todoItem);
    }

    public void deleteTodoById(final Long id) {
        todoRepo.deleteById(id);
    }
}