[Spring] JDBC: Spring, MyBatis (Day 56)

[🔗JDBC Java 코드]

- 🔧 초기 세팅

• DB 연결을 위해서는 라이브러리 사용 등 기본 세팅 필요.
  자세한 건 아래 링크 기본세팅 메뉴 참고
  https://velog.io/@kimmy25312/DB-1-%EA%B8%B0%EB%B3%B8-%EC%84%B8%ED%8C%85-%EA%B8%B0%EB%B3%B8-%EA%B0%9C%EB%85%90-DDL-%EB%AA%85%EB%A0%B9%EC%96%B4-Day-53#--2-sql-developer-%EA%B8%B0%EB%B3%B8-%EC%84%B8%ED%8C%85

- 🍦 Vanilla 코드

1. @Repository 클래스에 생성자를 통해 DB 전용 드라이버 로딩
   -- Class.forName("org.mariadb.jdbc.Driver");

2. DriverManager.getConnection(url, username, password)로 DB에 연결한 후

3. Connection.preparedStatement(sql)을 통해 sql 쿼리 세팅

4. PreparedStatement.setLong() 등을 통해 쿼리의 ? 값을 세팅

5. PreparedStatement.update(sql) : 조회 제외
   PreparedStatement.query(sql) : 조회 -> ResultSet 반환

6. (조회의 경우)
   while(ResultSet.next()) {
   Long field1 = ResultSet.getLong(column1)
   new Product(field1, field2)
   }

@Repository
public class PersonRepository {

    // Database에 로그인할 정보
    private String username = "root";
    private String password = "joder9141";
    // 데이터베이스가 설치된 주소 (JDBC URL)
    private String url = "jdbc:mariadb://localhost:3306/practice";

    // 전용 드라이버 클래스
    private String driverClassName = "org.mariadb.jdbc.Driver";

    // 데이터베이스 전용 드라이버 로딩
    public PersonRepository() {
        try {
            // 전용 로딩 클래스 - DB마다 다름
            Class.forName(driverClassName);
        } catch (ClassNotFoundException e) {
            System.out.println("DB 연결 실패!");
        }
    }
    
    // 다중 SELECT - 목록 조회
    public List<Person> findAll() {
        String sql = """
                    SELECT * FROM tbl_person
                """;

        List<Person> personList = new ArrayList<>();

        try {
            // 1. DB에 접속하고 접속 정보를 받아옴
            Connection conn = DriverManager.getConnection(url, username, password);

            // 2. SQL을 실행할 수 있는 실행기 객체를 가져옴
            PreparedStatement pstmt = conn.prepareStatement(sql);

            // 3. ?값을 세팅

            // 4. SQL 실행 명령
            //   4-a : 갱신(INSERT, UPDATE, DELETE) 명령 : executeUpdate()
            //   4-b : 조회(SELECT) 명령                 : executeQuery()

            // ResultSet : 조회결과로 나오는 2차원의 표
            //   -> 표에 접근하여 데이터를 조작할 수 있다.
            ResultSet rs = pstmt.executeQuery();


            // next(): 포인터를 한 행씩 이동
            while (rs.next()) {
                // 커서가 가리키는 행의 데이터 추출
                long id = rs.getLong("id");
                String personName = rs.getString("person_name");
                int age = rs.getInt("age");

                Person p = new Person(id, personName, age);
                System.out.println("p = " + p);

                personList.add(p);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return personList;
    }


}

- 🌱 Spring 코드

[ 1. 기본 세팅 ]

• main > resources > application.xml 파일 생성 후 아래와 같이 설정

// maria DB 기준
spring:
   datasource:
      url: jdbc:mariadb://localhost:3306/practice
      username: root
      password: 설정 비밀번호
      driver-class-name: org.mariadb.jdbc.Driver

[ 2. 작동 원리 ]

🔶 1) yml 파일에서 db 연결 세팅을 한다(id, password, driver, url)

• 위의 기본 세팅 내용 참고
  
  

🔶 2) JDbcTemplate로 DB와 통신하기 위해 JbcTemplate를 @Autowired로 생성

@Autowired
 prive final JdbcTemplate jdbcTemplate;

- 혹은 class를 @RequiredArgsConstructor로 하고, private final JdbcTemplete 변수명;

@RequiredArgsConstructor  // final 필드만 골라내서 생성자 만듬
 public class ProductRepository {
    private final JdbcTemplate jdbcTemplate; // 의존객체는 final처리

🔶 3) DB 명령어를 만들어 준다.

🔶 4) 명령어를 DB에 명령해 준다.
     🔹SELECT 외 : JdbcTemplate.update(실행할 SQL 명령어, SQL에서 ?로 표시되는 자리의 값)

int result = jdbcTemplate.update(
  "DELETE FROM scores WHERE id = ?", // 실행할 sql 명령어) 
  Product.getId() // 위의 sql 명령어에서 ? 부분에 들어갈 값 
);

     🔹SELECT에서 DB 전체 조회 :
          
          - i. List< T > result = jdbcTemplate.query(String sql, RowMapper< T > rowMapper);
           => **rowMapper 부분 쓰는 방법은 아래 참고

 	   // 1. 익명클래스 사용
	  //  - 작동 원리 : query로 반환된 REsultSet의 각 행을 돌아가면서, 
	  // product 객체로 만들고, 그 product를 담은 list를 만든다.
 	 new RowMapper<Product> {
   	    @Override
   	    public Product mapRow(ResultSet rs, int rowNum) throws SQLException {
  	       		return new Product(rs);
   	    });
  
  	// 2. 람다식
 	(rs, rawNum) -> new Product(rs);
 

      - ii. JdbcTemplate.query(sql, new BeanPropertyRowMapper(DB에서 변환하고자 하는 객체형태.class)

	  //jdbcTemplate.query(sql, new BeanPropertyRowMapper(db를 변환하고자 하는 객체 타입.class);
	  return jdbcTemplate.query("""
   	  SELECT * FROM products
   	  """,
      new BeanPropertyRowMapper<>(Product.class));

     🔹SELECT에서 DB 전체 조회 :
          - List< T > result = jdbcTemplate.queryForObject(String sql, RowMapper< T > rowMapper, 필터링 값);

    public Board findOne(Long id) {
      return jdbcTemplate.queryForObject("""
              SELECT * FROM tbl_board
              WHERE id = ?
              """, new BeanPropertyRowMapper<>(Board.class)
              , id);
  }

🔶 조회 최적화를 위해, Service 클래스에 @Transactional(readOnly=true)을 해준다.

- 🔌 MyBatis 코드

[ 1. 기본 세팅 ]

• src > resources > application.yml 파일에 아래와 같이 코드 작성

# database setting
Spring: 
  datasource:
    url: jdbc:mariadb://localhost:3306/practice
    username: root
    password: ****
    driver-class-name: org.mariadb.jdbc.Driver

# MyBatis Setting 
  mybatis:
    # sql file location
    #  - @Mapper가 붙어 있는 인터페이스의 메소드를 호출하면
    #  - mapper-locations 폴더에서 resource>적어놓은 경로>적어놓는 확장자의 파일을 찾아서 그 파일에서 해당 메소드와 연결도니 쿼리를 찾아서 실행해라
    mapper-locations: classpath:mapper/**/*.xml
    # 반환할 객체의 package 주소
    type-aliases-package: com.spring.mvcproject.database.mybatis
    # 니네가 DB column 이름이 aa_bb면 객체 필드명을 aaBb로 하면 내가 알아서 db랑 객체랑 mapping 해줄께
    configuration:
      # Java 필드명과 DB 칼럼명 간의 이름 매핑 설정
      # DB 칼럼명이 aa_bb인 경우, Java 객체의 필드명을 aaBb로 자동 매핑
      map-underscore-to-camel-case: true

[ 2. 작동 원리 ]

🔶 DB<->객체 간의 변환을 위한 entity 객체 생성

     - @EqualAndHashCode(of="id")
      : id가 같으면 같은 객체로 판단

     - @Builder (lombok 라이브러리)
      : Employee.builder.필드명(필드값).build()하면 알아서 this.필드명 = 필드값 생성

🔶 @Mapper 인터페이스를 만든다.
     - Repository 역할을 하는 인터페이스로,
       @Mapper을 붙임으로써 이 인터페이스에 정의된 메소드가 호출되면,
       resources>application.yml 파일의 MyBatias:Configuration:mapper-locations에서 지정된 경로에서 매핑된 SQL를 찾아 실행한다.

@Mapper
public interface PetRepository {


    // Create: spring이나 vanilla code와 달리, **boolean 이 반환됨**
    boolean save(Pet pet);

    // Read - Single Matching
    Pet findById(Long id);

    // Read - Multiple Matching
    List<Pet> findAll();

    // Read - Count
    int petCount();

    // Update : spring이나 vanilla code와 달리, **boolean 이 반환됨**
    boolean updatePet(Pet pet);

    // Delete - Single : spring이나 vanilla code와 달리, **boolean 이 반환됨**
    boolean deleteById(Long id);

🔶 resources>application.yml 파일의 MyBatias:Configuration:mapper-locations에서 지정된 경로에 파일을 만들어, SQL쿼리를 매핑

<?xml version="1.0" encoding="UTF-8"?>
<!-- mapper 태그로 시작되며, 규칙은 "" 안에 있는 주소의 규칙을 따른다. -->
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- namespace: 연동할 인터페이스의 풀네임  -->
<mapper namespace="com.spring.mvcproject.database.mybatis.repository.PetRepository">

    <!-- [구조]
          <쿼리종류(insert/select/update/delete)
                id="@Mapper 클래스의 어떤 메소드가 호출될때 이 쿼리를 실행하 것인가"
                    (DB의 정보를 추출하여 클라이언트에게 전달할 경우) resultType="DB 내용을 어떤 형태(객체, int 등)로 변환할 것인가"
           >
                  쿼리문
                  (클라이언트에게 메소드의 인자로 받은 값을 사용하려면, #{인자} 혹은 #{인자인 객체의 필드명})
          </쿼리닫기>
    -->
    <insert id="save" keyProperty="id", useGeneratedKeys="true">
        INSERT INTO tbl_pet
            (pet_name, pet_age, injection)
        VALUES
        --  클라이언트에게 메소드의 인자로 Pet을 받았는데(Pet 클래스의 save() 메소드 paraemter보면 Pet을 받음),
        --  DB의 pet_Name 칼럼의 값을 Values을 클라이언트에게 전달받은 Pet 객체의 petName 필드 값으로 넣어달라.
            (#{petName}, #{petAge}, #{injection})
    </insert>

    <!--  select는 resultType(DB를 어떤 것으로 변환할 것인지를 풀 네임으로) 필수 -->
    <!-- 원래는 com.spring.mvcproject.database.mybatis.Pet인데 귀찮으니까 설정파일에서 type-aliases-package에 지정-->
    <select id="findById" resultType="Pet"> 
        SELECT * FROM tbl_pet
        WHERE id = #{id}
        -- PetRepository 인터페이스의
        -- (해당 인터페이스는 @Mapper가 설정되어 있어야 하며, 이 파일에서도 mapper namespace에 해당 인터페이스가 설정되어 있어야 함) 
        -- findById(Long id) 메소드가 호츨되면 (id = "findById")
        --    ->  해당 쿼리를를 실행해라.
        --    -> 이 때, WHERE id = 의 조건은 findById(Long id)의 인자인 id를 써라.
        --    -> 그리고 next()을 하면서 한 줄 한 줄 돌아가면서 (resultType="Pet"이므로) Pet 객체로 바꿔줘라.
    </select>

}
  
 

</mapper>

🔶 sql 심화 과정
** 1) if문을 mybatis에 적용하기 ( when test , otherwise, choose )

• repository가 public User getUserData(String userRole) 일 때, 아래와 같이 mapper짤 수 있음
  

🔶 조회 최적화를 위해, Service 클래스에 @Transactional(readOnly=true)을 해준다.