오늘의 이야기

 

Eclipse에서 MyBatis XML Schema 검증 방법

xml 검증 방안

 

MyBatis를 사용할 때 XML 매퍼 파일은 SQL 실행의 핵심입니다. 하지만 문법 오류나 매핑 문제로 인해 The error may exist in SQL 같은 에러가 발생할 수 있습니다. 이를 예방하기 위해 Eclipse에서 Schema(DTD) 검증을 설정하는 방법을 정리했습니다.

1. DTD 선언 추가

매퍼 XML 상단에 MyBatis 공식 DTD를 선언해야 Eclipse가 문법 검증을 수행합니다.

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

이 선언이 없으면 Eclipse는 단순 XML로 인식해 검증을 하지 않습니다.

2. XML Validation 활성화

• Eclipse 메뉴에서 Window → Preferences → XML → XML Files → Validation으로 이동합니다.


• Enable automatic validation 옵션을 켜면 저장 시 자동으로 XML 검증이 실행됩니다.

3. 프로젝트 속성 설정

• 프로젝트 우클릭 → Properties → Validation 메뉴에서 XML Validator를 활성화합니다.


• 빌드 시점 또는 수동으로 검증을 실행할 수 있습니다.

4. MyBatis Eclipse Plugin 활용

MyBatis 전용 Eclipse 플러그인을 설치하면 매퍼 XML에 대한 문법 검증과 코드 자동 완성을 지원합니다. 매퍼 인터페이스와 XML 매핑 관계도 자동으로 확인할 수 있어 오류를 줄일 수 있습니다.

5. 수동 검증

XML 파일을 열고 Right Click → Validate를 실행하면 Eclipse가 DTD 기반으로 문법 검증을 수행합니다.

Tip: Eclipse에서 MyBatis XML을 제대로 검증하려면 DTD 선언을 반드시 추가하고, Eclipse의 XML Validator를 활성화하는 것이 핵심입니다.

6. MyBatis XML 검증 체크리스트

• DTD 선언: 매퍼 파일 상단에 올바른 DOCTYPE 선언이 있는가?


• 태그 구조: <mapper>, <select>, <insert>, <update>, <delete> 태그가 올바르게 닫혀 있는가?


• ID 매핑: XML의 id 값과 매퍼 인터페이스 메서드명이 일치하는가?


• 파라미터 바인딩: #{param} 구문이 올바르게 매핑되고 실제 값이 전달되는가?


• ResultType/ResultMap: 반환 타입이 DTO/VO 클래스와 정확히 일치하는가?


• SQL 실행: 로그에 출력된 SQL을 DB 툴에서 직접 실행했을 때 정상 동작하는가?


• Validation 설정: Eclipse XML Validator가 프로젝트에 활성화되어 있는가?

마무리

MyBatis XML 검증은 단순히 문법 오류를 잡는 것뿐 아니라, SQL 실행 오류를 사전에 예방하는 중요한 과정입니다. Eclipse 설정을 통해 자동 검증을 활성화하고 체크리스트를 활용하면 개발 효율성과 안정성을 크게 높일 수 있습니다.