[Spring] 자바와 DB를 연동하는 JDBC의 일련의 과정과 이를 위한 ORM 프레임워크, MyBatis 및 MyBatis-Spring 연동모듈

ORM (Object Relational Mapping)

🐀 객체와 관계형 데이터베이스의 데이터를 자동으로 매핑해주는 도구를 말한다

ORM 프레임워크 중 하나가 MyBatis이다.

🎯 JDBC 코드 및 매개변수의 중복작업 제거
🎯 자바코드와 SQL쿼리의 분리로 간결화
🎯 복잡한 쿼리 작성 가능
🎯 쉬운 객체 바인딩

🐦 위임할 때 parameter와 result만 결정해주면 알아서 조작해준다.
🐦 내부가 PreparedStatement로 동작

📕 Statement 클래스
기본적인 sql 질의를 실행하는데 사용한다.

🚀 Statement 클래스의 내장 method 🚀
- executeQuery(String sql)
select문을 실행하고 결과집합(ResultSet)을 반환

- executeUpdate(String sql)
insert, update, delete와 같은 DML쿼리를 실행하고, 영향을 미친 행의 수를 반환

- execute(String sql)
데이터베이스에서 지원하지 않는 특수한 작업을 수행하는데 사용

📘 쿼리 수행 방식
데이터베이스 엔진은 먼저 **parse와 문법검사를 실행한다.
Statement를 수행하기 위한 **가장 효율적인 방법을 탐색한다.(쿼리 플랜, 계산 과정에서 비용이 발생)
그 후 실행한다.

💣 Statement를 사용하면, 매번 쿼리를 수행할 때마다 위의 방식을 거친다. 즉, 캐시를 사용하지 않음으로 쿼리 플랜을 재사용할 수 없다.
또한,
💣 SQL Injection 공격에는 취약하다.

String eName = "\' \' OR 1=1";
String sqlQuery = "SELECT empNo, eName, job FROM emp WHERE eName = " + eName;
// Statement 생성
Statement stmt = conn.createStatement();
// SQL 쿼리 실행
ResultSet resultSet = statement.executeQuery(sqlQuery);

// 결과 처리
while(resultSet.next()) {
    int empNo = resultSet.getInt("empNo");
    String eName = resultSet.getString("eName");
    String job = resultSet.getString("job");
    System.out.println(empNo + ". name: " + eName + ", job: " + job);
}

eName에 충분히 악의적인 sql구문이 들어갈 수 있고, 때문에 의도하지 않은 동작을 수행할 수 있다.
이를 보완하기 위해, 해당 클래스는 두가지 하위 클래스로 나뉜다.
(1) PreparedStatement
sql문을 미리 컴파일하여 데이터베이스에 캐시한다.
미리 컴파일 해두는 것과 캐시된 쿼리플랜을 재사용하기 때문에 실행 속도가 빠르다.
또한 ?(placeholder)를 사용하여 sql문을 정의할 수 있으므로, 인자만 바꿔 반복 실행할 때 유용하며, 이는 캐시 사용에 적합하다.

PreparedStatement방식은 sql쿼리의 템플릿을 미리 작성하고 실행하기 전에 파라미터를 채워넣는 방식으로 동작한다.
이 때 JDBC Driver에 의해 자동으로 이스케이프되어 처리되는데,
이 과정으로 인해 파라미터(사용자 입력)가 sql문의 일부로 해석되지 않고, 그저 문자열 값 그대로 처리된다.(악의적인 sql코드로 해석을 방지)
즉, 데이터바인딩이 파라미터화되어 method를 통해 이루어짐으로 지정한 타입만을 넣을 수 있으며,
지정된 타입이 문자열일 시, 자동 이스케이프로 인해 문자열 그 자체로만 해석해, SQL Injection 공격을 예방할 수 있다.

String sqlQuery = "SELECT empNo, eName, job FROM emp WHERE empName = ?";
// PreparedStatement 생성
PreparedStatement pstmt = conn.preparedStatement(sqlQuery);

// 파라미터 설정
String empName = "woo";
preparedStatement.setString(1, empName);

// SQL 쿼리 실행
ResultSet resultSet = statement.executeQuery();

// 결과 처리
while(resultSet.next()) {
    int empNo = resultSet.getInt("empNo");
    String eName = resultSet.getString("eName");
    String job = resultSet.getString("job");
    System.out.println(empNo + ". name: " + eName + ", job: " + job);
}

(2) CallableStatement
저장 프로시저를 실행하는데 사용된다.
데이터베이스에서 미리 정의된 일련의 sql명령문을 실행하는데 사용된다.

JDBC (Java Database Connectivity)

🐀 JDBC 로드, 연결, 실행, 닫기

• 🚀 (1) 로드

  연동하려는 DB제품(벤더)를 선택하는 것, Driver가 필요하다.(~.jar)

  Class.forName("oracle:oracle.jdbc.driver.OracleDriver");

  ⚠️ 만약 Driver를 못찾으면 ClassNotFoundException 발생

• 🚀 (2) 연결

  로드된 DB에 접속, URL(host name, port, SID), ID, Password를 이용해서 연결객체(Connection)를 얻어오는 과정

  ⚠️ ConnectionException 발생

• 🚀 (3) 실행

  CRUD 작업 (Statement or PreparedStatement)

• 🚀 (4) 닫기

  사용된 객체를 반납

  close();

⚠️ 연결객체(Connection)는 절대로 공유하면 안된다.(1커넥션 == 1트랜잭션)

📜 DBManager.java

public class DBManager {
    // 로드
    static {
        try {
            Class.forName(DBProperties.DRIVER_NAME);
        } catch(ClassNotFoundException e) {
            e.printStackTrace();
        }
    }

    // 연결
    public static Connection getConnection() throws SQLException {
        return DriverManager.getConnection(DBProperties.URL, DBProperties.USER_ID, DBProperties.USER_PASS);
    }

    // 닫기 (DML 전용)
    public static void releaseConnection(Connection conn, PreparedStatement pstmt) {
        try {
            if(st != null) pstmt.close();
            if(conn != null) conn.close();
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    // 닫기 (SELECT 전용)
    public static void releaseConnection(Connection conn, PreparedStatement pstmt, ResultSet rs) {
        try {
            if(rs != null) rs.close();
        } catch (SQLException e) {
            e.printStackTrace();
        }
        releaseConnection(conn, pstmt);
    }
}

📜 DBProperties.java

public interface DBProperties {
    public static final String DRIVER_NAME = "oracle.jdbc.driver.OracleDriver";
    String URL = "jdbc:oracle:thin:@localhost:1521:XE";
    String USER_ID = "c##scott";
    String USER_PASS = "tiger";
}

📜 JDBCDQLExample.java

public class JDBCDQLExample {
    public static void main(String[] args) {
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = DBManager.getConnection();

            String sqlQuery = "SELECT empNo, eName, job FROM emp WHERE eName = ?";
            PreparedStatement pstmt = conn.preparedStatement(sqlQuery);

            String eName = "woo";
            preparedStatement.setString(1, eName);

            ResultSet resultSet = statement.executeQuery();
            while(resultSet.next()) {
                int empNo = resultSet.getInt("empNo");
                String eName = resultSet.getString("eName");
                String job = resultSet.getString("job");
                System.out.println(empNo + ". name: " + eName + ", job: " + job);
            }
        } catch (CloassNotFoundException e) {
            e.printStackTrace();
        } catch (SQLException e) {
            e.printStackTrace();
        } finally {
            try {
                releasConnection(conn, pstmt, rs);
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
}

Mapper문서

🐁 쿼리를 작성해놓은 문서

🪛 empmapper.xml

<mapper namespace="emp">
    <select id="select" parameterType="String" resultType="emp">
        SELECT * FROM emp WHERE eName=#{eName}
    </select>

    <select id="selectAll" resultType="emp">
        SELECT * FROM emp
    </select>

    <insert id="insert" parameterType="emp">
        INSERT INTO emp VALUES(#{empNo}, #{eName}, #{job})
    </insert>

    <update id="update" parameterType="emp">
        UPDATE TABLE emp SET job = #{job} WHERE empNo = #{empNo}
    </update>

    <delete id="delete" parameterType="int">
        DELETE FROM emp WHERE empNo = #{empNo}
    </delete>
</mapper>

🧀 #{ }: PreparedStatement 방식, 따옴표로 묶어서 매핑
🧀 ${ }: Statement방식, 그대로 매핑

⚠️ 파라미터가 하나만 들어올 때, 관례적으로 ${_parameter}를 쓴다.

sql 태그

🍪 재사용 가능한 sql 구문 정의한 태그를 말한다

<sql id="empColumns">empNo, eName, job</sql>
<sql id="select" parameterType="int" resultType="hashmap">
    select <include refid="empColumns" />
    from emp
    where empNo = #{empNo}
</sql>

MyBatis 주요 컴포넌트

🐙 MyBatis 주요 컴포넌트

• SqlSessionFactoryBuilder method scope

  SqlSessionFactory를 세우는 역할

• SqlSessionFactory application scope

  필요할 때마다 SqlSession을 생성해주는 역할, static singleton pattern

• SqlSession method scope

  JDBC connection과 동일 (Not to be shared, closing)

🧀 MyBatis는 auto commit이 아니다.

📜 DBManager.java

public class DBManager {
    private static SqlSessionFactory factory;

    static {
        try {
            String resource = "mybatis.xml";
            // 리소스 파일을 로드하여 Reader객체로 변환
            Reader reader = Resources.getResourceAsReader(resource);

            factory = new SqlSessionFactoryBuilder().build(reader);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSession() {
        return factory.openSession();
    }

    public static void sessionClose(SqlSession session) {
        if(session != null) session.close();
    }

    // 트랜잭션 처리
    // state가 true인 경우 commit(), false인 경우 rollback()
    public static void sessionClose(SqlSession session, boolean state) {
        if(session != null) {
            if(state) session.commit();
            else session.rollback();

            session.close();
        }
    }
}

🪛 mybatis.xml

<configuration>
    <!-- db정보를 담고 있는 외부 properties 파일 위치 지정 -->
    <properties resource="dbInfo.properties" />

    <!-- 값이 전달되지 않으면 NULL로 들어갈 수 있도록 설정 -->
    <settings>
        <setting name="jdbcTypeForNull" value="NULL" />
    </settings>

    <!-- 객체에 별칭 만들기 -->
    <typeAliases>
        <typeAlias type="app.dto.Emp" alias="emp" /> <!-- 클래스 경로를 emp로 간단하게 사용 -->
    </typeAliases>

    <!-- DBCP -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${driver}" />
                <property name="url" value="${url}" />
                <property name="username" value="${username}" />
                <property name="password" value="${password}" />
            </dataSource>
        </environment>
    </environments>

    <!-- 쿼리 작성 문서(mapper문서) 위치 지정(등록) -->
    <mappers>
        <mapper resource="empmapper.xml" />
    </mappers>
</configuration>

📜 XxxDAO.java

public class XxxDAO {
    public void selectByXxxName() {
        SqlSession session = null;

        try {
            session = DBManager.getSession();
            List<String> list = session.selectList("emp.select") // namespace.id
            System.out.println("list: " + list);
        } finally {
            DBManager.sessionClose(session);
        }
    }
}

🧀 mybatis 내부에서 executeQuery()가 실행된다.

mybatis-spring

🍪 Spring에서 ORM을 더 쉽게 사용할 수 있도록 라이브러리로 만들어서 제공한다.

🚀 mybatis-spring 주요 컴포넌트 🚀

• SqlSessionFactoryBean

  (mybatis) SqlSessionFactory를 SqlSessionTemplate의 생성자에 전달한다.

• SqlSessionTemplate

  (mybatis) SqlSession을 미리 만들어 놓는다.

🪛 mybatis-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/mvc"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsdhttp://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">

    <context:component-scan base-package="web.mvc.service,web.mvc.repository"/>

    <beans:bean id="dataSource"
                        class="org.apache.commons.dbcp.BasicDataSource"
                        p:driverClassName="${jdbc.oracle.driver}"
                        p:url="${jdbc.oracle.url}"
                        p:username="${jdbc.oracle.username}"
                        p:password="${jdbc.oracle.password}"
                        p:maxActive="10" />

    <beans:bean id="sqlSessionFactory"
                        class="org.mybatis.spring.SqlSessionFactoryBean">
        <beans:property name="dataSource" ref="dataSource" />
        <beans:property name="mapperLocation" value="classpath:mapper/*Mapper.xml" />
        <beans:property name="typeAliasesPackage" value="web.mvc.dto" /><!-- dto 폴더 안에 있는 클래스들 별칭 자동 만듦, 클래스의 첫글자만 소문자 -->
    </beans:bean>

    <beans:bean id="sqlSession"
                        class="org.mybatis.spring.SqlSessionTemplate">
        <beans:constructor-arg index="0" ref="sqlSessionFactory" />
    </beans:bean>
</beans:beans>