public class BoardDTO {
private Long bno;
@NotEmpty
@Size(min = 3, max = 100)
private String title;
@NotEmpty
private String content;
@NotEmpty
private String writer;
private LocalDateTime regDate;
private LocalDateTime modDate;
}
1) BoardController 처리
🚀 등록 처리는 GET 방식으로 화면을 보고 POST 방식으로 처리 🚀 @Valid에서 문제가 발생했을 때 모든 에러를 errors라는 이름으로 RedirectAttributes에 추가해서 전송
@GetMapping("/register")
public void registerGet() {}
@PostMapping("/register")
public String registerPost(@Valid BoardDTO boardDTO,
BindingResult bindingResult,
RedirectAttributes redirectAttributes) {
log.info("board POST register...");
if (bindingResult.hasErrors()) {
log.info("has errors...");
redirectAttributes.addFlashAttribute("errors", bindingResult.getAllErrors());
return "redirect:/board/register";
}
log.info(boardDTO);
Long bno = boardService.register(boardDTO);
redirectAttributes.addFlashAttribute("result", bno);
return "redirect:/board/list";
}
💡 addFlashAttribute() - Spring Framework에서 제공하는 메소드로, 주로 리다이렉트 시 데이터를 일시적으로 저장하는 데 사용 - Flash 속성은 리다이렉트 이후에만 유효하며, 한 번 읽히면 소멸하는 특성이 있음 - 이를 통해 사용자는 브라우저를 새로고침하거나 직접 URL을 입력해도 해당 데이터가 유지되지 않도록 할 수 있음
🚀 등록은 @Valid를 통해서 검증하므로 검증에 실패하면 다시 앞의 화면으로 이동 🚀 이때 addFlashAttribute()를 통해서 'errors' 라는 이름으로 에러 메시지들이 전송됨
<script layout:fragment="script" th:inline="javascript">
const errors = [[${errors}]];
console.log(errors);
let errorMsg = '';
if(errors) {
for (let i = 0; i < errors.length; i++) {
errorMsg += `${errors[i].field}은(는) ${errors[i].code} \n`;
}
alert(errorMsg);
}
</script>
💡 Thymeleaf의 인라인 기능을 이용하면 'errors'를 자바 스크립트의 배열로 처리할 수 있기 때문에 이를 이용해서 앞의 메시지를 작성할 수 있음 💡 브라우저를 통해서 아무것도 입력하지 않은 상태에서 submit이 실행되면 경고창이 보임 💡 콘솔창에는 배열로 만들어진 에러 메시지를 출력
4) 정상적인 처리와 모달창
🚀 등록 화면에서 필요한 내용들이 추가되면 정상적으로 '/board/list'로 이동하는 것을 확인 🚀 목록 화면으로 이동했을 때 BoardController에서 RedirectAttributes의 addFlashAttribute()를 이용해서 'result'라는 데이터를 추가적으로 전달. addFlashAttribute()로 전달된 데이터는 쿼리 스트링으로 처리되지 않기 때문에 브라우저의 경로에는 보이지 않음 🚀 list.html에서는 이렇게 전달된 result 변수를 이용해서 모달창으로 처리
list.html의 <script> 태그의 마지막 부분에 코드 추가
// show modal
const result = [[${result}]];
if(result) {
modal.show();
}
경고창이 동작한 것을 확인후에 모달창을 추가 - 모달창의 코드는 부트스트랩의 Componets 메뉴를 통해서 확인
🚀 가장 우선적으로 구현해야 하는 기능은 목록 기능이므로 list() 메서드를 추가하고 PageRequestDTO를 이용해서 페이징 처리와 검색에 이용
@Controller
@RequestMapping("/board")
@Log4j2
@RequiredArgsConstructor
public class BoardController {
private final BoardService boardService;
@GetMapping("/list")
public void list(PageRequestDTO pageRequestDTO, Model model) { }
}
1) 화면 구성을 위한 준비
화면 구성은 Thymeleaf를 이용해서 레이아웃을 적용할 수 있도록 준비. build.gradle 파일에 Thymeleaf의 레이아웃 관련 라이브러리의 존재 여부를 먼저 확인
@Service
@Log4j2
@RequiredArgsConstructor
@Transactional
public class BoardServiceImpl implements BoardService {
private final ModelMapper modelMapper;
private final BoardRepository boardRepository;
@Override
public Long register(BoardDTO boardDTO) {
Board board = modelMapper.map(boardDTO, Board.class);
Long bno = boardRepository.save(board).getBno();
return bno;
}
}
✓ BoardServiceImpl 클래스에는 의존성 주입 외에도@Transactional 어노테이션을 적용 ➡️ @Transactional을 적용하면 스프링은 해당 객체를 감싸는 별도의 클래스를 생성해 내는데, 간혹 여러 번의 데이터베이스 연결이 있을 수도 있으므로 트랜잭션 처리는 기본적으로 적용해 두는 것이 좋음
📍 test 폴더에 service 패키지를 추가하고 BoardServiceTests 클래스를 추가
@SpringBootTest
@Log4j2
class BoardServiceImplTest {
@Autowired
private BoardService boardService;
@Test
public void registerTest() {
log.info(boardService.getClass().getName());
}
}
✓ 실제 boardService 변수가 가르키는 객체의 클래스명을 출력하는데 실행해 보면 BoardServiceImpl이 나오지 않고 스프링에서 BoardServiceImpl을 감싸서 만든 클래스 정보가 출력
📍 등록처리의 구현은 다음과 같이 작성 - 콘솔에서 insert문이 동작하는지 확인하고 최종적으로 데이터 베이스에서 확인
@Override
public void remove(Long bno) {
boardRepository.deleteById(bno);
}
3) 목록 / 검색 처리
dto 패키지에 PageRequestDTO, PageResponseDTO 클래스 추가
PageRequestDTO
📍 페이징 관련 정보 외에 검색의 종류 type와 키워드 keyword를 추가해서 지정
@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageRequestDTO {
@Builder.Default
private int page = 1;
@Builder.Default
private int size = 10;
private String type; // 검색의 종류 t, c, w, tc, tw, twc
private String keyword;
}
✓ 검색의 종류는 문자열 하나로 처리해서 나중에 각 문자를 분리하도록 구성
📍 PageRequestDTO에는 몇 가지 필요한 기능들이 존재
현재 검색 조건들을 BoardRepository에서 String[]로 처리하기 때문에type이라는 문자열을 배열로 변환해 주는 기능이 필요.
페이징 처리를 위해서 사용하는Pageable 타입을 반환하는 기능도 필요.
public String[] getTypes() {
if (this.type == null || type.isEmpty()) {
return null;
}
return this.type.split("");
}
public Pageable getPageable(String...props) {
return PageRequest.of(this.page - 1, this.size, Sort.by(props).descending());
}
private String link;
public String getLink() {
if (link == null) {
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append("page=").append(this.page);
stringBuilder.append("&size=").append(this.size);
if (type != null && type.length() > 0) {
stringBuilder.append("&type=").append(this.type);
}
if (keyword != null) {
stringBuilder.append("&keyword=").append(URLEncoder.encode(this.keyword, StandardCharsets.UTF_8));
}
link = stringBuilder.toString();
}
return link;
}
getTypes(): type 문자열을 분리하여 문자열 배열로 반환합니다. type이 null이거나 비어있으면 빈 배열을 반환
getPageable(String... props): 페이지 요청(PageRequest) 객체를 생성. 페이지 번호는 page - 1 (0부터 시작하기 때문), 페이지 크기는 size, 정렬 기준은 주어진 속성(props)을 기준으로 내림차순
getLink메소드는 객체의page,size,type,keyword값을 기반으로 URL 쿼리 스트링을 동적으로 생성하고, 한 번 생성된 링크를 캐시하여 이후 호출 시 재사용. 이는 불필요한 문자열 연산을 피하기 위해 유용
if (type != null && type.length() > 0): type이 null이 아니고 비어 있지 않은 경우에만 type 파라미터를 추가. 예: &type=tc
if (keyword != null): keyword가 null이 아닌 경우에만 keyword 파라미터를 추가. 이때 URLEncoder.encode를 사용하여 keyword를 UTF-8로 인코딩. 이는 URL에 안전하게 포함시키기 위해 필요. 예: &keyword=example
PageResponseDTO
📍 화면에 DTO 목록과 시작 페이지 / 끝 페이지 등에 대한 처리를 담당
@Getter
@ToString
public class PageResponseDTO<E> {
private int page; // 페이지 번호
private int size; // 페이지 크기
private int total; // 전체 항목수
private int startPage; // 시작 페이지 번호
private int endPage; // 끝 페이지 번호
private boolean prev; // 이전 페이지 존재 여부
private boolean next; // 다음 페이지 존재 여부
private List<E> dtoList; // 페이지에 포함된 데이터 목록
@Builder(builderMethodName = "withAll")
public PageResponseDTO(PageRequestDTO pageRequestDTO, List<E> dtoList, int total) {
if (total <= 0) { // 총 항목 수가 0 이하인 경우, 생성자 실행을 중단
return;
}
this.page = pageRequestDTO.getPage(); // 현재 페이지 번호
this.size = pageRequestDTO.getSize(); // 한 페이지에 포함된 항목 수
this.total = total; // 전체 항목 수
this.dtoList = dtoList; // 데이터 리스트
this.endPage = (int)(Math.ceil(this.page / 10.0) * 10); // 끝 페이지 번호를 계산
this.startPage = this.endPage - 9; // 시작 페이지 번호를 계산
int last = (int) (Math.ceil(this.total / (double)this.size)); // 실제 마지막 페이지 번호를 계산
this.endPage = Math.min(endPage, last); // 더 작은 값을 사용
this.prev = this.startPage > 1; // 시작 페이지 번호가 1보다 큰 경우 이전 페이지가 존재함
this.next = total > this.endPage * this.size;
// 전체 항목 수가 끝 페이지 번호에 페이지 크기를 곱한 값보다 큰 경우 다음 페이지가 존재함
}
}
✓ PageResponseDTO클래스는 페이지네이션 정보와 함께데이터를 전달하기 위한 데이터 전송 객체.
✓ public PageResponseDTO(PageRequestDTO pageRequestDTO, List<E> dtoList, int total):생성자로, PageRequestDTO, 데이터 리스트(dtoList), 전체 항목 수(total)를 매개변수로 받는다.
데이터베이스를 이용해야 할 때 JPA나 JPQL을 이용하면 SQL을 작성하거나 쿼리를 처리하는 소스 부분이 줄어들기 때문에 무척 편리하지 만 어노테이션을 이용해서 지정하기 때문에 고정된 형태라는 단점이 있음 ✓ 예를 들어 Board의 경우 '검색' 기능이 필요한데 '제목 / 내용 / 작성자'와 같은 단일 조건이 생성되는 경우도 있지만 '제목과 내용, 제목과 작성자'와 같이 복합적인 검색 조건이 생길 수 있음. 만일 여러 종류의 검색 조건이 생기면 모든 경우의 수를 별도의 메소드로 작성을 해야함.
이러한 문제의 근본 원인은 JPQL이 정적으로 고정되기 때문. JPQL은 코드를 통해서 생성해야 하는데 이 문제를 해결하기 위해 다양한 방법이 존재하지만 국내에서 가장 많이 사용되는 방식은 Querydsl
📍 Querydsl 이란?
- JPQL을 코드로 작성할 수 있도록 도와주는 빌더 API
- 장점
1. 고정된 sql문이 아닌 조건에 맞게 동적으로 쿼리 생성
2. 비슷한 쿼리를 재사용 가능. 제약 조건 조립 및 가독성 향상
3. 문자열이 아닌 자바 소스코드로 작성하기 때문에 컴파일 시점에 오류를 발견할 수 있음
4. IDE의 도움을 받아서 자동 완성 기능을 이용할 수 있기 때문에 생산성을 향상시킬 수 있음
💡엄밀하게 말하면 'Querydsl'은 JPA의 구현체인 Hibernate 프레임워크가 사용하는 HQL Hibernate Query Language 을 동적으로 생성할 수 있는 프레임워크지만 JPA를 지원 ➡️ Q도메인이라는 존재가 필요한데 Q도메인은 Querydsl의 설정을 통해서 기존의 엔티티 클래스를 Querydsl에서 사용하기 위해서 별도의 코드로 생성하는 클래스
1) Querydsl을 사용하기 위한 프로젝트 설정 변경
Querydsl을 이용하기 위해서는 build.gradle 설정을 변경 dependencies에 Querydsl 관련 라이브러리들을 추가
🚀 Querydsl의 목적은 '타입'기반으로 '코드'를 이용해서 JPQL 쿼리를 생성하고 실행하는 것 ➡️ 이때 코드를 만드는 클래스가 Q도메인 클래스
BoardSearchImpl에서 Q도메인을 이용하는 코드를 작성
@Override
public Page<Board> search1(Pageable pageable) {
QBoard board = QBoard.board; // Q도메인 객체
JPQLQuery<Board> query = from(board); // select .. from board
query.where(board.title.contains("1")); // where title like
List<Board> list = query.fetch();
long count = query.fetchCount();
return null;
}
✓ search1()은 아직 완성된 코드는 아니지만 Q도메인을 어떻게 사용하고 JPQLQuery라는 타입을 어떻게 사용하는지 보여줌 ✓ JPQLQuery는 @Query로 작성했던 JPQL을 코드를 통해서 생성할 수 있게 함. 이를 통해서 where나 group by 혹은 조인 처리 등이 가능. ✓ JPQLQuery의 실행은 fetch()라는 기능을 이용하고, fetchCount()를 이용하면 count쿼리를 실행할 수 있음
아직은 null을 반환하지만 Querydsl을 이용해서 코드를 통한 JPQL의 쿼리를 확 인하기 위해 테스트 코드 작성
Querydsl의 실행 시에 Pageable을 처리하는 방법은 BoardSearchImpl이 상속한 QuerydslRepositorySupport라는 클래스의 기능을 이용
search1()의 코드 중간에 getQuerydsl()과 applyPagination()을 적용
@Override
public Page<Board> search1(Pageable pageable) {
QBoard board = QBoard.board; // Q도메인 객체
JPQLQuery<Board> query = from(board); // select .. from board
query.where(board.title.contains("1")); // where title like
// paging
this.getQuerydsl().applyPagination(pageable, query);
List<Board> list = query.fetch();
long count = query.fetchCount();
return null;
}
✓ applyPagination()이 적용된 후에 실행되는 쿼리의 마지막에는 페이징 처리에 사용하는 limit 가 적용되는 것 확인
3) Querydsl로 검색 조건과 목록 처리
검색의 경우 '제목(t), 내용(c), 작성자(w)'의 조합을 통해서 이루어진다고 가정하고 이를 페이징 처리와 함께 동작하도록 구성
A. BooleanBuilder
예를 들어 '제목이나 내용'에 특정한 키워드 keyword가 존재하고 bno가 0보다 큰 테이터를 찾는다면 SQL을 다음과 같이 작성.
select * fromboardwhere (title like concat('%', '1', '%') or content like concat('%', '1', '%')) and bno > 0
📍 where 조건에 and와 or이 섞여 있을 때는 연산자의 우선 순위가 다르기 때문에 or 조건은 ()로 묶어서 하나의 단위를 만들어 주는 것이 좋음 📍 Querydsl을 이용할 때 '()'가 필요한 상황이라면 BooleanBuilder를 이용해서 작성할 수 있음
@Override
public Page<Board> search1(Pageable pageable) {
QBoard board = QBoard.board; // Q도메인 객체
JPQLQuery<Board> query = from(board); // select .. from board
//query.where(board.title.contains("1")); // where title like
BooleanBuilder booleanBuilder = new BooleanBuilder(); // (
booleanBuilder.or(board.title.contains("11")); // title like
booleanBuilder.or(board.content.contains("11")); // content like
query.where(booleanBuilder);
query.where(board.bno.gt(0L));
// paging
this.getQuerydsl().applyPagination(pageable, query);
List<Board> boards = query.fetch();
long count = query.fetchCount();
return null;
}
✓ 앞의 코드에는 '제목 혹은 or 내용'에 대한 처리를 BooleanBuilder에 or()을 이용해서 추가하고 있고, 'bno가 0보다 큰' 조건은 바로 JPQLQuery 객체에 적용되고 있음. ✓ 코드를 실행하게 되면 다음과 같은 쿼리가 실행되는데 '()'가 생성되어서 or 조건들을 하나로 묶어서 처리하는 것을 볼 수 있음
B. 검색을 위한 메서드 선언과 테스트
🚀 검색을 위해서는 적어도 검색 조건들과 키워드가 필요하므로 이를 types와 keyword로 칭하고 types은 여러 조건의 조합이 가능하도록 처리하는 메서드를 BoardSearch에 추가
페이징 처리의 최종 결과는 Page<T> 타입을 반환하는 것이므로 Querydsl에서는 이를 직접 처리해야 하는 불편함이 있음 Spring Data JPA에서는 이를 처리하기 위해서 PageImpl이라는 클래스를 제공해서 3개의 파라미터로 Page<T>을 생성할 수 있음
List<T> : 실제 목록 데이터
Pageable : 페이지 관련 정보를 가진 객체
long : 전체 개수
BoardSearchImpl 클래스 내 searchAll()의 마지막 return null 부분에 반영해서 수정
// paging
this.getQuerydsl().applyPagination(pageable, query);
List<Board> list = query.fetch();
long count = query.fetchCount();
return new PageImpl<>(list, pageable, count);
JDBC에서 작업하다가 MyBatis를 배울 경우에는 SQL 작성법도 거의 동일하고, 코드의 간략화가 목표여서 러닝커브가 높지 않지만 JPA의 경우에는 JDBC, MyBatis와는 사용방법이 상당한 차이가 있고, 추상적인 개념이 많이 포함이 되어서 러닝커브가 상당히 높음.
그리고 SQL문을 직접 만드는 것보다 JPA가 만드는 SQL의 효율이 떨어진다거나, 동일한 작업인데 JPA가 더 많은 SQL문을 사용하는 비효율성이 존재. 하지만 MSA 방식으로 애플리케이션을 설계하는 경향이 높아짐에 따라, JPA를 사용하는 작업이 많아짐.
1) ORM / JPA
우리가 사용하는 대부분의 프로그램은 사용자가 입력한 데이터나 비지니스 로직 수행 결과로 얻은 데이터를 재사용할 수 있도록 데이터베이스에 저장을 함. 하지만 자바의 객체와 데이터베이스의 테이블이 정확하게 일치하지는 않음. 따라서 둘 사이를 매핑하기 위해서 많은 SQL 구문과 자바 코드가 필요해짐.
💡 ORM은 정확하게 일치하지 않는 자바 객체와 테이블 사이를 매핑
✓ 자바 객체에 저장된 데이터를 테이블의 Row 정보로 저장하고. 반대로 테이블에 저장된 Row 정보를 자바 객체로 매핑
✓ 이 과정에서 사용되는 SQL 구문과 자바 코드를 ORM 프레임워크가 자동으로 만들어줌.
어떤 DB 연동 기술이나 프레임워크를 사용하더라도 SQL 명령어를 자바 클래스나 외부의 XML 파일에 작성해야 함. 그리고 작성된 SQL은 유지보수 과정에서 지속적으로 수정되며 새로운 SQL이 추가되기도 함.
💡 ORM 프레임워크의 가장 큰 특징이자 장점은 DB 연동에 필요한 SQL을 자동으로 생성 ✓ 이렇게 생성된 SQL은 DBMS가 변경될때 자동으로 변경이 됨
➡️ 다만 ORM 환경 설정 파일에서 DBMS가 변경된 것을 알려주어야 함
ORM ; Object Relational Mapping 객체 관계 매핑
자바와 같은 객체지향 언어에서 의미하는 객체와 RDB Relational Database 의 테이블을 자동으로 매핑하는 방법
클래스는 데이터베이스의 테이블과 매핑하기 위해 만들어진 것이 아니기 때문에 RDB 테이블과의 불일치가 존재
ORM이 이 둘의 불일치와 제약사항을 해결하는 역할. ORM을 이용하면 쿼리문 작성이 아닌 코드(메서드)로 데이터를 조작할 수 있음
JPA ; Java Persistence API
자바 진영의 ORM 기술 표준으로 채택된 인터페이스 모음
ORM이 큰 개념이라면 JPA는 더 구체화된 스펙을 포함. 즉, JPA 또한 실제로 동작하는 것이 아니고 어떻게 동작해야 하는지 매커니즘을 정리한 표준 명세
JPA를 구현한 대표적인 구현체로 Hibernate, EclipseLink, DataNucleus, OpenJpa 등이 있음
JPA 인터페이스를 구현한 가장 대표적인 오픈소스가 Hibernate이고 실질적인 기능은 하이버네이트에 구현되어 있음
Spring Data JPA
JPA를 편리하게 사용할 수 있도록 지원하는 스프링 하위 프로젝트 중 하나
CRUD 처리에 필요한 인터페이스를 제공하며, 하이버네이트의 엔티티 매니저를 직접 다루지 않고 repository를 정의해 사용함으로써스프링에 적합한 쿼리를 동적으로 생성하는 방식으로 데이터베이스를 조작
이를 통해 하이버네이트에서 자주 사용되는 기능을 더 쉽게 사용할 수 있게 구현한 라이브러리
JPA 사용 시 장점
A. 특정 데이터베이스에 종속되지 않음
✓ 오라클을 MariaDB로 변경한다면 데이터베이스마다 쿼리문이 다르기 때문에 전체를 수정해야 함. 따라서 처음 선택한 데이터베이스를 변경하기 어려움. 하지만 JPA는 추상화한 데이터 접근 계층을 제공함. 설정 파일에 어떤 데이터베이스를 사용하는지 알려주면 얼마든지 데이터베이스를 변경할 수 있음
B. 객체지향적 프로그램
✓ 데이터베이스 설계 중심의 패러다임에서 객체지향적으로 설계가 가능. 이를 통해 좀 더 직관적이고 비지니스 로직에 집중
C. 생산성 향상
✓ 데이터베이스 테이블에 새로운 컬럼이 추가 되었을 경우, 해당 테이블의 컬럼을 사용하는 DTO 클래스의 필드도 모두 변경해야 함. ✓ JPA에서는 테이블과 매핑된 클래스에 필드만 추가한다면 쉽게 관리가 가능. 또한 SQL문을 직접 작성하지 않고 객체를 이용하여 동작하기 때문에 유지보수 측면에서 좋고 재사용성도 증가.
JPA 사용 시 단점
A. 복잡한 쿼리 처리
✓ 통계 처리 같은 복잡한 쿼리를 사용할 경우는 SQL문을 사용하는 것이 나을 수 있음 ✓ JPA에서는 Native SQL을 통해 기존의 SQL문을 사용할 수 있지만 그러면 특정 데이터베이스에 종속된다는 단점이 생김. 이를 보완하기 위해서 SQL과 유사한 기술인 JPQL, Querydsl을 지원.
B. 성능 저하 위험
✓ 객체 간의 매핑 설계가 잘못했을 때 성능 저하가 발생할 수 있으며, 자동으로 생성되는 쿼리가 많기 때문에 개발자가 의도하지 않은 쿼리로 인해 성능이 저하되기도 함.
C. 학습 시간
✓ JPA를 제대로 사용하려면 알아야 할 것이 많아서 학습하는데 시간이 오래 걸림.
2) 엔티티
엔티티 Entity 란 데이터베이스의 테이블에 대응하는 클래스. @Entity가 붙은 클래스는 JPA에서 관리하며 엔티티라고 함. 클래스 자체나 생성한 인스턴스도 엔티티라 부름.
엔티티 매니저 팩토리 Entity Manager Factory
엔티티 매니저 인스턴스를 관리하는 주체
애플리케이션 실행 시 한 개만 만들어지며 사용자로 부터 요청이 오면 엔티티 매니저 팩토리로 부터 엔티티 매니저를 생성.
엔티티 매니저 Entity Manager
영속성 컨텍스트에 접근하여 엔티티에 대한 데이터베이스 작업을 제공
내부적으로 데이터베이스 커넥션을 사용해서 데이터베이스에 접근
영속성 컨텍스트 Persistence Context
엔티티를 영구 저장하는 환경으로 엔티티 매니저를 통해 영속성 컨텍스트에 접근
2. Board 엔티티와 JpaRepository
JPA를 이용하는 개발의 핵심은 객체지향을 통해서 영속 계층을 처리하는데 있음. 따라서 JPA를 이용할 때는 테이블과 SQL을 다루는 것이 아니라 데이터에 해당하는 객체를 엔티티 객체로 다루고 JPA로 이를 데이터베이스와 연동해서 관리. 엔티티 객체는 쉽게 말해서 PK 기본키를 가지는 자바의 객체. 엔티티 객체는 고유의 식별을 위해 @Id를 이용해서 객체를 구분하고 관리
Spring Data JPA는 엔티티 객체를 이용해서 JPA를 이용하는데 더욱 편리한 방법들을 제공하는 스프링 관련 라이브러리.자동으로 객체를 생성하고 이를 통해서 예외 처리 등을 자동으로 처리하는데 이를 위해서 제공되는 인터페이스가 JpaRepository.
💡 개발의 첫 단계은 엔티티 객체를 생성하기 위한 엔티티 클래스를 정의하는 것
프로젝트에 domain 패키지를 구성하고 게시물을 위한 Board 엔티티를 작성
@Entity
public class Board {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long bno;
private String title;
private String content;
private String writer;
}
🥸 엔티티 객체를 위한 엔티티 클래스는 반드시 @Entity를 적용해야 하고 @Id가 필요 🥸 게시물은 데이터베이스에 추가될 때 생성되는 번호 auto increment 를 이용할 것이므로 이런 경우에 '키 생성 전략 key generate strategy 중에 GenerationType.IDENTITY로 데이터베이스에서 알아서 결정하는 방식을 이용
👾 Spring Data JPA 를 이용할 때는 JpaRepository라는 인터페이스 선언만으로 데이터베이스 관련 작업을 어느 정도 처리할 수 있음 👾 개발 단계에서 JpaRepository 인터페이스를 상속하는 인터페이스를 선언하는 것 만으로 CRUD외 페이징 처리가 모두 완료
repository 패키지를 생성하고 BoardRepository 인터페이스를 선언
public interface BoardRepository extends JpaRepository<Board, Long> {}
🥸 JpaRepositoy 인터페이스를 상속할 때에는 엔티티 타입과 @Id 타입을 지정해 주어야 하는 점을 제외하면 아무런 코드가 없이도 개발 가능
3) 테스트 코드를 통한 CRUD / 페이징 처리 확인
👾 Spring Data JPA를 이용하면 SQL의 개발도 거의 없고, JPA의 많은 기능을 활용 할 수 있지만 항상 테스트 코드로 동작 여부를 확인하는 것이 좋음
프로젝트에 test에 repository 패키지를 추가하고 BoardRepositoryTests 클래스를 추가
@SpringBootTest
@Log4j2
public class BoardRepositoryTests {
@Autowired
private BoardRepository boardRepository;
}
insert 기능 테스트
✓ 데이터베이스에 insert를 실행하는 기능은 JpaRepository의 save()를 통해서 이루어짐 ✓ save()는 현재의 영속 컨텍스트 내에 데이터가 존재하는지 찾아보고 해당 엔티티객체가 없을 때는 insert를, 존재할 때는 update을 자동으로 실행
@Test
public void testInsert() {
for (int i = 1; i <= 100; i++) {
Board board = Board.builder()
.title("title...")
.content("content..." + i)
.writer("user" + (i % 10))
.build();
Board result = boardRepository.save(board);
log.info("BNO: " + result.getBno());
}
}
📍 save()의 결과는 데이터베이스에 저장된 데이터와 동기화된 Board 객체가 반환 📍 최종적으로 테스트 실행 후에 데이터베이스를 조회해 보면 100개의 데이터가 생성된 것을 확인 📍 테스트 코드의 경우 @Id 값이 null 이므로 insert만 실행. (update와 비교)
select 기능 테스트
✓ 특정한 번호의 게시물을 조회하는 기능은 findById()를 이용해서 처리. findById()의 리턴 타입은 Optional<T>
@Test
public void testSelect() {
Long bno = 100L; // 조회하고자 하는 bno 번호
Optional<Board> result = boardRepository.findById(bno);
Board board = result.orElseThrow();
log.info(board);
}
update 기능 테스트
✓ update 기능은 insert와 동일하게 save()를 통해서 처리. 동일한 @Id 값을 가지는 개체를 생성해서 처리가능. ✓ update는 등록 시간이 필요하므로 가능하면 findById()로 가져온 객체를 이용하여 약간의 수정을 통해서 처리하도록 함 ✓ 일반적으로 엔티티 객체(Board 클래스)는 가능하면 최소한의 변경이나 변경이 없는 immutable로 설계하는 것이 좋지만, 강제적인 사항은 아니므로 Board 클래스에 수정이 가능한 부분을 미리 메서드로 설계
📍 Board의 경우 '제목 / 내용'은 수정이 가능하므로 이에 맞도록 change() 라는 메서드를 추가
@Test
public void testUpdate() {
Long bno = 100L;
Optional<Board> result = boardRepository.findById(bno);
Board board = result.orElseThrow();
board.change("update... title 100", "update content 100");
boardRepository.save(board);
}
findById 실행 ▶️ save()실행 시 다시 검사 ▶️ update 실행
⚡️ update가 실행된 후에 moddate가 변경된 것 확인 ⚡️ 변경할 부분을 sql에서 set로 지정하는 것이 아니라, 객체를 영속성 콘텍스트에 올리면 @Id와 동일한 데이터를 찾아 매핑을 하는 개념이어서 수정할 부분만 엔티티 객체에 넣으면 안되고, 데이터베이스에 저장되어야 하는 데이터와 동일한 엔티티 객체가 필요함
📍 JDBC나 MyBatis 방식으로 처리하면 에러
@Test
public void testUpdate2() {
Long bno = 100L;
Board board = Board.builder()
.bno(bno)
.title("title...")
.content("content...update3")
.build();
boardRepository.save(board);
}
📍 없는 @Id 값을 지정하면 update가 아니라 insert가 실행
@Test
public void testUpdate3() {
Long bno = 10000L;
Board board = Board.builder()
.bno(bno)
.title("title...")
.content("content...update")
.build();
boardRepository.save(board);
}
delete 기능 테스트
✓ delete는 @Id에 해당하는 값으로 deleteById()를 통해서 실행
✓ deleteById() 역시 데이터베이스의 내부에 같은 @Id가 존재하는지 먼저 확인하고 delete문이 실행
@Test
public void testDelete() {
Long bno = 1L;
boardRepository.deleteById(bno);
}
수정이나 삭제 시에 굳이 select문이 먼저 실행되는 이유는 JPA의 동작 방식과 관련. JPA를 이용한다는 것은 엄밀하게 말하면 영속 컨텍스트와 데이터베이스를 동기화해서 관리한다는 의미. 그러므로 특정한 엔티티 객체가 추가되면 영속 컨텍스트에 추가하고, 데이터베이스와 동기화가 이루어짐. 마찬가지로 수정이나 삭제를 한다면 영속 컨텍스트에 해당 엔티티 객체가 존재해야만 하므로 먼저 select로 엔티티 객체를 영속 컨텍스트에 저장해서 이를 삭제한 후에 delete가 이루어짐.
4) Pageable과 Page<E> 타입
👾 Spring Data JPA를 이용해서 별도의 코드 없이도 CRUD가 실행되지만, 페이징 처리도 가능 👾 페이징 처리는 Pageable이라는 타입의 객체를 구성해서 파라미터로 전달하면 됨. 👾 Pageable은 인터페이스로 설계되어 있고, 일반적으로는 PageRequest.of()라는 기능을 이용해서 개발이 가능.
PageRequest.of(페이지 번호, 사이즈) : 페이지 번호은 0부터 PageRequest.of(페이지 번호, 사이즈, Sort) : 정렬 조건 추가 PageRequest.of(페이지 번호, 사이즈, Sort.Direction, 속성...) : 정렬 방향과 여러 속성 지정
⚡️ 파라미터로 Pageable을 이용하면 리턴 타입은 Page<T> 타입을 이용할 수 있는데 이는 단순 목록뿐 아니라 페이징 처리에 데이터가 많은 경우에는 count 처리를 자동으로 실행 ⚡️ 대부분의 Pageable 파라미터는 메서드 마지막에 사용하고, 파라미터에 Pageable이 있는 경우에는 메서드의 리턴 타입을 Page<T> 타입으로 설계.
JpaRepository에는 findAll()이라는 기능을 제공하여 기본적인 페이징 처리를 지원
@Test
public void testPaging() {
// 1 page order by bno desc
Pageable pageable = PageRequest.of(0, 10, Sort.by("bno").descending());
Page<Board> result = boardRepository.findAll(pageable);
}
✓ findAll()의 리턴 타입으로 나오는 Page<T> 타입은 내부적으로 페이징 처리에 필요한 여러 정보를 처리 ✓ 예를 들어 다음 페이지가 존재하는지, 이전 페이지가 존재하는지, 전체 데이터의 개수는 몇 개인지 등의 기능들을 모두 알아낼수 있음
👾 간단한 CRUD는 JpaRepository를 이용하면 되지만 다양한 검색 조건이 들어가게 되면 추가 기능이 필요하게 됨 👾 예를 들어 특정한 범위의 Memo 객체를 검색하거나, like 처리가 필요한 경우, 여러 검색 조건이 필요한 경우 등
💡 Spring Data JPA의 경우에는 이러한 처리를 위해 다음과 같은 방법을 제공 · 쿼리 메서드 : 메서드의 이름 자체가 쿼리의 구문으로 처리되는 기능. · @Query : SQL과 유사하게 엔티티 클래스의 정보를 이용해서 쿼리를 작성하는 기능. JPQL. · Querydsl 등의 동적 쿼리 기능
⚡️ 쿼리 메서드는 보통 SQL에서 사용하는 키워드와 컬럼들을 같이 결합해서 구성하면 그 자체가 JPA에서 사용하는 쿼리가 되는 기능 - 일반적으로는 메서드 이름을 'findBy...' 혹은 'get...'으로 시작하고 칼럼명과 키워드를 결합하는 방식으로 구성 (각 키워드 사용법은 https://spring.io/projects/spring-data-jpa 참고) - 인텔리제이 얼티메이트에서는 자동완성 기능으로 쿼리 메서드를 작성할 수 있는 기능을 지원 - 쿼리 메서드는 실제로 사용하려면 상당히 길고 복잡한 메서드를 작성하게 되는 경우가 많음 ➡️ 예를 들어 '제목'에 특정한 '키워드'가 존재하는 게시글들을 bno의 역순으로 정렬해서 가져오고 싶다면 아래의 메소드 이름이 생성
✓ 쿼리 메서드는 주로 단순한 쿼리를 작성할 때 사용하고 실제 개발에서는 많이 사용되지 않음
⚡️ @Query로 JPQL을 이용 - @Query 어노테이션의 value로 작성하는 문자열을 JPQL이라고 하는데 JPQL은 SQL과 유사하게 JPA에서 사용하는 쿼리 언어 query language 라고 생각하면 됨 - JPA는 데이터베이스에 독립적으로 개발이 가능하므로 특정한 데이터베이스에서만 동작하는 SQL 대신에 JPA에 맞게 사용하는 JPQL을 이용. JPQL은 테이블 대신에 엔티티 타입을 이용하고 컬럼 대신에 엔티티의 속성으로 이용해서 작성. JPQL은 SQL을 대신하는 용도로 사용하기 때문에 SQL에 존재하는 여러 키워드나 기능들이 거의 유사하게 제공.
📍 앞선 쿼리 메서드에 @Query를 이용한다면 다음과 같이 작성
@Query("select b from Board b where b.title like concat('%', :keyword, '%')")
Page<Board> findKeyword(String keyword, Pageable pageable);
✓ 작성된 JPQL을 보면 SQL과 상당히 유사하다는 것을 알 수 있음 ✓ @Query를 이용하면 크게 쿼리 메서드가 할 수 없는 몇 가지 기능을 할 수 있음 * 조인과 같이 복잡한 쿼리를 실행할 수 있는 기능 * 원하는 속성들만 추출해서 Object[]로 처리하거나 DTO로 처리하는 기능 * nativeQuery 속성값을 true로 지정해서 특정 데이터베이스에서 동작하는 SQL을 사용하는 기능
💡 kapt란? "자바 6부터 도입된 Pluggable Annotation Processing API (JSR 269)를 Kotlin에서도 사용 가능하게 하는 것입니다."[안드로이드 공식문서]
✓ 어노테이션 프로세싱이란 우리가 간단하게 '@명령어'처럼 사용하는 주석형태의 문자열을 실제 코드로 생성해주는 것 ✓ @로 시작하는 명령어를 어노테이션이라고 하는데, 어노테이션이 컴파일 시에 코드로 생성되기 때문에 실행 시에 발생할 수 있는 성능 문제가 많이 개선됨 ✓ Room을 사용하면 클래스명이나 변수명 위에 @어노테이션을 사용해서 코드로 변환할 수 있음
2) RoomMemo 클래스 정의하기
A. 먼저 SQLite 프로젝트에서 사용한 파일 중에서 java 패키지 아래에 있는 MainActivity, RecyclerAdapter를 복사해서 이 프로젝트에 붙여넣기 함
동일한 파일인 MainActivity가 이미 있기 때문에 붙여넣기 여부를 묻는 팝업창에 [Overwrite]를 클릭
붙여넣기를 한 ActivityMain을 열어보면 패키지 명과 네 번째 import인 ActivityMainBinding의 경로가 다름 두 군데만 수정
B. [res] - [layout] 밑에 있는 activity_main.xml과 item_recycler.xml도 복사해서 붙여넣기
C. 패키지 이름에서 [New] - [Kotlin File/Class]를 선택해서 RoomMemo로 클래스를 생성
@Entity(tableName = "room_memo")
class RoomMemo {
constructor(content: String, datetime: Long) {
this.content = content
this.datetime = datetime
}
@PrimaryKey(autoGenerate = true)
@ColumnInfo
var num: Long? = null
@ColumnInfo
var content: String = ""
@ColumnInfo(name = "date")
var datetime: Long = 0
}
@Entity(tableName = "room_memo")
class RoomMemo { ... }
✓ @Entity 어노테이션을 class RoomMemo 위에 작성. Room 라이브러리는 @Entity 어노테이션이 적용된 클래스를 찾아 테이블로 변환 ✓ 데이터베이스에서 테이블명을 클래스명과 다르게 하고 싶을 때는 @Entity(tableName = "테이블명")과 같이 작성하면 됨
@ColumnInfo
var num: Long? = null
@ColumnInfo
var content: String = ""
@ColumnInfo(name = "date")
var datetime: Long = 0
✓ 멤버 변수 num, content, date 3개를 선언하고 변수명 위에 @ColumnInfo 어노테이션을 작성해서 테이블의 컬럼으로 사용된다는 것을 명시. 컬럼명도 테이블명처럼 변수명과 다르게 하고 싶을 때는 @ColumnInfo(name = "컬럼명")과 같이 작성하면 됨.
@PrimaryKey(autoGenerate = true)
@ColumnInfo
var num: Long? = null
✓ num 변수에 @PrimaryKey 어노테이션을 사용해서 키(Key)라는 점을 명시하고 자동증가 옵션을 추가
Room은 데이터베이스에 읽고 쓰는 메서드를 인터페이스 형태로 설계하고 사용. 코드 없이 이름만 명시하는 형태로 인터페이스를 만들면 Room이 나머지 코드를 자동 생성함
💡 DAO란? Data Access Object의 약어로 데이터베이스에 접근해서 DML 쿼리 (SELECT, INSERT, UPDATE, DELETE)를 실행하는 메서드의 모음
[app] - [java] 밑의 패키지 아래에 RoomMemoDao 인터페이스를 생성
인터페이스 상단에 @Dao 어노테이션을 작성하고 Dao라는 것을 명시
@Dao
interface RoomMemoDao { ... }
조회, 삽입, 수정, 삭제에 해당하는 3개의 메서드를 만들고 각각의 어노테이션 을 붙여줌
@Dao
interface RoomMemoDao {
// 다른 ORM 툴과는 다르게 조회를 하는 select 쿼리는 직접 작성하도록 설계.
// 대부분의 ORM은 select도 메서드로 제공
@Query("SELECT * FROM room_memo")
fun getAll() : List<RoomMemo>
@Insert(onConflict = REPLACE)
fun insert(memo: RoomMemo)
}
✓ 두 번째 @Insert 어노테이션의 경우 옵션으로 onConflict = REPLACE를 적용하면 동일한 키를 가진 값이 입력되었을 때 UPDATE 쿼리로 실행이 됨
어노테이션의 종류
어노테이션
위치
옵션
설명
@Database
클래스
entities, version
데이터베이스
@Entity
클래스
(tableName = "테이블명")
테이블
@ColumnInfo
멤버변수
(name = "컬럼명")
컬럼
@PrimaryKey
멤버변수
(autoGenerate = true)
컬럼 옵션
@Dao
인터페이스
실행 메서드 인터페이스
@Query
멤버 메서드
("쿼리")
쿼리를 직접 작성하고 실행
@Insert
멤버 메서드
(onConflict = REPLACE)
중복 시 수정
@Delete
멤버 메서드
삭제
4) RoomHelper 클래스 정의하기
SQLiteOpenHelper를 상속받아서 구현했던 것처럼 Room도 유사한 구조로 사용할 수 있음. Room은 RoomDatabase를 제공하는데 RoomDatabase를 상속받아 클래스를 생성하면 됨 📍 주의할 점은 추상 클래스로 생성해야 함. 기존 클래스와 동일하게 생성하고 class 앞에 abstract 키워드를 붙이면 추상 클래스가 됨.
[app] - [java] 밑의 패키지 아래에 RoomHelper 클래스를 생성하고 앞에 abstract 키워드를 붙여서 추상 클래스를 만듦 이 클래스는 RoomDatabase를 상속받음.
abstract class RoomHelper: RoomdDatabase() {}
클래스명 위에 @Database 어노테이션을 작성
@Database(entities = arrayOf(RoomMemo::class), version = 1, exportSchema = false)
📌 @Database 어노테이션 속성
옵션
설명
entities
Room 라이브러리가 사용할 엔티티(테이블) 클래스 목록
version
데이터베이스의 버전
exportSchema
true면 스키마 정보를 파일로 출력
RoomHelper 클래스 안에 앞에서 정의한 RoomMemoDao 인터페이스의 구현체를 사용할 수 있는 메서드명을 정의
@Database(entities = arrayOf(RoomMemo::class), version = 1, exportSchema = false)
abstract class RoomHelper: RoomDatabase() {
abstract fun roomMemoDao(): RoomMemoDao
}
✓ 빈 껍데기 코드만 작성해 두는 것만으로 Room 라이브러리를 통해서 미리 만들어져 있는 코드를 사용할 수 있게 됨
5) 어댑터에서 사용하는 Memo 클래스를 RoomMemo 클래스로 변경
· Memo 문자열을 모두 RoomMemo로 수정
· helper 변수가 선언된 부분을 RoomHelper를 사용할 수 있도록 수정
➡️ var helper: SQLiteHelper? = null ▶️ var helper: RoomHelper? = null
· buttonDelete 클릭리스너에 있는 deleteMemo() 메서드를 RoomHelper의 메서드로 수정. RoomHelper를 사용할 때는 여러 개의 Dao가 있을 수 있기 때문에 '헬퍼.Dao().메서드()'형태로 어떤 Dao를 쓸 것인지 명시해야 함.
✓ helper에 null이 허용되므로 helper 안의 코드를 사용하기 위해서는 helper?.의 형태로 사용. 이어지는 roomMemoDao()?.도 같은 맥락이고, adapter의 listData에 null이 허용되지 않기 때문에 마지막에 ?:(Elvis Operator)를 사용해서 앞의 2개가 null일 경우 사용하기 위한 디폴트 값을 설정
저장 버튼을 클릭 시 사용하는 코드도 RoomHelper로 바꿔줌
binding.buttonSave.setOnClickListener {
if (binding.editMemo.text.toString().isNotEmpty()) {
val memo = RoomMemo(binding.editMemo.text.toString(), System.currentTimeMillis())
helper?.roomMemoDao()?.insert(memo)
adapter.listData.clear()
adapter.listData.addAll(helper?.roomMemoDao()?.getAll()?: listOf())
adapter.notifyDataSetChanged()
binding.editMemo.setText("")
}
}
