[iOS] 한성대 기숙사 어플 프로젝트

해당 프로젝트 GitHub Repository

https://github.com/HansungDomitory/HansungDomitory_Backend

GitHub - HansungDomitory/HansungDomitory_Backend

 

1. 주제 설명

 한성대학교 여름방학 진로탐색학점제 프로젝트입니다.

학교에서 방학동안 하는 특별한 활동인 만큼 이 기간 동안 꼭 만들어보고 싶었으면서도 학교에도 도움이 될 것 같은 주제로 하고 싶다는 생각이 들었습니다.

그러다가 학교 기숙사 어플리케이션을 사용하는데 불편한 점이 꽤 많았던 기억이 있어 이를 모티브하면 좋을 것 같아 주제를 한성대 기숙사 어플로 선정하게 되었습니다.

---

2. 개발 기간

2024.07.04 ~ 2024.08.05 (약 1개월)

---

3. 역할

백엔드, 배포 서버 관리

• 설계
  • ERD 설계
  • 로그인 과정 설계
• 구현
  • 로그인 기능 구현
  • 외박신청 기능 구현
  • 상벌점 기능 구현
  • 공지사항 기능 구현
• 배포
  • AWS EC2 인스턴스 배포

---

4. 기술 스택

• 언어: TypeScript
• 프레임워크: NestJS
• 데이터베이스: MySQL
• 배포: AWS EC2
• 도구: Docker, RestAPI, Swagger

---

5. ERD

---

6. 전체 구조

---

7. 상세 구현 내용

NestJS 환경에서 RestAPI로 백엔드 API를 구현했습니다.

7-1. 회원 관리

• JWT 토큰을 활용한 로그인 관리

JWT 토큰을 만들어서 학생의 로그인을 관리했습니다.

JWT 토큰은 로그인 처리를 담당하는 accessToken과 accessToken 기간 만료 시 재발급을 담당하는 refreshToken으로 만들었습니다.

refreshToken은 Cookie를 통해 클라이언트에 전달하는 방식을 사용하였습니다.

 

[accessToken 발급]

getAccessToken(student: Student | IStudentContext['student']): string {
    return this.jwtService.sign(
        { sub: student.id },
        { secret: process.env.JWT_ACCESS_SECRET, expiresIn: '100m' }
    );
}

 

[refreshToken 발급]

getRefreshToken(student: Student, context: IContext): void {
    const refreshToken = this.jwtService.sign(
        { sub: student.id },
        { secret: process.env.JWT_REFRESH_SECRET, expiresIn: '2w' },
    );

    context.res.setHeader(
        'set-cookie',
        `refreshToken=${refreshToken}; path=/;`,
    );
}

 

• 안정적인 비밀번호 관리

학생이 회원가입을 할 때 학번과 비밀번호를 입력하기 때문에 비밀번호를 데이터베이스에 안정적으로 저장하는 과정이 필요했습니다.

bcrypt의 hash 기능을 사용해서 비밀번호를 hash 처리한 후 저장하였고, 비밀번호 확인 시에는 hash 된 비밀번호를 복호화하여 매칭시켰습니다.

 

[회원가입 시 비밀번호 hash 처리]

async create({ createStudentInput }: IStudentServiceCreate): Promise<Student> {
    
    ...
    const { password, ...rest} = createStudentInput;
    const hashedPassword = await bcrypt.hash(password, 10);
    ...
}

 

 

7-2. 관리자 설정

상벌점 관리와 공지사항 작성은 관리자만 이용할 수 있어야 하기 때문에 회원가입 시 존재할 수 없는 학번인 '000000'을 가진 사용자를 관리자로 등록했습니다.

그리고, 정상적인 경로로 만들 수 없는 관리자 계정은 데이터베이스에서 직접 학번을 수정하여 만들었습니다.

 

[회원가입 시 관리자 계정 생성 방지]

async create({ createStudentInput }: IStudentServiceCreate): Promise<Student> {

    ...
    if(createStudentInput.id === '0000000') {
        throw new BadRequestException('회원가입할 수 없는 ID입니다.');
    }
    …
}

 

관리자만 호출할 수 있는 API에 호출한 사용자가 관리자인지 확인하는 작업을 추가하고, 관리자가 아닐 시에 ForbiddenException 예외를 발생시켜서 일반 사용자가 사용할 수 없도록 구현했습니다.

 

[상벌점 추가 API에서 관리자 확인 절차 추가]

async create(myId: string, createScoreRecordInput: CreateScoreRecordInput) {
    
    if(!myId || myId !== '0000000') {
        throw new ForbiddenException('관리자만 상벌점 기록을 생성할 수 있습니다.');
    }
    …
}

 

 

7-3. 랜덤 방 배정

기숙사 어플리케이션에 가입한 학생들은 각자 빈 방 번호가 배정이 되어야 합니다.

따라서, 배정이 되지 않은 빈 방을 찾는 과정과 배정되지 않은 빈 방을 회원 가입한 학생에게 배정하는 과정을 구현했습니다.

 

[랜덤 방 번호 생성]

private generateRandomRoom(): string {
    const floor = this.getRandomInt(1, 9);
    const roomSuffix = this.getRandomInt(1, 9);
    const tailDasi = this.getRandomInt(1, 2);
    return `${floor}0${roomSuffix}-${tailDasi}`;
}

 

[사용되지 않은 랜덤 방 번호 배정]

private async assignRandomRoom(): Promise<string> {
    const existingRooms = await this.studentRepository.find({ select: ['room'] });
    const existingRoomSet = new Set(existingRooms.map(student => student.room));

    while (true) {
        const randomRoom = this.generateRandomRoom();
        if (!existingRoomSet.has(randomRoom)) {
            return randomRoom;
        }
    }
}

 

 

7-4. 상벌점 관리

상벌점은 관리자가 학생에게 부여하는 방식으로 구현했습니다.

상점과 벌점은 따로 구현하지 않고, 하나의 점수 필드로 생성한 후 양수는 상점으로, 음수는 벌점으로 구현했습니다.

하나의 필드로만 구현한 이유

상점이 있는 상태에서 벌점이 부여되면 그만큼 상점이 차감되는 것처럼 상점과 벌점은 서로 연관되어 있는 상태이기 때문에, 상점과 벌점을 따로 나눠서 구현하지 않고 간단하게 점수라는 하나의 필드만 갖게 했습니다.

 

[점수 필드 하나로만 구현한 상벌점 기능 엔티티]

@Entity()
export class ScoreRecord {
    @ApiProperty({ description: "고유번호" })
    @PrimaryGeneratedColumn('increment')
    id: number;

    @ApiProperty({ description: "해당 기록 관련 학생" })
    @ManyToOne(() => Student, { onDelete: 'CASCADE' })
    @JoinColumn()
    student: Student;

    @ApiProperty({ description: "상점/벌점 여부" })
    @Column()
    is_merit: boolean;

    @ApiProperty({ description: "점수" })
    @Column()
    score: number;

    @ApiProperty({ description: "상세내용" })
    @Column()
    detail: string;

    @ApiProperty({ description: "생성일자" })
    @CreateDateColumn()
    create_at: Date;
}

---

8. 실행 시나리오

8-1. 회원가입, 로그인

• 회원가입: 이름, 학번, 비밀번호를 다 입력해야 회원가입이 가능합니다.
  • 회원가입을 하면 랜덤으로 기숙사 빈 방이 배정됩니다.
• 로그인: 회원가입 후, 학번과 비밀번호를 입력하면 로그인이 됩니다.

8-2. 홈 화면 및 기숙사 소개 화면

• 홈 화면: 메인 화면으로, 해당 페이지에서 기숙사 소개 페이지와 공지사항 페이지로 이동할 수 있습니다.
• 기숙사 소개 화면: 한성대학교 기숙사에 관한 정보가 나와있습니다.

8-3. 외박신청

• 이 페이지에서 외박 신청이 가능하며, 학번과 이름은 자동으로 불러와지고 날짜를 선택하면 자동으로 외박일수가 보여집니다.
• 날짜를 선택하고 내용까지 적어서 신청하기 버튼을 누르면 외박 현황 페이지가 나오고, 그 페이지에서 기간과 외박일수, 등록일자를 확인할 수 있습니다.
• 외박 신청했던 목록들은 등록일자 기준으로 내림차순으로 배열되어 있으며, 외박 기간이 되기 전에는 수정과 삭제가 가능합니다.

 

8-4. 마이페이지, 상벌점 조회

• 마이페이지
  • 학생 이름, 배정된 방이 나와 있으며, 해당 페이지에서 로그아웃 버튼을 누르면 로그아웃이 가능합니다.
  • 해당 페이지에서 공지사항 페이지, 외박현황 페이지, 상벌점현황 페이지로 이동할 수 있습니다.
• 상벌점 조회
  • 학생 정보와 상벌점 점수, 총점, 상벌점에 관한 사유와 적용일자가 나와있고 내림차순으로 나열되어 있습니다.
  • 파란색 +점수는 기존 점수에서 가산되고, 빨간색 -점수는 기존 점수에서 감산됩니다.

8-5. 공지사항

• 관리자측에서 기숙사와 관련된 공지사항을 올리면 학생들은 이 공지사항들을 확인할 수 있습니다.
• 공지사항은 가장 오래된 글부터 내림차순으로 올려져 있고, 학생들은 검색을 통해 궁금한 공지 사항을 볼 수 있습니다.