[Spring Boot] Toy Project 게시판 만들기 (3) - 조회, 삭제

---

1️⃣ ResponseDto 생성

💚 BoardReadDto

• 게시글 단독 조회 시 사용

package com.gdsc_teamb.servertoyproject.dto.boardDto;

import com.gdsc_teamb.servertoyproject.domain.post.domain.PostEntity;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserEntity;
import lombok.Getter;

// 게시글 조회 시 사용
@Getter
public class BoardReadDto {

    private Long id; // 게시글 ID
    private String title; // 게시글 제목
    private String content; // 게시글 내용
    private String nickname; // 작성자 정보

    // BoardReadDto 의 생성자
    public BoardReadDto(PostEntity entity){
        this.id=entity.getId();
        this.content=entity.getContent();
        this.title=entity.getTitle();
        this.nickname=entity.getUser().getNickname();
    }
}

💚 BoardListDto

• 게시글 목록 조회 시 사용

package com.gdsc_teamb.servertoyproject.dto.boardDto;

import com.gdsc_teamb.servertoyproject.domain.post.domain.PostEntity;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserEntity;
import lombok.Getter;

import java.time.LocalDateTime;

// 게시글 목록 조회 시 사용
@Getter
public class BoardListDto {

    private Long id; // 게시글 ID
    private String title; // 게시글 제목
    private String nickname; // 작성자 닉네임
    private LocalDateTime updated_at; // 수정 일자

    // BoardListDto 의 생성자
    public BoardListDto(PostEntity entity){
        this.id=entity.getId();
        this.title=entity.getTitle();
        this.nickname=entity.getUser().getNickname(); // UserEntity 에서 nickname 가져오기
        this.updated_at=entity.getUpdated_at();
    }
}

---

2️⃣ Service 생성

💚 BoardService

package com.gdsc_teamb.servertoyproject.service;

import com.gdsc_teamb.servertoyproject.domain.post.domain.PostEntity;
import com.gdsc_teamb.servertoyproject.domain.repository.PostRepository;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserEntity;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserRepository;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardListDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardReadDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardUpdateDto;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;
import java.util.stream.Collectors;

@Service
@RequiredArgsConstructor

public class BoardService {
    private final PostRepository postRepository;
    private final UserRepository userRepository;

    @Transactional
    public ResponseEntity<Object> findById (Long id) {
        try {
            // boardRepository 에서 주어진 id에 해당하는 게시글을 데이터베이스에서 조회
            PostEntity post = postRepository.findById(id)
                    .orElseThrow(() -> new IllegalArgumentException());
            return ResponseEntity.ok(new BoardReadDto(post));
        } catch (Exception e) {
            return ResponseEntity.badRequest().body("게시글 조회에 실패했습니다. " + e.getMessage());
        }

    }
    
    @Transactional (readOnly=true)
    public List<BoardListDto> findAllByOrderByIdDesc(){
        return postRepository.findAllByOrderByIdDesc().stream()
                // BoardRepository 의 findAllDesc 메서드를 호출하여 게시글을 내림차순으로 조회 (쿼리 기능)
                .map(BoardListDto::new)// 각 게시글을 BoardListDto 로 변환
                .collect(Collectors.toList()); // 이후 리스트로 수집하여 반환
    }

    @Transactional
    public ResponseEntity<Object> deletePost(Long id){
        try{
            // boardRepository 에서 주어진 id에 해당하는 게시글을 데이터베이스에서 조회
            PostEntity post= postRepository.findById(id)
                    .orElseThrow(() -> new IllegalArgumentException("해당 게시글이 없습니다. id="+id));
            // JpaRepository 에서 기본 제공되는 delete 메서드
            // 주어진 post 엔티티를 데이터베이스에서 삭제하는 역할
            postRepository.delete(post);
            return ResponseEntity.ok("게시글이 성공적으로 삭제되었습니다.");
        }catch (Exception e){
            return ResponseEntity.badRequest().body("게시글 삭제에 실패했습니다. " + e.getMessage());
        }

    }


}

📌 findById()

• 게시글 세부 내용 조회
• id는 조회할 게시글의 ID를 담음
• 조회된 게시글의 세부 내용을 담은 BoardReadDto를 return

📌 findAllByOrderByIdDesc()

• 게시글 목록 조회
• 게시글 목록을 담은 List<BoardListDto> return

📌 deletePost()

• 게시글 삭제
• id는 삭제할 게시글의 ID

---

3️⃣ Controller 생성

💚 BoardController

package com.gdsc_teamb.servertoyproject.controller;

import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardListDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardReadDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardUpdateDto;
import com.gdsc_teamb.servertoyproject.service.BoardService;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequiredArgsConstructor

public class BoardController {
    private final BoardService boardService;

    @GetMapping("/api/boards/{id}")
    public ResponseEntity<Object> findById (@PathVariable Long id){
        return boardService.findById(id);
    }

    @GetMapping("/api/boards")
    public List<BoardListDto> findAllDesc() {
        return boardService.findAllByOrderByIdDesc();
    }

    @DeleteMapping("/api/boards/{id}")
    public Long delete(@PathVariable Long id){
        boardService.deletePost(id);
        return id;
    }
}

📌 findById()

• HTTP GET 요청을 통해 특정 ID의 게시글을 조회
• 매개변수: 조회할 게시글의 ID를 전달받음
• @PathVariable을 통해 경로에서 추출된 게시글의 ID를 전달 받음
• 반환 값: 조회된 게시글의 세부 정보가 담긴 DTO를 반환

📌 findAllDesc()

• HTTP GET 요청을 통해 모든 게시글 목록을 조회
• 반환 값: 조회된 모든 게시글의 목록이 담긴 DTO 들을 리스트로 반환

📌 delete()

• HTTP DELETE 요청을 통해 특정 ID의 게시글을 삭제
• 매개변수: 삭제할 게시글의 ID를 전달 받음
• @PathVariable 을 통해 경로에서 추출된 게시글의 ID를 전달 받음
• 반환 값: 삭제가 완료된 게시글의 ID를 반환

---

4️⃣ TestCode

💚 BoardControllerTest

• 게시글 삭제 통신이 잘 이루어지는지에 대한 테스트 코드
• MocMvc 사용하여 통신

package com.gdsc_teamb.servertoyproject.controller;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.gdsc_teamb.servertoyproject.domain.post.domain.HeartEntity;
import com.gdsc_teamb.servertoyproject.domain.post.domain.PostEntity;
import com.gdsc_teamb.servertoyproject.domain.repository.PostRepository;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserRepository;
import com.gdsc_teamb.servertoyproject.domain.user.domain.UserEntity;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardDto;
import com.gdsc_teamb.servertoyproject.dto.boardDto.BoardUpdateDto;
import jakarta.transaction.Transactional;
import org.junit.jupiter.api.*;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.http.*;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;

import java.util.List;
import java.util.Map;
import java.util.Optional;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.test.util.AssertionErrors.fail;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;


@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
@Transactional
class BoardControllerTest {
    // 테스트에 사용할 서버의 랜덤 포트 번호를 할당
    @LocalServerPort
    private int port;
    @Autowired
    private PostRepository postRepository;
    @Autowired
    private UserRepository userRepository;
    @Autowired
    private MockMvc mockMvc;

    @Test
    @DisplayName("게시물 삭제 테스트")
    public void deletePost() throws Exception{
        UserEntity savedUser = userRepository.save(UserEntity.builder()
                .email("abc@abc.com")
                .password("password1234")
                .nickname("nickname")
                .phone("01012345678")
                .build());

        PostEntity savedPost = postRepository.save(PostEntity.builder()
                .title("title")
                .content("content")
                .user(savedUser)
                .build());

        Long deleteId = savedPost.getId();
        String url="http://localhost:" + port + "/api/boards/"+deleteId;

        // when
        mockMvc.perform(delete(url))
                .andExpect(status().isOk());

        // then
        // 삭제한 데이터 조회
        Optional<PostEntity> deletedPost = postRepository.findById(savedPost.getId());
        assertThat(deletedPost).isNotPresent();
    }
}

---