$$config title: Spring 에서의 JDBC keywords: - IT - Java - JDBC - Spring - WEB $$ # 관련 링크 모음 - 관련 링크 [github.blog](https://velog.io/@ddusi/Spring-1) - 관련 링크 [tistory.blog](https://sas-study.tistory.com/160) - 관련 링크 [tistory.blog](https://victorydntmd.tistory.com/321) - 관련 링크 [blog.com](https://pyxispub.uzuki.live/?p=1715) - 관련 링크 [blog.com](https://jogeum.net/6) --- # #1. 순수 JDBC를 이용한 JDBC Driver를 구현하여 DB 접근 - 스프링 프레임워크에서는 JDBC JPA를 제공하고 있다. 따라서, 이전 Servlet과 JSP만을 이용한, 혹은 그 이전의 방식대로 JDBC를 구현하여 사용할 필요가 없어진 것이다. 그러나 JDBC를 제대로 사용하기 위하여, 원리를 알고 있어야 하는 것이 보다 나을 수 있기 때문에, Spring에서 제공하는 JPA를 사용하지 않고 순수 JDBC만을 이용하여 원리를 파악해보고 그 내용을 정리하여 보았다. - 다음은 내용을 진행하기 이전 실습의 환경에 대한 가정이다. ``` - 1. 스프링부트를 이용하였다. - 2. MySQL(MariaDB)를 이용하였다. - 3. Intelli J를 사용하여 실습을 진행하였다. - 4. 사용된 빌드툴은 Gradle이다. ``` - 첫째로, 스프링에서 JDBC를 구현하기 위해서는 사용하고자 하는 DB와 관련한 의존성을 주입해주어야 한다. 만일, 프로젝트 생성시 해당 의존성을 주입한 상태로 프로젝트를 생성하였다면, 진행하지 않고 넘어가도 되는 부분이다. 내용은 예제와 같다. ```java dependencies { implementation 'org.springframework.boot:spring-boot-starter-jdbc' implementation 'org.springframework.boot:spring-boot-starter' runtimeOnly 'mysql:mysql-connector-java' testImplementation 'org.springframework.boot:spring-boot-starter-test' } ``` - DB관련 의존성 주입을 완료하였다면, 어플리케이션에게 데이터베이스와 관련된 정보를 알려주어 데이터베이스에 정상적으로 접속할 수 있도록 환경을 마련해주어야 한다. application.properties에 관련 예제의 내용을 입력하여 데이터베이스와 관련된 속성을 입력한다. ``` java spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/example?serverTimezone=UTC&characterEncoding=UTF-8 spring.datasource.username="DB아이디" spring.datasource.password="DB비밀번호" /* datasource.url과 관련된 추가정보 ?useUnicode=true&characterEncoding=utf8&autoReconnect=true&serverTimezone=Asia/Seoul&useOldAliasMetadataBehavior=true&zeroDateTimeNehavior=convertToNull&connectTimeout=60 */ ``` - 예제에서 각각의 정보는 다음과 같다. ``` - 1. datasource.driver-class-name : 사용하고자 하는 jdbc driver 클래스명 - 2. datasource.url : DB와의 연결정보를 나타낸다 각각의 내용은 다음과 같음, 더 많은 정보는 예제의 하단에 추가정보를 확인해보면 된다. - jdbc:mysql://"DB 호스트":"포트번호"/"DB이름" - ?serverTimezone=UTC : URL 쿼리 스트링에 serverTimezone을 작성함 - characterEncoding=UTF-8 : UTF-8로 인코딩함 - 3. datasource.username : DB아이디 를 입력한다. - 4. datasource.password : DB 비밀번호 를 입력한다. ``` - 예제는 데이터베이스와의 커넥션 관련 정보이다. 예제를 참고하여 커넥션 정보를 작성한 뒤, 프로젝트 내부의 application.properties에 추가하여 속성을 부여해주어야만 DB와 정상적으로 연결이 된다. - 예제를 통하여 DB와의 연결을 마쳤으면, 다음으로는 DB에 전송할 sql을 작성하여야 한다. prestatement로서 작성하는 방법은 다음의 예제와 같고, 만일 왜 prestatement를 작성해야 하는지 모른다면, 이전 php의 sqlInjection 공격에 관한 내용을 참고하자. ```java // DB에 전송할 쿼리문을 작성한다. preStatement String sql = "INSERT INTO `member` SET `name` = ?"; // DB와의 연결과 관련된 정보를 담을 변수들을 선언 Connection conn = null; PreparedStatement pstmt = null; // DB통신과의 결과를 담을 변수 ResultSet rs = null; // DB연결과 관련된 핵심 로직 try { // DB와의 커넥션을 불러와 할당한다. conn = getConnection(); // 우선 작성된 sql을 저장하고, prestatement의 RETURN_GENERATED_KEYS라는 옵션을 사용한다. // RETURN_GENERATED_KEYS는 DB에 Insert한 후, 리턴받을 번호를 가져오는 옵션이다. pstmt = conn.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS); // 첫번째 ?와 member의 name을 매핑하여 치환한다. pstmt.setString(1, member.getName()); // DB에 실제 쿼리가 발송된다. pstmt.executeUpdate(); // RETURN_GENERATED_KEYS 로 얻은 값을 불러와서 rs에 저장한다. rs = pstmt.getGeneratedKeys(); // 값이 있으면 불러오고 if (rs.next()) { member.setId(rs.getLong(1)); } else { // 그렇지 않으면 실패를 리턴한다. throw new SQLException("id 조회 실패"); } return member; } catch (Exception e) { throw new IllegalStateException(e); } finally { // DB와의 통신이 종료되면 반드시 연결을 종료해주어야 한다. close(conn, pstmt, rs); } ``` - DB와의 통신을 통한 정보를 불러오는 예제는 상기의 예제 그리고 그 주석과 같다. 여기서 연결을 종료하는 메소드를 다시 한 번 살펴보면 하기와 같다. ```java // DB와의 연결을 종료하는 메소드 private void close(Connection conn, PreparedStatement pstmt, ResultSet rs) { // 역순으로 DB와의 연결을 종료한다. try { if (rs != null) { rs.close(); } } catch (SQLException e) { e.printStackTrace(); } try { if (pstmt != null) { pstmt.close(); } } catch (SQLException e) { e.printStackTrace(); } try { if (conn != null) { close(conn); } } catch (SQLException e) { e.printStackTrace(); } } ``` - 작성된 예제외에도 더 나은 방법들이 존재한다. 그러나 실제로 현재 이 로직들은 잘 사용되지 않기 때문에 고전스타일로 작성된 예제이며, 에제는 DB에 데이터를 추가하는 기능을 주제로 작성된 것임으로, 만일 데이터 조회, 삭제, 수정 등 다른 로직이 필요할 때는 쿼리문과 옵션 등을 수정하여 작성할 수 있다. - 참조 1) - 커넥션을 획득할 때, ```java public JdbcMemberRepository(DataSource dataSource) { this.dataSource = dataSource; } ``` - 에서 dataSource.getConnection() 과 같이 직접 획득할 수 도 있으나, 트랜젝션등의 문제가 발생할 수 있으니, ```java private Connection getConnection() { return DataSourceUtils.getConnection(dataSource); } ``` - 상기와 같이 획득하면 커넥션이 유지됨으로 트랜젝션의 문제에서 보다 안전할 수 있다. # #2. Spring JDBC Template를 이용한 DB 접근 - 실습 설정은 이전 내용인 순수 JDBC와 같다. 참고하여 세팅하여 준다. - 스프링 JDBC Tempalte는 MyBatis와 비슷한 기능을 제공한다. JDBC Template와 MyBatis와 같은 라이브러리들은 JDBC의 API에서 반복코드를 대부분 제거해준다. 그러나 SQL은 직접 작성하여야 한다. ```java // 데이터베이스에서 넘어온 데이터를 DTO의 객체와 매핑해주어 할당하는 로직 private RowMapper memberRowMapper() { // RowMapper라는 클래스를 이용한다. return new RowMapper() { @Override public Member mapRow(ResultSet rs, int rowNum) throws SQLException { // 우선 매핑할 객체를 생성 Member member = new Member(); // 해당 객체의 Id 필드에 rs(DB와의 통신으로 얻은 결과)의 long데이터타입 key가 "id"인 값을 할당 member.setId(rs.getLong("id")); // 해당 객체의 name 필드에 rs(DB와의 통신으로 얻은 결과)의 String데이터타입 key가 "name"인 값을 할당 member.setName(rs.getString("name")); return member; } } } // 상기 코드를 람다식으로 변경 private RowMapper memberRowMapper() { // RowMapper라는 클래스를 이용한다. return (rs, rowNum) -> { // 우선 매핑할 객체를 생성 Member member = new Member(); // 해당 객체의 Id 필드에 rs(DB와의 통신으로 얻은 결과)의 long데이터타입 key가 "id"인 값을 할당 member.setId(rs.getLong("id")); // 해당 객체의 name 필드에 rs(DB와의 통신으로 얻은 결과)의 String데이터타입 key가 "name"인 값을 할당 member.setName(rs.getString("name")); return member; } } ``` - RowMapper를 이용하여 발송될 sql과 프로젝트 내부 bean의 필드와 매핑을 한 다음, ```java @Override public Optional findById(Long id) { List result = jdbcTemplate.query("SELECT * FROM `member` WHERE `id` = ?", memberRowMapper()); // 결과는 List에 담긴다. stream하여 List내부의 요소들을 전부 꺼낸다음, findany로 요소를 담아 리턴하면 된다. return result.stream().findAny(); } ``` - 해당 기능 로직에 상기와 같이 연결해준다면 DB접근 및 데이터 조회를 간단히 끝낼 수 있다. 데이터베이스에 데이터 삽입 예제는 다음과 같다. ```java @Override public Member save(Member member) { // SimpleJdbcInsert 객체는 jdbcTemplate를 주입받아 생성되는 인스턴스이다. SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate); // SimpleJdbcInsert를 이용하면, 이전에 순수하게 JDBC로만 구현한 것처럼 // generate key 옵션을 사용할 필요도 없고, 쿼리를 작성할 필요도 없이 하기 메소드만 있으면 // 해결된다. jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id"); Map parameters = new HashMap<>(); parameters.put("name", member.getName()); Number key = jdbcInsert.executeAndReturnKey(new MapSqlParameterSource(parameters)); member.setId(key.longValue()); return member; } ``` - 전체 회원을 반환하는 예제는 다음과 같다. ```java @Override public List findAll() { return jdbcTemplate.query("SELECT * FROM `member`", memberRowMapper()); } ``` - jdbcTemplate는 List를 반환하기 때문에, RowMapper를 이용하여 맵핑만 해서 반환하면 원하는 값을 얻을 수 있다. # #3. JPA 를 이용한 DB 접근 - JPA에 관한 내용은 Java/JSP에서 한 번 다룬적이 있으므로 해당 내용을 참고하면 된다. - 이전장까지는 순수하게 JDBC를 구현하여 DB를 접근하는 방법을 학습하였고, 그 후 출범한 JDBC Template를 이용하여 DB를 접근하는 방법을 학습하였다면, 이제는 JPA를 통하여 DB에 접근하는 방법에 대해서 학습한다. - 이전장까지의 내용으로 JDBC의 구조 및 원리를 대략적으로 파악하였으니 본 장의 내용을 이용하여 DB와의 접근을 하면 되겠다. - JDBC Template가 반복적으로 사용되는 코드를 없애주고 SQL의 입력만을 요구하였다면, JPA는 더 나아가 SQL도 직접 JPA가 작성하여 명령을 수행한다. - JPA를 사용한다면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다. 따라서 생산성이 증대된다. - JPA를 사용하려면 JPA와 관련된 의존성을 주입하여야 한다. 다음과 같다. ```java // implementation "org.springframework.boot:spring-boot-starter-jdbc" implementation "org.springframework.boot:spring-boot-starter-data-jpa" ``` - 본 실습을 같이 진행하였다면, 상기 JDBC와 관련된 의존성은 삭제하여도 무방하다. JPA 의존성에 JDBC 관련 의존성이 같이 따라오기 때문에 data-jpa라는 의존성만 주입하여주면 충분하다. - 정상적으로 의존성 주입이 완료되었다면 External Libraries란에 하기의 의존성들이 자동으로 주입되어 있을 것이다. ```java Gradle : org.hibernate.common:hibernate-commons-annotaions:"버전" Gradle : org.hibernate:hibernate-core:"버전" ``` - JPA는, 이전 Java/JSP에서도 정리한 바와 같이, 인터페이스이다. JPA를 구현것이 hibernate와 eclipsLink와 같은 것들이 있다. - 해당 예제는 hiberante를 이용하여 진행한다. - JPA는 ORM이라는 기술이다. ORM은 문자 그대로 Object(객체)와 Relational(관계형 데이터베이스)를 Mapping(매핑)하는 기술이다. 이때 매핑을 위하여 어노테이션을 이용하는 것이다. - 또한 application.properties에 JPA와 관련된 세팅을 추가하여야 한다. 다음과 같다. ```java spring.jpa.show.sql=true spring.jpa.hibernate.ddl-auto=none //spring.jpa.hibernate.ddl-auto=create ``` - 설정의 상세는 다음과 같다. ``` - 1. spring.jpa.show.sql=true : JPA가 작성한 SQL을 확인할 수 있다. - 2. spring.jpa.hibernate.ddl-auto=none : JPA를 사용한다면, DB와 매핑할 객체를 확인하여 자동으로 테이블을 생성해 주는 기능이 있다. 따라서 해당 설정을 none으로 해준다면, 자동으로 테이블을 생성해 주는 기능을 사용하지 않을 수 있다. - none을 create로 변경하여 저장한다면, JPA가 테이블까지 생성하도록 설정할 수 있다. ``` - 설정까지 마쳤다면, 다음으로는 객체와 데이터베이스의 테이블을 매핑하기 위하여 어노테이션을 추가하여야 한다. ```java @Entity public class Member { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; } ``` - @Entity : 해당 어노테이션은 데이터베이스의 테이블과 일대일로 매핑되는 객체 단위이며, Entitiy 객체의 인스턴스 하나가 테이블 하나의 레코드 값을 의미한다. - 따라서 객체의 인스턴스를 구분하기 위하여 유일한 키값(Key Value)을 보유하게 되는데, 이것은 테이블의 Primary Key(PK)와 같은 의미를 지니며, 클래스명 아래의 @Id 어노테이션으로 표기된다. ```java @Entity public class Member { @Id private Long id; ... // 일 때, CREATE TABLE `member`( `id` BIGINT(20) UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT, ... // `member` 테이블에서 PRIMARY KEY(PK)는 `id` 컬럼이기 때문에, // `id`컬럼과 일대일로 매핑되는 Member 클래스의 id필드에 @Id 어노테이션을 부여한 것이다. ``` - @GeneratedValue : PRIMARY KEY(PK)칼럼의 데이터 타입은 정해져 있지는 않으나 구분 가능한 유일한 값을 가지고 있어야 한다. 또한, 데이터 경합으로 인하여 발생되는 데드락* 현상을 방지하기 위하여 대부분 Java의 Long타입을 이용한다. - String형태의 고정된 키값을 직접 생성하여 관리하기도 하지만, 대량의 요청이 유입되더라도 중복과 데드락이 발생되지 않을 만큼 키값이 빨리생성되고 안전하게 관리되어야 한다는 것이 중점이다. - 상기와 같은 이유로서, MySQL에 AUTO_INCREMENT 방식으로 컬럼에 속성을 부여하는데, 매핑되는 테이블에 AUTO_INCREMENT 속성을 추가하였다면, EntityManager* 에게 매핑되는 필드가 AUTO_INCREMENT 속성이 부여되었다는 것을 명기해주어야 한다. - 그 때 사용하는것이 GenerationType인데, GenerationType.IDENTITY로 지정하여 EntityManager에게 매핑된 필드가 테이블에서는 AUTO_INCREMENT 인 것을 알려주는 것이다. - 이 때, 자동으로 생성되는 값을 가지는 PK칼럼(PRIMARY KEY AUTO_INCREMENT)의 이름은 명시적으로 id로 지정하는 것이 관례이다. 다음과 같다. ```java // 매핑할 객체 @Entity public class Member { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; ... // 매핑할 테이블 CREATE TABLE `member`( `id` BIGINT(20) UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT, ... ``` - 만일, 매핑할 테이블의 칼럼명과, 엔티티 클래스의 칼럼명이 일치하지 않는다면, @Column 어노테이션과 name속성을 이용하여 수동으로 매핑할 수 있다. ```java // 매핑할 테이블 CREATE TABLE `member`( ... `member_name` VARCHAR(100) NOT NULL ); // 매핑할 엔티티 클래스 @Entity public class Member { @Column(name="member_name") private String name; ``` - 기타 어노테이션은 API의 어노테이션 장에서 정리하였으니 참고하기 바란다. - 상기와 같이, 엔티티 클래스에 어노테이션을 추가하여 설정을 완료한다면, JPA가 SQL까지 자동으로 작성하여 INSERT, UPDATE, DELETE 등을 수행하기 때문에 DB와의 통신이 상당히 편리해진다. - *EntityManager : JPA에서는 EntityManager라는 모듈이 동작한다. 이전 장의 의존성 주입부분에서, spring-boot-starter-data-jpa를 추가하였을 때, 스프링 부트에서 자동으로 EntityManager라는 것을 생성하여준다. 따라서 스프링부트를 이용하였다면, 생성자로서 상태주입을 받기만 하면 된다. ```java public class JpaMemberRepository implements MemberRepository { // 스프링 부트에서 자동으로 생성하는 엔티티 매니저 private final EntityManager em; // 생성자로서 상태주입을 받는다. public JpaMemberRepository(EntityManager em) { this.em = em; } ``` - 이렇게 엔티티 매니저까지 상태주입을 받았다면 설정은 완료된 것이다. 이제 실제 DB와의 통신은 다음과 같이 이루어지게 된다. ```java // 1. INSERT @Override public Member save(Member member) { em.persist(member); return member; } // 2. SELECT * FROM `MEMBER` WHERE = ID @Override public Optional findById(Long id) { // 엔티티매니저의 find 메소드 사용 // 엔티티클래스와 식별자(PK)를 인자로 넘겨서 사ㅏ용한다. Member member = em.find(Member.class, id); return Optional.ofNullable(member); } // 3. SELECT * FROM `MEMBER` @Override public List findAll() { return em.createQuery("SELECT m FROM MEMBER as m", Member.class).getResultList(); } // 4. SELECT * FROM `MEMBER` WHERE `name` = name @Override public Optional findByName(String name) { List result = em.createQuery("select m from Member m where m.name = :name", Member.class) .setParameter("name",name) .getResultList(); return result.stream().findAny(); } ``` - 3번 예제에서는 JPQL이라는 것을 알고 있어야 한다. - JPQL이란, 테이블이 아닌 엔티티객체를 대상으로 데이터를 조회하는 객체지향 쿼리이다. SQL을 추상화하여 특정 DB의 SQL에 의존하지 않도록 하기 위하여 사용된다. - 이때, JPA는 JPQL을 분석한 후 적절한 SQL을 만들어 데이터베이스를 조회한다. 예제는 다음과 같다. ```java // 엔티티 클래스 @Entity(name = "Article") public class Article { @Column(name= "title") private String title; } // JPQL String jpql = "SELECT a FROM Article as a WHERE a.title = 'title'" ``` - 기본 분법은 SQL과 유사하다. SELECT문을 예시로 들었을 때, ```java # JPQL SELECT a FROM Article AS a ## SELECT a FROM Articel a ## AS는 생략이 가능하다 # Article은 TABLE명이 아니라 ENTITY 클래스명이다. ``` - JPQL은 별칭을 필수로 명시해주어야 한다, AS는 생략이 가능하다. - JPA를 사용함에 있어서 주의해야할점은, @Transactional 어노테이션을 사용해주어야 하는 것이다. ```java @Transactional @Service public class MemberService { private final MemberRepository memberRepository; ... ``` - JPA는 join이 실행될 때 모든 데이터 변경이 트랜잭션의 단위 안에서 이루어져야만 하기 떄문에 상기 예제와 같이 Transactional 이라는 어노테이션이 필요하다. # #4. Spring Data JPA - Spring 프레임워크에서는 Spring Data JPA라는 기능을 제공한다. 이전 장까지의 모든 내용은 본 장을 학습하기 위한, 원리학습의 내용을 정리한 것이라고 할 수 있다. - Spring Data JPA은 반복 개발하여온 CRUD기능을 제공한다. 따라서 개발자는 비즈니스 로직만을 개발하는데 주력할 수 있게 된다. - 그러나, 스프링 데이터 JPA는 JPA의 생산성을 극대화 하기 위하여 도와주는 기능을 할 뿐, 새로운 기술이 아니기 때문에 JPA를 선수학습 하고 난 후 스프링 데이터 JPA를 사용하여야 제대로 사용할 수 있으니, JPA에 대한 학습을 제대로 마쳐야 할 것이다. - cf) 인터페이스가 인터페이스를 상속받을때는 implements가 아니라 extends이다. 인터페이스는 다중상속이 가능하다 - SpringDataJpa를 사용하기 위해서는 JpaRepository라는 것을 구현해야 한다. 다음과 같다. ```java public interface SpringDataJpaMemberRepository extends JpaRepository, MemberRepository { ... ``` - 스프링 데이터 JPA를 사용하려면 예제와 같이 엔티티 클래스와, PK 필드의 데이터 타입을 받는 JpaRepository를 상속받으면 된다. ```java // < 엔티티 클래스, PK 필드의 데이터 타입 > JpaRepository ``` - 상기 예제와 같이 입력하고, 구현하고자 하는 인터페이스를 다중상속 받게되면, 스프링 데이터 Jpa가 자동으로 구현하게된다. 따라서 인터페이스만으로도 DB와 통신할 수 있게 되는 것이다. - 스프링 데이터 JPA에서는 개발자들이 공통적으로 구현하는 CURD에 한하여 인터페이스를 제공하고 있는 것이다. 그러나 비즈니스에 따라서 칼럼의 이름이나 구현하려고 하는 기능이 다른데, 다음과 같다. ```java @Override Optional findByName(String name); ``` - 상기의 코드는 Member를 Optional이라는 객체로서 반환하여 오는데 name을 기준으로 Member를 색인하여 받아온다. 해당 코드의 JPQL은 다음과 같다. ```java select m from Member m where m.name = ? ``` - 그렇다면, 필드이름 혹은 테이블 내의 칼럼 이름이 다르거나 name뿐만 아니라 다른 칼럼까지 같이 조회하고자 한다면 그것은 스프링 데이터 JPA에서 제공하는 인터페이스가 아니니 새로 구현해야 하는 것일까? - 해당 문제를 해결하기 위하여 스프링 데이터 JPA에서는 다음과 같은 기능을 제공한다. ```java Optional findByNameAndId(String name, Long id); ``` - 이렇게 인터페이스 내부의 메소드 이름을 지정해 주면 스프링 데이터 JPA가 알아서 JPQL을 작성하여 적용하여준다. - 따라서 상황에 맞게 메소드 이름을 변경하여 사용한다면 단순한 CURD 기능 구현이 끝나게 되는 것이다. - 여기까지 Spring 에서의 JDBC의 내용을 정리하였다.