Java Mybatis Alias 사용법

Mybatis Alias 사용법

 

마이바티스(MyBatis)에서 알리아스(Alias)는 매핑 구성 파일(XML 파일)에서 사용되는 간단한 이름 또는 닉네임을 의미합니다. 이를 사용하여 Java 클래스의 풀 패키지 이름을 대신하여 간결하고 읽기 쉬운 코드를 작성할 수 있습니다.

---

1. mapper.xml 에서 Alias 사용하기

 

 

일반적으로 MyBatis를 사용하면, 데이터베이스 테이블과 매핑되는 Java 클래스를 생성하게 됩니다. 이 때, 클래스의 풀 패키지 이름을 매핑 파일에 직접 사용할 수 있지만, 그 클래스의 알리아스를 지정하여 코드를 더 간결하게 만들 수 있습니다.
알리아스는 주로 XML 매핑 파일과 결과 매핑에서 사용됩니다. 예를 들어, XML 매핑 파일에서 SQL을 정의하거나 매개변수를 설정할 때 클래스의 풀 패키지 이름을 사용하는 대신, 해당 클래스에 알리아스를 설정하여 사용할 수 있습니다.
아래는 MyBatis에서 알리아스를 사용하는 방법의 예제입니다

 

1. Java 클래스에 알리아스 설정하기

// User.java
package com.example.domain;

public class User {
    private Long id;
    private String username;
    // getter and setter methods
}

2. XML 매핑 파일에서 알리아스 설정하기

<!-- UserMapper.xml -->
<mapper namespace="com.example.UserMapper">

  <!-- 알리아스 설정 -->
  <typeAlias type="com.example.domain.User" alias="User"/>

  <!-- SQL 정의에서 알리아스 사용 -->
  <select id="getUserById" resultType="User">
    SELECT * FROM users
    WHERE id = #{id}
  </select>

</mapper>

이제 UserMapper.xml에서 User라는 알리아스를 설정했습니다. 이렇게 하면 SQL 정의에서 결과 타입으로 User라고 지정하면, 실제로는 com.example.domain.User 클래스를 의미합니다. 이렇게 하면 패키지 이름을 매번 쓰는 번거로움을 줄이고 코드를 더 읽기 쉽게 만들 수 있습니다.

알리아스를 사용하면 코드 유지보수가 더욱 편리하고 가독성을 향상시킬 수 있습니다. 하지만 알리아스를 사용할 때에는 충돌을 피하기 위해 고유한 이름을 사용해야 합니다. 따라서 알리아스는 해당 클래스와 겹치지 않도록 신중하게 설정하는 것이 좋습니다.

---

반응형

2. mybatis-config.xml 에서 Alias 사용하기

 

이번에는 MyBatis의 구성 파일(mybatis-config.xml)에서 알리아스(Alias)를 설정하는 방법을 설명드리겠습니다. mybatis-config.xml은 MyBatis의 전역 설정을 담당하는 파일로서, MyBatis의 동작 방식에 대한 다양한 설정을 포함합니다.

알리아스를 설정하기 위해서는 mybatis-config.xml 파일에 <typeAliases> 요소를 추가하고, 그 안에 각 Java 클래스에 대한 알리아스를 설정합니다. 이렇게 하면 해당 알리아스를 매핑 파일에서 사용할 수 있게 됩니다.

 

아래는 mybatis-config.xml 파일에서 알리아스를 설정하는 예제입니다

<!-- mybatis-config.xml -->
<configuration>

  <!-- 기타 설정들 -->

  <!-- 알리아스 설정 -->
  <typeAliases>
    <!-- 클래스 이름과 알리아스 이름을 1:1로 매핑 -->
    <typeAlias type="com.example.domain.User" alias="User"/>
    <typeAlias type="com.example.domain.Product" alias="Product"/>
    <!-- 추가적인 알리아스 설정 -->
  </typeAliases>

</configuration>

위 예제에서는 <typeAliases> 요소 안에 <typeAlias> 요소를 사용하여 각 클래스에 대한 알리아스를 설정했습니다. type 속성에는 해당 클래스의 풀 패키지 이름을, alias 속성에는 설정하고자 하는 알리아스를 지정합니다.

 

이제 MyBatis 매핑 파일에서 설정한 알리아스를 사용할 수 있습니다. 이를 통해 매핑 파일에서 Java 클래스의 풀 패키지 이름을 사용하는 대신 알리아스를 더 간결하게 사용할 수 있습니다.

예를 들어, 이제 UserMapper.xml에서 <typeAlias>를 사용한 알리아스를 이용하여 SQL 정의를 할 수 있습니다

<!-- UserMapper.xml -->
<mapper namespace="com.example.UserMapper">

  <!-- SQL 정의에서 알리아스 사용 -->
  <select id="getUserById" resultType="User">
    SELECT * FROM users
    WHERE id = #{id}
  </select>

</mapper>

알리아스를 사용하면 코드의 가독성을 향상시키고 유지보수성을 높일 수 있습니다. 전역 설정인 mybatis-config.xml에서 한 번 알리아스를 설정하면, 해당 알리아스를 프로젝트 전체에서 사용할 수 있습니다.

 

마이바티스(MyBatis)의 mybatis-config.xml 파일을 사용하여 알리아스(Alias)를 설정하는 방법에 대해 설명드렸습니다.

간단히 요약하자면:

1. mybatis-config.xml  또는 mapper.xml 에 <typeAliases> 요소를 추가하여 알리아스를 설정합니다.
2. 각 <typeAlias> 요소 안에서 클래스의 풀 패키지 이름을 type 속성에 지정하고, 알리아스 이름을 alias 속성에 지정합니다.
3. 이렇게 설정한 알리아스를 MyBatis 매핑 파일에서 사용할 수 있습니다.

알리아스를 설정함으로써 코드의 가독성을 높이고 유지보수성을 향상시킬 수 있으며, XML 매핑 파일과 Java 클래스 간의 관계를 더욱 쉽게 파악할 수 있습니다.

MyBatis는 데이터베이스와 상호작용하는 강력한 도구로서, 동적 SQL 쿼리 작성과 매핑 설정 등 다양한 기능을 제공합니다. 앞으로 MyBatis를 활용하여 효율적인 데이터베이스 액세스를 구현하시길 바랍니다.

 

감사합니다.

 

 

 

2023.07.27 - [프로그래밍? 기록/Java] - Java Mybatis foreach 사용법

Java Mybatis foreach 사용법