hmkim 03-25
250325 김혜민 파일 관련 주석 리팩토링
@9547c15e129fc3286e32d16a56aa1b825c296828
src/main/java/com/takensoft/cms/token/service/impl/RefreshTokenServiceImpl.java
--- src/main/java/com/takensoft/cms/token/service/impl/RefreshTokenServiceImpl.java
+++ src/main/java/com/takensoft/cms/token/service/impl/RefreshTokenServiceImpl.java
@@ -170,7 +170,6 @@
     @Override
     @Transactional(rollbackFor = Exception.class)
     public int tokenReissueProc(HttpServletRequest req, HttpServletResponse res){
-        try {
             // refresh token 검증
             int result = (int) refreshTokenCheck(req).get("result");
             if(result == 0) return result;
@@ -225,11 +224,6 @@
             res.setHeader("Authorization", newAccessToken);
 
             return result;
-        } catch (DataAccessException dae) {
-            throw dae;
-        } catch (Exception e) {
-            throw e;
-        }
     }
     /**
      * @param req - HTTP 요청 객체
@@ -242,19 +236,12 @@
      */
     @Override
     public int delete(HttpServletRequest req, RefreshTknVO refreshTknVO) {
-        try {
             refreshTknVO.setUseIp(httpRequestUtil.getIp(req));
             //중복로그인 비허용시 삭제
             if (!redisConfig.isAllowMultipleLogin()) {
                 redisTemplate.delete("jwt:" + refreshTknVO.getMbrId()); // 기존 JWT 삭제
             }
             return refreshTokenDAO.deleteByRefresh(refreshTknVO);
-
-        } catch (DataAccessException dae) {
-            throw dae;
-        } catch (Exception e) {
-            throw e;
-        }
     }
     /**
      * @param req - HTTP 요청 객체
src/main/java/com/takensoft/common/file/dao/FileDAO.java
--- src/main/java/com/takensoft/common/file/dao/FileDAO.java
+++ src/main/java/com/takensoft/common/file/dao/FileDAO.java
@@ -4,42 +4,44 @@
 import org.egovframe.rte.psl.dataaccess.mapper.Mapper;
 
 import java.util.*;
-
 /**
  * @author  : 박정하
  * @since   : 2024.03.26
+ * @modification
+ *     since    |    author    | description
+ *  2024.03.26  |    박정하     | 최초 등록
  *
  * 파일 관련 Mapper
  */
 @Mapper("fileDAO")
 public interface FileDAO {
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileVO - 파일 관련 객체
+     * @return int - 등록 성공 여부
      *
      * 파일 등록
      */
     public int fileInsert(FileVO fileVO);
 
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileMngId - 파일 관리 아이디
+     * @return List<HashMap<String, Object>> - 파일 목록
      *
      * 파일 목록 조회
      */
     List<HashMap<String, Object>> fileSelectList(String fileMngId);
 
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param params - 파일 관리 아이디
+     * @return int - 등록 삭제 여부
      *
      * 파일 삭제
      */
     public int fileDelete(HashMap<String, Object> params);
 
     /**
-     * @author 방선주
-     * @since 2024.05.21
+     * @param fileId - 파일 아이디
+     * @return FileVO - 파일 데이터
      *
      * 파일 단일 조회
      */
src/main/java/com/takensoft/common/file/dao/FileMngDAO.java
--- src/main/java/com/takensoft/common/file/dao/FileMngDAO.java
+++ src/main/java/com/takensoft/common/file/dao/FileMngDAO.java
@@ -5,34 +5,36 @@
 import org.springframework.web.multipart.MultipartFile;
 
 import java.util.*;
-
 /**
  * @author  : 박정하
  * @since   : 2024.03.26
+ * @modification
+ *     since    |    author    | description
+ *  2024.03.26  |    박정하     | 최초 등록
  *
  * 파일매니저 관련 Mapper
  */
 @Mapper("fileMngDAO")
 public interface FileMngDAO {
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileMngVO - 파일 관리 관련 객체
+     * @return int - 파일 매니저 등록 성공 여부
      *
      * 파일매니저 등록
      */
     public int fileMngInsert(FileMngVO fileMngVO);
 
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param fileMngVO - 파일 관리 관련 객체
+     * @return int - 파일 매니저 수정 여부
      *
      * 파일매니저 수정
      */
     public int fileMngUpadate(FileMngVO fileMngVO);
 
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param params - 파일 매니저 아이디
+     * @return int - 파일 매니저 삭제 여부
      *
      * 파일매니저 삭제
      */
src/main/java/com/takensoft/common/file/service/FileMngService.java
--- src/main/java/com/takensoft/common/file/service/FileMngService.java
+++ src/main/java/com/takensoft/common/file/service/FileMngService.java
@@ -1,36 +1,49 @@
 package com.takensoft.common.file.service;
 
+import com.takensoft.common.exception.CustomDeleteFailException;
+import com.takensoft.common.exception.CustomInsertFailException;
+import com.takensoft.common.exception.CustomNotFoundException;
+import com.takensoft.common.exception.CustomUpdateFailException;
 import com.takensoft.common.file.vo.FileMngVO;
+import org.springframework.dao.DataAccessException;
 import org.springframework.web.multipart.MultipartFile;
 
 import java.util.*;
-
 /**
- * @author  : 박정하
- * @since   : 2024.03.26
+ * @author 박정하
+ * @since 2024.03.26
+ * @modification
+ *     since    |    author    | description
+ *  2024.03.26  |    박정하     | 최초 등록
  *
  * 파일매니저 관련 인터페이스
  */
 public interface FileMngService {
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileMngVO - 파일매니저 정보
+     * @param multipartFileList - 파일 목록
+     * @return HashMap<String, Object>
+     *  - fileInsertResult : 파일 등록 결과
+     *  - fileMngId : 파일매니저 아이디
+     *  - fileMngResult : 파일매니저 등록 결과
      *
      * 파일매니저 등록
      */
     public HashMap<String, Object> fileMngInsert(FileMngVO fileMngVO, List<MultipartFile> multipartFileList) ;
 
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param fileMngVO - 파일매니저 정보
+     * @param deleteFileList - 삭제 파일 목록
+     * @param multipartFileList - 파일 목록
+     * @return int - 파일매니저 수정 결과
      *
      * 파일매니저 수정
      */
     public int fileMngUpadate(FileMngVO fileMngVO, List<HashMap<String, Object>> deleteFileList, List<MultipartFile> multipartFileList);
-    
+
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param params - 파일매니저 아이디
+     * @return int - 파일매니저 삭제 결과
      *
      * 파일매니저 삭제
      */
src/main/java/com/takensoft/common/file/service/FileService.java
--- src/main/java/com/takensoft/common/file/service/FileService.java
+++ src/main/java/com/takensoft/common/file/service/FileService.java
@@ -1,48 +1,63 @@
 package com.takensoft.common.file.service;
 
+import com.takensoft.common.exception.CustomDeleteFailException;
+import com.takensoft.common.exception.CustomFileUploadFailException;
+import com.takensoft.common.exception.CustomInsertFailException;
+import com.takensoft.common.exception.CustomNotFoundException;
 import com.takensoft.common.file.vo.FileVO;
+import org.springframework.dao.DataAccessException;
 import org.springframework.web.multipart.MultipartFile;
 import org.springframework.web.multipart.MultipartHttpServletRequest;
 
 import java.util.*;
-
 /**
- * @author  : 박정하
- * @since   : 2024.03.26
+ * @author 박정하
+ * @since 2024.03.26
+ * @modification
+ *     since    |    author    | description
+ *  2024.03.26  |    박정하     | 최초 등록
  *
  * 파일 관련 인터페이스
  */
 public interface FileService {
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileMngId - 파일관리아이디
+     * @param multipartFileList - 파일 목록
+     * @return int - 파일 등록 결과
      *
      * 파일 등록
      */
     public int fileInsert(String fileMngId, List<MultipartFile> multipartFileList) ;
 
     /**
-     * @author 박정하
-     * @since 2024.03.26
+     * @param fileMngId - 파일관리아이디
+     * @return List<HashMap<String, Object>> - 파일 내용 정보를 담고 있는 객체 목록
      *
      * 파일 목록 조회
      */
     List<HashMap<String, Object>> fileSelectList(String fileMngId);
 
     /**
-     * @author 박정하
-     * @since 2024.03.27
+     * @param fileList - 파일 목록
+     * @return int - 파일 삭제 결과
      *
      * 파일 삭제
      */
     public int fileDelete(List<HashMap<String, Object>> fileList);
+
     /**
-     * @author 방선주
-     * @since 2024.05.21
+     * @param fileId - 파일 아이디
+     * @return FileVO - 파일 내용 정보를 담고 있는 객체
      *
      * 파일 단일 조회
      */
     public FileVO fileSelectOne(int fileId);
 
+    /**
+     * @param file - 파일 정보
+     * @return String - 이미지 경로
+     *
+     * 에디터 이미지 업로드
+     */
     public String editorUploadImg(MultipartFile file);
 }
(파일 끝에 줄바꿈 문자 없음)
src/main/java/com/takensoft/common/file/vo/FileMngVO.java
--- src/main/java/com/takensoft/common/file/vo/FileMngVO.java
+++ src/main/java/com/takensoft/common/file/vo/FileMngVO.java
@@ -1,12 +1,20 @@
 package com.takensoft.common.file.vo;
 
 import lombok.Data;
-
+/**
+ * @author  : takensoft
+ * @since   : 2024.04.01
+ * @modification
+ *     since    |    author    | description
+ *  2024.04.01  |  takensoft   | 최초 등록
+ *
+ * 파일 관리 관련 VO
+ */
 @Data
 public class FileMngVO {
-    private String fileMngId; // 파일관리아이디
-    private String rgtr; // 등록자
-    private String regDt; // 등록일
-    private String mdfr; // 수정자
-    private String mdfcnDt; // 수정일
+    private String fileMngId;   // 파일관리아이디
+    private String rgtr;        // 등록자
+    private String regDt;       // 등록일
+    private String mdfr;        // 수정자
+    private String mdfcnDt;     // 수정일
 }
(파일 끝에 줄바꿈 문자 없음)
src/main/java/com/takensoft/common/file/vo/FileVO.java
--- src/main/java/com/takensoft/common/file/vo/FileVO.java
+++ src/main/java/com/takensoft/common/file/vo/FileVO.java
@@ -1,18 +1,26 @@
 package com.takensoft.common.file.vo;
 
 import lombok.Data;
-
+/**
+ * @author  : takensoft
+ * @since   : 2024.04.01
+ * @modification
+ *     since    |    author    | description
+ *  2024.04.01  |  takensoft   | 최초 등록
+ *
+ * 파일 관련 VO
+ */
 @Data
 public class FileVO {
-    private int fileId; // 파일아이디
-    private String fileMngId; // 파일관리아이디
-    private String fileNm; // 파일명
-    private String maskNm; // 마스크명
-    private String fileType; // 파일타입
-    private String absltPath; // 절대경로
-    private String partPath; // 일부경로
-    private String extnNm; // 확장자
-    private String fileSz; // 크기
-    private String rgtr; // 등록자
-    private String regDt; // 등록일
+    private int fileId;         // 파일아이디
+    private String fileMngId;   // 파일관리아이디
+    private String fileNm;      // 파일명
+    private String maskNm;      // 마스크명
+    private String fileType;    // 파일타입
+    private String absltPath;   // 절대경로
+    private String partPath;    // 일부경로
+    private String extnNm;      // 확장자
+    private String fileSz;      // 크기
+    private String rgtr;        // 등록자
+    private String regDt;       // 등록일
 }
(파일 끝에 줄바꿈 문자 없음)
src/main/java/com/takensoft/common/file/web/FileController.java
--- src/main/java/com/takensoft/common/file/web/FileController.java
+++ src/main/java/com/takensoft/common/file/web/FileController.java
@@ -22,27 +22,26 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.UUID;
-
 /**
- * @author  : 방선주
- * @since   : 2024.05.23
+ * @author 방선주
+ * @since 2024.05.23
+ * @modification
+ *     since    |    author    | description
+ *  2024.05.23  |    방선주     | 최초 등록
  *
- * File 관련 컨트롤러
+ * File 관련 Controller
  */
-
 @RestController
 @RequiredArgsConstructor
 @Slf4j
 @RequestMapping(value="/sys/file")
 public class FileController {
+
     private final FileService fileService;
 
     /**
-     * @author 방선주
-     * @since  2024.05.21
-     * @param  fileId
-     * @return
-     * @throws Exception
+     * @param fileId - 첨부파일 아이디
+     * @param response - HTTP 응답 객체
      *
      * 게시판 첨부 파일 다운로드
      */
@@ -71,6 +70,14 @@
         }
     }
 
+    /**
+     * @param file - 첨부파일
+     * @return Map<String, Object>
+     *    - upload : 파일 업로드 여부
+     *    - url : 파일 경로
+     *
+     * 게시판 첨부 파일 다운로드
+     */
     @PostMapping("/postImageUpload.file")
     public Map<String, Object> handleFileUpload(@RequestPart("upload") MultipartFile file){
         Map<String, Object> response = new HashMap<>();
src/main/java/com/takensoft/common/idgen/service/IdgenService.java
--- src/main/java/com/takensoft/common/idgen/service/IdgenService.java
+++ src/main/java/com/takensoft/common/idgen/service/IdgenService.java
@@ -30,7 +30,7 @@
     @Autowired
     private IdgenMapper idgenMapper;
     /**
-     * @return 생성된 고유 아이디 값
+     * @return String - 생성된 고유 아이디 값
      *
      * 지정된 테이블에 대한 다음 고유 ID를 생성하여 반환
      * 새로 생성되는 경우 아이디 값은 1부터 시작하며, 기존 값은 1씩 증가하여 업데이트
Add a comment
List