Refactoring list

[thals0]

리팩토링 할 목록

Jmeter로 as-is 확인 필요

• 검색 쿼리 수정, 특정 공고 검색 안되는 이슈 해결 (원인 찾기) (fulltext ?)
• 변경 가능성이 적은 데이터들 레디스 이용해서 캐싱 처리
• 스케줄러 - findAll이 아니라 enddate가 LocalDateTime보다 이후면 들고오기 (쿼리짜서)
• 공고 수정 - patch로 변경
• 검색어 - 저장할 수 있는 단어 제한하기
• delete db 여러번 찌르는 거 쿼리로 해결

--

• 기본 이미지 s3에 넣고, 코드 수정
• jacoco 수정
• 채팅 - 기업이 채팅 목록 확인시 지원자인 유저는 표시해주기
• 소셜로그인시 닉네임 받아오는데 기존 로그인된 사람의 nickname과 겹치면 .. ?
• 전체 에러코드 enum 수정
• isCompanyLogin, userDetail 등 메서드 통일
• 공고 삭제시 해당 공고 북마크 했으면 이상(?)해짐

ETC.

• 테스트코드 80% 커버
• 뮤텍스(Mutex)와 세마포어(Semaphore) 등 동시성 제어
• 시간, 공간 복잡도 개선
• 더미데이터 넣기
• https

[thals0]

LabLink-BE

더 빠르고 더 나은 연구 매칭 플랫폼, LabLink

LabLink는 연구를 위한 지원자를 모집하는 기업/단체와 단기 알바를 원하는 유저간의 매칭을 더 간편하게 도와주는 서비스입니다.

❓실험 연구나 유저테스트 등 테스터를 모집하고 싶었는데 어떻게 모집해야 할 지 모르겠을 때
❓간단한 테스트로 돈을 벌고 싶을 때
💡 LabLink를 시작하세요 !

✅ 서비스 핵심 기능

1. 온라인 오프라인 어디서나 매칭 가능
오프라인에서 이뤄지는 연구는 물론이고, 온라인상에서 가능한 사용성 테스트, 리서치까지 매칭합니다.
2. 복잡한 이력서가 필요없는 쉬운 구인구직
길고 복잡한 이력어 없이 간단한 이력으로 바로 지원가능합니다.
3. 테스트부터 피드백까지 한번에
온라인의 경우 테스트 이후 피드백까지 한번에 손쉽게 관리할 수 있습니다.

📖 IA

🌐 API 명세서

API 명세서

📑 ERD

⚙️ Service Architecture

🛠 Development Environment

📁 Foldering

📁 lablink _ 
           |_ 📁 domain _ 
           |            |_ 📁 bookmark _
           |                           |_ 📁 controller
           |                           |_ 📁 dto
           |                           |_ 📁 entity
           |                           |_ 📁 exception
           |                           |_ 📁 repository
           |                           |_ 📁 service
           |            |_ 📁 chat
           |            |_ 📁 company
           |            |_ 📁 feedback
           |            |_ 📁 study
           |            |_ 📁 user
           |_ 📁 global _ 
           |            |_ 📁 config
           |            |_ 📁 dto
           |            |_ 📁 jwt
           |            |_ 📁 message
           |            |_ 📁 S3Image
           |            |_ 📁 scheduler
           |            |_ 📁 timestamp
           |_ 📋 LabLinkApplication

📌 Dependencies Module

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5'
    testImplementation 'junit:junit:4.13.1'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    runtimeOnly 'com.mysql:mysql-connector-j'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.springframework.security:spring-security-test'

    implementation 'mysql:mysql-connector-java'

    implementation 'org.springframework.boot:spring-boot-starter-validation'
    implementation group: 'org.json', name: 'json', version: '20230227'

    compileOnly 'io.jsonwebtoken:jjwt-api:0.11.2'
    runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.2'
    runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.2'

    testImplementation 'org.mockito:mockito-core:4.8.0'
    testImplementation 'org.mockito:mockito-junit-jupiter:4.8.0'

    implementation 'org.springframework.boot:spring-boot-starter-actuator'
    implementation 'io.micrometer:micrometer-registry-prometheus'

    implementation 'org.springdoc:springdoc-openapi-ui:1.6.6'
    
    // aws-s3 image
    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'

    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
    implementation 'io.lettuce:lettuce-core:6.1.5.RELEASE'


    implementation group: 'org.apache.poi', name: 'poi', version: '5.0.0' // xls
    implementation group: 'org.apache.poi', name: 'poi-ooxml', version: '5.0.0' // xlsx
    
    // websocket
    implementation 'org.springframework.boot:spring-boot-starter-websocket'
    implementation group: 'org.webjars', name: 'stomp-websocket', version: '2.3.3-1'

    // Mapper
    implementation 'org.mapstruct:mapstruct:1.5.3.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'

    //JUnit4 추가
    testImplementation("org.junit.vintage:junit-vintage-engine") {
        exclude group: "org.hamcrest", module: "hamcrest-core"
    }

    // Mail
    implementation "org.springframework.boot:spring-boot-starter-mail"

    // 소셜로그인
    implementation 'com.google.api-client:google-api-client:1.32.1'
    implementation 'com.google.oauth-client:google-oauth-client:1.32.1'
    implementation 'com.google.oauth-client:google-oauth-client-jetty:1.32.1'
    implementation 'com.google.http-client:google-http-client-jackson2:1.40.1'
    compileOnly('org.springframework.boot:spring-boot-starter-oauth2-client')
    implementation 'org.springframework.boot:spring-boot-starter'

    // 캐싱
    implementation 'org.springframework.boot:spring-boot-starter-cache'

    // queryDSL
    implementation 'com.querydsl:querydsl-jpa:5.0.0'
    implementation 'com.querydsl:querydsl-apt:5.0.0'

}

📌 Branch Strategy

Git Workflow

 1. local - feature에서 각자 기능 작업
 2. 작업 완료 후 local - dev 에 PR 후 Merge
 3. 이후 remote - develop 으로 PR
 4. 코드 리뷰 후 Confirm 받고 Merge
 5. remote - develop 에 Merge 될 때 마다 모든 팀원 remote - dev pull 받아 최신 상태 유지

Branch Name	설명
main	초기 세팅 존재
develop	로컬 develop merge 브랜치

📌 Commit Convention

[TAG] 메시지

태그 이름	설명
[CHORE]	코드 수정, 내부 파일 수정
[FEAT]	새로운 기능 구현
[ADD]	FEAT 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성
[HOTFIX]	issue나 QA에서 급한 버그 수정에 사용
[FIX]	버그, 오류 해결
[DEL]	쓸모 없는 코드 삭제
[DOCS]	README나 WIKI 등의 문서 개정
[CORRECT]	주로 문법의 오류나 타입의 변경, 이름 변경에 사용
[MOVE]	프로젝트 내 파일이나 코드의 이동
[RENAME]	파일 이름 변경이 있을 때 사용
[IMPROVE]	향상이 있을 때 사용
[REFACTOR]	전면 수정이 있을 때 사용

📌 Coding Convention

변수명

1. Camel Case 사용 ex) lowerCamelCase
2. 함수의 경우 동사+명사 사용 ex) getInformation()
3. flag로 사용 되는 변수는 조동사 + flag 종류로 구성 ex) isNum
4. 상수는 모두 대문자로 작성
5. list 이름 postList or postlist or posts → **posts**
6. 약어는 되도록 사용하지 않는다.

• 부득이하게 약어가 필요하다고 판단되는 경우 팀원과 상의를 거친다.

주석

한줄 주석은 // 를 사용한다.

  // 한줄 주석일 때
  /**
  * 여러줄
  * 주석일 때
  */

👩🏻‍💻 Developers