Mybatis

MyBatis

개발자가 지정한 SQL, 저장 프로시저 그리고 몇 가지 고급 매핑을 지원하는 SQL Mapper입니다
(프로시저 = 특정한 로직을 처리하기만 하고 결과 값을 반환하지 않는 서브 프로그램
== 테이블에서 데이터를 추출해 조작하고 그 결과를 다른 테이블에 다시 저장하거나 갱신하는 
== 일련의 처리를 할 때 주로 프로시저를 사용합니다.)

- JDBC로 처리하는 상당 부분의 코드와 파라미터 설정 및 결과 매핑을 대신해준다.
 = 기존에 JDBC를 사용할 때는 DB와 관련된 여러 복잡한 설정(Connection)들을 다루어야 했지만
   SQL Mapper는 자바 객체를 실제 SQL문에 연결함으로써, 빠른 개발과 편리한 테스트 환경을 제공한다.

- 데이터베이스 record에 원시 타입과 Map 인터페이스 그리고 자바 POJO를 설정해서 매핑하기 위해
  xml과 Annotation을 사용할 수 있다.

- MyBatis는 원래 Apache Foundation의 iBatis였으나, 생산성, 개발 프로세스, 
  커뮤니티 등의 이유로 Google Code 로 이전됨녀서 이름이 바뀌었다.
  - iBatis와 바뀐 차이점  = JDK 1.5 Annotation
  = Dynatic SQL, XML Element

장점
- SQL에 대한 모든 컨트롤을 하고자 할때 매우 적합하다.
- SQL쿼리들이 매우 잘 최적화되어 있을 때에 유용하다.

단점
- 어플리케이션과 데이터베이스 간의 설계에 대한 모든 조작을 하고자 할 때는 적합하지 않다.
- 어플리케이션과 데이터베이스 간에 서로 잘 구조화되도록 많은 설정이 바뀌어야 하기 때문이다.

==============================================================================

Spring boot 기본 개념

Spring boot 에서 중요한 개념인 Controller, Service, DAO, Mapper에 대해서 정리
- Spring boot 는 MVC pattern를 따른다.

request ->    <- response
		  ->	    ->	      ->   ->
 	Web Brower  Controller  Service  DAO  DataBase
		  <-	    <-	       <-   <-

  
Controller
- Controller는 웹 브라우저의 요청을 전담하여 처리합니다.
- Controller가 Service를 호출 한다.

Service
-Service는 비즈니스 로직을 수행 합니다.
- 유저의 요청이 들어왔을 때, Controller에서 모든 요청을 수용한다. 이때, Controller에서는 때로는
  복잡한 작업, 때로는 DB와 통신하는 작업 등 수많은 업무에 대한 요청을 받게 됩니다. 그 모든
  것을 Controller가 홀로 감당하는 형태로 프로그래밍을 하는 경우는 아마도 거의 없습니다.
  따라서 보통은 다른 클래스에서 그 일을 대신하게 해 주는데 Service 클래스가 하는 일이 그것입니다.
- DataBase에 접근하는 DAO를 이용해서 결과값을 받아옵니다.

DAO
- DAO는 데이터베이스에 접속하여 비즈니스 로직 실행에 필요한 쿼리를 호출합니다.
  JAVA DAO, DTO, VO 
DTO
- Data Transfer Object의 약자로 각 계층이 데이터를 주고 받을 때 사용하는 객체를 말합니다.
Mapper
- 마이바티스는(Mybatis)는 Mapper 인터페이스를 제공합니다.
- DAO대신 mapper를 사용하면 DAO를 만들지 않고 interface만을 이용해서 간편히 개발할 수 있습니다.
- MyBatis는 java code와 sql문을 분리하여 편리하게 관리하도록 합니다.
- SQL문은 *.xml 형식으로 저장합니다.
- DB에 질의할 쿼리문을 관리하는 Mapper파일에 요청합니다.

==============================================================================

Spring boot mysql 연동

의존성 설정
- build.gradle 파일에 위의 의존성을 작성합니다.
- Spring boot 프로젝트 생성 시  dependency에 mybatis framwork를 추가했다면 따로 의존성을 추가할 필요는 없습니다.
- 위의 방법이 아닌 경우 dependencies {...}에 implementation 
org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0을 
추가하고 Refresh Gradle Project를 해줍니다.
- version은 각자 맞는 버전으로 합니다.

=========================================================================

DB연결 설정 및 mybatis 설정
application.priperties 파일을 열고 아래와 같이 설정 정보를 작성합니다.

# database
spring.datasource.url: jdbc:mysql://host:port/dbname?characterEncoding=utf8
spring.datasource.username: root
spring.datasource.password: password
spring.datasource.driver-class-name: com.mysql.cj.jdbc.Driver

# mybatis
mybatis.config=mybatis-config.xml
mybatis.type-aliases-package: com.example.demo.model
mybatis.mapper-locations: mybatis/mapper/*.xml

mybatis.mapper-locations은 알맞게 설정해주어야 에러가 발생하지 않습니다.

mybatis config file 작성합니다.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <mappers>
    <mapper resource="TestMapper.xml"/>
  </mappers>
</configuration>

mybatis-config.xml에 위의 코드를 작성해줍니다.

- resource는 앞으로 만들 mapper.xml파일의 이름입니다.

==============================================================================
DTO 작성

데이터를 주고 받을때 사용하는 객체인 DTO를 만들어 줍니다.
ex)

package com.example.demo.model.aws.dto;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class portfolio {
    private String idx;

    private String start_date;

    private String deadline;

    private String header;

    private String description;

    private String image_path;
}

==============================================================================
mapper.xml 작성

mapper.xml은 DB쿼리문을 관리하며 DB와 상호작용하는 파일입니다.
쉽게 말해 쿼리문을 모아둔 파일임.

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.example.demo.model.aws.dao.TestMapper">

  <select id="getAllDataList" resultType="com.example.demo.model.aws.dto.portfolio">
    SELECT * FROM portfolio;
  </select>

</mapper>

TestMapper.xml
- portfolio 테이블의 모든 정보를 select하는 간단한 쿼리문을 작성합니다.
- mapper 태그의 namespace는 아직은 생성하지 않은 Mapper 인터페이스를 의미합니다.

==============================================================================
Mapper Interface 작성

package com.example.demo.model.aws.dao;

import java.util.List;

import com.example.demo.model.aws.dto.portfolio;

import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

@Repository
@Mapper
public interface TestMapper {
    List<portfolio> getAllDataList();

}

==============================================================================

Service class 작성
Service는 두가지를 구현해야 합니다.

1. service interface
2. service interface를 구현한 class 만들기 (service interface 구현체)

==============================================================================

package com.example.demo.service;

import java.util.List;

import com.example.demo.model.aws.dto.portfolio;

public interface TestService {
    public List<portfolio> getAllDataList();
}

==============================================================================

-TestService.java-

package com.example.demo.service;

import java.util.List;

import com.example.demo.model.aws.dao.TestMapper;
import com.example.demo.model.aws.dto.portfolio;

import org.springframework.stereotype.Service;

import lombok.RequiredArgsConstructor;

@Service
@RequiredArgsConstructor
public class TestServiceImpl implements TestService {
    private final TestMapper testMapper;

    @Override
    public List<portfolio> getAllDataList() {
        return testMapper.getAllDataList();
    }
}

TestServiceImpl.java
- @Service Annotation을 붙여 이 클래스가 서비스 클래스라는 것을 알려줍니다.
- 우리는 DAO를 사용하지 않고 매퍼를 사용할 것입니다.
- Service가 mapper를 호출하는 부분은 return testMapper.getAllDataList(); 입니다.

==============================================================================

Controller 작성 

package com.example.demo.controller;

import java.util.List;

import com.example.demo.model.aws.dto.portfolio;
import com.example.demo.service.TestService;

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

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
@RestController
public class TestController {
  private final TestService testService;

  @GetMapping("/hello")
  public String hello() {
    return "Hello World";
  }

  @GetMapping("/test")
  public List<portfolio> test() {

    return testService.getAllDataList();
  }
}

TestController.java
위의 코드를 모두 작성하였다면 /test uri로 접근 시 protfolio 테이블의 모든 정보를 확인할수 있다.

==============================================================================