Skip to content

Conversation

@DDINGJOO
Copy link
Owner

목적

코드베이스 전반의 네이밍 컨벤션 위반 및 철자 오류를 수정하여 코드 품질과 검색성을 향상시켰습니다.

변경 요약

1. 클래스명 Java 네이밍 컨벤션 준수

healthCheckController → HealthCheckController

  • 문제: Java 클래스명은 대문자로 시작해야 함
  • 위치: controller/HealthCheckController.java
  • 영향: 1개 파일

ConsentTable_init → ConsentTableInit

  • 문제: 클래스명에 언더스코어 사용 금지
  • 위치: util/data/ConsentTableInit.java
  • 영향: 6개 파일 (import 구문 수정)
    • ConsentsController.java
    • ConsentManagementServiceImpl.java
    • RequiredConsentsValidator.java
    • ConsentManagementServiceImplTest.java

2. 패키지명 수정

statictics → statistics (오타 수정)

  • 문제: 올바른 철자는 "statistics"
  • 위치: aop/statistics/
  • 영향: 2개 파일
    • ApiRequestCountAspect.java
    • ApiRequestStat.java

consents_name → consentsname (언더스코어 제거)

  • 문제: Java 패키지명은 소문자만 사용, 언더스코어 금지
  • 위치: entity/consentsname/
  • 영향: 7개 파일
    • ConsentsTable.java (패키지 선언)
    • ConsentTableRepository.java
    • ConsentTableInit.java
    • ConsentsController.java
    • ConsentManagementServiceImpl.java
    • RequiredConsentsValidator.java
    • ConsentManagementServiceImplTest.java

수정된 네이밍 오류 상세

# 구분 Before After 심각도 이유
1 클래스명 healthCheckController HealthCheckController 높음 Java Convention 위반
2 클래스명 ConsentTable_init ConsentTableInit 높음 언더스코어 사용 금지
3 패키지명 statictics statistics 높음 철자 오류
4 패키지명 consents_name consentsname 중간 언더스코어 사용 금지

변경 전후 비교

Before:

// 잘못된 클래스명
public class healthCheckController { }
public class ConsentTable_init { }

// 잘못된 패키지명
package com.teambiund.bander.auth_server.aop.statictics;
package com.teambiund.bander.auth_server.entity.consents_name;

After:

// 올바른 클래스명
public class HealthCheckController { }
public class ConsentTableInit { }

// 올바른 패키지명
package com.teambiund.bander.auth_server.aop.statistics;
package com.teambiund.bander.auth_server.entity.consentsname;

코드 개선 효과

1. 검색성 향상

  • Before: "ConsentTable init"으로 검색 시 찾기 어려움
  • After: "ConsentTableInit"으로 IDE 자동완성 및 검색 용이

2. 코드 가독성 향상

  • Java 네이밍 컨벤션 준수로 일관된 코드 스타일 유지
  • 새로운 개발자가 코드를 이해하기 쉬워짐

3. IDE 지원 개선

  • 클래스명이 대문자로 시작하여 IntelliJ, VSCode 등의 자동완성 기능 향상
  • 패키지명에 언더스코어가 없어 리팩토링 도구가 더 잘 작동

4. 오타 제거로 오해 방지

  • "statictics" → "statistics" 수정으로 코드 검토 시 혼란 제거

수용 기준 검증

  • 모든 클래스명이 대문자로 시작
  • 클래스명과 패키지명에 언더스코어 없음
  • 철자 오류 수정
  • 모든 import 구문 업데이트
  • 테스트 전체 통과

테스트

전체 테스트 결과

./gradlew test --rerun-tasks
BUILD SUCCESSFUL in 10s
5 actionable tasks: 5 executed

수동 검증 방법

# 1. 네이밍 컨벤션 위반 검색 (결과 없어야 함)
find src -name "*_*.java" | grep -v "test"  # 언더스코어 포함 파일명
grep -r "class [a-z]" src/main --include="*.java"  # 소문자 시작 클래스명

# 2. 패키지 구조 확인
tree src/main/java/com/teambiund/bander/auth_server/aop/
tree src/main/java/com/teambiund/bander/auth_server/entity/

# 3. 빌드 성공 확인
./gradlew build

브레이킹/마이그레이션

Breaking Change: 없음

이 변경은 내부 구조 변경만 포함하며, 다음에는 영향을 주지 않습니다:

  • API 엔드포인트
  • 데이터베이스 스키마
  • 외부 인터페이스
  • 런타임 동작

단, 다른 브랜치에서 작업 중인 경우:

  1. 이 PR 머지 후 rebase 필요
  2. import 구문 자동 업데이트 (IDE에서 자동 처리)

영향 범위

  • 변경된 파일: 10개
  • 파일명/패키지 이동: 4개
  • import 수정: 9개
  • 코드 로직 변경: 없음 (네이밍만 수정)

참조

체크리스트

  • 빌드 성공
  • 모든 테스트 통과
  • Java 네이밍 컨벤션 준수
  • 철자 오류 수정
  • import 구문 업데이트

## 변경 사항

### 1. 클래스명 Java 네이밍 컨벤션 준수
- **healthCheckController → HealthCheckController**
  - Java 클래스명은 대문자로 시작해야 함
  - 파일: controller/HealthCheckController.java

- **ConsentTable_init → ConsentTableInit**
  - 클래스명에 언더스코어 사용 금지
  - 파일: util/data/ConsentTableInit.java
  - 영향받은 파일: 6개 (import 수정)

### 2. 패키지명 수정

- **statictics → statistics** (오타 수정)
  - 올바른 철자: statistics
  - 위치: aop/statistics/
  - 영향받은 파일:
    - ApiRequestCountAspect.java
    - ApiRequestStat.java

- **consents_name → consentsname** (언더스코어 제거)
  - Java 패키지명 규칙 준수 (소문자, 언더스코어 금지)
  - 위치: entity/consentsname/
  - 영향받은 파일: 7개
    - ConsentsTable.java (패키지 선언)
    - ConsentTableRepository.java (import)
    - ConsentTableInit.java (import)
    - ConsentsController.java (import)
    - ConsentManagementServiceImpl.java (import)
    - RequiredConsentsValidator.java (import)
    - ConsentManagementServiceImplTest.java (import)

## 수정된 네이밍 오류 목록

| 구분 | Before | After | 심각도 |
|------|--------|-------|--------|
| 클래스명 | healthCheckController | HealthCheckController | 높음 |
| 클래스명 | ConsentTable_init | ConsentTableInit | 높음 |
| 패키지명 | statictics | statistics | 높음 (오타) |
| 패키지명 | consents_name | consentsname | 중간 |

## 테스트 결과

모든 테스트 통과:
```bash
./gradlew test --rerun-tasks
BUILD SUCCESSFUL
```

## 영향 범위

- 변경된 파일: 10개
- 파일명/패키지 이동: 4개
- import 수정: 9개
- Breaking Change: 없음 (내부 구조 변경만 해당)

## 참조

- refs #39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[STORY] 네이밍 오류 일괄 수정

2 participants