todyDev

Spring 개발 - 게시판 만들기 #첨부파일 수정 및 삭제

#에게 — Wed, 8 Dec 2021 14:11:23 +0900

게시판의 글을 수정하고 삭제하는 것처럼 게시글에 포함된 첨부파일도 수정, 삭제를 할 수 있게 만들어 주자.

1. 수정 페이지에 파일 정보 가져오기

수정 페이지에 게시글의 정보와 함께 등록된 파일의 정보들도 같이 가져오자. 기존의 수정 페이지의 로직에서 파일의 정보를 가져오는 로직을 추가하여 수정 페이지에 정보를 던져주었다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

// BoardController (GET)
@RequestMapping(value="/board/boardUpdate")
public ModelAndView boardUpdate(CommandMap commandMap, Criteria cri) throws Exception {
    
    ModelAndView mv = new ModelAndView("/board/boardUpdate");
    Map<String, Object> detail = boardService.selectBoardDetail(commandMap.getMap());
    List<Map<String, Object>> file = boardService.selectBoardFileDetail(commandMap.getMap());
    mv.addObject("detail",detail);
    mv.addObject("file", file);
    
    PageMaker pageMaker = new PageMaker();
    pageMaker.setCri(cri);
    mv.addObject("page",cri.getPage());
    mv.addObject("pageMaker", pageMaker);
        
    return mv;
}
 
// BoardService
List<Map<String, Object>> selectBoardFileDetail(Map<String, Object> map);
 
// BoardServiceImpl
@Override
public List<Map<String, Object>> selectBoardFileDetail(Map<String, Object> map) {
    // TODO Auto-generated method stub
    return boardDAO.detailFile(map);
}
 
// BoardDAO
@SuppressWarnings("unchecked")
public List<Map<String, Object>> detailFile(Map<String, Object> map) {
    return selectList("board.detailFile", map);
}
 
// SQL
<select id="selectFileInfo" parameterType="hashmap" resultType="hashmap">
    <![CDATA[
     SELECT
         IDX,
         BOARD_IDX,
         ORG_FILE_NAME,
         SAVE_FILE_NAME
     FROM
         tb_file
     WHERE
         IDX = #{ IDX}
    ]]>
</select>
Colored by Color Scripter

cs

7, 9행처럼 controller 에서 파일 정보를 가져오는 로직을 추가하여 servcie 영역을 추가하였고, dao, sql 영역은 상세 페이지에서 사용하던 기존 로직을 그대로 사용했다. 나처럼 controller 영역에서 file 정보를 가져오는 방법을 사용했지만, service 영역에서 file 정보를 가져오는 방법을 사용해도 된다.

2. 수정 페이지에 파일 정보 보여주기

수정 페이지에서 등록된 파일을 보여주고 삭제 버튼을 추가할 것이다. 그리고 기존 파일 삭제 뿐만 아니라 새로운 파일을 추가할 수 있어야 되기 때문에 등록 페이지에 있는 파일 추가하는 로직도 그대로 들고 왔다.

- boardUpdate.jsp

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
 
<form action='<c:url value='/board/boardUpdate${pageMaker.makeQueryPage(page) }'/>' method="post" enctype="multipart/form-data">
    ...
    <div class="form-group file-group" id="file-list">
        <div class="file-add">
            <a href="#this" onclick="addFile()"><span class="glyphicon glyphicon-plus" aria-hidden="true"></span> 파일추가</a>
        </div>
        <c:forEach items="${file }" var="file">
            <div class="file-input">
                <span class="glyphicon glyphicon-camera" aria-hidden="true"></span>
                ${file.ORG_FILE_NAME } <span>${file.FILE_SIZE }kb</span>
                <a href='#this' name='file-delete'>삭제</a>
            </div>
        </c:forEach>
     </div>
    ...
</form>
 
<script type="text/javascript">
    $(document).ready(function() {
        $("a[name='file-delete']").on("click", function(e) {
            e.preventDefault();
            deleteFile($(this));
        });
    })
 
    function addFile() {
        var str = "<div class='file-input'><input type='file' name='file'><a href='#this' name='file-delete'>삭제</a></div>";
        $("#file-list").append(str);
        $("a[name='file-delete']").on("click", function(e) {
            e.preventDefault();
            deleteFile($(this));
        });
    }
 
    function deleteFile(obj) {
        obj.parent().remove();
    }
</script>
Colored by Color Scripter

cs

수정 페이지에서도 새로운 파일을 보내야하기 때문에 3행처럼 반드시 form 태그에 enctype="multipart/form-data" 넣어야 한다. 그리고 스크립트 영역은 파일 업로드에서 사용했던 로직을 그대로 가지고 왔다.

이렇게 작업하고 실행을 하면 아래와 같이 수정 페이지에서 등록된 파일 정보들도 함께 보이게 된다.

3. 기존 파일의 삭제 여부 판단하기

기존에 등록된 파일의 정보가 넘어오지 않는다면 삭제했다고 판단하려고 한다. 그러기 위해서 수정 페이지에서 기존 파일의 고유 번호(IDX)를 가지고 있어야 한다. hidden 타입을 이용해서 파일의 고유번호를 가지고 있자. 만약 삭제버튼을 누르면 해당 hidden 타입을 같이 지워주면 지운 파일의 고유번호는 넘어가지 않을 것이다.

- boardUpdate.jsp

1
2
3
4
5
6
7
8

<c:forEach items="${file }" var="file">
    <div class="file-input">
        <span class="glyphicon glyphicon-camera" aria-hidden="true"></span>
        ${file.ORG_FILE_NAME } <span>${file.FILE_SIZE }kb</span>
        <input type="hidden" name="FILE_${file.IDX }" value="true">
        <a href='#this' name='file-delete'>삭제</a>
    </div>
</c:forEach>
Colored by Color Scripter

cs

5행의 input hidden 타입을 추가해서 파일의 고유번호를 form 태그에 같이 넘어가도록 했다. name을 FILE_(파일IDX) 형태로 만들었고 넘어온 키 값 중에 파일의 고유번호가 없으면 삭제됐다고 판단할 것이다. 키 값으로만 판단하기 때문에 value는 true로 넘겨주었다. 새로 추가한 파일은 mulitpartFile에 담겨져 있을 것이다.

4. 게시글 및 파일 업데이트 작업

service 영역에서 기존 파일 삭제 여부를 판단하여 파일을 삭제하고, 새로운 파일들을 받아 게시글 업로드와 같은 방식으로 업데이트를 진행할 것이다. 수정페이지에서 정의한 키 값으로 등록된 파일의 정보와 비교하여 삭제여부를 판단해보자.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

// BoardController (POST)
@RequestMapping(value="/board/boardUpdate", method=RequestMethod.POST)
public ModelAndView boardUpdatePOST(CommandMap commandMap, Criteria cri, RedirectAttributes redAttr, MultipartFile[] file) throws Exception {
    
    ModelAndView mv = new ModelAndView("redirect:/board/boardDetail");
    mv.addObject("idx", commandMap.get("idx"));
    
    boardService.updateBoard(commandMap.getMap(), file);
 
    redAttr.addAttribute("page", cri.getPage());
    redAttr.addAttribute("perPagNum", cri.getPerPageNum());
    
    return mv;
}
 
// BoardService
void updateBoard(Map<String, Object> map, MultipartFile[] file) throws Exception;
 
// BoardServcieImpl
@Override
public void updateBoard(Map<String, Object> map, MultipartFile[] file) throws Exception {
   // TODO Auto-generated method stub
   boardDAO.updateBoard(map);
   List<Map<String, Object>> fileDetail = boardDAO.detailFile(map);
   for(int i=0; i<fileDetail.size(); i++) {
       String idx = "FILE_" + fileDetail.get(i).get("IDX");
       if(!map.containsKey(idx)) {
           Map<String, Object> list = fileDetail.get(i);
           boardDAO.updateDeleteFile(list);
       }
   }
   List<Map<String, Object>> fileList = fileUtils.parseFileInfo(map, file);
   for(int i=0; i<fileList.size(); i++) {
       boardDAO.insertFile(fileList.get(i));
   }
}
Colored by Color Scripter

cs

- 3, 17, 21행: 새로 추가된 파일 정보를 가져오기 위해서 MultipartFile[] file 추가한다.

- 8행: service 영역에 file 정보들도 함께 넘겨서 업데이트한다.

- 24행: 기존에 등록된 파일 정보들을 가져온다.

- 25-31행: "FILE_(파일IDX)" 형식으로 키 값으로 넘어오기 때문에 기존 파일의 정보도 FILE_(파일IDX) 형식으로 바꿔서(26행) 비교한다. 만약 클라이언트에서 넘어온 값 중에 기존 파일의 정보가 없다면(27행) 파일을 삭제한다(29행).

- 32-35행: 새로 추가한 파일을 등록한다.

파일 삭제는 기존 파일이 삭제됐다고 판단(29행)됐을 때 DB에서 파일을 직접 삭제하지 않고 DEK_CHK 라는 컬럼을 Y로 업데이트하는 방식으로 작업했다. 그럴려면 상세 페이지에서 파일을 가져올 때 DEL_CHK 가 N인 파일들만 가져오는 작업이 필수로 되어 있어야 한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// BoardDAO
public void updateDeleteFile(Map<String, Object> list) {
   // TODO Auto-generated method stub
   update("board.deleteFile", list);
}
 
// SQL
<update id="deleteFile">
   <![CDATA[
       UPDATE
           tb_file
       SET
           DEL_CHK = 'Y'
       WHERE
           IDX = #{ IDX}
   ]]>
</update>
Colored by Color Scripter

cs

5. 테스트

수정 페이지에서 컨텐츠 및 파일을 수정하는 테스트를 진행했다.

> 수정 전 상세 페이지

> 컨텐츠를 수정하고 기존 파일 하나를 삭제하고 새로운 파일을 등록

> 고유번호 2번 파일만 넘어온 것 확인

> 삭제된 기존 파일 업데이트 하고 새로 추가된 파일 등록

> 수정 후 상세페이지

기존 파일의 삭제 여부를 판단하는 작업은 내가 작업한 이 방법 말고도 다른 여러 방법들이 있다. 본인들이 이해하기 쉽고 편한걸로 사용하면 되지 않을까 싶다. 이렇게 게시판 만들기의 첨부 파일 관련 작업은 끝났다. 그렇게 오래 걸릴 일은 아닌데 현생이 바빠서 이제 마무리 글을 올렸다. 그래서 너무 오랜만에 보는 거라 머리가 멍하기도 했지만 오랜만에 스프링 작업을 해보니 재밌었다.

Spring 개발 - 게시판 만들기 #첨부파일 다운로드

#에게 — Fri, 29 Oct 2021 18:05:29 +0900

이전 게시글에서 파일을 업로드했다면, 이번에는 업로드된 파일을 다운로드하는 기능을 만들 것이다. 생각보다 복잡하지 않아서 개발하기 좋았다. 아래는 파일 다운로드가 진행될 순서이다. 참고해서 작업을 진행하면 된다.

1. 클라이언트에서 서버에 파일 다운로드 요청
2. 서버에서 다운로드할 파일 정보를 DB에 요청
3. DB에서 파일 정보 검색 후 서버로 전달
4. 서버에서 전달받은 정보로 파일 저장 경로에 있는 파일을 가져옴
5. 가져온 파일 데이터를 클라이언트에 전송하여 다운로드

1. 파일 다운로드 요청

- boardDetail.jsp

1
2
3
4
5

<div class="file-info">
    <span class="glyphicon glyphicon-camera" aria-hidden="true"></span>
    <a href='<c:url value="/filedownload?IDX=${file.IDX }"/>'>${file.ORG_FILE_NAME }</a>
    <span>${file.FILE_SIZE }kb</span>
</div>
Colored by Color Scripter

cs

- 3행: 파일의 아이디를 같이 넘겨 다운로드 요청을 한다.

2. 파일 정보 가져오기

클라이언트에서 서버로 전달한 정보를 이용해서 다운로드할 파일의 정보를 가져오자. 이 부분은 이제껏 많이 작업해왔던 부분이기 때문에 따로 설명은 하지 않을 것이다.

- FileService.java

1
2
3
4
5

public interface FileService {
    
    Map<String, Object> selectFile(Map<String, Object> map);
 
}
Colored by Color Scripter

cs

- FileServiceImpl.java

1
2
3
4
5
6
7
8
9
10
11
12

@Service("fileService")
public class FileServiceImpl implements FileService {
    
    @Resource(name="fileDao")
    private FileDAO fileDao;
 
    @Override
    public Map<String, Object> selectFile(Map<String, Object> map) {
        return fileDao.selectFileInfo(map);
    }
 
}
Colored by Color Scripter

cs

- FileDAO.java

1
2
3
4
5
6
7
8
9

@Repository("fileDao")
public class FileDAO extends AbstractDAO{
    
    @SuppressWarnings("unchecked")
    public Map<String, Object> selectFileInfo(Map<String, Object> map) {
        return (Map<String, Object>) selectOne("file.selectFileInfo", map);
    }
 
}
Colored by Color Scripter

cs

- file_sql.xml

1
2
3
4
5
6
7
8
9
10
11
12
13

    <select id="selectFileInfo" parameterType="hashmap" resultType="hashmap">
     <![CDATA[
         SELECT
             IDX,
             BOARD_IDX,
             ORG_FILE_NAME,
             SAVE_FILE_NAME
         FROM
             tb_file
         WHERE
             IDX = #{ IDX}
     ]]>
    </select>
Colored by Color Scripter

cs

3. 클라이언트로 파일 전송

다운로드할 파일의 정보를 가져와서 클라이언트로 파일을 전송하는 작업을 해보자.

FileController.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

package com.tody.board.controller;
 
import java.io.File;
import java.net.URLEncoder;
import java.util.Map;
 
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.apache.commons.io.FileUtils;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
 
import com.tody.board.service.FileService;
import com.tody.common.common.CommandMap;
 
@Controller
public class FileController {
    
    @Resource(name="uploadPath")
    String uploadPath;
    
    @Resource(name="fileService")
    private FileService fileService;
    
    @RequestMapping(value="/filedownload")
    public void downloadFile(CommandMap commandMap, HttpServletRequest request, HttpServletResponse response) throws Exception {
        
        Map<String, Object> file = fileService.selectFile(commandMap.getMap());
 
            String saveFileName = (String)file.get("SAVE_FILE_NAME");
            String originalFileName = (String)file.get("ORG_FILE_NAME");
            
            File downloadFile = new File(uploadPath + saveFileName);
            
            byte fileByte[] = FileUtils.readFileToByteArray(downloadFile);
            
            response.setContentType("application/octet-stream");
            response.setContentLength(fileByte.length);
            
            response.setHeader("Content-Disposition", "attachment; fileName=\"" + URLEncoder.encode(originalFileName,"UTF-8") +"\";");
            response.setHeader("Content-Transfer-Encoding", "binary");
            
            response.getOutputStream().write(fileByte);
            response.getOutputStream().flush();
            response.getOutputStream().close();
        
    }
    
}
 
Colored by Color Scripter

cs

- 28행: 서버에서 화면으로 응답을 하기 위해 HttpServletResponse 를 사용한다.

- 30행: 클라이언트로부터 전달받은 정보로 DB에서 다운로드할 파일 정보를 가져온다.

- 35행: 파일을 업로드할 때 저장한 파일 이름을 가지고 디렉토리를 가져온다.

- 37행: 파일을 byte 배열로 변환한다.

- 39행: "application/octet-stream" 은 자바에서 사용하는 파일 다운로드 응답 형식으로, 어플리케이션 파일이 리턴된다고 설정한다.

- 40행: 파일 사이즈를 지정한다.

- 42행: "attachment;fileName="을 사용하면 다운로드시 파일 이름을 지정해줄 수 있다.

- 43행: "application/octet-stream"은 binary 데이터이기 때문에 binary로 인코딩해준다.

- 45행: 버퍼에 파일을 담아 스트림으로 출력한다.

- 46행: 버퍼에 저장된 내용을 클라이언트로 전송하고 버퍼를 비운다.

- 47행: 출력 스트림을 종료한다. 참고로 close() 함수 자체에서 flush() 함수를 호출하기 때문에 굳이 flush() 를 호출하지 않아도 된다.

파일을 클라이언트로 전송하는 방법외엔 전부 여지껏 작업해왔던 부분이라서 쉽게 다운로드를 구현할 수 있다. 만들다보니, "전체 다운로드" 기능도 만들면 좋지 않을까? 라는 생각도 들었다. 작업할 지 모르겠지만 만약 만들게 된다면 아래에 추가하도록 하겠다.
이제 정말 마지막으로 게시글을 수정/삭제할 때 파일도 수정/삭제 할 수 있도록 작업만 하면 파일 업/다운로드는 진짜 끝이 난다! 와!

Spring 개발 - 게시판 만들기 #첨부파일 업로드

#에게 — Tue, 17 Dec 2019 15:22:05 +0900

게시글에 파일을 업로드 할 수 있게 하려고 한다. 단일 파일 업로드 방식도 있고 다중 파일 업로드 방식도 있다. 여기선 다중 파일 업로드 방식을 포스팅한다. 단일 파일 업로드와 다중 파일 업로드는 차이가 없다고 생각한다. 왜냐하면 첨부파일 업로드를 공부할 때 단일 파일 업로드를 만들고 배열을 이용해서 다중 파일 업로드로 확장시켰기 때문이다. 따라서 단일파일 업로드를 원하면 배열인 부분들만 없애주면 된다.

1. DB 생성

첨부 파일의 정보를 저장하는 테이블을 생성한다.

1
2
3
4
5
6
7
8
9
10
11
12
CREATE TABLE `tb_file` (
  `IDX` int(11) NOT NULL AUTO_INCREMENT,
  `BOARD_IDX` int(11) NOT NULL,
  `ORG_FILE_NAME` varchar(260) NOT NULL,
  `SAVE_FILE_NAME` varchar(36) NOT NULL,
  `FILE_SIZE` int(11) DEFAULT NULL,
  `UPDATE_DATE` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `CREA_ID` varchar(30) NOT NULL,
  `DEL_CHK` varchar(1) NOT NULL DEFAULT 'N',
  `CREA_DATE` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`IDX`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8
Colored by Color Scripter
cs

2. 라이브러리 추가

pom.xml

1
2
3
4
5
6
<!-- commons-fileupload -->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.3.2</version>
</dependency>
Colored by Color Scripter
cs

파일 업로드를 위한 라이브러리를 추가한다.

3. context 설정

spring 설정 폴더에 context-*.xml 파일을 생성한다. file을 위한 설정만 넣어둘거기 때문에 새로 만들었다.

context-file.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
    <!-- MultipartResolver 설정 -->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <property name="maxUploadSize" value="100000000" />
        <property name="maxInMemorySize" value="100000000" />
    </bean>
    
    <!-- 파일 업로드 디렉토리 설정 -->
    <bean id="uploadPath" class="java.lang.String">
        <constructor-arg value="C:\\_dev\\file\\"/>
    </bean>
    
</beans>
Colored by Color Scripter
cs

파일 업로드를 처리하기 위해서 CommonsMultipartResolver를 등록해야 한다. property 설정을 통해 파일의 최대 크기를 제한할 수 있다. 단위는 byte로, 10MB로 제한하였다. 참고로 한글명이 깨지지 않기 위해서는 UTF-8 코딩이 되어 있어야 한다. (프로젝트를 설정할 때 필터 설정을 했을 것이다.)

파일 업로드의 디렉토리를 설정한다. 즉, 업로드되는 파일들을 저장할 경로를 설정하는 것이다. 원하는 경로를 넣으면 된다. 경로는 //가 아닌 \\로 설정해야 한다. 해당 경로에 폴더가 굳이 없어도 된다. 나중에 업로드 할 파일들을 조작하는 클래스를 생성할 때 폴더가 없으면 새로 생성하는 로직도 넣을 것이다.

4. 파일 업로드 JSP 생성

파일 추가 버튼을 눌러 파일 업로드를 할 수 있는 input 태그가 생기는 자바스크립트를 추가할 것이다. (자바스크립트는 미숙하기 때문에 완벽하지 않을 수도 있다.) 스크립트를 쓰고 싶지 않다면 등록될 파일 수를 정해서 input 태그를 정한 만큼만 보여주는 방법도 있다. jsp 부분은 많은 방법이 있으니 원하는 방법을 사용하면 된다.

boardWrite.jsp

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<form action='<c:url value='/board/boardInsert'/>' method="post" enctype="multipart/form-data">
    <!-- 생략 -->
    <div class="form-group" id="file-list">
        <a href="#this" onclick="addFile()">파일추가</a>
        <div class="file-group">
            <input type="file" name="file"><a href='#this' name='file-delete'>삭제</a>
        </div>
    </div>
    <button type="submit" class="btn btn-default">작성하기</button>
</form>
 
<script type="text/javascript">
    $(document).ready(function() {
        $("a[name='file-delete']").on("click", function(e) {
            e.preventDefault();
            deleteFile($(this));
        });
    })
 
    function addFile() {
        var str = "<div class='file-group'><input type='file' name='file'><a href='#this' name='file-delete'>삭제</a></div>";
        $("#file-list").append(str);
        $("a[name='file-delete']").on("click", function(e) {
            e.preventDefault();
            deleteFile($(this));
        });
    }
 
    function deleteFile(obj) {
        obj.parent().remove();
    }
</script>
Colored by Color Scripter
cs

- 01행 : enctype="multipart/form-data" 부분이 반드시 있어야 파일들을 가져올 수 있다.

- 04, 20-27행 : 추가 버튼을 누르면 onclick을 이용해 addFile() 함수를 실행하여 input 태그를 생성해준다.

- 06, 29-31행 : 삭제 버튼을 눌러 해당 input 태그를 없애준다.

파일추가 버튼을 누르면 파일 선택 폼이 하나씩 생기고 삭제를 누르면 해당 폼이 없어지는 형태로 구성하였다.

5. 파일 데이터가 넘어오는 지 확인

파일 데이터들이 구분되서 넘어오는 지 확인을 해보자. 어떻게 넘어오는 지 파악해야 추가, 삭제를 손쉽게 할 수 있기 때문이다.

UploadController

1
2
3
4
5
6
7
8
9
10
11
12
13
14
    @RequestMapping("/board/boardInsert")
    public ModelAndView boardInsert(CommandMap commandMap, MultipartFile[] file) throws Exception {
        ModelAndView mav = new ModelAndView("redirect:/board/boardList");
        //boardService.insertBoard(commandMap);
        for(int i=0; i<file.length; i++) {
            log.debug("================== file start ==================");
            log.debug("파일 이름: "+file[i].getName());
            log.debug("파일 실제 이름: "+file[i].getOriginalFilename());
            log.debug("파일 크기: "+file[i].getSize());
            log.debug("content type: "+file[i].getContentType());
            log.debug("================== file   END ==================");
        }
        return mav;
    }
Colored by Color Scripter
cs

- 02행: MultipartFile[] file 을 추가한다. 다중 파일이 넘어오기 때문에 배열로 선언한다.

- 04행: 파일들이 잘 넘어오는 지 확인 용도이기 때문에 게시글 추가 서비스는 주석처리 했다.

- 05~12행: for문을 사용해서 넘어오는 파일들이 정보를 확인할 것이다.

실행을 해서 파일을 여러개 추가해서 글을 작성해보자. 그러면 로그에도 이렇게 업로드한 파일의 실제 이름, 크기, 타입 등을 확인할 수 있다. 다중 파일 업로드가 아닌 단일 파일 업로드를 하려고 한다면, 배열로 선언된 MultipartFile[] 부분을 MultipartFile 로 선언해주면 된다. 이제 배열로 파일들이 들어온 걸 확인 했으니 컨트롤러를 원상복귀시킨 뒤에 업로드를 처리하는 클래스를 만들어보자.

6. FileUtils 클래스 생성

업로드할 파일들을 조작하고 업로드 기능들을 처리할 클래스를 생성한다. 파일 업로드는 다른 곳에서도 사용가능한 공통적인 부분이라 생각했기에 common 패키지 아래 Utils 패키지를 생성해서 그 안에 클래스를 생성했다.

FileUtils.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@Component("fileUtils")
public class FileUtils {
    
    private Log log = LogFactory.getLog(this.getClass());
    
    @Resource(name="uploadPath")
    String uploadPath;
 
    public List<Map<String, Object>> parseFileInfo(Map<String, Object> map, MultipartFile[] file) throws Exception {
        
        String boardIDX = String.valueOf(map.get("idx"));
        String creaID = (String) map.get("crea_id");
        
        List<Map<String, Object>> fileList = new ArrayList<Map<String, Object>>();
 
        File target = new File(uploadPath);
        if(!target.exists()) target.mkdirs();
        
        for(int i=0; i<file.length; i++) {
 
            String orgFileName = file[i].getOriginalFilename();
            String orgFileExtension = orgFileName.substring(orgFileName.lastIndexOf("."));
            String saveFileName = UUID.randomUUID().toString().replaceAll("-", "") + orgFileExtension;
            Long saveFileSize = file[i].getSize();
            
            log.debug("================== file start ==================");
            log.debug("파일 실제 이름: "+orgFileName);
            log.debug("파일 저장 이름: "+saveFileName);
            log.debug("파일 크기: "+saveFileSize);
            log.debug("content type: "+file[i].getContentType());
            log.debug("================== file   END ==================");
 
            target = new File(uploadPath, saveFileName);
            file[i].transferTo(target);
            
            Map<String, Object> fileInfo = new HashMap<String, Object>();
 
            fileInfo.put("BOARD_IDX", boardIDX);
            fileInfo.put("ORG_FILE_NAME", orgFileName);
            fileInfo.put("SAVE_FILE_NAME", saveFileName);
            fileInfo.put("FILE_SIZE", saveFileSize);
            fileInfo.put("CREA_ID", creaID);
            fileList.add(fileInfo);
            
        }
        return fileList;
    }
}
Colored by Color Scripter
cs

- 01행: xml의 Bean으로 fileUtils를 등록한다.

- 06, 07행: context 설정에서 설정한 디렉토리를 담고 있다.

- 11, 12행: 해당 게시글의 글 번호(idx)와 작성자(crea_id)를 담는다.

- 14행: 가공된 파일들을 담을 곳이다.

- 16, 17행: 파일을 저장할 경로가 존재하지 않으면 폴더를 생성한다.

- 22, 23행: 실제 파일의 이름을 랜덤의 이름으로 변경한다. 이 이름으로 파일이 서버에 저장될 것이다.

- 33행: 서버에 실제 파일을 저장한다. (임시디렉토리에 업로드)

- 34행: 임시 디렉토리에 업로드된 파일 데이터를 지정한 폴더에 저장한다.

- 36~43행: 파일의 정보를 각각의 이름으로 fileInfo에 담은 뒤, fileList에 담아준다.

- 46행: 파일들의 정보가 담긴 fileList를 반환한다.

7. 파일 등록 DAO, SQL 추가

파일 등록과 게시글 등록의 테이블은 각자 다르기 때문에 파일 등록의 DAO, SQL을 추가해준다.

boardDAO.java

1
2
3
public void insertFile(Map<String, Object> map) {
    insert("board.insertFile", map);
}
Colored by Color Scripter
cs

baord_sql.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<insert id="insertFile" parameterType="hashmap">
    <![CDATA[
        INSERT INTO tb_file
        (
            BOARD_IDX,
            ORG_FILE_NAME,
            SAVE_FILE_NAME,
            FILE_SIZE,
            CREA_ID,
            CREA_DATE,
            UPDATE_DATE
        )
        VALUES
        (
            #{ BOARD_IDX},
            #{ ORG_FILE_NAME},
            #{ SAVE_FILE_NAME},
            #{ FILE_SIZE},
            #{ CREA_ID},
            SYSDATE(),
            SYSDATE()
        )
    ]]>
</insert>
Colored by Color Scripter
cs

FileUtils 클래스에서 38~42행의 name을 사용해준다.

8. 게시글 등록페이지 수정

글을 작성할 때 제목, 내용, 작성자 등은 CommandMap에 담아 오고, 파일들은 MultipartFile에 담아 온다. 그리고 게시글을 등록한 후에 게시글의 idx를 포함해서 파일을 등록 해준다.

Controller 영역

1
2
3
4
5
6
    @RequestMapping("/board/boardInsert")
    public ModelAndView boardInsert(CommandMap commandMap, MultipartFile[] file) throws Exception {
        ModelAndView mav = new ModelAndView("redirect:/board/boardList");
        boardService.insertBoard(commandMap, file);
        return mav;
    }
Colored by Color Scripter
cs

- 02행: MutlipartFile 을 배열형태로 가져온다.

- 04행: 게시글의 정보와 파일의 정보를 같이 넘겨준다.

Service 영역

1
2
3
4
5
6
7
8
9
10
11
12
// BoardService 영역
void insertBoard(CommandMap commandMap, MultipartFile[] file) throws Exception;
 
// BoardServiceImpl 영역
@Override
public void insertBoard(CommandMap commandMap, MultipartFile[] file) throws Exception{
    boardDAO.insertBoard(commandMap);
    List<Map<String, Object>> fileList = fileUtils.parseFileInfo(commandMap.getMap(), file);
    for(int i=0; i<fileList.size(); i++) {
        boardDAO.insertFile(fileList.get(i));
    }
}
Colored by Color Scripter
cs

- 02, 06행: 마찬가지로 MutltipartFile을 배열형태로 가져온다.

- 08~11행: fileUtils 클래스에서 가공된 정보들을 하나씩 sql처리 해서 등록한다.

board_sql.xml

1
2
3
4
5
<insert id="insertBoard" parameterType="hashmap" useGeneratedKeys="true" keyProperty="idx">
    <![CDATA[
        ...
    ]]>
</insert>
Colored by Color Scripter
cs

게시글의 내용을 등록하는 부분인데, 여기에 useGeneratedKeys 와 keyProperty가 추가되었다. 파일을 등록할때 해당 게시글의 번호(idx)가 필요하기 때문에 이 두가지를 추가해준다.

9. 상세페이지 수정

상세 페이지에 들어왔을 때 등록된 파일들을 보여줘야 한다. 파일 이름, 파일 크기 정도를 보여주려고 한다.

BoardDAO.java

1
2
3
4
    @SuppressWarnings("unchecked")
    public List<Map<String, Object>> detailFile(Map<String, Object> map) {
        return selectList("board.detailFile", map);
    }
Colored by Color Scripter
cs

board_sql.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
    <select id="detailFile" parameterType="hashmap" resultType="hashmap">
        <![CDATA[
            SELECT
                IDX,
                ORG_FILE_NAME,
                ROUND(FILE_SIZE/1024,1) AS FILE_SIZE
            FROM
                tb_file
            WHERE
                BOARD_IDX = #{ idx}
                AND
                DEL_CHK = 'N'
        ]]>
    </select>
Colored by Color Scripter
cs

- 06행: 파일 사이즈를 kb로 표시하기 위해 계산이 들어갔다.

boardServiceImpl.java

1
2
3
4
5
6
7
8
9
10
11
12
13
    @Override
    public Map<String, Object> viewBoardDetail(Map<String, Object> map) {
        // TODO Auto-generated method stub
        boardDAO.updateHitBoard(map);
        Map<String, Object> detail = boardDAO.detailBoard(map);
        List<Map<String, Object>> fileDetail = boardDAO.detailFile(map);
 
        Map<String, Object> resultBoard = new HashMap<String, Object>();
        resultBoard.put("detail", detail);
        resultBoard.put("file", fileDetail);
 
        return resultBoard;
    }
Colored by Color Scripter
cs

- 06행: 파일의 정보를 가져온다.

- 08~12행: 게시글이 정보와 파일의 정보를 한 곳에 담아서 내보낸다.

boardController.java

1
2
3
4
5
6
7
8
9
10
11
12
    @RequestMapping("/board/boardDetail")
    public ModelAndView boardDetail(CommandMap commandMap, Criteria cri) throws Exception {
        
        ModelAndView mv = new ModelAndView("/board/boardDetail");
        Map<String, Object> resultBoard = boardService.viewBoardDetail(commandMap.getMap());
        mv.addObject("detail",resultBoard.get("board"));
        mv.addObject("file",resultBoard.get("file"));
        
        /* 생략 */
        
        return mv;
    }
Colored by Color Scripter
cs

- 05행: resultBoard에 게시글과 파일정보들을 담는다.

- 06행: 게시글은 detail에 담아서 보낸다.

- 07행: 파일은 file에 담아서 보낸다.

boardDetail.jsp

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>
 
<c:choose>
    <c:when test="${fn:length(file) > 0 }">
    <div class="blog-file">
        <ul>
        <c:forEach items="${file }" var="file">
            <li> 
                <span class="file-img"></span>
                <div class="file-info">
                    <a href='#'><i class="fa fa-camera"></i> ${file.ORG_FILE_NAME }</a>
                    <span>${file.FILE_SIZE }kb</span>
                </div>
            </li>
        </c:forEach>
        </ul>
    </div>
    </c:when>
</c:choose>
Colored by Color Scripter
cs

- 01행: fn 함수를 사용하기 위해 추가해주어야 한다.

- 04행: file이 있을 경우에만 보여주기 위해서 조건문을 넣었다.

- 07~15행: 파일을 보여주 보여주는 부분이다.

10. 실행

게시글의 내용과 파일을 2개 등록했다. 콘솔로그로 등록되는 쿼리를 확인해보자.

파일을 제외하고 게시글의 내용만 등록하는 쿼리를 볼 수 있다.

fileUtils 클래스에서 파일의 정보들을 확인할 수 있다. 그리고 파일들이 하나씩 등록되는 것도 볼 수 있다. 파일이 업로드될 디렉토리로 가보면(context-file.xml에 설정함) 업로드한 파일들이 랜덤의 이름으로 저장되어 있는 것을 확인할 수 있다.

파일을 등록한 게시글의 상세페이지에 들어가서 등록한 파일들이 보이면 파일 업로드가 완성되었다. 이미지외에도 다른 확장자의 파일들도 저장할 수 있다. 이제 등록된 첨부파일들을 다운로드할 수 있어야 한다. 첨부파일 다운로드는 다음 포스팅에 작성하려고 한다. 얼른 올려야겠당..

Spring 개발 - 게시판 만들기 #페이징 처리 (2)

#에게 — Mon, 2 Dec 2019 17:04:20 +0900

이전 게시글에서 페이징 처리에는 성공했으나, 후 작업이 더 필요해서 게시글을 분리했다. 페이징 원칙 중에 특정 페이지의 한 게시글을 조회하거나 수정, 삭제 처리가 된 후에 다시 목록으로 리다이렉트할 경우, 그 특정 페이지로 이동해야 한다는 원칙이 있다. 그 원칙에도 만족하도록 페이징 개선 작업을 할 것이다.

예를 들어 5페이지에 있는 30번 게시글을 조회하거나 수정한 뒤, 목록으로 돌아가는 버튼을 눌렀다고 해보자. 그러면 이전 글의 게시판일 경우에는 1페이지로 돌아갈 것이다. 그렇게 되면 한 페이지의 여러 게시글들을 읽고 싶다면 매우 불편할 것이다. 그래서 우리는 첫 페이지로 가는게 아니라, 특성 페이지로 이동하도록 작업을 해야한다. 삭제 처리 또한 특정 페이지로 리다이렉트하도록 작업을 할 것이다.

현재 페이지 번호 page

페이지당 보여줄 게시글의 갯수 perPageNum

특정 페이지의 게시글 목록을 보기 위해서는 위의 정보들이 필요하다. 위의 정보들은 이전 게시글의 Criteria 클래스에서 정의했다. 조회, 수정, 삭제 작업들이 이루어질 때, 목록 페이지의 정보를 유지하기 위해 해당 정보들도 함께 넘어가도록 작업을 할 것이다.

1. UriComponents Class

이 클래스는 URI를 생성할 때 도움이 되는 Spring에서 제공해주는 클래스이다. 쿼리 문자열을 추가해줘서 원하는 URI를 만들 수 있다. 쿼리 문자열은 /board/boardList?IDX=77&page=3&perPageNum=10 주소 URI을 보면 ?(물음표) 뒤에 오는 것들을 말한다. uriComponents를 사용하게 되면 /board/boardDetail${pageMaker.makeQueryPage(page)} 이런식으로 사용이 가능하다.

PageMaker

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

public class PageMaker {
    
    /* 생략 */
    
    public String makeQueryPage(int page) {
        UriComponents uri = UriComponentsBuilder.newInstance()
                .queryParam("page", page)
                .queryParam("perPageNum", cri.getPerPageNum())
                .build();
        return uri.toUriString();
    }
    
    public String makeQueryPage(int idx, int page) {
        UriComponents uri = UriComponentsBuilder.newInstance()
                .queryParam("idx", idx)
                .queryParam("page", page)
                .queryParam("perPageNum", cri.getPerPageNum())
                .build();
        return uri.toUriString();
    }
 
}
Colored by Color Scripter

cs

2개의 메소드를 생성했다. idx가 필요한 uri도 있어서 추가해줬는데, 둘 중에서 첫번째의 메소드만 사용해도 된다. 그렇게 한다면, idx도 필요한 uri는 /board/boardDetail${pageMaker.makeQueryPage(page)}&idx=23 이렇게 뒤에 문자열을 추가해서 보내주면 된다. 나는 idx 포함된 uri 주소를 만들었기 때문에 idx가 필요없으면 page 정보만, idx가 필요하면 idx, page 정보를 넘겨주면 된다.

게시글에 들어가고 나올 때마다 현재 페이지 번호와 페이지당 보여줄 게시글의 갯수를 가지고 있어야 한다. 생성한 makeQueryPage() 메소드를 이용해 URI에 정보를 담아갈 수 있게 Controller 및 JSP를 수정해야 한다. 하나씩 수정해보도록 하자. 변경된 부분만 설명을 달았다.

2. BoardController.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

    @RequestMapping("/board/boardDetail")
    public ModelAndView boardDetail(CommandMap commandMap, Criteria cri) throws Exception {
        
        ModelAndView mv = new ModelAndView("/board/boardDetail");
        Map<String, Object> detail = boardService.viewBoardDetail(commandMap.getMap());
        mv.addObject("detail",detail);
        
        PageMaker pageMaker = new PageMaker();
        pageMaker.setCri(cri);
        mv.addObject("page",cri.getPage());
        mv.addObject("pageMaker", pageMaker);
        
        return mv;
    }
 
    @RequestMapping(value="/board/boardUpdate")
    public ModelAndView boardUpdate(CommandMap commandMap, Criteria cri) throws Exception {
        
        ModelAndView mv = new ModelAndView("/board/boardUpdate");
        Map<String, Object> detail = boardService.selectBoardDetail(commandMap.getMap());
        mv.addObject("detail",detail);
        
        PageMaker pageMaker = new PageMaker();
        pageMaker.setCri(cri);
        mv.addObject("page",cri.getPage());
        mv.addObject("pageMaker", pageMaker);
        
        return mv;
    }
 
    @RequestMapping(value="/board/boardUpdate", method=RequestMethod.POST)
    public ModelAndView boardUpdatePOST(CommandMap commandMap, Criteria cri, RedirectAttributes redAttr) throws Exception {
        
        ModelAndView mv = new ModelAndView("redirect:/board/boardDetail");
        mv.addObject("idx", commandMap.get("idx"));
        boardService.updateBoard(commandMap.getMap());
        
        redAttr.addAttribute("page", cri.getPage());
        redAttr.addAttribute("perPagNum", cri.getPerPageNum());
        
        return mv;
    }
    
    @RequestMapping(value="/board/boardDelete")
    public ModelAndView boardDelete(CommandMap commandMap, Criteria cri, RedirectAttributes redAttr) throws Exception {
        ModelAndView mv = new ModelAndView("redirect:/board/boardList");
        boardService.deleteBoard(commandMap.getMap());
        
        redAttr.addAttribute("page", cri.getPage());
        redAttr.addAttribute("perPagNum", cri.getPerPageNum());
        
        return mv;
    }
Colored by Color Scripter

cs

- 02, 17행: 이전 목록에 대한 정보를 Criteria 클래스에 담는다.

- 08~11, 23~26행: PageMaker 인스턴트를 생성하고 현재 페이지와 함께 view로 던진다.

- 32, 45행: 이전 목록에 대한 정보를 Criteria 클래스에 담고, 리다이렉트를 위해 RedirectAttributes 를 사용한다.

- 38~39, 49~50행: 페이지 정보를 리다이렉트해준다.

3. boardList.jsp

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<td><a href='<c:url value='/board/boardDetail${pageMaker.makeQueryPage(bList.IDX, pageMaker.cri.page) }'/>'>${bList.TITLE }</a></td>
 
<ul class="pagination">
  <c:if test="${pageMaker.prev }">
  <li>
      <a href='<c:url value="/board/boardList${pageMaker.makeQueryPage(pageMaker.startPage-1) }"/>'><i class="fa fa-chevron-left"><</i></a>
  </li>
  </c:if>
  <c:forEach begin="${pageMaker.startPage }" end="${pageMaker.endPage }" var="pageNum">
  <li>
      <a href='<c:url value="/board/boardList${pageMaker.makeQueryPage(pageNum) }"/>'>${pageNum }</a>
  </li>
  </c:forEach>
  <c:if test="${pageMaker.next && pageMaker.endPage >0 }">
  <li>
      <a href='<c:url value="/board/boardList${pageMaker.makeQueryPage(pageMaker.endPage+1) }"/>'><i class="fa fa-chevron-right">></i></a>
  </li>
  </c:if>
</ul>
Colored by Color Scripter

cs

- 01행: 게시글의 상세페이지로 가는 부분에 추가했다.

- 06, 11, 16행: 페이징 버튼 부분에 추가했다.

4. boardDetail.jsp

1
2
3

<a href='<c:url value='/board/boardUpdate${pageMaker.makeQueryPage(detail.IDX, page) }'/>'>수정</a>
<a href='<c:url value='/board/boardDelete${pageMaker.makeQueryPage(detail.IDX, page) }'/>'>삭제</a>
<a href='<c:url value='/board/boardList${pageMaker.makeQueryPage(page) }'/>'>목록으로</a>

cs

수정, 삭제의 경우는 게시글의 idx도 넘어가야하기 때문에 idx 정보도 포함해서 넘겨준다.

5. boardUpdate.jsp

1
2
3
4
5
6

<form action='<c:url value='/board/boardUpdate${pageMaker.makeQueryPage(page) }'/>' method="post">
    <!-- 생략 -->
    <input type="hidden" name="idx" value="${detail.IDX }">
    <button type="submit" class="btn btn-default">수정하기</button>
    <a href='<c:url value='/board/boardDetail${pageMaker.makeQueryPage(detail.IDX, page) }'/>'>이전으로</a>
</form>
Colored by Color Scripter

cs

- 01행: idx도 넘어가야 하는데, input hidden 으로 보내주고 있기 때문에 uri에는 포함시키지 않았다.

- 08행: 이전 상세페이지로 돌아가는 부분에 추가했다.

6. 확인

이제 상세 페이지에 들어가보고 수정, 삭제, 목록으로, 이전으로 버튼을 눌러서 되는 지 테스트해보면 된다. 수정, 삭제가 되는 걸 보여주는 건 의미없어 보이고, uri이 잘 생성 되었는 지 확인하려고 한다. 개발자 모드(F12)를 켜서 uri를 확인해보자.

상세페이지에 들어가는 uri

페이징 버튼 부분 uri

상세페이지의 수정,삭제,목록 uri

이처럼 uri들이 적용되어 있는 것을 확인할 수 있다. idx가 포함되어 있는 uri도 있고, 페이지 정보만 담겨있는 uri도 확인할 수 있다. uriComponents 클래스의 경우는 다른 곳에서도 쓰일 수 있을 거 같아서 더 연구해보면 좋을 거 같다.

티스토리 앱 알람이 왜 안오냐ㅠㅠ?

#에게 — Tue, 9 Apr 2019 11:45:15 +0900

아니 ㅠㅠ 댓글 알람이 하나도 안와서 답변을 제때 못해드렸잖아 ㅠㅠ

요즘 바빠서 티스토리 앱 알림만 믿고 있었는데 와.. 하나도 알람이 안왔어... 미친... 아악!!

잠시 여유가 생겨서 들어와봤더니... 이게 무슨 일이람ㅠㅠ

답변 늦어서 죄송함니다.. 티스토리.. ㅂㄷㅂㄷ...

Spring Security - 로그인 성공 후 부가 작업

#에게 — Tue, 8 Jan 2019 17:21:48 +0900

로그인에 성공했을 때의 부가작업도 해보려고 한다. 마찬가지로 Spring Security에서 제공하는 AuthenticationSuccessHandler 인터페이스를 구현할 것이다. 따라서 실패 핸들러를 구현할 때와 비슷하다고 생각하며 된다. 그리고 해당 인터페이스에서 오버라이드하는 메서드에서도 3가지의 객체가 넘어오는데, 실패 핸들러와는 조금의 차이가 있을 뿐이다.

HttpServletRequest 객체: 웹에서 넘어온 Request 값을 가지고 있는 객체

HttpServletResponse 객체: 출력을 정의할 수 있는 객체

Authentication 객체: 인증에 성공한 사용자의 정보를 가지고 있는 객체

AuthenticationFailureHandler 인터페이스에는 로그인 실패 정보를 가지고 있었다면, AuthenticationSuccessHandler 인터페이스에는 로그인 성공 정보를 가지고 있다. 차이가 많이 나는 것이 아니기 때문에 큰 어려움은 없을 것이다. 다만, 성공 핸들러를 구현할때에는 기본적으로 해야하는 것이 있다. 로그인에 성공 후 이동할 URL을 지정하여 지정한 URL로 이동해야 한다. 로그인에 성공했을 때 이동할 곳은 다 다르다. 로그인 버튼을 눌러 직접 로그인화면으로 갔다면 성공 후엔 메인 화면으로 가야 할 것이고, 권한이 필요한 곳에 접근하여 강제로 로그인 화면으로 이동했다면 성공 후엔 그 권한이 필요했던 곳으로 가야한다. 그리고 혹시나 있을 에러 세션을 지우는 작업도 해줘야 한다. 기본적으로 2가지를 작업하고 다른 추가적인 부가 작업을 해주려고 한다.

1. 로그인 성공시, 어떤 URL로 Redirect 할 지 결정

2. 로그인 실패 에러 세션 지우기

3. 로그인 성공시, 실패 카운터 초기화

그리고 나는 여기서 추가적으로 마지막 접속 날짜를 갱신하는 로직을 추가했다. 생략한 이유는 실패 카운터 초기화 작업과 다를 게 없다. 그렇기 때문에 방문 카운터를 증가시키거나 방문자 수를 업데이트 하는 등 실패 카운터 초기화 작업의 과정을 보면서 자신이 원하는 부가 작업을 추가하면 된다.

파라미터 설정

LoginSuccessHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
public class LoginSuccessHandler implements AuthenticationSuccessHandler {
    
    private String loginidname;
    private String defaultUrl;
 
    @Override
    public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
            Authentication authentication) throws IOException, ServletException {
    }
 
    public String getLoginidname() {
        return loginidname;
    }
 
    public void setLoginidname(String loginidname) {
        this.loginidname = loginidname;
    }
 
    public String getDefaultUrl() {
        return defaultUrl;
    }
 
    public void setDefaultUrl(String defaultUrl) {
        this.defaultUrl = defaultUrl;
    }
 
}
Colored by Color Scripter
cs

Security 설정

context-security.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
<security:form-login
    username-parameter="loginId"
    password-parameter="loginPwd"
    login-processing-url="/login"
    login-page="/secu/loginPage"
    authentication-failure-handler-ref="loginFailureHandler"
    authentication-success-handler-ref="loginSuccessHandler"
/>
 
<bean id="loginSuccessHandler" class="tody.common.handler.LoginSuccessHandler">
    <property name="loginidname" value="loginId"/>
    <property name="defaultUrl" value="/"/>
</bean>
Colored by Color Scripter
cs

- 07행: authentication-success-handler-ref 속성을 추가해준다. 해당 핸들러를 통해 default url이 설정되기 때문에 default-target-url 속성은 필요가 없어진다.

- 10행: AuthenticationSuccessHandler 인터페이스를 구현할 클래스를 <bean> 등록해준다.

- 11, 12행: 사용할 파라미터 값들을 설정해준다.

1. 로그인 성공시, 어떤 URL로 Redirect 할 지 결정

로그인에 성공하고 난 후, 가야 할 이동 경로는 어떻게 로그인 화면에 접근했느냐에 따라 다르다. 또한 어떻게 설정해주냐에 따라 달라질 수도 있다. 로그인에 성공하면 무조건 메인 화면으로 간다던지, 로그인 성공 화면을 띄워준다 던지 등등 어떤 경우에 어떤 url로 보낼 지 결정하고 만드는 게 좋다. 나는 2가지의 경우로 나누어 redirect 시킬 것이다.

- 인증 권한이 필요한 페이지에 접근했을 때

- 직접 로그인 페이지로 접근했을 때

먼저 인증 권한이 필요한 페이지에 접근하게 되면, 로그인 화면을 띄우기 전에 필요한 정보들을 세션에 저장하게 된다. spring security에서 제공하는 사용자의 요청을 저장하고 꺼낼 수 있는 RequestCache 인터페이스를 이용해, 사용자 요청 정보들이 들어 있는 SavedRequest 클래스 객체를 세션에 저장하게 된다. 그럼 우리는 RequestCache 객체를 생성해 SavedRequest 객체를 가져와서 로그인 화면을 보기 전에 방문했던 URL 정보를 가져오면 된다.

다음으로는 직접 로그인 페이지로 접근했을 때 즉, 인증 권한을 위해 로그인 화면을 자동으로 띄워주는 것이 아니라 직접 로그인 url을 통해 이동했을 경우에는 세션에 저장되지 않기 때문에 SavedRequest 객체로는 URL 정보를 가져올 수 없다. 이런 경우에는 HttpServletRequest 객체의 getHeader 메소드를 이용해서 REFERER 헤더 값을 읽어 올 수 있다. REFERER 헤더 값은 이전 페이지 URL을 가져오는 데 가장 보편적인 방법이다. 하지만 로그인에 관한 작업을 할 때에는 REFERER 헤더 값을 이용하는 걸 추천하지 않는다.

로그인 화면에서 <form> 태그로 action을 지정했었다. 로그인 버튼을 누르게 되면 해당 action 을 통해 로그인 처리 과정이 이루어질 것이다. 여기서 문제가 발생한다. 이렇게 로그인에 성공하게 되면 REFERER 헤더 값은 어떤 url이 저장되어 있을까? 바로 로그인 화면 url이 저장되어 있다. 따라서 직접 로그인 했을 때 redirect 로 REFERER 헤더 값을 지정한다면, 로그인에 성공하게 되도 다시 로그인 화면을 보여주게 된다. 그렇기 때문에 REFERER 헤더 값을 사용하는 것은 로그인 처리에서는 별로 좋지 못하다. 따라서 우리는 지정된 화면으로 이동하게 만들어 줄 것이다. security 설정에서 defalut-target-url 을 설정한 적이 있다. 로그인 성공시 이동할 url을 설정했는데, 이 url로 이동하게 해주면 된다.

LoginSuccessHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public class LoginSuccessHandler implements AuthenticationSuccessHandler {
        
    private RequestCache requestCache = new HttpSessionRequestCache();
    private RedirectStrategy redirectStratgy = new DefaultRedirectStrategy();
    
    ...
 
    @Override
    public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
            Authentication authentication) throws IOException, ServletException {
        
        ...
        
        resultRedirectStrategy(request, response, authentication);
        
    }
 
    ...
    
    protected void resultRedirectStrategy(HttpServletRequest request, HttpServletResponse response,
            Authentication authentication) throws IOException, ServletException {
        
        SavedRequest savedRequest = requestCache.getRequest(request, response);
        
        if(savedRequest!=null) {
            String targetUrl = savedRequest.getRedirectUrl();
            redirectStratgy.sendRedirect(request, response, targetUrl);
        } else {
            redirectStratgy.sendRedirect(request, response, defaultUrl);
        }
        
    }
}
Colored by Color Scripter
cs

- 03행: RequestCache 객체를 생성한다.

- 04행: RedirectStratgy 객체를 생성한다.

- 14행: redirect url 작업을 위한 메서드를 호출한다.

- 23행: RequestCache 객체를 통해 SavedRequest 객체를 가져온다.

- 25행: 세션에 이동할 url의 정보가 담겨져 있을때 즉, 인증 권한이 필요한 페이지에 접근했을 경우를 뜻한다.

- 26행: savedRequest 객체를 통해 getRedirectUrl (로그인화면을 보기 전에 갔던 url)을 가져온다.

- 28행: 직접 로그인 화면으로 이동했을 경우를 뜻한다.

- 27, 29행: 화면 이동을 위해 redirectStratgy 의 sendRedirect 를 재정의해준다. 각각에 알맞은 url 정보를 넣어주면 된다.

spring security에서 자동적으로 해주던 부분을 커스터마이징 해주면서 우리가 직접 경로를 설정하게 된 것이다. 만약에 권한에 따라 서로 다른 페이지로 이동하게 하고 싶으면 인증에 성공한 사용자의 권한을 이용해서 원하는 url로 보내주면 된다. 어떨 때 어디로 보낼 지 먼저 정해놓고 시작한다면 어렵지 않게 원하는대로 커스터마이징할 수 있을 것이다.

2. 로그인 실패 에러 세션 지우기

로그인을 하는 과정에서 한번만에 로그인에 성공할 수도 있지만, 실패를 한 후 로그인에 성공하는 경우도 있다. 이처럼 로그인에 실패하는 상황이 한번이라도 발생한다면, 에러가 세션에 저장되어 남아있게 된다. 로그인에 성공했다고 하지만 이렇게 세션에 에러가 남겨진 채로 넘어갈 수는 없다. 따라서 로그인 성공 핸들러에서 에러 세션을 지우는 작업을 해줘야 한다.

LoginSuccessHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
    Authentication authentication) throws IOException, ServletException {
 
        clearAuthenticationAttributes(request);
 
    }
 
    protected void clearAuthenticationAttributes(HttpServletRequest request) {
        HttpSession session = request.getSession(false);
        if(session==null) return;
        session.removeAttribute(WebAttributes.AUTHENTICATION_EXCEPTION);
    }
 
}
Colored by Color Scripter
cs

- 05행: 에러 세션을 지우는 메서드를 실헹한다.

- 10행: 세션을 받아온다.

- 11행: 세션이 null 즉, 세션에 에러가 없다면 그냥 return 된다.

- 12행: WebAttributes.AUTHENTICATION_EXCEPTION 이름 값으로 정의된 세션을 지운다.

3. 로그인 성공시, 실패 카운터 초기화

로그인 실패 핸들러에서 로그인에 실패 시, 실패 카운터를 증가시켰다. 그런데 실패 카운터가 증가된 상태로 로그인에 성공하게 되면, 다음번에 로그인할 때는 더 적은 실패 기회를 얻게 될 것이다. 따라서 로그인을 시도할 때마다 같은 시도 횟수를 주려고 한다면, 로그인에 성공할 때 실패 카운터를 초기화해야 한다.

LoginSuccessHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Resource(name="userSer")
private UserService userSer;
 
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
    Authentication authentication) throws IOException, ServletException {
        
    String username = request.getParameter(loginidname);
        
    userSer.resetFailureCnt(username);
 
    ...
        
}
Colored by Color Scripter
cs

Service 영역

1
2
3
4
5
6
7
8
//UserService
void resetFailureCnt(String username);
 
//UserServiceImpl
@Override
public void resetFailureCnt(String username) {
    userDAO.updateFailureCountReset(username);
}
Colored by Color Scripter
cs

UserDAO.java

1
2
3
public void updateFailureCountReset(String username) {
    sqlSession.update("user.updateFailureCountReset", username);
}
Colored by Color Scripter
cs

user_sql.xml

1
2
3
4
5
6
7
8
9
10
<update id="updateFailureCountReset">
    <![CDATA[
        UPDATE
            user
        SET
            FAILURE_CNT = 0
        WHERE
            ID = #{ loginId}
    ]]>
</update>
cs

이런 로직 작업은 정말 껌일 것이다. 그래서 따로 설명하지 않고 로직이 어디에 들어가야 하는 지만 잘 알아두면 언제든지 하고 싶은대로 커스텀 할 수 있다. 프로젝트를 실행시켜서 테스트를 해보자. 실패 카운터도 초기화 되고, url도 생각한 것처럼 이동되면 완성된 것이다!

GitHub

참고 : 사랑이 고픈 프로그래머..

Spring Security - 로그인 실패 후 부가 작업

#에게 — Thu, 3 Jan 2019 15:52:55 +0900

로그인에 실패했을 때 에러 메시지만 보여줘도 되지만 나는 추가적인 부가 작업을 해보려고 한다. 로그인에 실패했을 때 부가적인 작업을 할 수 있는 인터페이스를 Spring Security 에서 제공한다. 마찬가지로 로그인 실패 작업을 커스터마이징 한다고 생각하면 된다. 물론 필요가 없으면 사용하지 않아도 되지만, 대부분은 부가 작업을 하게 될 것이다. 나는 아래의 3개의 작업을 할 것이다.

1. 로그인 실패시 입력한 로그인 정보 띄우기

2. 세션을 이용하지 않고 에러 메시지 보여주기

3. 비밀번호를 3번 이상 틀릴시 계정 잠금 처리

Spring security 에서 제공하는 AuthenticationFailureHandler 인터페이스를 구현하게 되면 onAuthenticationFailure() 메서드를 오버라이드 받게 된다. 즉, 로그인에 실패하게 되면 해당 메서드가 실행이 되는 것이다. 해당 메서드에서 넘어오는 객체는 3가지가 있다. 해당 객체들을 이용해서 정보를 가져오고 추가작업들을 하면 된다.

HttpServletRequest 객체: 웹에서 넘어온 Request 값을 가지고 있는 객체

HttpServletResponse 객체: 출력을 정의할 수 있는 객체

AuthenticationException 객체: 로그인 실패 정보를 가지고 있는 객체

HttpServletReqeust 객체를 이용해서 웹에서 넘오는 로그인 정보들을 메서드(getParameter)를 이용해서 가져올 수 있다. 이렇게 가져온 값들을 그대로 다시 셋팅(setAttribute)해서 다시 웹으로 넘겨주면 된다. 또한 AuthenticationException 객체를 통해 실패 메시지를 가져와서 다시 셋팅하여 웹으로 보내면 된다. 이렇게 셋팅한 값들을 메서드(getRequestDispatcher)를 통해 보여줄 화면으로 forward 해주면, jstl을 이용해서 셋팅한 값들을 보여줄 수 있다.

먼저 4가지의 파라미터를 설정할 것이다. 우리가 필요한 정보들을 불러올 때 사용하는 파라미터라고 생각하면 된다. 다시말해, 이 파라미터들을 이용해서 각각의 값들을 불러오게 된다. 이렇게 불러온 값들을 샛팅해서 보여줄 페이지에 jstl을 이용해서 보여주면 된다.

파라미터 설정

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
public class LoginFailureHandler implements AuthenticationFailureHandler {
    
    private String loginidname;
    private String loginpwdname;
    private String errormsgname;
    private String defaultFailureUrl;
 
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception)
            throws IOException, ServletException {
    }
 
    public String getLoginidname() {
        return loginidname;
    }
 
    public void setLoginidname(String loginidname) {
        this.loginidname = loginidname;
    }
 
    public String getLoginpwdname() {
        return loginpwdname;
    }
 
    public void setLoginpwdname(String loginpwdname) {
        this.loginpwdname = loginpwdname;
    }
 
    public String getErrormsgname() {
        return errormsgname;
    }
 
    public void setErrormsgname(String errormsgname) {
        this.errormsgname = errormsgname;
    }
 
    public String getDefaultFailureUrl() {
        return defaultFailureUrl;
    }
 
    public void setDefaultFailureUrl(String defaultFailureUrl) {
        this.defaultFailureUrl = defaultFailureUrl;
    }
 
}
Colored by Color Scripter
cs

- 03행: HttpServletRequest 에서 로그인 아이디가 저장되어 있는 파라미터 이름. 아이디값이 들어오는 input 태그 name

- 04행: HttpServletRequest 에서 로그인 비밀번호가 저장되어 있는 파라미터 이름. 비밀번호값이 들어오는 input 태그 name

- 05행: 로그인 페이지에서 jstl을 이용하여 에러메시지를 가져올 때 사용할 변수 이름.

- 06행: 실패시 보여줄 화면 url

- 13~43행: 파라미터들의 getter/setter이다. getter/setter가 존재하지 않으면 <bean> 등록시 <property> 태그에 오류가 발생한다.

security 설정

context-security.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<security:form-login
    username-parameter="loginId"
    password-parameter="loginPwd"
    login-processing-url="/login"
    login-page="/secu/loginPage"
    default-target-url="/"
    authentication-failure-handler-ref="loginFailureHandler"
/>
 
<bean id="loginFailureHandler" class="tody.common.handler.LoginFailureHandler">
    <property name="loginidname" value="loginId"/>
    <property name="loginpwdname" value="loginPwd"/>
    <property name="errormsgname" value="ERRORMSG"/>
    <property name="defaultFailureUrl" value="/secu/loginPage?error"/>
</bean>
Colored by Color Scripter
cs

- 07행: authentication-failure-handler-ref 속성에 <bean>태그로 등록한 값을 설정한다. authenticaton-failure-url 속성을 사용해서 로그인에 실패했을 때 호출할 url을 설정했다면, authentication-failure-url 속성이 필요가 없어진다. 우리가 앞서 설정한 파라미터 중 defaultFailureUrl 이 해당 역할을 해줄 것이다.

- 10행: AuthenticationFailureHandler 인터페이스를 구현한 클래스를 <bean> 태그를 이용해 등록한다.

- 11~14행: 4가지의 파라미터 값들을 셋팅해주었다. 이것은 웹에서 넘어온 input 태그의 이름, 혹은 지정한 url 페이지이다.

1. 로그인 실패시 입력한 로그인 정보 띄우기

HttpServletRequest 객체의 getParameter 메서드를 이용하여 사용자가 입력한 로그인 아이디와 비밀번호를 가져오면 된다. 아이디와 비밀번호 input 태그의 name을 이용해거 가져오면 된다. 앞서 정의한 파라미터들을 이용하면 된다.

LoginFailureHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception)
            throws IOException, ServletException {
        
        String username = request.getParameter(loginidname);
        String password = request.getParameter(loginpwdname);
        
        request.setAttribute(loginidname, username);
        request.setAttribute(loginpwdname, password);
 
        request.getRequestDispatcher(defaultFailureUrl).forward(request, response);
    }
Colored by Color Scripter
cs

- 05, 06행: 아이디와 비밀번호를 getParameter 메서드를 이용해 가져온다.

- 08, 09행: input 태그의 name에 가져온 아이디와 비밀번호 정보를 HttpServletRequest 에서 제공하는 메서드(setAttribute)로 셋팅해준다.

- 11행: HttpServletRequest 의 getRequestDispatcher 메서드를 이용해서 보여줄 화면으로 forward 해준다. forward를 해줘야만 jstl을 이용해서 값들을 가져올 수 있다. 여기서 보여줄 화면은 로그인 실패 시 이동할 페이지(defaultFailureUrl) 이라고 생각하면 된다.

2. 세션을 이용하지 않고 에러 메시지 보여주기

지금까지의 에러메시지는 웹에서 세션에 접근해서 메시지를 보여주었다. 에러 메세지를 세션에 저장하는 것은 spring security 에서 자동으로 하는 것이다. 하지만 이렇게 웹에서 세션을 통해 에러 메시지를 가져오는 건 좋지 않다. 그래서 request의 setAttribute를 이용해서 에러 메시지를 보여줄 것이다. 헷갈릴 수도 있어서 더 설명하자면, 웹에서 세션을 통해 에러메시지를 가져오는 걸 막기 위해서 세션을 통해 가져온 에러메시지를 Attribute를 이용해 저장한 다음, 웹에서는 jstl로 보여주는 작업을 하는 것이다.

LoginFailureHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception)
            throws IOException, ServletException {
        
        String username = request.getParameter(loginidname);
        String password = request.getParameter(loginpwdname);
        String errormsg = exception.getMessage();
        
        request.setAttribute(loginidname, username);
        request.setAttribute(loginpwdname, password);
        request.setAttribute(errormsgname, errormsg);
 
        request.getRequestDispatcher(defaultFailureUrl).forward(request, response);
    }
Colored by Color Scripter
cs

- 07행: 세션을 통해 에러메시지를 가져온다.

- 11행: 에러 메시지를 셋팅해준다.

사실 세션을 통해 에러메시지를 가져와서 다른 값에 셋팅해주어 보여주기만 한다면 이렇게 간단하다. 이렇게 해도 별 문제는 없다. 하지만 나는 추가 작업이 더 필요하다. 내가 쉬운 방법을 찾지 못한건지 모르겠지만, 이 다음 작업인 비밀번호가 틀렸을 때 해주어야할 작업이 남아있는데, 이 작업을 위해서는 아이디가 틀린 경우, 비밀번호가 틀린 경우를 구분해줘야 한다. (사실 이 부분부터는 내가 생각한 방식이여서 정확한 방법이 아닐 수도 있다.)

먼저 메세지 프로퍼티 사용하기 위해서 Message Source Accessor를 등록해줘야한다. 별로 많은 내용이 있지는 않지만 따로 분리해서 설명을 하려고 한다. 메세지 프로퍼티를 사용할 준비가 됐다면 에러를 분리해보자. 내가 찾은 spring security의 예외 세션들이다.

Exception	설명
BadCredentialException	비밀번호가 일치하지 않을 때 던지는 예외
InternalAuthenticationServiceException	존재하지 않는 아이디일 때 던지는 예외
AuthenticationCredentialNotFoundException	인증 요구가 거부됐을 때 던지는 예외
LockedException	인증 거부 - 잠긴 계정
DisabledException	인증 거부 - 계정 비활성화
AccountExpiredException	인증 거부 - 계정 유효기간 만료
CredentialExpiredException	인증 거부 - 비밀번호 유효기간 만료

여기서 알아둬야 할 것은, 비밀번호와 아이디가 일치하지 않는 예외들의 메세지를 분리해서는 안된다. 물론 분리해서 아이디가 틀렸습니다, 혹은 비밀번호가 틀렸습니다와 같은 메세지를 보여줘도 된다. 하지만 이러면 보안성이 낮아진다. 조금이라도 더 보안성을 높이려면 두 개의 예외를 하나의 메세지로 처리하는 것이 좋다.

예외 분리

1
2
3
4
5
6
7
8
9
//AuthenticationProvider 인터페이스를 구현한 클래스의 Authentication()
if(!user.isEnabled() || !user.isCredentialsNonExpired()) {
    throw new AuthenticationCredentialsNotFoundException(username);
}
 
//UserDetailsService 인터페이스를 구현한 클래스의 loadUserByUsername() 메서드
if(user==null) {
    throw new InternalAuthenticationServiceException(username);
}
Colored by Color Scripter
cs

계정 인증 관련 예외들을 BadCredentialException 예외로 던지면 세션에서 알아서 세분류 되어 에러 메시지를 보여주었다. 마찬가지로 좀 더 세분화하기 위해 인증과 관련된 예외중 상위 예외인 AuthenticationCredentialNotFoundException 예외를 사용했다. 해당 예외로 던지면 핸들러에 오는 에러 세션는 좀 더 세분화 된 예외로 들어오게 된다. 그렇기에 or 조건을 사용하여 인증 관련 예외들은 하나로 묶은 뒤 해당 예외를 던져주었다.

계정이 존재하지 않을 때 UserNotFoundException 예외를 던지게 되면, BadCredentialException 예외로 받게 된다. 그러면 아이디 예외와 비밀번호 예외가 구분되지 않아서, 찾다가 찾은 예외가 InternalAuthenticationServcieException 예외이다. 해당 예외는 UserDetailsService 인터페이스에서 아무런 값이 리턴되지 않을 때 발생하는 예외이다. 리턴값이 아무것도 없다는 것은 아이디가 존재하지 않다는 뜻이라 생각해서 해당 예외를 사용하게 되었다.

LoginFailureHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception)
            throws IOException, ServletException {
        
        String username = request.getParameter(loginidname);
        String password = request.getParameter(loginpwdname);
        String errormsg = null;
        
        if(exception instanceof BadCredentialsException) {
            errormsg = MessageUtils.getMessage("error.BadCredentials");
        } else if(exception instanceof InternalAuthenticationServiceException) {
            errormsg = MessageUtils.getMessage("error.BadCredentials");
        } else if(exception instanceof DisabledException) {
            errormsg = MessageUtils.getMessage("error.Disaled");
        } else if(exception instanceof CredentialsExpiredException) {
            errormsg = MessageUtils.getMessage("error.CredentialsExpired");
        }
        
        request.setAttribute(loginidname, username);
        request.setAttribute(loginpwdname, password);
        request.setAttribute(errormsgname, errormsg);
 
        request.getRequestDispatcher(defaultFailureUrl).forward(request, response);
    }
Colored by Color Scripter
cs

- 07행: 에러 메시지를 담을 변수를 지정한다.

- 09~17행: AuthenticationException 에서 오는 예외의 타입을 체크해서 알맞은 에러 메시지를 메세지 프로퍼티를 이용해 변수에 담아준다. 비밀번호가 틀릴 경우와 아이디가 없을 경우의 예외가 서로 다르지만, 같은 에러 메시지를 뿌려준다.

- 21행: 저장된 에러 메시지를 셋팅해준다.

security_message.properties

1
2
3
4
5
error.BadCredentials=아이디나 비밀번호가 맞지 않습니다. 다시 확인해주세요.
error.Disaled=계정이 비활성화되었습니다. 관리자에게 문의하세요.
error.CredentialsExpired=비밀번호 유효기간이 만료 되었습니다. 관리자에게 문의하세요.
error.Locked=계정이 잠겨있습니다. 관리자에게 문의하세요.
error.AccountExpired=계정이 만료되었습니다. 관리자에게 문의하세요.
cs

에러에 맞게끔 예외 메세지를 작성해준다. 내가 사용하고 싶은 key값들로 바뀌었을 뿐 메세지에는 크게 변화는 없다.

3. 비밀번호를 3번 이상 틀릴 시 계정 잠금 처리

비밀번호가 일치하지 않는 예외일 때 해당 로직을 작성해주면 된다. 우리가 예외를 분리한 이유이다. 비밀번호 틀린 횟수를 어떻게 가지고 있어야 할까? DB를 이용해서 틀린 횟수를 체크하려고 한다. DB에 실패 카운터 컬럼을 생성해서 비밀번호가 틀릴 경우 실패 카운터 컬럼을 1씩 증가시킨다면 틀린 횟수를 쉽게 알 수 있게 된다.

1. 비밀번호 실패 카운터 1 증가

2. 비밀번호 실패 횟수 가져오기

3. 만약 3번 틀렸다면 계정 잠금 처리

비밀번호가 틀렸으면 먼저 실패 카운터를 1 증가시킨 후, 실패 횟수를 가져온다. 실패 횟수가 3번이면 계정 잠금 처리를 하고 아니면 그냥 넘어간다. 이렇게 하면 3번째에 틀렸을 경우 계정이 잠금이 되고, 4번째에 비밀번호가 맞든 틀리든 계정이 잠금되었다는 에러 메시지가 나갈 것이다.

LoginFailureHandler.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class LoginFailureHandler implements AuthenticationFailureHandler {
 
    @Resource(name="userSer")
    private UserService userSer;
 
    ...
 
    @Override
     public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response,
                    AuthenticationException exception) throws IOException, ServletException {    
         ...
 
        if(exception instanceof BadCredentialsException) {
            loginFailureCount(username);
            errormsg = MessageUtils.getMessage("error.BadCredentials");
        }
        ...
    }
 
    protected void loginFailureCount(String username) {
        userSer.countFailure(username);
        int cnt = userSer.checkFailureCount(username);
        if(cnt==3) {
            userSer.disabledUsername(username);
        }
    }
    
    ...
}
Colored by Color Scripter
cs

- 14행: 비밀번호가 틀렸을 경우 실패 카운터와 관련된 메서드를 실행시킨다.

- 20행: 실패 카운터 메서드이다. 로그인 실패 핸들러 안에 존재한다.

- 21행: 실패 카운터를 증가시킨다.

- 22행: 실패 횟수를 가져온다.

- 23~25행: 실패 횟수가 3회일때 계정을 잠금 처리한다.

Service 영역

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
public interface UserService {
 
    void countFailure(String username);
 
    int checkFailureCount(String username);
 
    void disabledUsername(String username);
 
}
 
@Service("userSer")
public class UserServiceImpl implements UserService {
    
    @Resource(name="userAuthDAO")
    private UserAuthDAO userDAO;
 
    @Override
    public void countFailure(String username) {
        userDAO.updateFailureCount(username);
    }
 
    @Override
    public int checkFailureCount(String username) {
        return userDAO.checkFailureCount(username);
    }
 
    @Override
    public void disabledUsername(String username) {
        userDAO.updateDisabled(username);
    }
 
}
Colored by Color Scripter
cs

DAO 영역

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Repository("userAuthDAO")
public class UserAuthDAO {
    
    @Autowired
    private SqlSessionTemplate sqlSession;
 
    public CustomUserDetails getUserById(String username) {
        return sqlSession.selectOne("user.selectUserById", username);
    }
 
    public void updateFailureCount(String username) {
        sqlSession.update("user.updateFailureCount", username);
    }
    
    public int checkFailureCount(String username) {
        return sqlSession.selectOne("user.checkFailureCount", username);
    }
 
}
Colored by Color Scripter
cs

SQL 영역

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<mapper namespace="user">
 
     <select id="selectUserById" resultType="tody.common.vo.CustomUserDetails">
        <![CDATA[
            SELECT
                *
            FROM
                user
            WHERE
                ID=#{ loginId}
        ]]>
    </select>
    
    <update id="updateFailureCount">
        <![CDATA[
            UPDATE
                user
            SET
                FAILURE_CNT = FAILURE_CNT + 1
            WHERE
                ID = #{ loginId}
        ]]>
    </update>
    
        <select id="checkFailureCount" resultType="Integer">
        <![CDATA[
            SELECT
                FAILURE_CNT
            FROM
                user
            WHERE
                ID=#{ loginId}
        ]]>
    </select>
    
 </mapper>
Colored by Color Scripter
cs

4. jstl 적용

LoginFailureHandler 클래스에 로그인 정보, 에러 메시지 등을 셋팅하고 로그인 화면으로 forward 해줬다면 이제 jstl을 이용해서 셋팅한 값들을 그대로 보여주면 된다. 주의해야 할 점은 jstl 파라미터 이름을 정확하게 입력해주어야 한다. 그거만 조심하면 문제없이 나올 것이다.

loginPage.jsp

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<form action="/login" method="post">
    ...
        <input type="text" name="loginId" placeholder="example" value="${loginId }">
    ...
        <input type="password" name="loginPwd" placeholder="Password" value="${loginPwd }">
    ...
    <c:if test="${not empty ERRORMSG}">
        <font color="red">
        <p>Your login attempt was not successful due to <br/>
        ${ERRORMSG }</p>
        </font>
    </c:if>
    ...
</form>
Colored by Color Scripter
cs

- 03, 05행: 사용자가 입력한 로그인 정보를 셋팅하여 jstl을 이용해서 보여준다.

- 07, 10행: 이젠 세션에서 에러메시지를 가져오는 것이 아닌 jstl을 이용해서 에러 메세지를 보여준다.

그리고 에러메시지를 더이상 세션에서 가져오는 것이 아니기 때문에 <c:remove> 태그를 이용해 세션을 지우던 로직은 삭제하였다.

로그인 성공 후 부가 작업부터 하지 않고 실패 핸들러 작업부터 한 이유는, 비밀번호를 2번 틀리고 로그인에 성공했을 때 로그인 횟수가 남아있다면 다음번에 로그인을 할 때 한번이라도 틀리면 계정이 잠금된다. 그걸 방지하기 위해 로그인 성공시 로그인 실패 카운터를 초기화 해주는 작업을 해야 하는데 로그인 성공 핸들러부터 한다면 뭔가 거꾸로 가는 기분이라서 실패 핸들러부터 작성했다.

GitHub

참고 : 사랑이 고픈 프로그래머..

처음으로 Fork 당했다(?)!

#에게 — Wed, 2 Jan 2019 16:43:13 +0900

연말 잘 보내고 행복한 새해를 맞이하고 왔더니, 기분 좋은 알람이 딸랑 딸랑~

호에에엑!! 누가 내 프로젝트를 Fork를 한 것이다! 우와아아앙ㅇ!! 신기해 신기해!! 1 Fork 신기해!!!

아직 완성되지 않은 프로젝트인지라 조-금 부끄럽지만.. 이슈나 풀리퀘스트 언제든지 받습니다! 얏호!

사실 블로그에 댓글 달리는 것도 정말 신기하다. 달릴 때마다 신기하다!

감사하다는 댓글들, 질문들 전부 감사할 뿐이다. 덕분에 글 쓸 때 더 긴장된다. 후하후하-

틀린게 있으면 어쩌지ㅠㅠ (쭈굴) 그래서 더 찾아보게 되고 더 공부하게 된다! 댓글 좋아~♥

유난히 새로운 것을 많이 접하게 된 2018년도여서 그런지, 정신없이 바쁘기도 했고 그만큼 지치기도 했다.

이 많은 공부들을 내가 끝까지 혼자 다 할 수 있을까, 라는 생각도 많이 들었고,

괜히 일 크게 벌려서 사서 고생하는 거 아닐까, 라는 생각도 많이 들었다.

근데 이렇게 누군가가 나의 글에 관심을 갖는것, 그리고 누군가에게 도움이 된다는 것이 내 열정에 기름을 들이 붓는다(ㅎㅁㅎ)!

사서 고생이라고 해도 나는 재밌는 걸 어떡하냐! 내가 재밌으면 됐지! 내가 즐거웠으면 된거야!

그럼 2019년도도 수고하고 화이팅!

Spring Security - 인증 절차 인터페이스 구현 (2) AuthenticationProvider

#에게 — Mon, 3 Dec 2018 16:56:39 +0900

AuthenticationProvider 인터페이스는 화면에서 입력한 로그인 정보와 DB에서 가져온 사용자의 정보를 비교해주는 인터페이스이다. 해당 인터페이스에 오버라이드되는 authenticate() 메서드는 화면에서 사용자가 입력한 로그인 정보를 담고 있는 Authentication 객체를 가지고 있다. 그리고 DB에서 사용자의 정보를 가져오는 건 UserDetailsService 인터페이스에서 loadUserByUsername() 메서드로 구현했다. 따라서 authenticate() 메서드에서 loadUserByUsernmae() 메서드를 이용해 DB에서 사용자 정보를 가져와서 Authentication 객체에서 화면에서 가져온 로그인 정보와 비교하면 된다. AuthenticationProvider 인터페이스는 인증에 성공하면 인증된 Authentication 객체를 생성하여 리턴하기 때문에 비밀번호, 계정 활성화, 잠금 모든 부분에서 확인이 되었다면 리턴해주도록 하자.

1. AuthenticationProvider

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public class CustomAuthenticationProvider implements AuthenticationProvider {
    
    @Autowired
    private UserDetailsService userDeSer;
 
    @SuppressWarnings("unchecked")
    @Override
    public Authentication authenticate(Authentication authentication) throws AuthenticationException {
        
        String username = (String) authentication.getPrincipal();
        String password = (String) authentication.getCredentials();
        
        CustomUserDetails user = (CustomUserDetails) userDeSer.loadUserByUsername(username);
        
        if(!matchPassword(password, user.getPassword())) {
            throw new BadCredentialsException(username);
        }
 
        if(!user.isEnabled()) {
            throw new BadCredentialsException(username);
        }
        
        return new UsernamePasswordAuthenticationToken(username, password, user.getAuthorities());
    }
 
    @Override
    public boolean supports(Class<?> authentication) {
        return true;
    }
    
    private boolean matchPassword(String loginPwd, String password) {
        return loginPwd.equals(password);
    }
 
}
Colored by Color Scripter
cs

10행: 화면에서 입력한 아이디를 username에 담는다.

11행: 화면에서 입력한 비밀번호를 password에 담는다.

13행: 화면에서 입력한 아이디(username)로 DB에 있는 사용자의 정보를 UserDetails 형으로 가져와 user에 담는다.

15행: 화면에서 입력한 비밀번호와 DB에서 가져온 비밀번호를 비교하는 로직이다. 비밀번호가 맞지 않다면 예외를 던진다.

19행: 계정 활성화 여부를 확인하는 로직이다. AuthenticationProvider 인터페이스를 구현하게 되면 계정 잠금 여부나 활성화 여부등은 여기에서 확인해야 한다.

23행: 계정이 인증됐다면 UsernamePasswordAuthenticationToken 객체에 화면에서 입력한 정보와 DB에서 가져온 권한을 담아서 리턴한다.

27행: AuthenticationProvider 인터페이스가 지정된 Authentication 객체를 지원하는 경우에 true를 리턴한다.

31행: 비밀번호를 비교하는 메서드이다. 맞으면 true를 리턴한다.

계정 관련 체크 여부(19행)에 관해서 언급할 게 있다. 이 부분은 온전히 내 생각일 뿐이기 떄문에 정확한 건 아니다. 좀 더 찾아봐야 할 부분이다. 그리고 난 왜 UserDetailsService 인터페이스를 구현할 때 이걸 궁금해하지 않았는 지 의문이다(ㅋㅋ) UserDetailsService 인터페이스를 구현할 때 비활성화된 계정을 체크하는 로직이 없었다. 근데 비활성화된 계정은 에러로 예외가 던져졌다(!!!) 왜 이걸 궁금해하지 않고 그냥 넘어갔을 까 ㅋㅋㅋ 정확히는 모르지만 DB에서 가져온 사용자의 정보를 UserDetails 인터페이스에 담으면서 계정관련 체크 여부를 알아서 확인하고 예외를 던지는 것 같다.

근데 AuthenticationProvider 인터페이스를 구현하게 됐을 때 문제가 발생했었다. 비활성화된 계정이 예외를 던지지않고 그냥 로그인에 성공해버리는 문제가 생겼었다ㅠㅠ.. AuthenticationProvider 인터페이스를 구현하니까 UserDetailsService 인터페이스에서 계정 관련 체크를 하지 않았다ㅠㅠ AuthenticationProvider 인터페이스를 구현하게 되면서 UserDetailsService 인터페이스는 DB에서 사용자의 정보를 가져오는 역할만 하게 되버린 것 같다. 그래서 UserDetailsService 인터페이스에서 계정 활성화여부를 체크해보려고 했는데 적절한 예외가 없어서 에러 메시지가 제대로 나오지 않았다. 근데 AuthenticationProvider 인터페이스에는 적절한 에러 메시지를 던지는 예외가 있는 걸 확인했다! 유레카! 그래서 내 생각에는 AuthenticationProvider 인터페이스와 UserDetailsService 인터페이스를 구현하게 되면 UserDetailsServcie 인터페이스는 DB에서 사용자의 정보를 가져오는 역할을 하고, AuthenticationProvider 인터페이스에서 비밀번호 체크 및 계정과 관련된 각종 체크여부를 확인해야 되는 것 같다. 대부분 계정 체크 부분을 true로 하고 만들어서 그런지 자료가 없었다ㅠㅠ 그냥 내 생각일 뿐이니.. 얼른 정확한 자료를 찾아봐야 겠다ㅠㅠ

2. Security 설정

context-security

1
2
3
4
5
6
7
8
<security:authentication-manager>
    <security:authentication-provider ref="userAuthProvider"/>
    <security:authentication-provider user-service-ref="userService">
    </security:authentication-provider>
</security:authentication-manager>
        
<bean id="userService" class="tody.common.service.CustomUserDetailsService"/>
<bean id="userAuthProvider" class="tody.common.service.CustomAuthenticationProvider"/>
cs

02행과 08행이 추가되었다. AuthenticationProvider 인터페이스를 구현한 CustomAuthenticationProvider 클래스를 등록하는 부분이다.

<authentication-provider> 태그는 여러 요소를 사용할 수 있는데, 여러 요소를 사용할 경우 순서대로 진행된다. 사실 어떤걸 먼저 선언하든 로그인 결과에는 영향을 주지는 않는다. 하지만 UserDetailsService 인터페이스가 먼저 선언되서 사용될 경우 에러 메시지가 제대로 나오지 않는다. 정확히는 에러 메시지 프로퍼티를 사용할 수 없다. 이 부분에 대해선 정확히 잘 몰라서 설명하지 못하지만(ㅠㅠ) UserDetailsService 인터페이스가 먼저 실행되면 AuthenticationProvider 인터페이스를 구현할 이유가 없지 않을까? 싶다..ㅋㅋㅋㅋ

3. 실행

비밀번호가 틀릴 경우, 비밀번호가 맞지 않다는 에러 문구가 뜨고 로그인에 실패할 것이다. 물론 비밀번호를 맞게 한다면 당연히 로그인에 성공해야 한다. 이렇게 비밀번호 비교 확인이 완벽하게 이루어진다면 AuthenticationProvider 인터페이스도 완벽하게 구현된 것이다! 휴! 뭔가 어려워보였지만 인터페이스에 맞는 기능들을 생각하고 구현한다면 그리 어렵지만은 않다.

GitHub

~~그리고 지금까지 개인적인 생각으로는 AuthenticationProvider 인터페이스까진 구현하지 않아도 충분히 사용할 수 있을 거 같다 ㅋㅋ~~

Spring 개발 - 게시판 만들기 #페이징 처리 (1)

#에게 — Fri, 30 Nov 2018 16:10:11 +0900

이전에 만든 CRUD 게시판은 100개의 게시글이 있다면 한번에 100개의 게시글이 모두 보여진다. 정말 비효율적인 게시판이다..(ㅎ) 그래서 게시판 목록 페이징 처리를 하려고 한다. 그러면 좀 더 게시판 스럽지 않을까 싶다! 나는 만들어 놓은 CURD 게시판을 수정해서 작업을 하는 것이기 때문에 본인의 게시판에 맞게 적절히 섞어(?)주면 된다.

1. 페이징 규칙

먼저 페이징이 어떤식으로 처리되는 지 이해해보자. 페이지당 게시글을 10개씩 보여주고 페이징 버튼은 최대 10개까지만 보인다고 하자.

총 게시글 수 77개

[1] [2] [3] [4] [5] [6] [7] [8]

총 게시글 수가 77이면 페이지 번호의 끝 번호가 8이여야 한다.

페이지의 끝 번호를 알기 위해서는 총 게시글의 수가 필요하다.

총 게시글 수 135개

[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [다음]

[이전] [11] [12] [13]

화면에 보여줄 페이지 버튼의 수가 10개 이상이라면 다음 버튼을 이용해 다음 페이지를 이용할 수 있어야 한다.

시작 페이지의 번호가 1이 아니라면 이전 버튼을 이용해 이전 페이지를 이용할 수 있어야 한다.

총 게시글 수 215개

[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [다음]

[이전] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [다음]

[21] [22]

현재 페이지의 번호가 1~10 사이라면 시작 번호는 1이여야 한다.

현재 페이지의 번호가 11~20 사이라면 시작 번호는 11이여야 한다.

2. 페이징 원칙

페이징 처리를 함에 있어서 원칙들이 있다.

페이징 처리는 반드시 GET 방식만을 이용해야 한다.
게시글 목록 페이지의 하단에 페이지들의 번호를 보여주고 원하는 번호를 선택하면 해당 페이지로 이동해서 목록을 보여줘야 한다.
페이징은 반드시 필요한 페이지 번호만 출력해야 한다. 만약 페이지당 10개의 게시글을 출력하는데 전체 게시글의 수가 42개라면 페이지의 번호는 5페이지까지여야 한다.
이전과 다음 버튼이 존재해야 한다. 게시글이 1000개인데 1페이지당 10개의 게시글을 볼 수 있게 했다면 페이징 버튼은 100개가 필요하다. 그런데 이전과 다음 버튼이 존재하지 않는다면 100개의 버튼을 한번에 보여줘야 한다. 그렇기때문에 하단 페이지에 보여줄 버튼의 갯수를 정하고 더 많은 데이터가 있다면 이전과 다음 버튼으로 표시해줘야 한다.
게시글을 조회하거나 수정, 삭제를 하고 난 뒤, 다시 원래의 목록 페이지로 이동해야 한다. 예를 들면 게시판에 5페이지에 있는 어떠한 게시물을 조회하거나 수정, 삭제를 했다고 한다면, '목록으로'버튼을 이용해 목록으로 돌아갈 땐 5페이지로 이동해야 한다.

3. SQL : LIMIT

페이징 처리를 확인하기 위해서 DB에 100개의 데이터를 넣어뒀다. 그럼 게시판 목록을 조회하는 쿼리를 실행하게 되면 어떻게 될까?

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
mysql> SELECT ...
    -> FROM board
    -> WHERE DEL_CHK = 'N'
    -> ORDER BY IDX DESC;
+-----+--------------+---------+------------+-------------+
| IDX | TITLE        | HIT_CNT | CREA_DATE  | CREA_ID     |
+-----+--------------+---------+------------+-------------+
| 100 | 타이틀100    |       0 | 2018.11.26 | 테스트100    |
|  99 | 타이틀99A    |       0 | 2018.11.26 | 테스트99     |
|  98 | 타이틀98     |       0 | 2018.11.26 | 테스트98     |
|                      . . . .                            |
|   4 | 타이틀4      |       0 | 2018.11.26 | 테스트4      |
|   3 | 타이틀3      |       0 | 2018.11.26 | 테스트3      |
|   2 | 타이틀2      |       0 | 2018.11.26 | 테스트2      |
|   1 | 타이틀1      |       0 | 2018.11.26 | 테스트1      |
+-----+--------------+---------+------------+-------------+
100 rows in set (0.01 sec)
Colored by Color Scripter
cs

100개의 게시글이 한번에 나올 것이다. 한 페이지(화면)에 100개 혹은 1000개의 게시글을 한번에 보여주기엔 벅차다. 그렇기에 게시글 목록에는 페이징 처리가 반드시 필요하다. DB에 따라 페이징 처리를 할 수 있는 쿼리가 존재한다고 한다. 그렇기에 각자 사용하는 DB를 확인해서 쿼리를 사용하면 된다. 나는 MySQL을 사용하기 때문에 LIMIT을 이용해서 페이징 처리를 할 것이다.

1
2
3
4
SELECT *
FROM 테이블명
ORDER BY 게시글 번호 DESC
LIMIT 시작 행, 출력할 갯수
cs

LIMIT을 위와 같이 사용하게 되면 특정 페이지의 게시글을 보여줄 수 있다. 게시글 번호로 내림차순 정렬한 데이터를 출력할 행부터 출력할 갯수까지 조회해주는 쿼리이다. 데이터의 행은 0부터 시작한다. 따라서 LIMIT 0, 10 이라고 설정하면 0행부터 10개까지의 게시글이 조회될 것이다. 그러면 페이징 처리를 하기 위해선 어떻게 조회를 해야 할까?

1페이지 -> 00행 ~ 09행 (10개) : LIMIT 0, 10

2페이지 -> 10행 ~ 19행 (10개) : LIMIT 10, 10

3페이지 -> 20행 ~ 29행 (10개) : LIMIT 20, 10

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
mysql> select * from board
    -> where DEL_CHK='N'
    -> ORDER BY IDX desc
    -> LIMIT 0, 10;
+-----+--------------+-------------+---------+---------+-------------+---------------------+
| IDX | TITLE        | CONTENTS    | HIT_CNT | DEL_CHK | CREA_ID     | CREA_DATE           |
+-----+--------------+-------------+---------+---------+-------------+---------------------+
| 100 | 타이틀100    | 내용100     |       0 | N       | 테스트100    | 2018-11-26 14:37:00 |
|  99 | 타이틀99     | 내용99      |       0 | N       | 테스트99     | 2018-11-26 14:37:00 |
|  98 | 타이틀98     | 내용98      |       0 | N       | 테스트98     | 2018-11-26 14:37:00 |
|  97 | 타이틀97     | 내용97      |       0 | N       | 테스트97     | 2018-11-26 14:37:00 |
|  96 | 타이틀96     | 내용96      |       0 | N       | 테스트96     | 2018-11-26 14:37:00 |
|  95 | 타이틀95     | 내용95      |       0 | N       | 테스트95     | 2018-11-26 14:37:00 |
|  94 | 타이틀94     | 내용94      |       0 | N       | 테스트94     | 2018-11-26 14:37:00 |
|  93 | 타이틀93     | 내용93      |       0 | N       | 테스트93     | 2018-11-26 14:37:00 |
|  92 | 타이틀92     | 내용92      |       0 | N       | 테스트92     | 2018-11-26 14:37:00 |
|  91 | 타이틀91     | 내용91      |       0 | N       | 테스트91     | 2018-11-26 14:37:00 |
+-----+--------------+-------------+---------+---------+--------------+--------------------+
10 rows in set (0.00 sec)
 
mysql> select * from board
    -> where DEL_CHK='N'
    -> ORDER BY IDX desc
    -> LIMIT 10, 10;
+-----+-------------+-------------+---------+---------+------------+---------------------+
| IDX | TITLE       | CONTENTS    | HIT_CNT | DEL_CHK | CREA_ID    | CREA_DATE           |
+-----+-------------+-------------+---------+---------+------------+---------------------+
|  90 | 타이틀90    | 내용90      |       0 | N       | 테스트90    | 2018-11-26 14:37:00 |
|  89 | 타이틀89    | 내용89      |       0 | N       | 테스트89    | 2018-11-26 14:37:00 |
|  88 | 타이틀88    | 내용88      |       0 | N       | 테스트88    | 2018-11-26 14:37:00 |
|  87 | 타이틀87    | 내용87      |       0 | N       | 테스트87    | 2018-11-26 14:37:00 |
|  86 | 타이틀86    | 내용86      |       0 | N       | 테스트86    | 2018-11-26 14:37:00 |
|  85 | 타이틀85    | 내용85      |       0 | N       | 테스트85    | 2018-11-26 14:37:00 |
|  84 | 타이틀84    | 내용84      |       0 | N       | 테스트84    | 2018-11-26 14:37:00 |
|  83 | 타이틀83    | 내용83      |       0 | N       | 테스트83    | 2018-11-26 14:37:00 |
|  82 | 타이틀82    | 내용82      |       0 | N       | 테스트82    | 2018-11-26 14:37:00 |
|  81 | 타이틀81    | 내용81      |       0 | N       | 테스트81    | 2018-11-26 14:37:00 |
+-----+-------------+-------------+---------+---------+-------------+--------------------+
10 rows in set (0.00 sec)
 
mysql> select * from board
    -> where DEL_CHK='N'
    -> ORDER BY IDX desc
    -> LIMIT 20, 10;
+-----+-------------+----------+---------+---------+-------------+--------------------+
| IDX | TITLE       | CONTENTS | HIT_CNT | DEL_CHK | CREA_ID     | CREA_DATE          |
+-----+-------------+----------+---------+---------+-------------+--------------------+
|  80 | 타이틀80    | 내용80   |       0 | N       | 테스트80    | 2018-11-26 14:37:00 |
|  79 | 타이틀79    | 내용79   |       0 | N       | 테스트79    | 2018-11-26 14:37:00 |
|  78 | 타이틀78    | 내용78   |       0 | N       | 테스트78    | 2018-11-26 14:37:00 | 
|  77 | 타이틀77    | 내용77   |       0 | N       | 테스트77    | 2018-11-26 14:37:00 |
|  76 | 타이틀76    | 내용76   |       0 | N       | 테스트76    | 2018-11-26 14:37:00 |
|  75 | 타이틀75    | 내용75   |       0 | N       | 테스트75    | 2018-11-26 14:37:00 | 
|  74 | 타이틀74    | 내용74   |       0 | N       | 테스트74    | 2018-11-26 14:37:00 |
|  73 | 타이틀73    | 내용73   |       0 | N       | 테스트73    | 2018-11-26 14:37:00 |
|  72 | 타이틀72    | 내용72   |       0 | N       | 테스트72    | 2018-11-26 14:37:00 |
|  71 | 타이틀71    | 내용71   |       0 | N       | 테스트71    | 2018-11-26 14:37:00 |
+-----+-------------+----------+---------+---------+-------------+--------------------+
10 rows in set (0.00 sec)
Colored by Color Scripter
cs

이런식으로 페이징 처리가 이루어져야 한다. 그래서 특정 페이지의 첫번째 게시글의 행번호와 출력할 갯수만 전달 받는다면 특정 페이지의 게시글들을 조호할 수 있을 것이다. 나는 전달받을 파라미터들을 각각 pageStart와 perPageNum으로 정했다. 그러면 아래와 같은 쿼리로 페이징 처리를 하면 된다.

1
2
3
4
5
SELECT ...
FROM board
WHERE DEL_CHK='N'
ORDER BY IDX DESC
LIMIT #{pageStart}, #{perPageNum}
cs

pageStart : 특정 페이지의 첫번째 게시글의 행이다.
perPageNum : 한 페이지당 보여줄 게시글의 개수이다.

특정 페이지를 조회하기 위해 두 개의 파라미터를 담는 클래스를 만들 것이다. 이렇게 클래스를 만드는 이유는 뭘까? 게시판에도 여러 종류의 게시판이 존재한다. 그러면 게시판 마다 페이징 조회 로직을 생성해야 한다. 하지만 페이징 관련된 기능들을 별도의 클래스로 분리해놓는다면 조금 더 효율적인 작업을 할 수 있다.

4. 특정 페이지 조회를 위한 Criteria 클래스

게시글 조회 쿼리에 전달될 파라미터를 담게 될 클래스이다. VO라고 생각하면 쉬울 것이다.

Criteria

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
public class Criteria {
    
    private int page;
    private int perPageNum;
    
    public int getPageStart() {
        return (this.page-1)*perPageNum;
    }
    
    public Criteria() {
        this.page = 1;
        this.perPageNum = 10;
    }
    
    public int getPage() {
        return page;
    }
    public void setPage(int page) {
        if(page <= 0) {
            this.page = 1;
        } else {
            this.page = page;
        }
    }
    public int getPerPageNum() {
        return perPageNum;
    }
    public void setPerPageNum(int pageCount) {
        int cnt = this.perPageNum;
        if(pageCount != cnt) {
            this.perPageNum = cnt;
        } else {
            this.perPageNum = pageCount;
        }
    }
    
}
Colored by Color Scripter
cs

int page : 현재 페이지 번호
int perPageNum : 한 페이지당 보여줄 게시글의 갯수
int getPageStart() : 특정 페이지의 게시글 시작 번호, 게시글 시작 행 번호

1
2
//현재 페이지의 게시글 시작 번호 = (현재 페이지 번호 - 1) * 페이지당 보여줄 게시글 갯수
getPerPageNum = (this.page - 1) * perPageNum
cs

현재 페이지 번호	페이지당 보여줄 게시글 수	계산식	게시글 시작 행 번호
5	10	(5-1)*10	40
3	5	(3-1)*5	10
15	10	(15-1)*10	140

Criteria() : 기본 생성자

1
2
this.page = 1;
this.perPageNum = 10;
cs

최초로 게시판 목록에 들어 왔을 때를 위해서 기본 셋팅을 해야 한다. 왜냐하면 페이징을 처리하기 위해선 현재 페이지 번호와 페이지당 게시글 수가 필요한데 처음 게시판에 들어오게 되면 두 개의 정보를 가져올 방법이 없기 때문에 기본 생성자를 통해 기본 값을 셋팅하도록 하자. 현재 페이지를 1페이지로, 페이지당 보여줄 게시글의 수를 10개로 기본 셋팅해두었다.

setter : 잘 못된 값들이 셋팅되지 않게 적절하게 set 메서드 셋팅

- setPage() : 페이지가 음수값이 되지 않게 설정. 음수가 되면 1페이지를 나타낸다.

- setPerPageNum() : 페이지당 보여줄 게시글 수가 변하지 않게 설정했다.

getter : get 메서드를 셋팅

5. 게시판 페이징을 처리하는 PageMaker 클래스

페이징에 관련된 버튼들을 만드는 기능을 하는 클래스이다. 페이지에 페이징 버튼들을 만들기 위한 계산 클래스라고 생각하면 된다. 그래서 계산이 필요한 부분이 많다.(ㅠㅠ) 하지만 그냥 공식이라 생각하고 이렇게 쓰는구나, 정도의 이해만 하고 넘어가도 된다.

PageMaker

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
public class PageMaker {
    
    private Criteria cri;
    private int totalCount;
    private int startPage;
    private int endPage;
    private boolean prev;
    private boolean next;
    private int displayPageNum = 5;
    
    public Criteria getCri() {
        return cri;
    }
    public void setCri(Criteria cri) {
        this.cri = cri;
    }
    public int getTotalCount() {
        return totalCount;
    }
    public void setTotalCount(int totalCount) {
        this.totalCount = totalCount;
        calcData();
    }
    
    private void calcData() {
        
        endPage = (int) (Math.ceil(cri.getPage() / (double) displayPageNum) * displayPageNum);
 
        startPage = (endPage - displayPageNum) + 1;
        if(startPage <= 0) startPage = 1;
        
        int tempEndPage = (int) (Math.ceil(totalCount / (double) cri.getPerPageNum()));
        if (endPage > tempEndPage) {
            endPage = tempEndPage;
        }
 
        prev = startPage == 1 ? false : true;
        next = endPage * cri.getPerPageNum() < totalCount ? true : false;
        
    }
    
    public int getStartPage() {
        return startPage;
    }
    public void setStartPage(int startPage) {
        this.startPage = startPage;
    }
    public int getEndPage() {
        return endPage;
    }
    public void setEndPage(int endPage) {
        this.endPage = endPage;
    }
    public boolean isPrev() {
        return prev;
    }
    public void setPrev(boolean prev) {
        this.prev = prev;
    }
    public boolean isNext() {
        return next;
    }
    public void setNext(boolean next) {
        this.next = next;
    }
    public int getDisplayPageNum() {
        return displayPageNum;
    }
    public void setDisplayPageNum(int displayPageNum) {
        this.displayPageNum = displayPageNum;
    }
 
}
Colored by Color Scripter
cs

- 22행: 총 게시글 수를 셋팅할때 calcData() 메서드를 호출하여 페이징 관련 버튼 계산을 한다.

- 25행: 페이징의 버튼들을 생성하는 계산식을 만들었다. 끝 페이지 번호, 시작 페이지 번호, 이전, 다음 버튼들을 구한다.

Criteria cri.getPage() : 현재 페이지 번호

Criteria cri.getPerPageNum() : 한 페이지당 보여줄 게시글의 갯수

int totalCount : 총 게시글 수

1
2
SELECT count(*)
FROM board
cs

조회 쿼리에서 count(*)를 이용해서 구해야 한다. 총 게시글 수 쿼리는 조금 있다가 설정할 것이다.

int endPage : 화면에 보여질 마지막 페이지 번호, 끝 페이지 번호

1
2
//끝 페이지 번호 = (현재 페이지 번호 / 화면에 보여질 페이지 번호의 갯수) * 화면에 보여질 페이지 번호의 갯수
endPage = (int) (Math.ceil(cri.getPage() / (double) displayPageNum) * displayPageNum);
cs

현재 페이지 번호	페이지 번호의 갯수	계산식	끝 페이지 번호
1	10	Math.ceil(1/10) * 10	10
3	10	Math.ceil(3/10) * 10	10
13	10	Math.ceil(13/10) * 10	20
23	20	Math.ceil(23/20) * 20	40

끝 페이지 번호는 총 게시글 수와 연관이 있다. 근데 100개의 게시글을 20개씩 보여준다고 하면 끝 페이지의 번호가 5여야 하는데 위의 계산식으로 계산을 하게 되면 끝 페이지 번호가 20이 나오게 된다. ( Math.ceil(1/20)*20 = 20 ) 그래서 총 게시글 수와 페이지당 보여줄 게시글의 갯수로 마지막 페이지 번호를 구해 서로 비교해서 화면에 보여질 끝 페이지 번호를 구해야 한다.

1
2
3
4
5
//마지막 페이지 번호 = 총 게시글 수 / 한 페이지당 보여줄 게시글의 갯수
int tempEndPage = (int) (Math.ceil(totalCount / (double) cri.getPerPageNum()));
if (endPage > tempEndPage) {
    endPage = tempEndPage;
}
Colored by Color Scripter
cs

마지막 페이지의 번호를 구한 뒤, 끝 페이지 번호보다 작은 경우에 마지막 페이지의 번호를 끝 페이지 번호로 저장해준다. 화면에 보여질 끝 페이지 번호는 마지막 페이지의 번호보다 클 수는 없다. 그렇기 때문에 위와 같은 조건을 넣어줘야 한다. 이 부분은 시작 페이지 번호까지 구한 뒤에 처리해줘야 한다.

int startPage : 화면에 보여질 첫번째 페이지 번호, 시작 페이지 번호

1
2
3
//시작 페이지 번호 = (끝 페이지 번호 - 화면에 보여질 페이지 번호의 갯수) + 1
startPage = (endPage - displayPageNum) + 1
if(startPage <= 0) startPage = 1
cs

끝 페이지 번호	페이지 번호의 갯수	계산식	시작 페이지 번호
10	10	(10-10) + 1	1
30	10	(30-20) + 1	11
40	20	(40-20) + 1	21
20	5	(20-5) + 1	16

시작 페이지 번호를 구할 때, 마지막 페이지 번호가 화면에 보여질 페이징 버튼의 갯수보다 작으면 문제가 생긴다. 시작 페이지 번호가 음수가 되어버리는 상황이 발생한다. 예를들면 끝 페이지의 번호가 3이고, 보여줄 페이지 갯수가 5라면, 시작 페이지 번호는 -1이 된다. 따라서, 구한 시작페이지 번호가 0보다 작으면(음수) 시작 페이지를 1로 해주는 로직을 추가해야 한다.

boolean prev : 이전 버튼 생성 여부

1
2
//이전 버튼 생성 여부 = 시작 페이지 번호 == 1 ? false : true
prev = startPage == 1 ? false : true
cs

이전 버튼은 시작 페이지 번호가 1이 아니면 생기면 된다.

boolean next : 다음 버튼 생성 여부

1
2
//다음 버튼 생성 여부 = 끝 페이지 번호 * 한 페이지당 보여줄 게시글의 갯수 < 총 게시글의 수 ? true: false
next = endPage * cri.getPerPageNum() < totalCount ? true: false
cs

끝 페이지 번호	페이지당 게시글 수	총 게시글 수	계산식	다음 버튼 생성 여부
7	10	65	7 * 10 < 65	false
10	10	100	10 * 10 < 100	false
10	10	127	10 * 10 < 107	true
20	10	260	20 * 10 < 260	true

int displayPageNum : 화면 하단에 보여지는 페이지 버튼의 수

보여지는 버튼의 수를 정하면 된다. 나는 5개만 보이게 할 것이다.

PageMaker 객체를 사용하려면 setCri() 와 setTotalCount()를 먼저 호출해서 값을 셋팅해야 한다. 페이징 버튼들의 값을 구하려면 제일 먼저 총 게시글 수가 있어야 위의 계산식대로 차례로 구할 수 있다. 그렇기에 총 게시글을 셋팅할 때 계산식 메소드를 호출하게 한 것이다. 또한 Criteria 객체에서 필요한 page 와 perPageNum을 사용하기 위해서 setCri()를 먼저 셋팅해야 한다. 컨트롤러에서 객체로 값을 셋팅할 때 유의하자.

6. 목록 조회 수정

** 이전에 만들어 둔 CURD 게시판을 수정해서 사용한다.

6-1. Controller

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@RequestMapping(value="/board/boardList")
public ModelAndView openBoardList(Criteria cri) throws Exception {
        
    ModelAndView mav = new ModelAndView("/board/boardList");
        
    PageMaker pageMaker = new PageMaker();
    pageMaker.setCri(cri);
    pageMaker.setTotalCount(100);
        
    List<Map<String,Object>> list = boardServcie.selectBoardList(cri);
    mav.addObject("list", list);
    mav.addObject("pageMaker", pageMaker);
        
    return mav;
        
}
Colored by Color Scripter
cs

- 02행: 현재 페이지 번호와 페이지당 보여줄 게시글 수가 담긴 Criteria 객체를 사용한다.

- 06행: PageMaker() 객체를 생성한다.

- 07행: page와 perPageNum을 셋팅해준다.

- 08행: 총 게시글의 수를 셋팅해준다. 아직 총 게시글 수를 조회하는 로직은 구현하지 않았기 때문에 현재 DB에 있는 총 게시글의 수인 100을 넣어줬다.

- 10행: 원래의 목록 조회 로직에서 Criteria 파라미터를 사용하기 위해 수정했다.

- 12행: 셋팅된 pageMaker에는 페이징을 위한 버튼의 값들이 들어있고 ModelAndView를 이용해 jsp에 넘겨준다.

6-2. Service 영역 및 DAO

1
2
3
4
5
6
7
8
9
10
11
12
13
14
//BoardService
List<Map<String, Object>> selectBoardList(Criteria cri);
 
//BoardServiceImpl
@Override
public List<Map<String, Object>> selectBoardList(Criteria cri) {
    return boardDAO.selectBoardList(cri);
}
 
//BoardDAO
@SuppressWarnings("unchecked")
public List<Map<String, Object>> selectBoardList(Criteria cri) {
    return (List<Map<String,Object>>)selectList("board.selectBoardList", cri);
}
Colored by Color Scripter
cs

게시글 목록 조회하는 Service, DAO 영역에 Criteria 객체에 담긴 파라마터를 보내기 위해 수정했다. 각자의 목록 조회에 맞게 수정하면 된다. Criteria 객체에 담아서 SQL 매핑에 보낼 파라미터는 특정 페이지 게시글의 행(pageStart)과 페이지당 보여줄 게시글의 갯수(perPageNum)이다.

6-3. SQL

1
2
3
4
5
6
7
8
9
10
11
12
<select id="selectBoardList" resultType="hashmap" parameterType="hashmap">
    <![CDATA[
        SELECT
            *
        FROM
            board
        WHERE
            DEL_CHK = 'N'
        ORDER BY IDX DESC
        LIMIT #{pageStart}, #{perPageNum}
    ]]>
</select>
Colored by Color Scripter
cs

- 10행: 페이징 조회를 위해 LIMIT를 이용해서 원래의 목록 조회 쿼리를 수정했다.

6-4. JSP

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<ul class="btn-group pagination">
    <c:if test="${pageMaker.prev }">
    <li>
        <a href='<c:url value="/board/boardList?page=${pageMaker.startPage-1 }"/>'><i class="fa fa-chevron-left"></i></a>
    </li>
    </c:if>
    <c:forEach begin="${pageMaker.startPage }" end="${pageMaker.endPage }" var="pageNum">
    <li>
        <a href='<c:url value="/board/boardList?page=${pageNum }"/>'><i class="fa">${pageNum }</i></a>
    </li>
    </c:forEach>
    <c:if test="${pageMaker.next && pageMaker.endPage >0 }">
    <li>
        <a href='<c:url value="/board/boardList?page=${pageMaker.endPage+1 }"/>'><i class="fa fa-chevron-right"></i></a>
    </li>
    </c:if>
</ul>
Colored by Color Scripter
cs

- 02행: 이전 버튼의 생성 여부를 확인하여 버튼을 보여줄 것이다.

- 06행: 현재 페이지가 어디인 지 알기 위해 추가했다.

- 07행: 페이지의 시작 번호와 끝 번호를 이용해 페이지 버튼들을 뿌려줄 것이다.

- 12행: 다음 버튼의 생성 여부를 확인하여 버튼을 보여줄 것이다.

7. 총 게시글 갯수 구하기 (totalCount)

그럼 마지막으로 총 게시글 갯수를 구하는 로직을 만들자.

7-1. SQL

1
2
3
4
5
6
7
8
9
10
<select id="countBoardList" resultType="Integer">
    <![CDATA[
        SELECT
            count(*)
        FROM
            board
        WHERE
            DEL_CHK='N'
    ]]>
</select>
Colored by Color Scripter
cs

- 01행: 결과는 int로 리턴되어야 한다.

- 04행: 조회한 결과의 갯수를 뿌려주는 쿼리이다.

- 08행: 총 게시글 중에 삭제된 건 빼야 한다.

7-2. DAO

1
2
3
public int countBoardList(){
    return (Integer) selectOne("board.countBoardList");
}
Colored by Color Scripter
cs

7-3. Service 영역

1
2
3
4
5
6
7
8
//Service
int countBoardListTotal();
 
//ServiceImpl
@Override
public int countBoardListTotal() {
    return boardDAO.countBoardList();
}
Colored by Color Scripter
cs

7-4. Controller

1
 pageMaker.setTotalCount(boardServcie.countBoardListTotal());
cs

100으로 셋팅한 부분에 총 게시글 수를 구하는 로직을 넣었다.

8. 확인

밑에 페이징 버튼들이 나오고 10개의 게시글만 나왔다! 그럼 다른 페이지의 버튼를 눌러보자.

페이지에 따라 목록이 바뀐다. 이전, 다음 버튼도 알맞게 구동된다!

페이징 처리에 성공했지만 아직 개선해야 될 부분이 남아있다. 페이징 원칙에서도 언급했는데, 특정 페이지의 한 게시글을 조회, 수정, 삭제를 하고 난 후에 다시 목록으로 돌아가게 될 경우 그 특정 페이지로 돌아가야 한다. 그 부분만 해결된다면 페이징 처리는 완성된것이다.