Spring Boot에서 게시글 댓글 관리 해보기! ヽ(✿ﾟ▽ﾟ)ノ

• 사용 IDE : IntelliJ IDEA Ultimate
• 사용 DB : MySQL
• 사용 언어 & SDK : Java & Amazon correto 11
• 정리본입니다 참고용으로만 봐주세요 :D
• 게시글 댓글 작성에 대해 알아보기!! (っ・∀・）っ
  
  
  이전글
  𝜌 Spring Boot 예제1 (게시글 관리) ヽ(✿ﾟ▽ﾟ)ノ
  𝜎 SpringBoot 예제2 (게시글 관리) (っ・∀・）っ

---

Comment

안녕하세요:D
오늘은 댓글 관리에 대해 알아보도록 하겠습니다~~!!
댓글작성 및 출력은 기존과 다른게 없으므로 댓글 저장 및 출력은 생략하겠습니다 :D
그대신 DB관련 내용이 복잡할 수 있으므로 이에 설명을 하겠습니다!!
그럼 바로 시작하시죠!(๑•̀ㅂ•́)و

---

CommentEntity

댓글 작성을 하기 전 Spring Framework에서와 같이 table을 생성해야합니다.
이번엔 JPA로 댓글 관리를 할 예정이기 때문에 Entity Class를 하나 생성해줍니다.

@Entity
@Getter
@Setter
@Table(name = "comment_table")
public class CommentEntity extends BaseEntity {
// 시간은 BaseEntity가 생성하게 할 것이기 때문에 BaseEntity를 상속받는 클래스로 선언!

	// 만들 컬럼 : 댓글번호, 작성자, 내용, 원글 번호

	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	@Column(name = "comment_id")
	private Long id;

	// JPA에서 참조관계 맺기
	// JPA 문법이기 때문에 외우기
	// 원글의 게시글 번호를 참조하기 위한 설정
	// 댓글과 게시글의 관계에서 댓글 입장에선 -> N : 1 관계, 게시글 입장에선 1 : N
	@ManyToOne(fetch = FetchType.LAZY)  // @ManyToOne : N : 1 관계로 설정 (현재 엔티티를 기준으로 결정, 댓글용 엔티티이므로  N : 1)
	@JoinColumn(name = "board_id")  // 부모 테이블(참조하고자 하는 테이블)의 pk 컬럼 이름
	private BoardEntity boardEntity;    // 참조하고자 하는 테이블을 관리하는 엔티티

	// LAZY : 다른 Entity를  쓸 때 만 요청해서 가져옴
	// EAGER : 다른 Entity를 쓰던 말던 무조건 가져옴.
	// EAGER는 데이터의 양이 커 부담이 크기 때문에 잘 사용하지 않는다.

	@Column
	private String commentWriter;

	@Column
	private String commentContents;

	// 차후에 써야하기 때문에 미리 만들어놓겠습니다.
	public static CommentEntity toSaveEntity(CommentSaveDTO commentSaveDTO, BoardEntity boardEntity) {
		CommentEntity commentEntity = new CommentEntity();
		commentEntity.setCommentWriter(commentSaveDTO.getCommentWriter());
		commentEntity.setCommentContents(commentSaveDTO.getCommentContents());
		commentEntity.setBoardEntity(boardEntity); 
		// jpa가 제공하는 기능을 활용하기 위해 Entity데이터 자체를 넣음.
		return commentEntity;
	}
}

위에 보시다시피 다른 테이블의 컬럼을 참조하기 위해선 먼저 ERD의 개념을 알아야합니다.
DB 생성 후 DataBase에서 역설계를 해 ERD를 만들어서 보면 >----| |- 이런식으로 선이 있는걸 볼 수 있습니다.
이 선이 바로 1:1, 1:N, N:1, N:N 관계를 나타내는 선입니다. 자세한 내용은 구글링... :D
아무튼 DB에서 직접 테이블 생성 시 참조키를 설정하면 문제가 없지만 JPA를 이용한다면 말이 달라집니다.
직접 Entity에서 설정을 해줘야하는데요, 위 어노테이션과 같이 먼저 이게 몇대몇 관계인지 정해놓고,
@ManyToOne, @OneToMany 등 맞는 어노테이션을 붙여줘야합니다.
그럼 CommentEntity를 생성했으니 BoardEntity에도 이 내용을 만들러 가야합니다
그럼 가보시죠!!

BoardEntity

// BoardEntity에 아래 내용 추가
// 댓글 연관관계
@OneToMany(mappedBy = "boardEntity", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.LAZY)
private List<CommentEntity> commentEntityList = new ArrayList<>();
// 게시글 하나에 댓글이 여러개 붙기 때문에 리스트 타입으로 선언해야함.
// 리스트 타입으로는 자식테이블의 엔티티가 들어감.

이렇게 제작을 해야 완성이 됩니다.
cascade, orphanRemoval은 참조키의 delete on cascade라고 생각하시면 이해하기 쉬울겁니다!!
또한 게시글 하나에는 댓글이 여러개가 올 수 있기 때문에 List타입으로 선언을 해야합니다.
List 타입으로는 자식테이블의 엔티티를 넣어야합니다!!
말이 좀 길었지만 중요한 내용이기 때문에 어쩔 수 없습니다 ŏ̥̥̥̥םŏ̥̥̥̥
그럼 DTO를 생성하러 가볼까요??

---

DTO

댓글 저장용 DTO 생성

@Data
@NoArgsConstructor
@AllArgsConstructor
public class CommentSaveDTO {

    private Long boardId;
    private String commentWriter;
    private String commentContents;

}

댓글 출력용 DTO 생성

@Data
@NoArgsConstructor
@AllArgsConstructor
public class CommentDetailDTO {

	private Long commentId;
	private Long boardId;
	private String commentWriter;
	private String commentContents;
	private LocalDateTime createTime;

	// 차후에 써야하니깐 미리 만들어놓겠습니다!
	public static CommentDetailDTO toCommentDetailDTO(CommentEntity commentEntity) {
		CommentDetailDTO commentDetailDTO = new CommentDetailDTO();
		commentDetailDTO.setCommentId(commentEntity.getId());
		commentDetailDTO.setBoardId(commentEntity.getBoardEntity().getId());
		commentDetailDTO.setCommentWriter(commentEntity.getCommentWriter());
		commentDetailDTO.setCommentContents(commentEntity.getCommentContents());
		commentDetailDTO.setCreateTime(commentEntity.getCreateTime());
		return commentDetailDTO;
	}
}

네 이렇게 댓글을 달 준비는 모두 끝났습니다.
html은 생략하고 Controller와 Service만 만들고, Test코드로만 진행하겠습니다:D
Service Interface에 대한 내용은 생략하겠습니다!
html은 ajax형식으로 직접 한번 해보시는것도...ㅎ
그럼 바로 가시죠~!

---

Controller

@Controller
@RequiredArgsConstructor
@RequestMapping("/comment")
public class CommentController {

	private final CommentService cs;

	@PostMapping("/save")
	public @ResponseBody List<CommentDetailDTO> save(@ModelAttribute CommentSaveDTO commentSaveDTO) {
		Long commentId = cs.save(commentSaveDTO);
		List<CommentDetailDTO> commentList = cs.findAll(commentSaveDTO.getBoardId());
		return commentList;
	}

}

---

Service

@Service
@RequiredArgsConstructor
public class CommentServiceImpl implements CommentService{

	private final CommentRepository cr;
	private final BoardRepository br;

	@Override
	public Long save(CommentSaveDTO commentSaveDTO) {
		BoardEntity boardEntity = br.findById(commentSaveDTO.getBoardId()).get();
		CommentEntity commentEntity = CommentEntity.toSaveEntity(commentSaveDTO, boardEntity);
		return cr.save(commentEntity).getId();
	}

	@Override
	public List<CommentDetailDTO> findAll(Long boardId) {
		BoardEntity boardEntity = br.findById(boardId).get();
		List<CommentEntity> commentEntityList = boardEntity.getCommentEntityList();
		List<CommentDetailDTO> commentList = new ArrayList<>();
		for (CommentEntity c: commentEntityList) {
			CommentDetailDTO commentDetailDTO = CommentDetailDTO.toCommentDetailDTO(c);
			commentList.add(commentDetailDTO);
		}
		return commentList;
	}

}

이렇게만 잘 따라왔다면 댓글 작성 및 댓글 목록을 불러오는데는 큰 지장이 없습니다.
물론 프론트에서 사용하기 위해선 html에 해당 내용을 작성해야하지만 저는 생략했습니다... :D
그럼 Test가 잘 작동하는지 보러가시죠!

---

Test

@SpringBootTest
public class CommentTest {

    @Autowired
    private BoardService bs;

    @Autowired
    private CommentService cs;

    @Autowired
    private CommentRepository cr;

    @Test
    @Transactional  // 참조관계의 데이터를 사용할 때 @Transactional 을 사용해야함. 그래야 나중에 여러가지에 사용 가능
    @Rollback(value = false)  // Rollback을 하지 않겠다는 의미
    @DisplayName("댓글작성 테스트")
    public void commentTest() {
//        Long boardId = bs.save(new BoardSaveDTO("테스트작성자", "테스트비밀번호", "테스트제목", "테스트내용"));
//        Long commentId = cs.save(new CommentSaveDTO(boardId, "댓글작성자", "댓글내용"));
//        assertThat(commentId).isNotNull();
        assertThat(cs.save(new CommentSaveDTO(bs.save(new BoardSaveDTO("테스트작성자", "테스트비밀번호", "테스트제목", "테스트내용")), "댓글작성자", "댓글내용"))).isNotNull();
    }

    @Test
    @Transactional
    @DisplayName("댓글 조회 테스트")
    public void findByIdTest() {
        CommentEntity commentEntity = cr.findById(1L).get();
        // 원래 Long타입을 매개변수로 보낼 때 뒤에 L을 붙여서 보내야한다.
        System.out.println("commentEntity.toString() = " + commentEntity.toString());
        System.out.println("commentEntity.getId() = " + commentEntity.getId());
        System.out.println("commentEntity.getCommentWriter() = " + commentEntity.getCommentWriter());
        System.out.println("commentEntity.getCommentContents() = " + commentEntity.getCommentContents());
        System.out.println("commentEntity.getBoardEntity() = " + commentEntity.getBoardEntity());
        System.out.println("commentEntity.getBoardEntity().getBoardTitle() = " + commentEntity.getBoardEntity().getBoardTitle());
        // 이렇게 board_table에 속한 컬럼도 갖고 올 수 있다.
    }

    @Test
    @Transactional
    @DisplayName("댓글 목록 조회 테스트")
    public void findByAllTest() {
        List<CommentDetailDTO> commentDetailDTOList = cs.findAll(1L);
        for (CommentDetailDTO c: commentDetailDTOList) {
            System.out.println("c.toString() = " + c.toString());
        }
    }

}

이렇게 댓글에 관한 내용도 끝입니다!!
아까 Entity타입으로 변환하는 메서드에서 boardEntity를 그대로 담은것에 대해 의아해 하셨을텐데
이렇게 댓글 테이블에서 참조한 게시글 테이블에 속한 컬럼을 가져올 수 있기 때문입니다.
다음시간에는 회원제 게시판에 대해 알아볼 예정이니 다음에 건강한 모습으로 만나요~!! :D