[Mybatis] XML 주석 사용 예제

21 Aug 2023

mybatis

MyBatis에서는 XML 주석을 사용하여 SQL 매퍼 파일에서 주석을 작성할 수 있습니다. 주석은 SQL 쿼리나 매퍼 설정에 대한 설명, 메모, 문서화 등 다양한 용도로 활용할 수 있습니다. 아래는 XML 주석 사용 예제입니다.

예제: XML 주석 사용

<!-- UserMapper.xml -->
<mapper namespace="com.example.UserMapper">
    <!-- 이 쿼리는 사용자를 ID로 조회합니다. -->
    <select id="getUserById" resultType="User">
        SELECT * FROM users WHERE user_id = #{id}
    </select>
    
    <!-- 아래는 다중 주석입니다.
         여러 줄 주석은 이렇게 사용할 수 있습니다. -->
    
    <insert id="insertUser" parameterType="User">
        <!-- 이 쿼리는 사용자를 삽입합니다. -->
        INSERT INTO users (username, email) VALUES (#{username}, #{email})
    </insert>
</mapper>` 

위의 예제에서는 다양한 주석 스타일을 보여줍니다. 다중 줄 주석 ()과 한 줄 주석 ()을 사용하여 SQL 매퍼 파일에 주석을 추가했습니다.

주석은 코드의 가독성을 높이고 나중에 코드를 이해하거나 유지 관리할 때 도움이 됩니다. 특히 복잡한 SQL 쿼리나 복잡한 매퍼 설정을 다룰 때 주석을 활용하면 유용합니다.