[웹개발의 봄, Spring] 3주차 개발일지(1) - Timeline Service 서버

 

3주차에서는 간단한 프로젝트를 처음부터 끝까지 완성해봤다. 완성한 프로젝트는 Timeline Service로, 사용자가 간단한 메모를 작성, 수정, 삭제할 수 있는 서비스이다. 특이한 점은, 작성한 지 24시간이 지난 메모들은 자동으로 삭제된다는 점이다. 

 

완성된 프로젝트 화면

 

프로젝트 진행 절차는 다음과 같다. 

1. API 설계하기
2. Repository, Service, Controller 만들기
3. 클라이언트 설계하기
4. 클라이언트 완성하기

중간에 HTML, CSS, Javascript, jQuery에 관한 내용을 학습했지만, 이 부분은 왕초보 시작반 강의 내용과 겹치기 때문에 따로 정리하진 않겠다. 

 

서버와 관련된 1, 2번과 클라이언트와 관련된 3, 4번을 나눠서 포스팅을 작성하려한다. 이번 포스팅에서는 서버 관련 내용을 적어보겠다😉

 

 

 

API 설계 및 구현

💡 API 설계

기능	Method	URL	Return
메모 생성하기	POST	/api/memos	Memo
메모 조회하기	GET	/api/memos	List<Memo>
메모 변경하기	PUT	/api/memos/{id}	Long
메모 삭제하기	DELETE	/api/memos/{id}	Long

 

 

💡 Repository 만들기

1. 프로젝트에 domain 패키지 만들기
2. Memo 클래스 만들기
   - 메모는 1) username, 2) contents로 이루어짐
   - username은 메모를 생성할 때 자동으로 주어지는 익명의 id임
   - Timestamped 클래스를 생성해서 상속 받기
3. MemoRepository 인터페이스 만들기
   - JpaRepsitory를 상속받고 ID가 Long 타입인 MemoRepository를 생성
4. MemoRequestDto 클래스 만들기

 

 

💡 Service 만들기

1. 프로젝트에 service 패키지 만들기
2. MemoService 클래스 만들기
   - Annotation으로 Service임을 명시해야 함
   - MemoRepository를 멤버 변수로 가져야 함
3. MemoService 클래스에 update 기능 추가하기
   - id와 requestDto을 받아서 해당 메모를 수정하고 id를 반환하는 메소드 생성
4. Memo 클래스에 update 메소드 추가하기

 

 

💡 Controller 만들기

1. 프로젝트에 controller 패키지 만들기
2. MemoController 클래스 만들기
   - Annotation으로 RestController임을 명시해야 함
   - Create, Read, Delete를 위해 MemoRepository를 멤버 변수로 가져야 함
   - Update를 위해 MemoService를 멤버 변수로 가져야 함
3. url 매핑을 통해 CRUD 메소드 작성하기

 

 

💡 Memo 목록 조회 수정하기

Timeline Service에서는 24시간 이내에 작성 또는 수정된 메모만 보여주도록 하고 있다. 따라서 MemoRepository에서 메모를 불러오는 부분을 수정해주어야 한다. 

 

- MemoRepository.java

public interface MemoRepository extends JpaRepository<Memo, Long> {
    List<Memo> findAllByModifiedAtBetweenOrderByModifiedAtDesc(LocalDateTime start, LocalDateTime end);
}

 

- MemoController.java의 getMemos()

@GetMapping("/api/memos")
public List<Memo> getMemos() {
    LocalDateTime start = LocalDateTime.now().minusDays(1);
    LocalDateTime end = LocalDateTime.now();
    return memoRepository.findAllByModifiedAtBetweenOrderByModifiedAtDesc(start, end);
}

 

아래 사이트에서 JPA query에 대한 내용을 참고할 수 있다. 

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods

Spring Data JPA - Reference Documentation

 

 

💡 전체 소스 코드 확인

https://github.com/mjmjmj9840/Sparta-Spring-Basic/tree/main/week03

mjmjmj9840/Sparta-Spring-Basic

 

 

 

 

 

 

참고 자료: 스파르타코딩클럽 웹개발의 봄, Spring 3주차 강의자료