Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor : 인증 관련 도메인 계층 자바에서 코틀린으로 리팩터링 #8

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

tlarbals824
Copy link
Member

No description provided.

Copy link

제공된 코드는 JWT(Json Web Token)를 생성하고 유효성을 검사하는 클래스 및 관련 클래스들을 포함하고 있습니다. 코드의 구조는 Kotlin으로 작성되어 있고, JWTProvider, JwtKeyFactory, JwtProperties, JwtValidator, PrivateClaims, TokenType 등의 클래스로 구성되어 있습니다.

코드 검토를 토대로 몇 가지 권장 사항을 제시하겠습니다.

권장 사항:

  1. 클래스 및 메서드 명명 규칙:

    • 클래스명 및 메서드명은 명확하게 기능을 설명하도록 작성되어야 합니다. 동사와 명사를 함께 사용하여 무엇을 하는지 명확히 드러내는 것이 좋습니다.
  2. 예외 처리:

    • 예외 처리 부분을 보다 구체적으로 나누어서 구현하고, 적합한 예외 처리 클래스를 활용하여 관리하는 것이 좋습니다.
  3. 메소드 역할 분리:

    • 일부 메서드들이 많은 기능을 동시에 처리하고 있습니다. 이를 분리하여 각 메서드가 하나의 역할을 수행하도록 수정하는 것이 유지보수에 용이합니다.
  4. 주석 및 문서화:

    • 코드의 가독성을 높이기 위해 주석을 추가하고, 필요한 경우 함수나 클래스에 대한 문서화를 향상시키는 것이 좋습니다.

솔루션:

  1. 클래스 및 메서드명 변경:

    • JwtProvider, JwtKeyFactory, JwtProperties, JwtValidator 등의 클래스명과 메서드명을 보다 명확하고 기능을 표현할 수 있는 이름으로 변경하세요.
  2. 예외 처리 세분화:

    • JwtValidator 클래스의 validateToken 메서드에서 발생하는 예외 처리를 세분화하여, 각 예외 타입에 따라 적절한 예외를 던지도록 수정하세요.
  3. 메소드 역할 분리:

    • JwtProvider 클래스 내의 몇몇 메서드가 한 가지 이상의 역할을 수행하고 있습니다. 각 메서드는 하나의 기능에 집중하도록 분리하고 리팩토링하세요.
  4. 주석 추가와 문서화:

    • 각 클래스와 메서드에 주석을 추가하고, 코드의 의도와 작동 방식을 설명하는 데 도움이 되도록 주석을 작성하세요.

이러한 권장 사항을 고려하여 코드를 개선하면 더욱 명확하고 유지보수가 쉬운 형태로 발전할 수 있습니다. 개선된 코드 예시를 원하신다면 샘플 코드를 제공해주세요.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant