SHA-256 암호화방식을 사용해 회원가입기능 구현, 암호 decrypt를통해 로그인 구현, session을 삭제함으로써 로그아웃 구현

Author: junshock5

.gitignore

@@ -31,6 +31,5 @@ build/
 .vscode/
 
 
-/src/main/resources/application.properties
 /.idea/
 /et HEAD CONTRIBUTING.md

git

@@ -13,39 +13,44 @@
 
 import javax.servlet.http.HttpServletRequest;
 
-@RequiredArgsConstructor
 //이 어노테이션은 초기화 되지않은 final 필드나,
 //@NonNull 이 붙은 필드에 대해 생성자를 생성해 줍니다.
 //주로 의존성 주입(Dependency Injection) 편의성을 위해서 사용되곤 합니다.
+@RequiredArgsConstructor
+// ControllerAdvice의 annotation은 @ControllerAdvice @RestControllerAdvice 두가지가 있습니다. 예외 발생 시 json형태로 결과를 반환하려면
+// @RestControllerAdvice를 클래스에 선언하면 됩니다. annotation에 추가로 패키지를 적용하면 위에서 설명한 것처럼 특정 패키지 하위의 Controller에만 로직이 적용되게도 할 수 있습니다.
+// ex) @RestControllerAdvice(basePackages = “com.rest.api”)
+// 아무것도 적용하지 않으면 프로젝트의 모든 Controller에 로직이 적용됩니다.
 @RestControllerAdvice
-//ControllerAdvice의 annotation은 @ControllerAdvice @RestControllerAdvice 두가지가 있습니다. 예외 발생 시 json형태로 결과를 반환하려면
-//@RestControllerAdvice를 클래스에 선언하면 됩니다. annotation에 추가로 패키지를 적용하면 위에서 설명한 것처럼 특정 패키지 하위의 Controller에만 로직이 적용되게도 할 수 있습니다.
-//ex) @RestControllerAdvice(basePackages = “com.rest.api”)
-//실습에서는 아무것도 적용하지 않아 프로젝트의 모든 Controller에 로직이 적용됩니다.
 public class ExceptionAdvice {
     private final ResponseService responseService;
     private final MessageSource messageSource;
-    @ExceptionHandler(Exception.class)
+
     //Exception이 발생하면 해당 Handler로 처리하겠다고 명시하는 annotation입니다. 괄호안에는 어떤 Exception이 발생할때 handler를 적용할 것인지
     //Exception Class를 인자로 넣습니다. 예제에서는 Exception.class를 지정하였는데 Exception.class는 최상위 예외처리 객체이므로 다른
     //ExceptionHandler에서 걸러지지 않은 예외가 있으면 최종으로 이 handler를 거쳐 처리됩니다. 그래서 메서드 명도 defaultException이라 명명하였습니다.
-    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    @ExceptionHandler(Exception.class)
+
     //해당 Exception이 발생하면 Response에 출력되는 HttpStatus Code가 500으로 내려가도록 설정합니다.
     //참고로 성공 시엔 HttpStatus code가 200으로 내려갑니다. 실습에서 HttpStatus Code의 역할은 성공이냐(200)
     //아니냐 정도의 의미만 있고 실제 사용하는 성공 실패 여부는 json으로 출력되는 정보를 이용합니다.
+    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
     protected CommonResult defaultException(HttpServletRequest request, Exception e) {
         return responseService.getFailResult(Integer.valueOf(getMessage("unKnown.code")), getMessage("unKnown.msg"));
     }
+
     @ExceptionHandler(CUserNotFoundException.class)
     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
     protected CommonResult userNotFoundException(HttpServletRequest request, CUserNotFoundException e) {
         // 예외 처리의 메시지를 MessageSource에서 가져오도록 수정
         return responseService.getFailResult(Integer.valueOf(getMessage("userNotFound.code")), getMessage("userNotFound.msg"));
     }
+
     // code정보에 해당하는 메시지를 조회합니다.
     private String getMessage(String code) {
         return getMessage(code, null);
     }
+
     // code정보, 추가 argument로 현재 locale에 맞는 메시지를 조회합니다.
     private String getMessage(String code, Object[] args) {
         return messageSource.getMessage(code, args, LocaleContextHolder.getLocale());

src/main/java/com/market/Server/advice/ExceptionAdvice.java

@@ -0,0 +1,9 @@
+package com.market.Server.advice.exception;
+
+public class DuplicateIdException extends RuntimeException {
+  
+  public DuplicateIdException(String msg) {
+    super(msg);
+  }
+  
+}

src/main/java/com/market/Server/advice/exception/DuplicateIdException.java

@@ -0,0 +1,146 @@
+package com.market.Server.controller;
+
+import com.market.Server.dto.UserDTO;
+import com.market.Server.service.ResponseService;
+import com.market.Server.service.UserServiceImpl;
+import com.market.Server.utils.SessionUtil;
+import com.sun.istack.internal.NotNull;
+import io.swagger.annotations.Api;
+import lombok.*;
+import lombok.extern.log4j.Log4j2;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import javax.servlet.http.HttpSession;
+
+
+@Api(tags = {"2. users"})
+@RestController
+@RequestMapping("/user")
+@Log4j2
+public class UserController {
+
+    private final UserServiceImpl userService ;
+
+    @Autowired
+    public UserController(UserServiceImpl userService, ResponseService responseService) {
+        this.userService=userService;
+    }
+
+    /**
+     * 로그인한 사용자가 마이페이지를 눌렀을 때 보여줄 사용자 정보를 반환한다.
+     *
+     * @param session 현재 사용자의 세션
+     * @return UserDTO
+     */
+    @GetMapping("myInfo")
+    public UserInfoResponse memberInfo(HttpSession session) {
+        String id = SessionUtil.getLoginMemberId(session);
+        UserDTO memberInfo = userService.getUserInfo(id);
+        return new UserInfoResponse(memberInfo);
+    }
+
+
+    /**
+     * 유저가 입력한 정보로 회원가입을 진행한다. 보낸 값들 중 NULL값이 있으면 "NULL_ARGUMENT" 를 리턴한다. 회원가입 요청을 보내기 전 먼저 ID 중복체크를
+     * 진행한다. ID 중복시 403 상태코드를 반환한다. 회원가입 성공시 201 상태코드를 반환한다.
+     *
+     * @param userDTO 회원가입을 요청한 정보
+     * @return
+     *
+     */
+    @PostMapping("sign up")
+    @ResponseStatus(HttpStatus.CREATED)
+    public void signUp(@RequestBody @NotNull UserDTO userDTO) {
+        if(UserDTO.hasNullDataBeforeSignup(userDTO)){
+            throw new NullPointerException("회원가입시 필수 데이터를 모두 입력해야 합니다.");
+        }
+        userService.register(userDTO);
+    }
+    /**
+     * 회원 로그인을 진행한다. Login 요청시 id, password가 NULL일 경우 NullPointerException을 throw한다.
+     */
+    @PostMapping("login")
+    public ResponseEntity<LoginResponse> login(@RequestBody @NotNull UserLoginRequest loginRequest,
+                                               HttpSession session) {
+        ResponseEntity<LoginResponse> responseEntity = null;
+        String id = loginRequest.getId();
+        String password = loginRequest.getPassword();
+        LoginResponse loginResponse;
+        UserDTO userInfo = userService.login(id, password);
+
+        if (userInfo == null) {
+            // ID, Password에 맞는 정보가 없을 때
+            loginResponse = LoginResponse.FAIL;
+            responseEntity = new ResponseEntity<UserController.LoginResponse>(loginResponse,
+                    HttpStatus.UNAUTHORIZED);
+        } else if (UserDTO.Status.DEFAULT.equals(userInfo.getStatus())) {
+            // 성공시 세션에 ID를 저장
+            loginResponse = LoginResponse.success(userInfo);
+            SessionUtil.setLoginMemberId(session, id);
+            responseEntity = new ResponseEntity<LoginResponse>(loginResponse, HttpStatus.OK);
+        } else {
+            // 예상하지 못한 오류일 경우
+            log.error("login ERROR" + responseEntity);
+            throw new RuntimeException("login ERROR!");
+        }
+
+        return responseEntity;
+    }
+
+    /**
+     * 회원 로그아웃 메서드.
+     *
+     * @author jun
+     * @param session 현제 접속한 세션
+     * @return 로그인 하지 않았을 시 401코드를 반환하고 result:NO_LOGIN 반환 로그아웃 성공시 200 코드를 반환
+     */
+    @GetMapping("logout")
+    public void logout(HttpSession session) {
+        SessionUtil.logoutMember(session);
+    }
+
+    @Getter
+    @AllArgsConstructor
+    private static class UserInfoResponse {
+        private UserDTO userDTO;
+    }
+
+    // -------------- response 객체 --------------
+
+    @Getter
+    @AllArgsConstructor
+    // 필드값을 모두 포함한 생성자를 자동 생성해준다.
+    @RequiredArgsConstructor
+    // 생성자를 자동 생성하지만, 필드명 위에 @NonNull로 표기된 경우만 생성자의 매개변수로 받는다.
+    private static class LoginResponse {
+        enum LoginStatus {
+            SUCCESS, FAIL, DELETED
+        }
+
+        @NonNull
+        private LoginStatus result;
+        private UserDTO userDTO;
+
+        // success의 경우 userInfo의 값을 set해줘야 하기 때문에 new 하도록 해준다.
+        private static final LoginResponse FAIL = new LoginResponse(LoginStatus.FAIL);
+        private static LoginResponse success(UserDTO userDTO) {
+            return new LoginResponse(LoginStatus.SUCCESS, userDTO);
+        }
+
+
+    }
+
+    // -------------- request 객체 --------------
+
+    @Setter
+    @Getter
+    private static class UserLoginRequest {
+        @NonNull
+        private String id;
+        @NonNull
+        private String password;
+    }
+}

src/main/java/com/market/Server/controller/UserController.java

@@ -11,19 +11,22 @@ public class UserDTO {
     public enum Status {
         DEFAULT, DELETED
     }
+
     private String id;
     private String pw;
     private String name;
     private String phone;
     private String address;
+    private Status status;
 
 
-    public UserDTO(String id, String pw, String name, String phone, String address) {
+    public UserDTO(String id, String pw, String name, String phone, String address, Status status) {
         this.id = id;
         this.pw =pw;
         this.name = name;
         this.phone = phone;
         this.address = address;
+        this.status = status;
     }
 
     /**

src/main/java/com/market/Server/controller/UserRegisterController.java

@@ -20,5 +20,7 @@ public interface UserProfileMapper {
 
     public int register(UserDTO userDTO);
 
+    public UserDTO findByIdAndPassword(@Param("id") String id, @Param("pw") String pw);
 
+    int idCheck(String id);
 }

src/main/java/com/market/Server/dto/UserDTO.java

@@ -7,6 +7,9 @@
 
 import java.util.List;
 
+
+// 해당 Class가 서비스(서버에서 클라이언트에게 응답할때 response 패킷을 정의) 레이어 클래스라는 것을 spring framework에 정의한다.
+// response를 class로 분리한 이유는 해당 클래스를 사용하는 곳에서 ExceptionHandler의 형태를 직접 정의한다.
 @Service
 public class ResponseService {
     // enum으로 api 요청 결과에 대한 code, message를 정의합니다.

src/main/java/com/market/Server/mapper/UserProfileMapper.java

@@ -6,4 +6,5 @@ public interface UserService {
 
     // 회원 가입 처리
     void register(UserDTO userProfile);
+
 }

src/main/java/com/market/Server/service/ResponseService.java

@@ -1,11 +1,16 @@
 package com.market.Server.service;
 
+import com.market.Server.advice.exception.DuplicateIdException;
 import com.market.Server.mapper.UserProfileMapper;
 import com.market.Server.dto.UserDTO;
+import com.market.Server.utils.SHA256Util;
+import lombok.extern.log4j.Log4j2;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 @Service
+@Log4j2
+// https://logging.apache.org/log4j/2.x/
 public class UserServiceImpl implements UserService {
 
     @Autowired
@@ -15,10 +20,61 @@ public UserServiceImpl(UserProfileMapper userProfileMapper){
         this.userProfileMapper=userProfileMapper;
     }
 
-    // 회원 가입 처리
+
+    public UserDTO getUserInfo(String userId) {
+        return userProfileMapper.getUserProfile(userId);
+    }
+
+    /**
+     * 회원 가입 메서드.
+     *
+     * @param UserDTO 저장할 회원의 정보
+     * @return
+     *
+     * - 고객 회원가입 메서드 비밀번호를 암호화하여 세팅한다. MyBatis에서 insert return값은 성공시 1이 리턴된다. return값은 검사하여 null값이면
+     * true, null이 아닐시 insert에 실패한 것이니 false를 반환한다
+     */
     @Override
     public void register(UserDTO userDTO) {
-        userProfileMapper.register(userDTO);
+        // id 중복체크
+        boolean duplIdResult = isDuplicatedId(userDTO.getId());
+        if (duplIdResult) {
+            throw new DuplicateIdException("중복된 아이디입니다.");
+        }
+
+        userDTO.setPw(SHA256Util.encryptSHA256(userDTO.getPw()));
+        int insertCount = userProfileMapper.register(userDTO);
+
+        if (insertCount != 1) {
+            log.error("insertMember ERROR! {}", userDTO);
+            throw new RuntimeException(
+                    "insertUser ERROR! 회원가입 메서드를 확인해주세요\n" + "Params : " + userDTO);
+        }
     }
 
+    /**
+     * 고객 로그인 메서드.
+     *
+     * @param id 고객 아이디
+     * @param password 고객 비밀번호
+     * @return
+     */
+    public UserDTO login(String id, String password) {
+        String cryptoPassword = SHA256Util.encryptSHA256(password);
+        UserDTO memberInfo = userProfileMapper.findByIdAndPassword(id, cryptoPassword);
+        return memberInfo;
+    }
+
+    /**
+     * 회원가입시 아이디 중복 체크를 진행한다.
+     *
+     * @param id 중복체크를 진행할 아이디
+     * @return true : 중복된 아이디 false : 중복되지 않은 아이디(생성 가능한 아이디)
+     */
+    public boolean isDuplicatedId(String id) {
+        return userProfileMapper.idCheck(id) == 1;
+    }
+
+
+
 }