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

• 사용 IDE : IntelliJ IDEA Ultimate
• 사용 DB : MySQL
• 사용 언어 & SDK : Java & Amazon correto 11
• 정리본입니다 참고용으로만 봐주세요 :D
• 회원관리 예제처럼 천천히 진행 할 예정입니다! 그럼 프로젝트부터 만들러 가시죠!

---

프로젝트 생성

• 프로젝트 이름 : BoardProject

• 기본 패키지 : com.icia.board

• Type : Gradle

• dependency : Spring web, lombok, Thyleaf, Validation, Spring Data Jpa, Mysql Driver

• 설정 후 생성

---

초기 세팅

build.gradle

• 맨 처음에 dependency를 설정 할 때 초반에 필요한 dependency는 전부 추가했으므로, 설정할거 X

application.yml

# 포트번호는 전에랑 안겹치게 자유롭게 쓰세요!
server:
  port: 8096

# DB접속 정보
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springbootclass?serverTimezone=Asia/Seoul&characterEncoding=UTF-8
    username: bootuser
    password: 1234
  # cache값을 사용하지 않겠다는 의미
  thymeleaf:
    cache: false

  # JPA 관련 설정, datasource: 위치와 같은 위치에 작성해줘야함.
  jpa:
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    show-sql: true
    hibernate:
      ddl-auto: update
      # create : 실행할 때 마다 전체 재시작
      # update : 실행할 때 table drop 없이 실행.

---

BoardProject

• 이번 시간에 게시글 관리 예제를 진행하며 할 것

1. 기본기능

   • 기본 주소 요청 시 index.html 출력
   • MainController에서 기본 주소 처리

2. index.html

   • 글쓰기 페이지(/board/save), 목록페이지(/board/) 요청 링크 존재

3. BoardController

   • 글작성 페이지 요청이 오면 글작성 페이지 출력
   • 글작성 페이지 위치 : templates/board/save.html

4. save.html

   • 글쓰기 항목 : 작성자, 비밀번호, 제목, 내용
     각 필드 이름 : boardWriter, boardPassword, boardTitle, boardContents
   • 글쓰기 한 내용은 BoardSaveDTO에 담아서 컨트롤러로 전송

5. BoardSaveDTO

   • 필드 설정
   • String boardWriter
   • String boardPassword
   • String boardTitle
   • String boardContents

6. BoardEntity

   • 컬럼 설정
   • id : pk로 지정
   • boardWriter
   • boardPassword
   • boardTitle
   • boardContents
   • boardDate : java.time.LocalDateTime으로 import
   • createTime : java.time.LocalDateTime으로 import
   • udparteTime :java.time.LocalDateTime으로 import

7. BoardRepository

   • JpaRepository implements하기

---

게시글 저장

위 항목 중 간단한 MainController, index 등은 건너뛰겠습니다.
이번 시간엔 Thymeleaf를 자주 사용할 예정이니 이 점 참고해주세요 :D
그럼 Entity에서 컬럼 설정을 어떻게 했는지만 보고, 컨트롤러로 넘어가겠습니다.

---

Entity

긴급수정! (22.01.13.목 19:00 ~ 20:00)

• BaseEntity 추가

• 기존 Entity를 상속받는 자식클래스로 설정

• boardDate 삭제, createTime, updateTime 추가

• 급하게 변경한 점 사과드립니다 ( ; ω ; )

@Entity
@Getter
@Setter
@Table(name = "board_table")
// BaseEntity를 상속받는 자식 클래스로 설정
public class BoardEntity extends BaseEntity {

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

	@Column
	private String boardWriter;

	@Column
	private String boardPassword;

	@Column
	private String boardTitle;

	@Column
	private String boardContents;

	// 기존 boardDate 삭제
	// @Column
	// private LocalDateTime boardDate;
    
	// createTime, updateTime 추가는 BaseEntity에서 추가
    
}

저는 위와 같이 설정했습니다.
Column 지정 후 아무것도 지정을 안해준다면 String은 varchar(255)로 생성이 됩니다.
이는 회원관리 예제에서 설명해놨으니 참고해주세요.
그럼 Entity를 만들었으니 Controller로 넘어가려고 했지만 긴급 내용 수정이 있겠습니다...
Entity를 보조해주는 클래스를 하나 더 생성해보도록 하겠습니다.ヽ(✿ﾟ▽ﾟ)ノ

BaseEntity

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
// 자식 Entity 즉 상속받은 Entity 클래스가 무슨 기능을 수행하는지 감지하는 어노테이션
@Getter
public abstract class BaseEntity {
	// abstract : 추상 클래스

	@CreationTimestamp // create 즉 insert가 수행된 시간
	@Column(updatable = false) // update 할 때 값이 들어가지 않게
	private LocalDateTime createTime; // insert 수행한 시간.

	@UpdateTimestamp // update 즉 update가 수행된 시간
	@Column(insertable = false) // insert 할 때 값이 들어가지 않게
	private LocalDateTime updateTime; // update 수행한 시간.

}

• 긴급 수정 사유
  기존 boardDate로만 사용 시 차후에 수정 시간 사용 불가 및 오류 발생으로 인한 수정
  불편을 끼쳐드려 죄송합니다 ŏ̥̥̥̥םŏ̥̥̥̥
  그럼 Controller에서 뵙겠습니다...

---

Controller

thymeleaf를 이용하기 위해 Controller 페이지 요청메서드에 내용이 몇가지 추가되는게 있습니다.
아래 코드를 보며 같이 이해하시죠!

@Controller
@RequiredArgsConstructor
@Slf4j // 로그를 기록할 수 있는 라이브러리(어노테이션)
// 목록 출력 & 상세조회 때 사용해보겠습니다.
@RequestMapping("/board")
// /board/* 대신에 /board 도 사용 가능, 이번엔 후자를 사용해보겠습니다!
public class BoardController {

	// 글작성 페이지 요청
	@GetMapping("/save")
	public String saveForm(Model model) {
		model.addAttribute("board", new BoardSaveDTO());
		return "board/save";
	}
}

기존은 그저 주소 요청을 받으면 return으로 페이지만 띄워주고 끝이였지만
thymeleaf애서 제공하는 코드를 사용하기 위해 이에 맞춰 코드가 몇가지 추가가 된 모습입니다.
매개변수에 Model이 추가되었고, return을 하기 전 BoardSaveDTO()를 model에 담아갑니다.
이 코드가 무슨 역할을 하는지 save.html을 만들러 가시죠 :D

---

save.html

<!DOCTYPE html>
<!-- 아래 thymeleaf 사용문을 꼭 쓰셔야합니다!!!!!! -->
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
	<meta charset="UTF-8">
	<title>Title</title>
</head>
<body>
<h2>save.html</h2>
<form action="/board/save" method="post" th:object="${board}">
	<!-- th:object="${}" : model에서 설정한 키를 사용 -->
	<!-- Controller에서 설정한 model 키값과 같게 작성해야 오류가 안납니다!! -->
	<input type="text" th:field="*{boardWriter}" placeholder="작성자">
	<!-- th:field="*{}" : DTO의 필드값을 input태그의 id와 name값으로 사용하겠다는 의미 -->
	<!-- 반드시 DTO의 필드 네임과 같게 작성해야 오류가 안납니다!! -->
	<input type="text" th:field="*{boardPassword}" placeholder="비밀번호">
	<input type="text" th:field="*{boardTitle}" placeholder="제목">
	<input type="text" th:field="*{boardContents}" placeholder="내용">
	<input type="submit" th:value="글작성">
</form>
</body>
</html>

원래는 공백 체크 및 오류잡는 @Variable도 사용하려 했으나 한번에 너무 많은걸 사용하면
다들 어려워할거 같아서 지금은 제외했습니다. 나중에 자세히 다뤄볼께요!!

위의 주석과 같이 th:object="${model키값}" & th:field="*{DTO 필드 이름}" 를 위해
컨트롤러에서 페이지 요청 메서드에 model을 사용했던겁니다!!
위에처럼 코드를 작성한다면 id와 name값을 잘못 지정해 오류가 발생하는 확률을 없앨 수 있습니다.
처음에는 사용하기 불편할 수 있지만 계속 사용해보면서 숙달하면 좋겠죠??
그럼 save.html을 완성했으니 이를 저장하는 메서드를 만들러 Controller로 가봅시다 :D

---

Controller

// 글작성 저장
// thymeleaf를 쓰지 않는다면 @ModelAttribute 생략 가능
// 저는 썼으므로 작성
@PostMapping("/save")
public String save(@ModelAttribute("board") BoardSaveDTO boardSaveDTO) {

	bs.save(boardSaveDTO);
	return "index";
    
}

위 주석에서 설명한것처럼 만약 thymeleaf를 사용하지 않고 일반적인 방법으로 form을 작성했다면 @ModelAttribute를 생략할 수 있습니다. Spring Boot가 알아서 잡아주기 때문이죠!!
게시글 저장 메서드엔 별 내용이 없으므로 바로 Service로 넘어가겠습니다.

---

Service

• Interface class에는 설명할 내용이 없으므로 앞으로는 생략하겠습니다.
  알아서 Interface에 메서드를 추가하신 후 잘 구현하실거라 믿습니다!!

@Service
@RequiredArgsConstructor
public class BoardServiceImpl implements BoardService {

	private final BoardRepository br;

	@Override
	public Long save(BoardSaveDTO boardSaveDTO) {
		BoardEntity boardEntity = BoardEntity.saveBoard(boardSaveDTO);
		// DTO타입을 Entity타입으로 변환
		return br.save(boardEntity).getId();
		// 리턴으로 게시글 번호를 넘겨줌.
	}
}

Jpa를 사용하기 위해서는 DTO타입을 Entity타입으로 변환시켜주는 작업이 필요합니다.
Jpa를 사용할 때 이를 항상 주의해주세요!

---

Entity

• DTO타입을 Entity타입으로 변환시켜주는 메서드 추가

public static BoardEntity saveBoard(BoardSaveDTO boardSaveDTO) {
	BoardEntity boardEntity = new BoardEntity();
	boardEntity.setBoardWriter(boardSaveDTO.getBoardWriter());
	boardEntity.setBoardPassword(boardSaveDTO.getBoardPassword());
	boardEntity.setBoardTitle(boardSaveDTO.getBoardTitle());
	boardEntity.setBoardContents(boardSaveDTO.getBoardContents());
	// boardEntity.setBoardDate(LocalDateTime.now());
	// 긴급수정으로 인한 삭제
	return boardEntity;
    }

여기까지 잘 따라오셨다면 게시글 저장은 문제없이 잘 작동할 겁니다.
게시글 작성 시간은 BaseEntity에서 만든 내용으로 인해 자동으로 들어가집니다.
그럼 게시글 목록 출력으로 넘어가봅시다!! :D

---

게시글 목록 출력 & 상세조회

지금부터 게시글 목록출력에 대해 알아보도록 하겠습니다!
이전에 회원관리 예제를 하신 분이라면 거의 똑같이 흘러가기 때문에 문제없이 잘 하실 수 있을겁니다 :D
그럼 바로 가시죠~!٩(๑•̀o•́๑)و

BoardDetialDTO

게시글 목록 출력용 & 상세조회를 같이 수행하는 DTO를 만들어야합니다.
DTO를 만들면서 Entity타입을 DTO타입으로 변환시켜주는 메서드를 미리 생성해줍니다.
알아두면 좋은 팁으로 변환이 필요한 타입이 속한 메서드에 변환 메서드를 작성하는것이 좋습니다!!
toBoardDetailDTO : Entity타입을 DTO타입으로 변환시켜주는 메서드
toBoardDetailDTOList : List<Entity>타입을 List<BoardDetailDTO>타입으로 변환

@Data
@AllArgsConstructor
@NoArgsConstructor
public class BoardDetailDTO {

	private Long boardId;
	private String boardWriter;
	private String boardPassword;
	private String boardTitle;
	private String boardContents;
    
	// boardDate 삭제
	// private LocalDateTime boardDate;
    
	// 아래 두 줄 추가
	private LocalDateTime createTime;
	private LocalDateTime updateTime;

	public static BoardDetailDTO toBoardDetailDTO(BoardEntity boardEntity) {
		BoardDetailDTO boardDetailDTO = new BoardDetailDTO();
		boardDetailDTO.setBoardId(boardEntity.getId());
		boardDetailDTO.setBoardWriter(boardEntity.getBoardWriter());
		boardDetailDTO.setBoardPassword(boardEntity.getBoardPassword());
		boardDetailDTO.setBoardTitle(boardEntity.getBoardTitle());
		boardDetailDTO.setBoardContents(boardEntity.getBoardContents());
		// boardDetailDTO.setBoardDate(boardEntity.getBoardDate());
		boardDetailDTO.setCreateTime(boardEntity.getCreateTime());
		boardDetailDTO.setUpdateTime(boardEntity.getUpdateTime());
		return boardDetailDTO;
	}

	public static List<BoardDetailDTO> toBoardDetailDTOList(List<BoardEntity> boardEntityList) {
		List<BoardDetailDTO> boardDetailDTOList = new ArrayList<>();
		for(BoardEntity b: boardEntityList) {
			boardDetailDTOList.add(toBoardDetailDTO(b));
		}
		return boardDetailDTOList;
	}
}

---

Controller

// 글목록 출력
@GetMapping("/")
public String findAll(Model model) {
	log.info("글보기 메서드 호출. 요청글번호 {}", boardId);
	List<BoardDetailDTO> boardDetailDTOList = bs.findAll();
	model.addAttribute("boardList", boardDetailDTOList);
	return "board/findAll";
}

@GetMapping("/{boardId}")
// {}앞에 / 가 붙어도 @PathVariable뒤 ("boardId") 생략가능
public String findById(@PathVariable Long boardId, Model model) {
	// 변수를 찍고싶다면 {} 가 반드시 필요. {}안에 변수가 들어감
	// 로그 종류
	// info : 하나하나 동작을 전부 기록
	// warn : 경고, 에러는 아니지만 문제의 소지가 있다.
	// error : 문제 발생
	log.info("글보기 메서드 호출. 요청글번호 {}", boardId);
	BoardDetailDTO boardDetailDTO = bs.findById(boardId);
	model.addAttribute("boardDetailDTO",boardDetailDTO);
	return "board/findById";
}

// ajax는 제외하겠습니다. 사용하실분들은 아래 주석을 해제하시고 사용하시면 됩니다!
// ResponseEntity로 데이터와 상태코드를 같이 보내는 방법.
// @PostMapping("/{boardId}")
// public ResponseEntity findById2(@PathVariable Long boardId) {
//	 BoardDetailDTO boardDetailDTO = bs.findById(boardId);
//	 return new ResponseEntity<BoardDetailDTO>(boardDetailDTO, HttpStatus.OK);
//	 보내고자 하는 데이터의 타입을 <> 안에 써야한다. (생략가능하긴하지만 쓰는게 좋음)
//	 양식 : new ResponseEntity<보내고자하는 데이터 타입>(데이터 변수이름, 상태코드)
//	 HttpStatus.BAD_REQUEST를 통해 잘못 들어온 요청에 대해 분기처리를 할 수 있다.
}

기존 회원관리와 똑같이 가는것을 볼 수 있습니다.
다른점이 있다면 log를 사용하는 부분이 보일텐데요, 꼭 필요한건 아니지만 이러한 콘솔 로그기록을 통해
어떤 메서드가 언제 호출이 됬는지 더 편하게 볼 수 있습니다. 한번씩 사용해보시는것도 나쁘지 않을겁니다 :D
그럼 바로 html을 만들러 가보시죠!!

---

findAll.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="https://code.jquery.com/jquery-3.6.0.js"></script>
    <script>
	// ajax를 사용해보고 싶으신 분들은 아래 주석처리를 해제하시고 쓰시면 됩니다.
	// 자세한 설명은 생략하니 직접 아래 코드들이 무슨 역할을 하는 건지 알아보시는것도 좋을거 같습니다:D
        // const detail = (boardId) => {
        //     console.log(boardId)
        //     const reqUrl = "/board/"+boardId
        //     $.ajax({
        //         type: "post",
        //         url: reqUrl,
        //         dataType: "json",
        //         success: function (result) {
        //             console.log(result)
        //             let output=""
        //             output += "<table>\n" +
        //                 "    <thead>\n" +
        //                 "        <tr>\n" +
        //                 "            <th>번호</th>\n" +
        //                 "            <th>작성자</th>\n" +
        //                 "            <th>제목</th>\n" +
        //                 "            <th>내용</th>\n" +
        //                 "            <th>작성일자</th>\n" +
        //                 "        </tr>\n" +
        //                 "    </thead>\n" +
        //                 "    <tbody>\n" +
        //                 "        <tr>\n" +
        //                 "            <td>" + result.boardId + "</td>\n" +
        //                 "            <td>" + result.boardWriter + "</td>\n" +
        //                 "            <td>" + result.boardTitle + "</td>\n" +
        //                 "            <td>" + result.boardContents + "</td>\n" +
        //                 "            <td>" + result.createTime + "</td>\n" +
        //                 "        </tr>\n" +
        //                 "    </tbody>\n" +
        //                 "</table>"
        //             document.getElementById("board-detail").innerHTML = output;
        //         },
        //         error: function () {
        //             alert('ajax 실패')
        //         }
        //     })
        // }
    </script>
</head>
<body>
<h2>findAll.html</h2>
<table>
    <thead>
        <tr>
            <th>번호</th>
            <th>작성자</th>
            <th>제목</th>
            <th>작성일자</th>
            <th>수정일자</th>
            <!-- th>ajax 상세조회</th> ajax사용하실 분은 주석해제하셔용 -->
        </tr>
    </thead>
    <tbody>
        <tr th:each="board:${boardList}">
            <td th:text="${board.boardId}"></td>
            <td th:text="${board.boardWriter}"></td>
            <!-- 이 코드로도 사용 가능 <td><a th:text="${board.boardTitle}" th:href="@{|/board/${board.boardId}|}"></a></td> -->
            <td>
                <a th:href="@{|/board/${board.boardId}|}">
                    <span th:text="${board.boardTitle}"></span>
                </a>
            </td>
            <td th:text="${board.createTime}"></td>
            <td th:text="${board.updateTime}"></td>
            <!-- 제목 클릭하면 상세조회화면(findById.html) 출력 -->
            <!-- ajax를 이용한 상세조회, 조회 버튼을 누르면 목록 아래에 해당 글의 상세 내용 출력 -->
            <!-- <td><button th:onclick="detail([[${board.boardId}]])">상세조회(ajax)</button></td> -->
	    <!-- 사용하실 분들은 주석을 해제해주세요:D -->
        </tr>
    </tbody>
</table>
<!-- ajax를 사용하고 싶으면 주석을 해제해주세요! -->
<!-- <div id="board-detail"></div> -->
</body>
</html>

findById.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h2>findById.html</h2>
<table>
    <thead>
        <tr>
            <th>번호</th>
            <th>작성자</th>
            <th>제목</th>
            <th>내용</th>
            <th>작성시간</th>
            <th>수정시간</th>
            <th>수정</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <th th:text="${boardDetailDTO.boardId}"></th>
            <th th:text="${boardDetailDTO.boardWriter}"></th>
            <th th:text="${boardDetailDTO.boardTitle}"></th>
            <th th:text="${boardDetailDTO.boardContents}"></th>
            <th th:text="${boardDetailDTO.createTime}"></th>
            <th th:text="${boardDetailDTO.updateTime}"></th>
            <th><a th:href="@{|/board/update/${boardDetailDTO.boardId}|}">수정페이지</a></th>
        </tr>
    </tbody>
</table>
</body>
</html>

이렇게 게시글 목록출력용과 상세조회용 html을 제작했으니 Service에 코드를 만들러 가봅시다!!
만약 ajax로 해보고 싶으신 분들은 주석처리한 부분을 사용하시면 됩니다.
ajax에 대해 새로운 내용은 주석으로 설명을 붙여놨으니 걱정 않으셔도 됩니다!!

---

Service

@Override
public List<BoardDetailDTO> findAll() {
	List<BoardEntity> boardEntityList = br.findAll();
	List<BoardDetailDTO> boardDetailDTOList = BoardDetailDTO.toBoardDetailDTOList(boardEntityList);
	return boardDetailDTOList;
}

@Override
public BoardDetailDTO findById(Long boardId) {

	/*
		Optional 사용
		먼저 null 체크를 해야 함.

		Optional 객체 메서드
		.isPresent() : 데이터가 있으면 true, 없으면 false 반환
		.isEmpty() : 데이터가 있으면 false, 없으면 true 반환
		.get() : Optional 객체에 들어있는 실제 데이터를 가져올 때
	*/

	Optional<BoardEntity> optionalBoardEntity = br.findById(boardId);
	BoardDetailDTO boardDetailDTO = null;
	if (optionalBoardEntity.isPresent()) {
		BoardEntity boardEntity = optionalBoardEntity.get();
		boardDetailDTO = BoardDetailDTO.toBoardDetailDTO(boardEntity);
	}
	return boardDetailDTO;
}

이번에는 Optional객체를 사용하는 방법에 대해 알아봤습니다.
Boot에서는 DB에서 데이터를 가져올 때 null이든 null이 아니든 무조건 Optional객체에 담아서 보내게 됩니다.
(findAll같이 데이터 전체를 가져오는게 아닌, findById같은 쿼리에서)
저번에는 바로 .get()으로 안에 값을 꺼내 사용했지만 이번에는 먼저 null체크 후 값을 가져가게끔 만들었습니다.
만약 더 추가되는 내용이 있다면 나중에 자세히 다뤄보도록 하죠!! :D

---

마치며

이렇게 게시글 저장부터 게시글 목록 출력, 상세 조회까지 알아보았습니다.
아직까지는 회원관리 예제와 겹치는 부분이 많아 이전 게시글들을 따라해보신 분들이라면
별 무리없이 잘 하셨을겁니다 :D
다음시간에는 수정과 그 외 다른거에 대해 알아보도록 하겠습니다.
그럼 다들 다음에 건강한 모습으로 만나요~!! :D