📚 [Spring] 스프링 데이터 JPA, API 문서화, 커밋과 이슈

이가은·2024년 6월 19일

Spring

목록 보기

12/13

📕 스프링 데이터 JPA

JPA(Java Persistent API)는 스프링 프레임워크에서 JPA를 편리하게 사용할 수 있도록 지원하는 프로젝트

CRUD를 처리하기 위한 공통 인터페이스를 제공
Repository 계층에 구현 클래스 없이 인터페이스만 작성하면 실행 시점에 스프링 데이터 JPA가 구현 객체를 동적으로 생성 및 주입
공통 메소드는 스프링 데이터 JPA가 제공하는 org.springframework.date.jpa.repository.JpaRepository 인터페이스에 count, delete, deleteAll, deleteAll, deleteById, existsById, findById, save 등이 구현되어 있다

📖 공통 인터페이스 기능

public interface SpringDataJpaItemRepository extends JpaRepository<Item,Long> {
    List<Item> findByItemNameLike(String itemName);
 
    List<Item> findByPriceLessThanEqual(Integer price);
 
    //쿼리 메소드 (아래 메소드와 같은 기능 수행)
    List<Item> findByItemNameLikeAndPriceLessThanEqual(String itemName, Integer price);
 
    //쿼리 직접 실행
    @Query("select i from Item i where i.itemName like :itemName and i.price <= :price")
    List<Item> findItems(@Param("itemName") String itemName, @Param("price") Integer price);
}

✔ 이렇게 JpaRepository 인터페이스만 상속받아도 Spring Data JPA가 프록시 기술을 사용해서 구현 클래스를 만들고 스프링 빈으로 등록해주기 때문에 개발자는 구현 클래스 없이 인터페이스만 만들면 기본 CRUD 기능을 사용할 수 있다

📖 쿼리 메소드 기능

//쿼리 메소드
List<Item> findByItemNameLikeAndPriceLessThanEqual(String itemName, Integer price);

✔ 스프링 데이터 JPA는 인터페이스에 메소드 이름만 적어두면, 메소드 이름을 분석해서 쿼리를 자동으로 만들고 실행해주는 기능을 제공한다

//쿼리 직접 실행
@Query("select i from Item i where i.itemName like :itemName and i.price <= :price")
List<Item> findItems(@Param("itemName") String itemName, @Param("price") Integer price);

✔ 쿼리 메소드 기능을 사용하지 않고 직접 JPQL을 사용하고 싶을 때는 @Query에 직접 JPQL을 작성하면 된다
✔ @Query를 사용하면 메소드 이름으로 실행하는 규칙이 무시된다

📙 JPQL

JPQL(Java Persistence Query Language)는 엔티티 객체를 대상으로 하는 쿼리 언어

//나이가 18살 이상인 유저를 조회
select u from User as u where u.age > 18

//쿼리 직접 실행
@Query("select i from Item i where i.itemName like :itemName and i.price <= :price")
List<Item> findItems(@Param("itemName") String itemName, @Param("price") Integer price);

📒 API 명세서

소프트웨어 개발에서 사용되는 문서로 API의 이름, 파라미터(매개변수), 인터페이스, 반환 값 등의 구문, 인증 및 인가방법(동작방식), 데이터 전달 형식 등 API를 정확하게 호출하고 그 결과를 명확히 해석하는데 필요한 정보들을 일관된 형식으로 기술한 것

📖 API 명세서 필요성

◾ API의 설계, 개발 및 문서화 과정에서 용이
◾ 서로 다른 클라우드 서비스 간의 API 연동에서 필요함

📗 ERD

ERD(Entity Relationship Diagram)는 'Entity 개체'와 'Relationship 관계'를 중점적으로 표시하는 데이터베이스 구조를 한 눈에 알아보기 위해 그려놓는 다이어그램

📘 커밋 컨벤션과 이슈 작성하기

type: Subject

body

footer

✔ 기본적인 커밋 메시지 구조는 제목, 본문, 꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분한다

📖 타입

feat : 새로운 기능
fix : 버그 해결
docs : 문서 변경
style : formatting, 놓친 세미콜론 등... 코드의 변경은 없음
refactor : 코드 리팩토링
test : 테스트 코드 추가 혹은 테스트 코드 리팩토링. 코드의 변경은 없음
chore : 패키지 매니저 구성, 빌드 작업 업데이트. 코드의 변경은 없음

📖 Subject

제목은 50자를 넘어서는 안된다
대문자로 시작해야 한다
마침표로 끝나면 안된다
커밋이 수행 한 작업에 대해 명령형으로 작성한다

📖 Body

바디는 옵션이고, 커밋이 약간의 설명과 문단이 필요할 때 바디가 사용된다
'어떻게'가 아닌 '무엇을' 그리고 '왜'에 대한 설명을 위해 바디를 사용해야한다
바디를 적을 때, 타이틀과 바디 사이에 공백을 적어야 하고 각 줄에 글자가 72자를 넘지 않도록 해야한다

푸터도 옵션이고, 이슈트래커 아이디 참조로 사용된다

Feat: 관심지역 알림 ON/OFF 기능 추가(#123)

시군구의 알림을 각각 ON/OFF 할 수 있도록 기능을 추가함
 - opnion0055: 구분 코드

해결: close #123

📔 패키지 구조 설정

📖 계층형 디렉터리 구조

com
 ㄴ example
     ㄴ sju
         ㄴ config
         ㄴ controller
         ㄴ domain
         ㄴ repository
         ㄴ service
         ㄴ security
         ㄴ exception

✔ 스프링 웹 계층의 대표 클래스 혹은 디렉터리들을 기반으로 패키징하는 방법
✔ 계층형 구조는 전체적인 구조를 빠르게 파악할 수 있는 장점이 있지만, 각각의 패키지 디렉터리에 클래스들이 너무 많이 모이게 된다는 단점이 존재한다

📖 도메인형 디렉터리 구조

com
 ㄴ example
     ㄴ vivid
         ㄴ domain
         |   ㄴ user
         |   |   ㄴ api
         |   |   ㄴ application
         |   |   ㄴ dao
         |   |   ㄴ domain
         |   |   ㄴ dto
         |   |   ㄴ exception
         |   ㄴ video
         |   |   ㄴ api
         |   |   ㄴ application
         |   |   ㄴ dao
         |   |   ㄴ domain
         |   |   ㄴ dto
         |   |   ㄴ exception
         |   ...
         ㄴ global
             ㄴ auth
             ㄴ common
             ㄴ config
             ㄴ error
             ㄴ infra
             ㄴ util

✔ 각각의 도메인 별로 패키지 분리가 가능하여 관리에 있어서 계층형 방식보다 직관적이며, 각각의 도메인들은 서로를 의존하는 코드가 없도록 설계하기 적합해서 코드의 재활용성이 향상된다

📓 PR

PR(Pull Request)은 원격 저장소에 push하여 새로운 사항이 저장되었을 때, 프로젝트 관리자에게 새로운 코드 변경사항을 알리고 원본 소스 코드에 병합을 요청하는 것이다. 코드를 병합하는 과정에서 서로 코드도 확인할 수 있고 어떤 부분을 수정했는지도 확인할 수 있도록 Pull request를 진행한다.