TTOTTOGA-PROJECT

서비스 설명

서비스 이용 가이드

팀원 구성

제이드/김광현

로빈/김여원

루아/오남의

허찬영/허찬영

1. Stack Info

JAVA 17
SpringBoot 3.2.1
Build Tool Gradle 0 groovy

Dependencies

Spring Web, H2(로컬용), JPA, Lombok, MySql

2. 브랜치 전략

master는 언제든지 배포가 가능한 상태(릴리즈)
새로운 프로젝트는 develop을 기반으로 별도 feature 브랜치를 생성하여 작업을 진행함
브랜치는 로컬에 commit하고, 정기적으로 원격 브랜치에 push함
피드백이나 도움이 필요하거나,코드 병합 할 준비가 되었다면 pull request를 만듬
다른사람이 변경된 코드를 검토 한 뒤 승인하면 master에 병합함
병합된 master는 즉시 배포할 수 있으며, 배포 해야만 함

3. 커밋 컨벤션

출처 : https://puleugo.tistory.com/165

예시(깃모지 사용)

4. 코드 컨벤션

🐫 함수명, 변수명은 카멜케이스로 작성합니다.

for문 / if문은 다음과 같이 기입합니다. (한 칸 띄어쓰기)

List<HouseResponseDto> houseResponseDtoList = new ArrayList<>();
        for (House house : findHouses) {
            List<Review> reviewList = reviewRepository.findAllByHouse(house);
            if (reviewList.size() == 0) {
                houseResponseDtoList.add(HouseResponseDto.of(house, 0, 0));
                continue;
            }

Optional<CardLike> cardLike = cardLikeRepository.findByCardIdAndUserId(id, user.getId());
        if(cardLike.isEmpty()) {
            cardLikeRepository.saveAndFlush(CardLike.of(card.get(), user));
            return ResponseEntity.ok().body(MessageResponseDto.of("좋아요 추가", HttpStatus.OK));
        } else{
            cardLikeRepository.delete(cardLike.get());
            return ResponseEntity.ok().body(MessageResponseDto.of("좋아요 취소", HttpStatus.OK));
        }

주석 예시

// 댓글 수정
@Transactional
    public ResponseEntity updateComment(Long id, CommentRequestDto commentRequestDto, User user){

        // 해당 id의 댓글이 DB에 있는지 확인
        Optional<Comment> comment = commentRepository.findById(id);
        if (comment.isEmpty()) {
            throw new IllegalArgumentException("해당 댓글이 존재하지 않습니다.");
        }

연산자 사이에는 공백을 추가하여 가독성 높이기

a+b+c+d // bad
a + b + c + d // good

콤마 다음에 값이 올 경우 공백을 추가하여 가독성을 높입니다.

int[] num = {1,2,3,4,5,6,7,8,9}; //bad
int[] num = {1, 2, 3, 4, 5, 6, 7, 8, 9}; //good

Refactoring 이후 추가된 부분

1️⃣ 클래스명 뒤에는 한 칸 띄어쓰기, 위에 첫 줄 띄어쓰기 아래는 한 줄 띄어쓰기

public class AdminController {
                                                                               
    private final AdminService adminService;

    @Operation(summary = "회원가입 API", description = "회원을 등록합니다.")
    @ResponseStatus(value = HttpStatus.OK)
    @Secured(PositionEnum.Authority.ADMIN)
    @PostMapping("/signup")
    public SuccessResponse signup(@Valid @RequestBody SignupRequestDto signupRequestDto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
        return adminService.signup(signupRequestDto, userDetails.getMember());
    }
                                                                             
}

2️⃣ import 해서 쓸 때는 줄 띄어쓰기 (X)

private final PostRepository postRepository;
private final CategoryRepository categoryRepository;
private final KeywordRepository keywordRepository;
private final EmitterRepository emitterRepository;

3️⃣ 변수 선언 다음 메소드 오면 줄바꿈 해 주세요.

Optional<Post> findPost = postRepository.findById(id);
                                                                             
        if (findPost.isEmpty()) {
            throw new IllegalArgumentException("해당 게시글이 없습니다.");
        } else if (member.getPosition().getNum() < findPost.get().getModifyPermission().getNum()) {
            throw new IllegalArgumentException("수정 가능한 회원 등급이 아닙니다.");
        }

4️⃣ else if는 앞에만 띄어쓰기 해 주세요.

if(post.isEmpty()) {
            throw new IllegalArgumentException("해당 게시글이 없습니다.");
        } else if(member.getPosition().getNum() < post.get().getReadablePosition().getNum()){
            throw new IllegalArgumentException("읽기 가능한 회원 등급이 아닙니다.");
        }

5️⃣ “}” 사이의 return문은 띄어쓰기를 해 주세요.

	  }
                                                                         
    return key.toString();
}

6️⃣ 메서드 명과 다음 줄은 띄어쓰기 해 주세요.

@Transactional
    public SuccessResponse createBookMarkFolder(String folderName, Member member){
                                                                                          
        Optional<Member> findMember = memberRepository.findById(member.getId());
		...
		}

5. 프로젝트 구조

ttg
    ├── TtgApplication.java
    ├── domain
    │   ├── coupon
    │   │   ├── api
    │   │   │   └── CouponController.java
    │   │   ├── application
    │   │   │   ├── CouponService.java
    │   │   │   └── CouponServiceImpl.java
    │   │   ├── dto
    │   │   │   ├── CouponResponseDto.java
    │   │   │   ├── MyPageCouponResponseDTO.java
    │   │   │   └── converter
    │   │   │       └── CouponConverter.java
    │   │   ├── entity
    │   │   │   └── Coupon.java
    │   │   ├── exception
    │   │   │   └── handler
    │   │   │       └── CouponHandler.java
    │   │   ├── repository
    │   │   │   └── CouponRepository.java
    │   │   └── utils
    │   │       ├── BitMatrixToMultipartFileConverter.java
    │   │       ├── CustomMultipartFile.java
    │   │       └── QrCodeGenerator.java
    │   ├── member
    │   │   ├── api
    │   │   │   └── MemberController.java
    │   │   ├── application
    │   │   │   ├── MemberCommandService.java
    │   │   │   ├── MemberCommandServiceImpl.java
    │   │   │   ├── MemberQueryService.java
    │   │   │   ├── MemberQueryServiceImpl.java
    │   │   │   ├── MemberService.java
    │   │   │   ├── MemberServiceImpl.java
    │   │   │   └── OAuth2MemberServiceImpl.java
    │   │   ├── dto
    │   │   │   ├── MemberImageRequestDTO.java
    │   │   │   ├── MemberImageResponseDTO.java
    │   │   │   ├── MyPageAllResponseDto.java
    │   │   │   ├── MyPageMemberResponseDTO.java
    │   │   │   └── converter
    │   │   │       └── MemberConverter.java
    │   │   ├── entity
    │   │   │   ├── CustomOAuth2Member.java
    │   │   │   ├── HeartStore.java
    │   │   │   └── Member.java
    │   │   ├── exception
    │   │   │   └── handler
    │   │   │       └── MemberHandler.java
    │   │   └── repository
    │   │       ├── HeartStoreRepository.java
    │   │       └── MemberRepository.java
    │   ├── review
    │   │   ├── api
    │   │   │   └── ReviewController.java
    │   │   ├── application
    │   │   │   ├── ReviewCommandService.java
    │   │   │   └── ReviewCommandServiceImpl.java
    │   │   ├── dto
    │   │   │   ├── MyPageReviewResponseDTO.java
    │   │   │   ├── ReviewRegisterRequestDTO.java
    │   │   │   └── ReviewRegisterResponseDTO.java
    │   │   ├── entity
    │   │   │   ├── Review.java
    │   │   │   └── ReviewStatus.java
    │   │   ├── exception
    │   │   │   └── handler
    │   │   │       └── ReviewHandler.java
    │   │   └── repository
    │   │       └── ReviewRepository.java
    │   └── store
    │       ├── api
    │       │   └── StoreController.java
    │       ├── application
    │       │   ├── StoreCommandService.java
    │       │   ├── StoreCommandServiceImpl.java
    │       │   ├── StoreQueryService.java
    │       │   └── StoreQueryServiceImpl.java
    │       ├── dto
    │       │   ├── HeartStoreResponseDto.java
    │       │   ├── HomeResponseDto.java
    │       │   ├── MyPageStoreResponseDto.java
    │       │   ├── StoreFindResponseDto.java
    │       │   ├── StoreRequestDto.java
    │       │   ├── StoreResponseDto.java
    │       │   ├── StoreResultResponseDto.java
    │       │   └── converter
    │       │       └── StoreConverter.java
    │       ├── entity
    │       │   ├── Menu.java
    │       │   ├── Region.java
    │       │   └── Store.java
    │       ├── exception
    │       │   └── handler
    │       │       └── StoreHandler.java
    │       └── repository
    │           ├── MenuRepository.java
    │           ├── RegionRepository.java
    │           └── StoreRepository.java
    └── global
        ├── auth
        │   ├── WebSecurityConfiguration.java
        │   ├── dto
        │   │   ├── KakaoAccessTokenInfoResponseDto.java
        │   │   └── NaverAccessTokenInfoResponseDto.java
        │   ├── handler
        │   │   └── OAuth2SuccessHandler.java
        │   └── jwt
        │       ├── JwtAuthenticationFilter.java
        │       ├── JwtProvider.java
        │       └── TokenParser.java
        ├── common
        │   ├── AwsS3.java
        │   ├── BaseResponseDto.java
        │   └── ResponseCode.java
        ├── config
        │   └── AwsS3Config.java
        ├── error
        │   ├── GeneralException.java
        │   └── handler
        │       ├── AwsS3Handler.java
        │       └── MasterExceptionHandler.java
        ├── infra
        │   └── infra.java
        └── util
            ├── AwsS3Service.java
            └── Time.java

Name		Name	Last commit message	Last commit date
Latest commit History 228 Commits
gradle/wrapper		gradle/wrapper
src		src
.gitignore		.gitignore
README.md		README.md
build.gradle		build.gradle
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

TTOTTOGA-PROJECT

서비스 설명

서비스 이용 가이드

팀원 구성

제이드/김광현

로빈/김여원

루아/오남의

허찬영/허찬영

1. Stack Info

Dependencies

2. 브랜치 전략

3. 커밋 컨벤션

예시(깃모지 사용)

4. 코드 컨벤션

🐫 함수명, 변수명은 카멜케이스로 작성합니다.

for문 / if문은 다음과 같이 기입합니다. (한 칸 띄어쓰기)

주석 예시

연산자 사이에는 공백을 추가하여 가독성 높이기

콤마 다음에 값이 올 경우 공백을 추가하여 가독성을 높입니다.

Refactoring 이후 추가된 부분

5. 프로젝트 구조

About

Releases

Packages

Contributors

Languages

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

TTOTTOGA-PROJECT

서비스 설명

서비스 이용 가이드

팀원 구성

제이드/김광현

로빈/김여원

루아/오남의

허찬영/허찬영

1. Stack Info

Dependencies

2. 브랜치 전략

3. 커밋 컨벤션

예시(깃모지 사용)

4. 코드 컨벤션

🐫 함수명, 변수명은 카멜케이스로 작성합니다.

for문 / if문은 다음과 같이 기입합니다. (한 칸 띄어쓰기)

주석 예시

연산자 사이에는 공백을 추가하여 가독성 높이기

콤마 다음에 값이 올 경우 공백을 추가하여 가독성을 높입니다.

Refactoring 이후 추가된 부분

5. 프로젝트 구조

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages