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

feat#3/config-querydsl #18

Merged
merged 2 commits into from
Aug 12, 2024
Merged

feat#3/config-querydsl #18

merged 2 commits into from
Aug 12, 2024

Conversation

kkyu0718
Copy link
Collaborator

✅ PR 체크

  • 하나의 PR 에는 100줄 정도의 커밋을 한다는 규칙을 지키고 있나요?
  • 무엇을 변경했는지 충분히 설명하고 있나요?
  • 새로운 기술을 사용했다면, 그 기술을 설명하고 있나요?
  • 이해하기 어려운 비즈니스 로직에 관해서 부연 설명을 하고 있나요?
  • 팀원 한 명을 Assign 했나요?
  • 작업 범위에 대해서 테스트를 작성하셨나요?

🚨 관련 이슈

closes #3

🌈 작업 상황

  • querydsl 설정 작업

@kkyu0718 kkyu0718 added the 설정 프로젝트에 필요한 요소를 설정한다 label Aug 12, 2024
@kkyu0718 kkyu0718 self-assigned this Aug 12, 2024
@kkyu0718 kkyu0718 added this to the 프로젝트 초기 설정 milestone Aug 12, 2024
}
compileQuerydsl {
options.annotationProcessorPath = configurations.querydsl
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드 리뷰에 대한 요청을 감사합니다. 다음은 주어진 코드 diff에 대한 검토 및 개선 제안입니다.

1. 코드 품질 및 자바 모범 사례

  • 의존성 관리: dependencyManagement를 사용하여 QueryDSL의 버전을 설정하는 부분이 명확하게 보이지 않으므로, 특정 버전(5.0.0)을 직접 사용하는 대신 이곳에서 관리된 버전을 사용하는 것이 좋습니다.
  • 주석: 추가된 주석이 있지만, 좀 더 상세한 설명을 추가하면 후에 코드를 읽는 사람들이 이해하는 데 도움이 될 것입니다.

2. 성능 및 효율성

  • 의존성 불필요 평가: QueryDSL과 관련된 모든 의존성을 포함하고 있음을 확인하였지만, 실제로 사용하는 API와 기능만 남기도록 정리해야 합니다. 예를 들어 프로젝트 내에서 사용할 필요 없는 의존성이 있다면 제거합니다.

3. API 설계 및 백엔드 아키텍처

  • QueryDSL 사용: QueryDSL을 비롯한 검색 쿼리 생성을 위한 API 구현 계획이 없다면, 이를 명시적으로 하는 것이 좋습니다. 향후 데이터베이스 연동 및 크기 확장성을 고려할 때 명확한 아키텍처가 필요합니다.

4. 보안 취약점

  • API 의존성 점검: 각 의존성(특히 사용되는 라이브러리)에 대한 보안 패치를 주기적으로 점검하세요. 특히 jakarta 기반의 의존성들은 최신 보안 업데이트가 적용되어야 합니다.
  • 주석 처리된 정보 보호: 주석 속에 민감한 정보를 넣지 않고 소스 코드에서 해당 정보를 관리하도록 합니다.

5. 테스트 커버리지

  • Jacoco 설정: Jacoco 설정이 잘 되어 있는지 확인합니다. 테스트가 작성되었는지, 그리고 코드 커버리지가 충분히 높은지 확인해야 합니다.
  • 테스트에 대한 문서화: 새로 추가된 기능이나 변경사항에 대해 관련 테스트 케이스를 추가하고 그 내용을 문서화하는 것이 중요합니다.

개선 제안 요약

  1. 의존성 정리 및 명확화: QueryDSL 버전을 dependencyManagement에서 관리하도록 수정.
  2. 자세한 주석 추가: 코드의 목적과 동작 방식에 대한 설명 추가.
  3. API 구현 계획 수립: QueryDSL을 사용한 API 설계를 세부적으로 작성.
  4. 정기적인 보안 점검 실시: 의존성의 보안 취약점을 주기적으로 점검.
  5. 테스트 케이스 추가 및 문서화: 변경사항에 따른 테스트 작성을 통해 코드 커버리지 확보.

이러한 점들을 신경 써서 개선한다면, 프로젝트의 안정성과 유지보수성을 높일 수 있을 것입니다.

@kkyu0718 kkyu0718 merged commit 75011c0 into main Aug 12, 2024
3 checks passed
@kkyu0718 kkyu0718 deleted the config-querydsl branch August 12, 2024 07:10
Copy link

Code Coverage Report

There is no coverage information present for the Files changed

Total Project Coverage 100% 🍏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
설정 프로젝트에 필요한 요소를 설정한다
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Config] QueryDSL 세팅
1 participant