[Spring Boot] Spring Data JPA

[DrMaemi]

프로젝트 생성, pom.xml

• Spring Web, Spring Data JPA, MySQL Driver 가 필요하다.
  pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>spring-data-jpa</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-data-jpa</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Repository

• "1. Working with Spring Data Repositories," docs.spring.io

사용 목적

• Data Access Layer에 필요한 boilerplate code들을 줄이기 위해 사용하는 추상화

주요 개념과 구조

• Repository 인터페이스를 상속받아 미리 정의되어 있거나 사용자가 정의한 쿼리 메서드를 통해 데이터에 접근한다.
• CrudRepository, JpaRepository, SimpleJpaRepository 등을 상속받아 사용자 정의 Repository 클래스를 생성해 사용하는 패턴이 많다

  classDiagram
  class Repository
  class CrudRepository
  class PagingAndSortingRepository
  <<interface>> Repository
  <<interface>> CrudRepository
  <<interface>> PagingAndSortingRepository
  Repository <--  CrudRepository : extends
  CrudRepository <-- PagingAndSortingRepository : extends

MySQL 구동

$ mysql.server start
$ mysql -u root -p
# 별 입력 없이 Enter

# 유저 생성
mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
4 rows in set (0.00 sec)

mysql> use mysql;
Database changed
mysql> select user, host from user;
+------------------+-----------+
| user             | host      |
+------------------+-----------+
| mysql.infoschema | localhost |
| mysql.session    | localhost |
| mysql.sys        | localhost |
| root             | localhost |
+------------------+-----------+
4 rows in set (0.00 sec)
mysql> CREATE USER 'springuser'@'%' IDENTIFIED BY 'ThePassword';
Query OK, 0 rows affected (0.01 sec)

mysql> select user, host from user;
+------------------+-----------+
| user             | host      |
+------------------+-----------+
| springuser       | %         |
| mysql.infoschema | localhost |
| mysql.session    | localhost |
| mysql.sys        | localhost |
| root             | localhost |
+------------------+-----------+
5 rows in set (0.00 sec)

# DB 생성
mysql> CREATE DATABASE spring_example;
Query OK, 1 row affected (0.00 sec)

mysql> SHOW DATABASES;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| spring_example     |
| sys                |
+--------------------+
5 rows in set (0.00 sec)

# 권한 부여
mysql> GRANT ALL ON spring_example.* TO 'springuser'@'%';
Query OK, 0 rows affected (0.00 sec)

MySQL 실행 후 유저로 접속

mysql -u springuser -p
Enter password:
# 'ThePassword' 입력
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 10
Server version: 8.3.0 Homebrew

Copyright (c) 2000, 2024, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql>

MySQL 종료

$ mysql.server stop

application.properties 작성

• Spring Boot 프로젝트의 default DB는 H2 이고, 다른 DB를 사용하고 싶다면 application.properties에 connection attributes 를 정의해줘야 한다. application.properties

  spring.jpa.hibernate.ddl-auto=update
  spring.datasource.url=jdbc:mysql://${MYSQL_HOST:localhost}:3306/spring_example
  spring.datasource.username=springuser
  spring.datasource.password=ThePassword
  spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  #spring.jpa.show-sql: true

• spring.jpa.hibernate.ddl-auto 옵션
  • none - MySQL default 값. DB 구조에 변화를 주지 않는다.
  • update - Spring 프로젝트에 정의된 Entity 구조에 따라 DB 구조를 변경한다. (DB, 테이블 생성부터 변경까지 ?)
  • create - Spring 프로젝트에 정의된 Entity 구조에 따라 DB 생성이 필요하면 생성한다. (close 될 때 DB 삭제는 하지 않는다.)
  • create-drop - create 에서 SessionFactory 가 close 될 때 DB 삭제까지 진행한다.

@Entity 모델 작성

A. 참조

• "Accessing data with MySQL," spring.io
• "Homebrew로 MySQL 설치/실행/종료 + DB 생성 및 조작," velog.io

[DrMaemi]

@OneToMany, @ManyToOne 양방향 관계에서 mappedBy를 사용하는 이유

• 각 엔티티가 서로 변경하는 등 무결성을 해칠 수 있음
• 이를 막기 위해 한 쪽에서만 테이블 변경을 하겠다는 의미로 mappedBy 를 사용한다. (mappedBy 의 값으로 상대 Entity의 필드 이름을 사용한다.)

• Team (1) - Member (N) 관계가 있을 때

  @Entity
  public class TeamEntity {
  
  @OneToMany(mappedBy = "teamEntity") // 상대 Entity가 가지고 있는 멤버변수 명
  private List<MemberEntity> memberEntities;
  }

  @Entity
  public class MemberEntity {
  
  @ManyToOne
  private TeamEntity teamEntity;
  }