💻 코딩 일기 : [Spring] 'MyBatis' 편

🔔 'MyBatis'에 대해서 알아보자!

💟 MyBatis

MyBatis : DB 액세스를 위한 자바 ORM 프레임워크입니다. SQL 쿼리와 자바 객체를 자동으로 매핑하는 기능을 가지고 있습니다.

• 동적쿼리에서 사용할 때 유용합니다.
• JDBC 보다 코드가 간결합니다.

💟 @SELECT

• 조회 결과의 컬럼명과 리턴타입의 객체 프로퍼티명이 같으면 값을 바인딩(할당) 해줍니다.
• 만약 컬럼명과 프로퍼티명이 다르다면 컬럼명을 AS를 사용하여 별칭을 정해주며 AS 키워드는 생략가능합니다.

Mapper02 인터페이스

@Mapper
public interface Mapper02 {

    @Select("SELECT * FROM Customers WHERE CustomerID = 1")
    MyBean254Customer selectOneCustomer2();

    @Select("""
            SELECT CustomerId id, CustomerName name, 
                    ContactName, Address, City, Country, PostalCode
            FROM Customers WHERE CustomerID = 1""")
    MyBean254Customer selectOneCustomer3();
}

• @Mapper 어노테이션을 사용하여 MyBatis mapper 인터페이스로 지정되었습니다.
• @Mapper가 붙은 인터페이스에 대해 자동으로 객체를 생성합니다.

Controller31.java

@Controller
@RequestMapping("main31")
@RequiredArgsConstructor
public class Controller31 {

    private final Mapper02 mapper; //Mapper 인터페이스 생성자 주입

    @GetMapping("sub3")
    public void method3(){
        MyBean254Customer c = mapper.selectOneCustomer2();
        System.out.println("c = " + c);
    }

    @GetMapping("sub4")
    public void method4(){
        MyBean254Customer c = mapper.selectOneCustomer3();
        System.out.println("c = " + c);
    }
}

• selectOneCustomer2()의 결과값은 c = MyBean254Customer(id=0, name=null, contactName=Maria Anders, address=Obere Str. 57, city=Berlin, country=독일, postalCode=12209) 이며 id, name이 컬럼명과 프로퍼티명이 같지 않아 값이 나오지 않습니다.

• selectOneCustomer3()의 결과값은 c = MyBean254Customer(id=1, name=Alfreds Futterkiste, contactName=Maria Anders, address=Obere Str. 57, city=Berlin, country=독일, postalCode=12209)이며 SQL 쿼리에서 별칭을 사용하여 컬럼명을 프로퍼티명과 같게 변경해주어서 모든 값이 나오게 합니다.

---

🟦 동적 처리하는 방법

• 리턴값이 여러 개일 경우 List 타입을 사용합니다. ex) 리턴타입이 한개면 MyBean254Customer 여러 개이면 List
• #{} 문법을 사용하여 SQL 쿼리의 파라미터를 바인딩합니다. 이 때 #{} 안에 적힌 이름은 메서드의 매개변수 이름과 일치해야 합니다.

@Mapper
public interface Mapper02 {
    @Select("""
            SELECT CustomerID id,
                   CustomerName name,
                   ContactName, Address, City, Country, PostalCode
            FROM Customers
            WHERE Country = #{country1} OR Country = #{country2}
            ORDER BY Country
            """)
    List<MyBean254Customer> selectCustomersByCountry(String country1, String country2);
}

• selectCustomersByCountry 메서드의 매개변수인 country1과 country2는 SQL 쿼리의 파라미터인 #{country1}과 #{country2}와 이름이 일치해야 합니다.

Controller31.java

@Controller
@RequestMapping("main31")
@RequiredArgsConstructor
public class Controller31 {
    private final Mapper03 mapper;

    @GetMapping("sub11")
    public void method11(){
        List<MyBean254Customer> list = mapper.selectCustomersByCountry("usa","uk");
        list.forEach(System.out::println);
    }
}

• selectCustomersByCountry() 메서드를 호출하여 미국(USA)과 영국(UK)에 해당하는 고객을 리스트에 저장하고, 그 리스트를 출력합니다.

💟 @Delete

• 해당 메서드가 데이터베이스에서 레코드를 삭제하는 SQL 쿼리를 나타냅니다.

Mapper02 인터페이스

@Mapper
public interface Mapper02 {
    @Delete("""
            DELETE FROM Customers WHERE CustomerId = #{id}
            """)
    int deleteOneCustomerByID(int id);
}

• 삭제 결과를 정수로 받을 필요가 없는 경우 리턴타입 void도 가능합니다.

Controller31.java

@Controller
@RequestMapping("main32")
@RequiredArgsConstructor
public class Controller32 {
    @GetMapping("sub2")
    public void method2(Integer cid){
        int rowCount = mapper.deleteOneCustomerByID(cid);
        System.out.println(rowCount + "명 고객 삭제됨");
    }
}

• cid 파라미터를 받아아서 해당 ID에 해당하는 고객을 삭제합니다.
• "/main32/sub2?cid=5"로 요청을 보내면 고객 id 5에 해당하는 고객이 삭제됩니다.

💟 @Insert

• 해당 메서드가 데이터베이스에서 레코드를 추가하는 SQL 쿼리를 나타냅니다.

Mapper02 인터페이스

@Mapper
public interface Mapper02 {
    @Insert("""
            INSERT INTO Customers(CustomerName, ContactName, Address, City, PostalCode, Country)
            VALUES (#{name}, #{contactName}, #{address}, #{city}, #{postalCode}, #{country})
            """)
    int insertCustomer(MyBean254Customer customer); 

}

• MyBean254Customer 객체의 프로퍼티에 직접 접근하여 값을 바인딩합니다.

Controller32.java

@Controller
@RequestMapping("main32")
@RequiredArgsConstructor
public class Controller32 {

    private final Mapper03 mapper;
    
    @GetMapping("sub5")
    public void method5(){
        // form이 있는 view 포워딩
    }

    @PostMapping("sub5")
    public String method6(MyBean258Employee employee, RedirectAttributes redirectAttributes){
        int rowCount = mapper.insertEmployee(employee);
        if (rowCount>0){
            redirectAttributes.addFlashAttribute("message", rowCount+"명 직원이 등록되었습니다.");
        }else{
            redirectAttributes.addFlashAttribute("message", "등록되지 않았습니다");
        }
        return "redirect:/main32/sub5";
    }
}

• GET 요청으로 입력 폼을 보여주고, POST 요청을 사용하여 폼에서 입력한 데이터를 추가해줍니다. 데이터 추가가 끝나면 리다이렉트로 인해 다시 GET 요청으로 입력 폼을 보여줍니다.
• mapper.insertEmployee(employee); 으로 인해 직원 등록 여부에 따른 메시지를 표시합니다.

sub5.jsp(view)

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="jakarta.tags.core" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<c:if test="${not empty message}">
    ${message}
</c:if>
<h3>직원 입력</h3>
<hr>
<div>
    <form method="post">
        <div>
            lastName <input type="text" name="lastName">
        </div>
        <div>
            firstName <input type="text" name="firstName">
        </div>
        <div>
            생일 <input type="date" name="birthDate">
        </div>
        <div>
            photo <input type="file" name="photo">
        </div>
        <div>
            노트 :
            <textarea rows="10" cols="30" name="notes"></textarea>
        </div>
        <div>
            <input type="submit" value="등록">
        </div>
    </form>
</div>

</body>
</html>

---

결과 View

데이터 삽입

---

@Options

@Options(useGeneratedKeys = true, keyProperty = "id") 어노테이션은 MyBatis에서 사용되는 것으로, 주로 데이터베이스의 자동 증가(primary key) 필드에 대한 설정을 지정할 때 사용됩니다.

• useGeneratedKeys = true: 데이터베이스가 자동으로 생성하는 키를 사용한다는 것을 지정합니다. 즉, 데이터베이스에 새로운 레코드를 삽입할 때 해당 키를 자동으로 생성하도록 합니다.
• keyProperty = "id": 자동 생성된 키를 매핑할 자바 객체의 속성을 지정합니다. 여기서 "id"는 자동 생성된 키를 받아들일 객체의 속성명을 의미합니다. 이 속성에는 자동 생성된 키의 값을 저장합니다.

예를 들어, 다음은 MyBatis XML 매퍼 파일에서 @Options 어노테이션을 사용하여 자동 생성된 키를 설정하는 예시입니다:

@Insert("""
            INSERT INTO Customers(CustomerName, ContactName, Address, City, PostalCode, Country)
            VALUES (#{name}, #{contactName}, #{address}, #{city}, #{postalCode}, #{country})
            """)
  @Options(useGeneratedKeys = true, keyProperty = "id")
  int insertCustomer(MyBean254Customer customer); 

useGeneratedKeys="true"를 설정하여 데이터베이스에서 자동 생성된 키를 사용하도록 지정하고, keyProperty="id"를 설정하여 해당 키를 User 객체의 id 속성에 매핑하고 있습니다. 이렇게 함으로써 MyBatis는 데이터베이스에서 자동 생성된 키를 User 객체에 자동으로 할당할 것입니다.

💟 @Update

• 해당 메서드가 데이터베이스에서 레코드를 수정하는 SQL 쿼리를 나타냅니다.

Mapper 인터페이스

@Mapper
public interface Mapper02 {
    @Select("""
            SELECT EmployeeID id,
                   FirstName,
                   LastName,
                   Notes,
                   Photo,
                   BirthDate 
            FROM Employees
            WHERE EmployeeID = #{id}
            """)
    MyBean258Employee selectOneEmployee2(Integer id);
}

@Mapper
public interface Mapper03 {
    @Update("""
            UPDATE Employees 
            SET LastName = #{lastName}, FirstName = #{firstName}, 
                     BirthDate = #{birthDate}, Photo = #{photo}, Notes = #{notes}
            WHERE EmployeeId = #{id}
            """)
    int updateEmployee(MyBean258Employee employee);
}

• 수정하기 위해서는 먼저 해당 직원의 정보를 조회하는 SELECT 쿼리와 수정하는 UPDATE 쿼리 모두 필요합니다.

Controller32.java

@Controller
@RequestMapping("main32")
@RequiredArgsConstructor
public class Controller32 {

    private final Mapper03 mapper;
    private final Mapper02 mapper02;

    @GetMapping("sub6")
    public void method7(@RequestParam(value = "id", required = false) Integer eid, Model model){
        if(eid != null){
            MyBean258Employee e = mapper02.selectOneEmployee2(eid);
            model.addAttribute("employee", e);
        }
    }

    @PostMapping("sub6/update")
    public String method8(MyBean258Employee employee, RedirectAttributes redirectAttributes){
        int rowCount = mapper.updateEmployee(employee);
        if (rowCount>0){
            redirectAttributes.addFlashAttribute("message", rowCount+"명 직원이 수정되었습니다.");
        }else{
            redirectAttributes.addFlashAttribute("message", "수정되지 않았습니다");
        }
        redirectAttributes.addAttribute("id", employee.getId());
        return "redirect:/main32/sub6";
    }
}

• 수정하기 전에 GET 방식으로 아이디를 입력받아 조회된 결과를 보여줍니다.
• POST 방식으로 데이터를 수정하고 리다이렉트로 인해 다시 GET 요펑으로 조회 폼을 보여줍니다.
• redirectAttributes.addAttribute("id", employee.getId()); : 수정된 직원 아이디를 다시 조회 페이지로 전달하기 위해 사용합니다.
  • 이 코드는 redirectAttributes 객체의 addAttribute() 메서드를 사용하여 id라는 이름의 쿼리 파라미터에 employee.getId()로부터 얻은 직원의 아이디를 전달하면 리다이렉트될 URL에 id 파라미터가 추가되어 직원의 아이디가 포함된 URL이 생성됩니다.

sub6.jsp(view)

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="jakarta.tags.core" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h3>직원 조회 및 수정</h3>
<c:if test="${not empty message}">
    ${message}
</c:if>
<form>
    번호
    <input type="number" name="id">
    <button>조회</button>
</form>
<hr>
<c:if test="${empty employee}">
    조회된 직원이 없습니다.
</c:if>
<c:if test="${not empty employee}">
    <h3>${employee.id}번 직원</h3>
    <form action="/main32/sub6/update" method="post">
        <div>last name
            <input type="text" value="${employee.lastName}" name="lastName"></div>
        <div>first name
            <input type="text" value="${employee.firstName}" name="firstName"></div>
        <div>birth
            <input type="date" value="${employee.birthDate}" name="birthDate"></div>
        <div>
            photo
            <input type="file" value="${employee.photo}" name="photo">
        </div>
        <div>notes
            <textarea name="notes" id="" cols="30" rows="10">${employee.notes}</textarea></div>
        <div style="display: none">
            <input type="text" name="id" value="${employee.id}">
        </div>
        <div>
            <input type="submit" value="수정">
        </div>
    </form>
</c:if>
</body>
</html>

• 조회된 데이터를 수정하는 경우, 폼의 각 입력 필드에는 수정할 데이터의 현재 값을 보여주기 위해 value 속성을 사용해야 합니다.
• 수정된 데이터를 서버로 제출할 때 각 입력 필드의 name 속성은 해당 데이터 객체의 프로퍼티명과 일치해야 합니다.

---

birth를 1968-12-08에서 1968-12-20으로 수정

📢 프로퍼티는 자바빈의 속성을 말합니다.

@Data
@AllArgsConstructor
@NoArgsConstructor
public class MyBean254Customer {
    private int id;
    private String name;
    private String contactName;
    private String address;
    private String city;
    private String postalCode;
    private String country;
}

자바빈의 프로퍼티 명과 JSP에서 사용할 때의 name 속성을 매칭시켜야 합니다. 이렇게 하면 JSP에서 폼을 사용하여 데이터를 전송할 때, 각 입력 필드의 이름이 해당 프로퍼티와 일치하게 됩니다. 이는 서버 측에서 이러한 이름을 통해 폼 데이터를 수신하고 처리할 때 유용합니다.

• 마이바티스(MyBatis)에서는 SQL 쿼리에 파라미터 값을 바인딩하기 위해 # 기호를 사용합니다. # 기호 내에는 객체의 프로퍼티를 지정할 수 있으며, 이는 객체의 getter 메서드를 통해 값을 가져옵니다. 따라서 주어진 updateCustomer 메서드에서는 MyBean254Customer 객체의 프로퍼티 값을 가져와서 SQL 쿼리에 바인딩합니다.