📋 익명게시판 제작

👩🏻‍🦰 익명게시판 제작. 회원가입, 로그인 기능은 필요 없음!

✔ 목표

• 게시글 작성 기능 ✔
  • 게시글 구성 : 제목, 내용 ✔
  • 게시글 저장 시, id(PK)를 Auto-increment 형식으로 저장 ✔
  • 작성 성공 시, 응답값으로 작성된 게시글에 대한 정보 반환 ✔
• 게시글 전체 조회 기능 ✔
  • id, 제목, 내용 포함 ✔
• 특정 게시글 조회, 수정, 삭제 기능 ✔
  • id를 통해 수행 ✔
  • 수정 성공 시, 게시글 정보 반환 ✔

📌 배운점

• REST API 규칙을 지키며 설계하기
  • URL 경로 및 HTTP 메서드 기반 요청 라우팅
  • Request Body, Query Params, Path Params 사용
• postman : 요청부터 응답까지 전체 과정을 경험
  • [POST] 시 "status": 406, "error": "Not Acceptable"
    에러 원인 : DTO에 @ToString 부재로 Json파일 반환 시 주소 값이 반환돼서 발생. ➡ DTO에 @DATA 추가
• JPA의 ORM(객체-RDB Mapping)에 대한 이해
• HTTP 상태코드에 대한 이해
• @annotation에 대한 이해

💡 라우팅

• 웹 애플리케이션에서 클라이언트 요청을 적절한 핸들러 또는 컨트롤러로 전송하는 프로세스
• URL과 HTTP 메서드를 기반으로 요청을 처리하고, 애플리케이션 내에서 적절한 동작을 수행

👩🏻‍💻 개발 과정

1. 데이터 모델 클래스 생성

@Setter
@Getter
@ToString
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(of = "postId", callSuper = false)
@Builder

@Entity
@Table(name = "tbl_post")
public class Post {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
  @Column(name = "title", nullable = false)
  private String title;
  @Column(name = "content", nullable = false)
  private String content;
}

@Data 의 Setter는 그 의도가 분명하지 않고 객체를 언제든지 변경할 수 있는 상태가 되어서 객체의 안전성이 보장받기 힘들다.

2. Repository 인터페이스 생성

public interface BoardRepository extends JpaRepository<Post, Long> {}

JpaRepository

save(S entity) 저장 or 업데이트
findById(ID id): ID 값으로 검색
existsById(ID id) ID 값에 해당하는 데이터가 존재하는지 여부
findAll()모든 엔티티를 검색
count() 저장된 엔티티의 총 수
deleteById(ID id)지정된 ID 값 삭제
delete(T entity): 지정된 엔티티를 삭제
deleteAll()모든 엔티티를 삭제

• Spring Data JPA 프레임워크에서 제공하는 인터페이스, 데이터베이스와 상호작용
• 기본적인 CRUD(Create, Read, Update, Delete) 작업을 간소화하고 추상화하는 기능 제공

3. 게시글 작성

1. Controller 클래스 생성

1. 클라이언트로부터 HTTP 요청을 받는다.
2. Service를 통해 게시글을 작성하고 클라이언트에 응답을 반환한다.

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/anonymous")
public class BoardController {
  private final BoardService boardService;

  // 게시글 작성
  @PostMapping
  public ResponseEntity<PostResponseDTO> createPost(@RequestBody final Post requestPost) {
    PostResponseDTO dto = boardService.savePost(requestPost);
    return ResponseEntity.ok(dto);
  }

final

• 안정성 : 매개변수를 final 로 선언하여 안정성을 높입니다. 실수로 값을 재할당하거나 수정하는 것을 방지합니다.
• 가독성 : 메서드나 블록내에서 변경되지 않는다는 것을 명시적으로 나타냅니다.
• 스레드 안정성 : final로 선언된 매개변수는 다른 스레드에서 매개변수를 수정하려고 시도할 수 없으므로 스레드 간 충돌을 방지합니다.

2. Service

컨트롤러로부터 받은 요청을 처리하고, 필요한 데이터베이스 작업을 수행하여 응답을 생성하는 중간 계층 역할

1. CrudRepository를 상속 받은 BoardRepository의 .save()를 통해 게시글 정보를 DB에 저장한다.
2. PostResponseDTO로 변환하여 결과를 반환한다.

@Service
@RequiredArgsConstructor
public class BoardService {
  private final BoardRepository boardRepository;

  public PostResponseDTO savePost(final Post post) {
    return new PostResponseDTO(boardRepository.save(post));
  }
}

• DTO

    public PostResponseDTO(Post post) {
      this.id = post.getId();
      this.title = post.getTitle();
      this.content = post.getContent();
    }

4. 게시글 전체 조회

• 리스트로 반환 : .stream.map.collect(Collectors.toList());

// Controller
  @GetMapping
  public ResponseEntity<List<PostResponseDTO>> getPostAll(){
    List<PostResponseDTO> allPostDto = boardService.findAllPost();
    return ResponseEntity.ok(allPostDto);
  }
  
// Service
  public List<PostResponseDTO> findAllPost(){
    List<Post> posts = boardRepository.findAll();
    return posts.stream()
            .map(post -> new PostResponseDTO(post))
            .collect(Collectors.toList());
  }

5. 특정 게시글 (orElseThrow)

1) 조회

• ?id=1 쿼리를 통해 받을 경우
  : @GetMapping(params = "postId") 과 @RequestParam

// Controller
  @GetMapping(params = "id")
  public ResponseEntity<PostResponseDTO> getPostsById(@RequestParam("id") final Long postId){
    PostResponseDTO postDto = boardService.findPostById(postId);
    return ResponseEntity.ok(postDto);
  }

• Optional type 변환 하기
  .orElseThrow(() -> new NoSuchElementException("Post not found"));

// Service
  public PostResponseDTO findById(Long postId){
    return new PostResponseDTO(returnPost(postId));
  }

  private Post returnPost(Long postId) {
    return boardRepository.findById(postId)
       .orElseThrow(() -> new NoSuchElementException("Post not found"));
  }

2) 수정

• URL 경로 : /api/anonymous/1
• 수정 할 내용 : HTTP 요청의 본문을 POST로 매핑

  @PutMapping("/{postId}")
  public ResponseEntity<PostDTO> updatePost(
      @PathVariable final Long postId,
      @RequestBody final PostUpdateDTO updatedPost) {
    log.info("update post by id - controller : id = "+postId);
    log.info("update post content - controller : content = "+updatedPost.toString());

    PostDTO postDto = boardService.update(postId, updatedPost);
    return ResponseEntity.ok(postDto);
  }

  public PostDTO update(Long postId, PostUpdateDTO updatedPost) {
    Post post = returnPost(postId);
    post.setTitle(updatedPost.getTitle());
    post.setContent(updatedPost.getContent());
    return new PostDTO(post);
  }

3) 삭제

  @DeleteMapping("/{postId}")
  public ResponseEntity<Boolean> deletePost(@PathVariable final Long postId) {
    boolean isDeleted = boardService.deletePost(postId);
    return ResponseEntity.ok(isDeleted);
  }
---  
  public boolean deletePost(Long postId) {
    try {
      boardRepository.deleteById(postId);
      return true; // 삭제 성공 시 true 반환
    } catch (EmptyResultDataAccessException e) {
      // 해당 ID의 게시글이 이미 삭제된 경우
      return false; // 삭제 실패 시 false 반환
    }
  }