f:["$","div",null,{"className":"prose","children":[["$","h1",null,{"children":"SAW에서 Exception을 다루는 방법"}],"\n",["$","p",null,{"children":["💡SAW 프로젝트 백엔드의 글로벌 Exception은 하단의 코드를 참조하십시오.\n",["$","a",null,{"href":"https://github.com/SleepAswell/SAW_BackEnd/blob/main/src/main/java/com/sleepaswell/backend/configs/exceptions/UserExceptionHandler.java"}]]}],"\n",["$","h1",null,{"children":"Exception은 언제 사용하는가?"}],"\n",["$","h2",null,{"children":"일반적으로"}],"\n",["$","p",null,{"children":"Exception은 보통 예상이 되는 오류 제어에 사용하게 됩니다."}],"\n",["$","p",null,{"children":"흔히 Java에서는 File을 입출력 받을때 반드시 사용해야합니다."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"try {\n\tFile file = new File(\"/path/to/file\");\n FileInputStream stream = new FileInputStream(file);\n} catch (FileNotFoundException e) {\n System.out.println(e.getCause());\n}\n"}]}],"\n",["$","p",null,{"children":"이렇게 오류 제어를 강제로 하는 함수도 있는가 하면은 오류 제어를 사용자의 재량에 맡기는 경우도 있죠."}],"\n",["$","p",null,{"children":"흔히 String 같이 일반적으로 사용이 가능한것들이 있습니다."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"public static void main(String[] args) {\n\tString str = null;\n System.out.println(str.length());\n}\n"}]}],"\n",["$","p",null,{"children":"해당 코드를 사용하면 반드시 Null Point Exetpion(NPE) 오류가 발생합니다."}],"\n",["$","p",null,{"children":["이런식으로 ",["$","strong",null,{"children":"예상"}],"되는 오류를 제어하기 위해서 흔히 try-catch 를 사용하게 됩니다."]}],"\n",["$","p",null,{"children":"그리고 API 작성시에 흔히 많은 오류제어를 하게 되겠죠."}],"\n",["$","h2",null,{"children":"반복적인 에러 반환"}],"\n",["$","p",null,{"children":"하지만 백엔드에서 대부분의 에러들은 공통적으로 메세지를 반환하는경우가 많습니다."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"public ResponseEntity foo1() {\n String x = null;\n try {\n System.out.println(x.length());\n return ResponseEntity.ok(\"ok!\");\n } catch (NullPointerException e) {\n return ResponseEntity.status(400).body(\"faild...\");\n }\n}\n\npublic ResponseEntity foo2() {\n int[] arr = null;\n try {\n System.out.println(arr[0]);\n return ResponseEntity.ok(\"ok!\");\n } catch (NullPointerException e) {\n return ResponseEntity.status(400).body(\"faild...\");\n }\n}\n"}]}],"\n",["$","p",null,{"children":"하지만 해당 방식은 계속해서 무언가를 반환하기 위해 retrun과 객체를 반복적으로 작성을 해서 명시해줘야하는 경우가 많습니다."}],"\n",["$","p",null,{"children":"그렇기 때문에 에러가 발생시 바로 ResponseEntity 같은 값을 리턴 할 수 있는 방법이 있습니다."}],"\n",["$","p",null,{"children":"Restful API 설계와 규모가 있는 프로젝트에 아주 좋은 방식이죠."}],"\n",["$","p",null,{"children":"물론 try-catch 로 감쌀 경우에는 원하는 방식으로 제어가 가능합니다."}],"\n",["$","p",null,{"children":"해당 방식은 throws 같은 경우에만 작동하죠"}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"public ResponseEntity foo1() throws NullPointerException{\n String x = null;\n System.out.println(x.length());\n return ResponseEntity.ok(x);\n}\n\n@Override\npublic CustomUserDetails loadUserByUsername(final String username) throws UsernameNotFoundException {\n Optional optionalUser = userEntityRepository.findByUserID(username);\n\n /* 유저를 찾지 못할시 에러 강제 발생 */\n if (optionalUser.isEmpty()) throw new UsernameNotFoundException(username);\n\n UserEntity userEntity = optionalUser.get();\n USER_ROLE userRole = userRoleEntityRepository.findByUserID(userEntity.getUserID()).getUserRole();\n\n Collection grantedAuthorities = List.of(new SimpleGrantedAuthority(userRole.getValue()));\n\n return new CustomUserDetails(userEntity, grantedAuthorities);\n}\n"}]}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"public ResponseEntity foo1() throws NullPointerException{\n String x = null;\n System.out.println(x.length());\n return ResponseEntity.ok(x);\n}\n\n@Override\npublic CustomUserDetails loadUserByUsername(final String username) throws UsernameNotFoundException {\n Optional optionalUser = userEntityRepository.findByUserID(username);\n\n /* 유저를 찾지 못할시 에러 강제 발생 */\n if (optionalUser.isEmpty()) throw new UsernameNotFoundException(username);\n\n\t\t/.../\n}\n"}]}],"\n",["$","h1",null,{"children":"Exception 글로벌 관리하기"}],"\n",["$","h2",null,{"children":"메서드에서 사용하기"}],"\n",["$","p",null,{"children":"X라는 컨트롤 클래스가 있다고 가정합시다.\n그렇다면 이 메서드에서 어떠한 Exception이 발생하면 특정 객체를 반환합니다."}],"\n",["$","p",null,{"children":"그리고 해당 컨트롤 내에서만 작동하는 Exception-Retrun이죠."}],"\n",["$","p",null,{"children":"@ExceptionHandler 어노테이션만 사용해서 작동합니다."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"@RestController\npublic class X{\n\n @GetMapping(\"/example\")\n public String foo() {\n\t\t /* 커스텀 예외 발생 */\n throw new CustomException(\"오류 발생\");\n }\n\n @ExceptionHandler(CustomException.class)\n public ResponseEntity handleCustomException(CustomException e) {\n return ResponseEntity.status(HttpStatus.BAD_REQUEST)\n .body(e.getMessage());\n }\n\n public static class CustomException extends RuntimeException {\n public CustomException(String message) {\n super(message);\n }\n }\n}\n"}]}],"\n",["$","h2",null,{"children":"글로벌하게 사용하기"}],"\n",["$","p",null,{"children":"메서드 내에서만 사용이 가능하다면 필터처럼 프로젝트 단위 내에서 Exception이 발생하면 반환을 제어하는 어노테이션도 있습니다."}],"\n",["$","p",null,{"children":"@RestControllerAdvice or @ControllerAdvice (둘 모두 사용 가능)\n@ExceptionHandler으로 제어합니다."}],"\n",["$","p",null,{"children":"**SpringBoot의 필터들을 모두 거친 후(중요합니다!!!)**에 에러가 발생시, 해당 객체를 반환하게 되죠."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"@RestControllerAdvice\npublic class UserExceptionHandler {\n @ExceptionHandler(UsernameNotFoundException.class)\n public ResponseEntity usernameNotFound(UsernameNotFoundException e) {\n return ResponseEntity.status(HttpStatus.NOT_FOUND)\n .body(String.format(\"해당 유저를 찾지 못했습니다. : %s\", e.getMessage()));\n\t }\n}\n"}]}],"\n",["$","p",null,{"children":"예제 코드처럼 UsernameNotFoundException이 발생시에 작동을 합니다."}],"\n",["$","pre",null,{"children":["$","code",null,{"className":"language-java","children":"@Override\npublic CustomUserDetails loadUserByUsername(final String username) throws UsernameNotFoundException {\n Optional optionalUser = userEntityRepository.findByUserID(username);\n\n /* 유저를 찾지 못할시 에러 강제 발생 */\n if (optionalUser.isEmpty()) throw new UsernameNotFoundException(username);\n\n /.../\n}\n"}]}],"\n",["$","p",null,{"children":"이렇게 현재 저희 프로젝트에서 Exception을 글로벌하게 다루고 있습니다."}],"\n",["$","p",null,{"children":"현재 컨트롤하고 있는 Exception의 리스트는 다음 문서를 참조하세요."}],"\n",["$","p",null,{"children":["$","a",null,{"href":"https://www.notion.so/Global-Exception-35f51641e09d4d19b6ed94f6fda288e7?pvs=21","children":"Global Exception"}]}],"\n",["$","h1",null,{"children":"추가 참고 자료"}],"\n",["$","p",null,{"children":["$","a",null,{"href":"https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestControllerAdvice.html","children":"RestControllerAdvice"}]}],"\n",["$","p",null,{"children":["$","a",null,{"href":"https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/ExceptionHandler.html","children":"ExceptionHandler"}]}],"\n",["$","p",null,{"children":["$","a",null,{"href":"https://mangkyu.tistory.com/205","children":"RestControllerAdvice를 이용한 Spring 예외 처리 방법 - (2/2)\n출처: https://mangkyu.tistory.com/205 [MangKyu's Diary:티스토리]"}]}]]}]