[MyBatis] Mapper 설정과 문법, 자주하는 실수

스프링 프레임워크 프로젝트 과제 중 작성함

 

xx_mapper.xml 생성 및 설정

• mapper 파일 경로 설정
  • root-context.xml 파일에 mapper 경로를 설정하기
  • src/main/webapp/WEB-INF/spring/root-context.xml

    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <!---->
        <property name="mapperLocations" value="classpath:mapper/**/*.xml"/>
    </bean>

 

• 설정한 위치에 mapper.xml 생성하기

생성위치

 

• mapper.xml 파일 코드 구성

<?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"> <!--그냥 xml파일을 MyBatis파일로 바꿔주는 것-->

<mapper namespace="documentMapper"> <!--Repository에서 사용할 mapper의 고유한 이름-->

	<!--예시 매퍼-->
    <select id="getMaxDocumentId" parameterType="long" resultType="long">
        SELECT MAX(document_id)
        FROM xx_document
    </select>


</mapper>

 

• MyBatis 설정 파일 mybatis-config.xml 생성

mybatis-config.xml 생성

 

• mybatis-config.xml 파일 코드

<?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>

    <typeAliases>
        <typeAlias alias="Document" type="com.study.student.domain.Document"/>
        <typeAlias alias="조회결과타입클래스별명" type="해당.클래스가.위치한.주소.클래스이름"/>
    </typeAliases>

</configuration>

 

• 당연히 의존성 추가해야함(생략)

 

 

 

기본 문법

• 태그 종류 : update, insert, select, sql, resultMap, delete, cache, cache-ref,parameterMap
  • 태그는 SQL 쿼리와 데이터 매핑을 정의하는 중요한 역할을 
  • 각 태그는 데이터베이스 작업이나 설정에 대한 특정 지시를 제공함

태그 종류

• 각 태그별 설명 [아래의 더보기를 누르세요]

1. <select>: 데이터베이스에서 데이터를 조회하는 SQL 쿼리를 정의하는 데 사용됩니다. `<select>` 태그는 결과를 반환하는 SQL 문을 포함합니다. 반환되는 결과는 단일 객체, 객체의 리스트, 또는 기본 데이터 타입일 수 있습니다.

2. <insert>: 데이터베이스에 새로운 데이터를 삽입하는 SQL 쿼리를 정의하는 데 사용됩니다. 이 태그는 보통 삽입 작업을 수행하는 SQL 문을 포함하며, 필요에 따라 삽입된 데이터의 키(예: auto-increment)를 반환할 수도 있습니다.

3. <update>: 데이터베이스의 기존 데이터를 수정하는 SQL 쿼리를 정의하는 데 사용됩니다. 이 태그는 수정 작업을 수행하는 SQL 문을 포함합니다.

4. <delete>: 데이터베이스에서 데이터를 삭제하는 SQL 쿼리를 정의하는 데 사용됩니다. 이 태그는 삭제 작업을 수행하는 SQL 문을 포함합니다.

5. <sql>: SQL 문의 일부를 재사용하기 위한 세그먼트를 정의합니다. 이 태그 내에 정의된 SQL은 다른 SQL 문 내에서 재사용될 수 있으며, 중복을 줄이고 유지보수를 용이하게 합니다.

6. <resultMap>: SQL 쿼리의 결과와 자바 객체 사이의 매핑을 정의합니다. 이 태그는 복잡한 조인이나 복합 데이터 타입을 처리할 때 유용합니다.

7. <cache>: 마이바티스의 내장 캐시 기능을 활성화합니다. 이 태그를 사용하면 SQL 쿼리의 결과를 캐시하여, 동일한 쿼리에 대한 반복 요청 시 성능을 향상시킬 수 있습니다.

8. <cache-ref>: 다른 매퍼에서 정의된 캐시 설정을 참조합니다. 이를 통해 여러 매퍼 간에 캐시 설정을 공유할 수 있습니다.

9. <parameterMap>: (더 이상 권장되지 않음) SQL 쿼리의 입력 파라미터를 정의합니다. 이 태그는 현재는 `<parameterType>` 속성으로 대체되었습니다.

 

• 태그의 속성 : 
  • 다양한 속성들은 SQL 쿼리의 동작과 결과 처리 방법을 제어하는 데 중요한 역할을 함

태그의 속성

• 각 속성의 특정한 목적 설명  [아래의 더보기를 누르세요]

1. parameterType: SQL 쿼리에 전달되는 매개변수의 Java 타입을 지정합니다. 이는 `<insert>`, `<update>`, `<delete>`, `<select>` 등의 태그에서 사용됩니다.

2. resultType: `<select>` 쿼리의 결과로 반환될 객체의 Java 타입을 지정합니다. 예를 들어, 기본 타입, 객체 타입 등이 될 수 있습니다.

3. resultMap: 복잡한 SQL 쿼리 결과를 Java 객체로 매핑하는 방법을 정의합니다. `resultMap`은 다양한 컬럼과 객체 속성 간의 매핑 관계를 세밀하게 설정할 수 있습니다.

4. databaseId: 데이터베이스 벤더(예: MySQL, Oracle)별로 다른 쿼리를 정의할 때 사용합니다. 이를 통해 동일한 매퍼 파일 내에서 다양한 데이터베이스 시스템에 대응할 수 있습니다.

5. fetchSize: JDBC 드라이버에 의해 한 번에 가져올 수 있는 행(row)의 수를 지정합니다. 이는 대량의 데이터를 처리할 때 성능에 영향을 줄 수 있습니다.

6. flushCache: 쿼리 실행 후 마이바티스의 내부 캐시를 비울지 여부를 결정합니다. 데이터 변경 쿼리에서 주로 사용됩니다.

7. lang: 쿼리를 작성하는 데 사용된 스크립트 언어를 지정합니다. 기본값은 XML입니다.

8. parameterMap: (더 이상 권장되지 않음) 입력 매개변수를 정의하는 데 사용되었던 속성입니다. 이는 `parameterType`으로 대체되었습니다.

9. resultOrdered: 중첩된 결과 매핑에서 결과의 순서가 중요한 경우 이를 `true`로 설정합니다.

10. resultSets: 다중 결과 집합을 처리할 때 사용됩니다. 주로 저장 프로시저를 호출할 때 필요합니다.

11. resultSetType: JDBC의 `ResultSet` 타입을 지정합니다. 예를 들어, `FORWARD_ONLY`, `SCROLL_SENSITIVE`, `SCROLL_INSENSITIVE` 등이 있습니다.

12. statementType: 사용할 JDBC statement 타입을 지정합니다. `STATEMENT`, `PREPARED`, `CALLABLE` 중 하나를 선택할 수 있습니다.

13. timeout: 쿼리 실행의 최대 시간을 초 단위로 설정합니다. 이 시간을 초과하면 예외가 발생합니다.

14. useCache: 해당 쿼리의 결과를 마이바티스의 내부 캐시에 저장할지 여부를 결정합니다. 주로 조회 쿼리에서 사용됩니다.

이러한 속성들을 적절히 사용하면, 마이바티스를 통해 데이터베이스와의 상호작용을 더욱 효율적이고 유연하게 관리할 수 있습니다. 속성의 사용은 매퍼의 구체적인 요구사항과 데이터베이스의 특성에 따라 달라질 수 있습니다.

 

• 쿼리별 사용예시

    <!-- 특정 document_id로 Document 조회 -->
    <select id="selectDocumentById" parameterType="int" resultType="com.example.model.Document">
        SELECT document_id, title, content
        FROM Document
        WHERE document_id = #{documentId}
    </select>

 

• myBatisConfig.xml에 타입 별칭 등록
  • 별칭(Alias)을 사용하여 parameterType과 resultType을 더 간단하게 지정할 수 있음
  • 별칭을 등록하면, 전체 클래스 이름을 사용하는 대신에 이 별칭을 사용해서 매핑 클래스를 참조할 수 있기 때문에 XML 설정을 더 간결하게 만들고, 가독성을 향상시켜줌

 

• mybatis-config.xml 생성하기
  
  • 생성위치 : 마이바티스(MyBatis)의 mybatis-config.xml 파일 위치는 일반적으로 Java 프로젝트의 resources 디렉토리 아래에 두는 것이 일반적임

mybatis-config.xml 생성 위치

 

• 코드 예시

<?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>

    <typeAliases>
        <typeAlias alias="Document" type="com.example.model.Document"/>
    </typeAliases>
    
</configuration>

• 별칭 등록 이후에는 <select id="selectDocumentById" parameterType="int" resultType=" Document "> 라고 입력 할 수 있음

 

• 바인딩 타입 클래스 생성시 주의점
  • 컬럼명과 프로퍼티 이름 매칭
    • 마이바티스는 SQL 쿼리의 결과 컬럼 이름과 바인딩 타입 클래스의 프로퍼티 이름을 자동으로 매핑함
    • 데이터베이스의 컬럼명이 user_name이라면, 바인딩 클래스의 프로퍼티는 userName과 같이 카멜 케이스(CamelCase)로 매핑됨
  • 생성자 매개변수 순서
    • 생성자를 통한 매핑을 사용할 경우 SELECT 절의 컬럼 순서와 생성자 매개변수의 순서가 일치해야 함
    • resultMap에서 <constructor> 태그를 사용하여 명시적으로 매핑할 수도 있음
  • 기본 생성자의 중요성
    • 마이바티스는 클래스의 인스턴스를 생성할 때 기본 생성자(인자가 없는 생성자)를 사용함
    • 바인딩 타입 클래스에는 기본 생성자가 반드시 있어함
  • 타입 핸들러
    • 때때로 데이터베이스의 컬럼 타입과 자바 클래스의 필드 타입이 직접적으로 매핑되지 않을 때 타입 핸들러를 사용해서 변환을 처리할 수 있음
  • 접근성
    • 프로퍼티에 직접 접근하는 대신, getter와 setter 메서드를 통한 접근을 권장함
  • 필드 네이밍
    • 데이터베이스의 컬럼명과 자바 클래스의 필드명이 다른 경우, @Result 어노테이션을 사용하여 명시적으로 매핑할 수 있음

( to do 겪었던 오류 코드 추가하기 )

 

 

 

재사용과 조건 검색

• 자주사용하는 쿼리 부분 <sql><include> 태그를 이용해서 재사용 하기
  • SQL 쿼리의 유지보수가 훨씬 쉬워지고, 코드의 가독성과 재사용성이 크게 향상

 

•  재사용할 SQL 조각을 <sql> 태그로 정의하기 (여러 쿼리에서 공통으로 사용되는 부분)

<sql id="whereDocumentStatus">
    WHERE status = #{status}
</sql>

 

• <sql> 태그를 다른 쿼리에서 <include> 태그로 포함시켜 재사용 시키기

<select id="selectDocumentsByStatus" parameterType="map" resultType="Document">
    SELECT document_id, title, content
    FROM Document
    <include refid="whereDocumentStatus"/>
</select>

 

 

 

parameterType으로 제공하는 객체에 null값이 있을 때

• 같이 객체가 전체 값이 있을 때/일부 값이 null일때 update문을 재사용을 위해서 데이터 타입 설정하기
• #{변수명, null값이어도 타입은 이거야 알려주기}
  • ex) MANAGER_APPROVAL_ID = #{ managerApprovalId , jdbcType=NUMERIC }
  • ex) MANAGER_APPROVAL_DATE = #{ managerApprovalDate , jdbcType=DATE },

    <update id="updateDocument" parameterType="Document">
        update XX_DOCUMENT
        set title = #{title},  content = #{content}, APPROVAL_STATUS = #{approvalStatus},
            MANAGER_APPROVAL_ID = #{managerApprovalId,jdbcType=NUMERIC},
            MANAGER_APPROVAL_DATE = #{managerApprovalDate,jdbcType=DATE},
            DIRECTOR_APPROVAL_ID = #{directorApprovalId,jdbcType=NUMERIC},
            FINAL_APPROVAL_DATE = #{finalApprovalDate,jdbcType=DATE}
        where document_id = #{documentId}
    </update>

 

 

 

객체가 아닌 컬렉션 반환

• resultType을 특정 객체가 아닌 컬렉션으로 반환하기
• Map으로 결과 반환하기 List<Map<String,Object>>
• 특정 상황에서 유용할 수 있지만, 일반적으로는 도메인 모델(즉, 비즈니스 객체)을 사용하는 것이 더 좋은 방법이므로 설명은 생략하겠음

 

 

 

내가 가장 많이 했던 실수

• mapper에서 resultType이나 parameterType으로 쓰는 객체에 @NoArgsConstructor 애너테이션 붙인 것 -> 일부 필드 바인딩이 잘 안됨
  • 조회 결과 : Document(documentId=null, employeeId=null, title=연간 마케팅 전략 및 실행 계획, content=홍보 많이 하겠습니다., approvalStatus=null, managerApprovalId=null, directorApprovalId=null, regDate=null, finalApprovalDate=null)
• 조회결과 타입 클래스의 생성자 매개변수 순서와 데이터베이스에서 조회하는 컬럼의 순서가 다를 때
  •  java.sql.SQLException: 부적합한 열 유형: getLong not implemented for class oracle.jdbc.driver.T4CDateAccessor." 
• 변수명 오타 
  •  java.sql.SQLSyntaxErrorException: ORA-00904: "COLUMN_NAME": invalid identifier 
• mapper 안의 쿼리태그 id 중복으로 인한 오류
  
  • java.lang.IllegalArgumentException: Mapped Statements collection already contains value for namespace.mapperId
• 오라클 데이터베이스 버전에서 지원하지 않는 SQL 표준 구문 사용
  • FETCH FIRST ROW ONLY
  •  bad SQL grammar []; nested exception is java.sql.SQLSyntaxErrorException: ORA-00933: SQL command not properly ended 
• mapper의 sql문 에 세미콜론을 입력함
  •  bad SQL grammar []; nested exception is java.sql.SQLSyntaxErrorException: ORA-00911: invalid character 
• 조회결과 타입 클래스의 필드 수와 데이터베이스에서 조회하는 컬럼의 숫자가 일치하지 않을 때
  •  ### Error querying database. Cause: java.lang.IndexOutOfBoundsException: Index 7 out of bounds for length 7 
• 조건절에서 Enum의 값 비교조건을 넣은 부분에서 나는 오류
  •  java.lang.IllegalArgumentException: invalid comparison: com.study.student.giantUtil.ApprovalStatus and java.lang.String 
  • 해결방법 : mapper로 값을 전달할 때 Enum그대로가 아니라 문자열로 전달해서 문자열 비교가 가능하게 하기
  • String approvalStatusStr = searchCondition.getApprovalStatus() != null ? searchCondition.getApprovalStatus().name() : null;
  • map.put("approvalStatus",approvalStatusStr);