Project

General

Profile

Feature #1292

Updated by 성용 양 13 days ago

## 목적 

 업무 담당자가 학생과 관련 정보를 빠르게 찾도록 검색을 제공합니다. 개인정보 검색은 권한·감사 대상입니다. (FR-SEARCH-001) 

 ## 쉬운 설명 

 업무 담당자가 학생과 관련 정보를 빠르게 찾도록 검색을 제공합니다. 개인정보 검색은 권한·감사 대상입니다. 

 ## 기술 스택 

 Django ORM 쿼리·인덱스, PostgreSQL 인덱스(필요 시 trigram 후보), 02-04 권한, 02-05 감사 로그. 

 ## 예상 결과(산출물) 

 search 앱의 검색 화면·서비스, 필터(소속·학적·학기), 권한별 결과 제한, 테스트. 

 ## 개발 작업 상세 

 1. 개인정보(이름) 검색은 security 서비스 함수를 거쳐 하고 결과 노출을 권한으로 제한한다. 
 2. 학번·소속·학적 상태·수강·성적·납부 상태 필터를 만든다. 
 3. 각 앱의 조회 서비스 함수만 호출한다(다른 앱 모델 직접 쿼리 금지). 
 4. 느린 쿼리를 확인하고 필요한 인덱스를 요청한다(소유자 앱 마이그레이션). 
 5. 테스트. 

 ## 완료 기준 

 - 학생·학적·수강·성적·납부 현황을 검색할 수 있다. 

 ## 충돌 방지(소유 범위) 

 search/ 앱은 우섭 소유. 

 ## 선행·후행·위험 

 선행: 07-03 지도교수 지정·학생 상세 통합 화면(우섭, 12/04 종료) / 08-04 성적 정정 이력·재수강·대체/인정 학점(성용, 12/17 종료) / 09-02 장학금·감면·환불·분할 납부·처리 이력(서현, 12/15 종료) 

 후행: 13-02 업무 대시보드(우섭) 

 ## 결과 확인 방법 

 "완료 기준"의 각 항목을 화면 또는 명령으로 직접 확인합니다. 

 1. 학생·학적·수강·성적·납부 현황을 검색할 수 있다. 
 2. pytest가 모두 통과한다. 
 3. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. 

 ## 시작 전 준비 

 1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다. 
 2. 저장소를 최신으로 맞춘다: git switch main 후 git pull --ff-only origin main 
 3. 저장소 README 8번과 팀 로컬 세팅 안내 README(01-01 결과) 순서대로 환경을 준비한다. 보통 py -3.12 python -m venv .venv, 가상환경 켜기, python -m pip install -r requirements-dev.txt, Windows에 설치한 PostgreSQL 18에서 개인 로컬 DB(university_dev) 생성, .env.local 설정(DB_NAME, DB_USER, DB_PASSWORD, DB_HOST, DB_PORT), requirements.txt, docker compose up -d db(DB 실행), python manage.py check, python manage.py migrate 순서이다. 최초 실행에 makemigrations는 필요 없고, .env.local과 비밀번호는 공유·커밋하지 않는다. 
 4. #1226의 폴더 소유 표에서 내가 고칠 수 있는 폴더를 확인한다. 

 ## 작업 진행 순서 

 1. 브랜치를 만든다: git switch -c feature/MDGU-번호-짧은이름 
 2. "개발 작업 상세"의 번호 순서대로 한 단계씩 구현하고, 단계마다 pytest로 확인한다. 
 3. 모델을 바꾸면 python manage.py makemigrations, 그다음 python manage.py migrate를 실행한다. 
 4. 화면은 python manage.py runserver로 실행해 직접 열어 보고 "완료 기준"과 하나씩 대조한다. 
 5. git add, git commit, git push 후 PR을 만든다. PR 템플릿의 체크리스트를 채우고 폴더 소유자의 리뷰를 받는다. 
 6. 병합 후 이 일감 메모에 PR 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 검색 결과에 개인정보 원문이 과도하게 노출되지 않는지 02 규칙으로 점검하세요. 

 그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요. 

 ## 용어 풀이 

 - **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다. 
 - **감사 로그**: 누가 언제 무엇을 했는지 남기는 변경 불가 기록입니다. 문제가 생겼을 때 추적하는 근거가 됩니다. 
 - **서비스 함수**: 다른 앱이 직접 DB를 건드리지 않고 이 함수를 통해서만 기능을 쓰게 만든 창구입니다.

Back