Skip to content

Commit

Permalink
[REFACT] 전반적인 API 리팩토링, 프로필 카드에 대한 찔러보기 요청 취소 API 기능 개발 (#166)
Browse files Browse the repository at this point in the history
* [REFACT] 탈퇴하지 않은 사용자에 대한 프로필 카드 리스트 조회 쿼리 메서드 구현

* [REFACT] 동네 인증 여부 유효성 검사 로직을 User 도메인으로 이동

* [REFACT] 주어진 좌표, 법정구역코드가 유효한 서비스 지역인지 검증하는 유효성 검사 메서드 리팩토링

* [REFACT] ProfileCard 도메인에 '찔러보기' 요청 증가, 감소 메서드 구현

* [REFACT] User 도메인에 찔러보기 요청 카운트 증가 메서드 구현

* [FEAT] senderId, receiverId를 이용해 ProfileCardLike 조회 메서드 구현

* [FEAT] 서비스 지역명 영어 네이밍 변경

* [FEAT] 회원가입한 사용자에 대한 프로필 카드 생성 요청 DTO 구현

* [FEAT] ProfileCard 관련 Custom Exception 클래스 구현

* [FEAT] ProfileCard에 대해 '찔러보기' 요청 취소 DTO 구현

* [FEAT] ProfileCard 도메인 관련 유효성 검사 로직 추가 및 리팩토링

* [FEAT] ProfileCardLike 도메인 관련 유효성 검사 로직 추가 및 리팩토링

* [FEAT] Project 도메인 관련 매칭 요청이 가능한 상태인지 유효성 검사 로직 구현

* [FEAT] ProjectJoinRequest 도메인 관련 매칭 요청이 가능한 상태인지 유효성 검사 로직 구현 및 리팩토링

* [REFACT] 사용자가 받은 '찔러보기' 요청 수 조회 메서드 네이밍 변경

* [REFACT] 메서드 네이밍 변경 및 불필요한 메서드 제거

* [REFACT] 불필요한 메서드 제거 및 네이밍 변경

* [REFACT] 오타 수정 및 빌더 패턴을 정적 팩토리 메서드로 대체

* [REFACT] 유효성 검사 관련 리팩토링 및 DDD 적용

* [REFACT] 프로필 카드 생성 로직 구현, DDD 적용으로 인한 불필요한 메서드 제거

* [REFACT] 메서드 네이밍 변경 및 DDD를 적용한 유효성 검사 관련 리팩토링

* [REFACT] 회원가입과 동시에 프로필 카드가 생성되도록 프로필 생성 로직 추가

* [FEAT] 400, 404 관련 에러코드 추가

* [FEAT] ProfileCard 관련 Swagger 오류 예시 클래스 작성

* [FEAT] 프로필 카드에 대한 찔러보기 요청 취소 API 구현

* [FEAT] 프로필 카드에 대한 찔러보기 요청 취소 API 관련 Swagger 작성, 에러코드와 에러 예시 작성

* [REFACT] 도메인의 유효성 검사 로직 위치 변경
  • Loading branch information
JIN-076 authored Feb 24, 2024
1 parent 3ce2748 commit 5086100
Show file tree
Hide file tree
Showing 29 changed files with 346 additions and 161 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

import io.oeid.mogakgo.common.base.CursorPaginationInfoReq;
import io.oeid.mogakgo.common.base.CursorPaginationResult;
import io.oeid.mogakgo.core.properties.swagger.error.SwaggerProfileCardErrorExamples;
import io.oeid.mogakgo.core.properties.swagger.error.SwaggerProfileCardLikeErrorExamples;
import io.oeid.mogakgo.core.properties.swagger.error.SwaggerUserErrorExamples;
import io.oeid.mogakgo.domain.profile.presentation.dto.req.UserProfileLikeCancelAPIReq;
import io.oeid.mogakgo.domain.profile.presentation.dto.req.UserProfileLikeCreateAPIReq;
import io.oeid.mogakgo.domain.profile.presentation.dto.res.UserProfileLikeAPIRes;
import io.oeid.mogakgo.domain.profile.presentation.dto.res.UserProfileLikeCreateAPIRes;
Expand Down Expand Up @@ -125,4 +127,33 @@ ResponseEntity<CursorPaginationResult<UserProfileLikeInfoAPIRes>> getProfileLike
@Parameter(description = "'찔러보기' 요청을 조회하는 사용자 ID", required = true) Long id,
@Parameter(hidden = true) CursorPaginationInfoReq pageable
);

@Operation(summary = "사용자의 '찔러보기' 요청 취소", description = "사용자가 자신이 보낸 '찔러보기' 요청을 취소할 때 사용하는 API")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "'찔러보기' 요청 취소 성공"),
@ApiResponse(responseCode = "400", description = "요청한 데이터가 유효하지 않음",
content = @Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class),
examples = {
@ExampleObject(name = "E040105", value = SwaggerProfileCardLikeErrorExamples.PROFILE_CARD_LIKE_NOT_EXIST),
@ExampleObject(name = "E040104", value = SwaggerProfileCardErrorExamples.PROFILE_CARD_LIKE_AMOUNT_IS_ZERO),
@ExampleObject(name = "E020107", value = SwaggerUserErrorExamples.USER_AVAILABLE_LIKE_COUNT_IS_ZERO),
@ExampleObject(name = "E020108", value = SwaggerUserErrorExamples.USER_AVAILABLE_LIKE_COUNT_IS_FULL)
}
)),
@ApiResponse(responseCode = "404", description = "요청한 데이터가 존재하지 않음",
content = @Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class),
examples = {
@ExampleObject(name = "E020301", value = SwaggerUserErrorExamples.USER_NOT_FOUND),
@ExampleObject(name = "E040301", value = SwaggerProfileCardLikeErrorExamples.PROFILE_CARD_NOT_FOUND)
}
)),
})
ResponseEntity<Void> cancel(
@Parameter(hidden = true) Long userId,
UserProfileLikeCancelAPIReq request
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package io.oeid.mogakgo.core.properties.swagger.error;

public class SwaggerProfileCardErrorExamples {

public static final String PROFILE_CARD_LIKE_AMOUNT_IS_ZERO = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E040104\",\"message\":\"해당 프로필 카드에 찔러보기 요청이 존재하지 않으므로 더 이상 차감할 수 없습니다.\"}";
private SwaggerProfileCardErrorExamples() {

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
public class SwaggerProfileCardLikeErrorExamples {

public static final String PROFILE_CARD_LIKE_ALREADY_EXIST = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E040102\",\"message\":\"이미 찔러보기 요청을 전송한 프로필 카드에 찔러보기 요청을 전송할 수 없습니다.\"}";
public static final String PROFILE_CARD_LIKE_NOT_EXIST = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E040105\",\"message\":\"해당 프로필 카드에 찔러보기 요청이 존재하지 않아 요청을 취소할 수 없습니다.\"}";
public static final String INVALID_PROFILE_CARD_LIKE_RECEIVER_INFO = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E040103\",\"message\":\"찔러보기 요청의 사용자가 존재하지 않습니다.\"}";
public static final String PROFILE_CARD_LIKE_FORBIDDEN_OPERATION = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":403,\"code\":\"E040103\",\"message\":\"본인의 프로필 카드 외에 대해 찔러보기 요청 권한이 없습니다.\"}";
public static final String PROFILE_CARD_NOT_FOUND = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":404,\"code\":\"E040301\",\"message\":\"해당 프로필 카드가 존재하지 않습니다.\"}";

private SwaggerProfileCardLikeErrorExamples() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ public class SwaggerUserErrorExamples {
public static final String USER_NOT_FOUND = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":404,\"code\":\"E020301\",\"message\":\"해당 유저가 존재하지 않습니다.\"}";
public static final String USER_WANTED_JOB_DUPLICATE = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E020105\",\"message\":\"중복된 희망 직무가 있습니다.\"}";
public static final String INVALID_USER_NAME = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E020103\",\"message\":\"유저 이름은 비어있을 수 없습니다.\"}";
public static final String USER_AVAILABLE_LIKE_COUNT_IS_ZERO = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E020107\",\"message\":\"당일 사용 가능한 찔러보기 요청을 모두 소진했습니다.\"}";
public static final String USER_AVAILABLE_LIKE_COUNT_IS_FULL = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E020108\",\"message\":\"당일 사용 가능한 찔러보기 최대 요청 횟수를 초과활 수 없습니다.\"}";

private SwaggerUserErrorExamples() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import io.oeid.mogakgo.domain.geo.domain.enums.Region;
import io.oeid.mogakgo.domain.geo.exception.GeoException;
import io.oeid.mogakgo.domain.user.application.UserCommonService;
import io.oeid.mogakgo.domain.user.application.UserGeoService;
import io.oeid.mogakgo.domain.user.domain.User;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
Expand All @@ -18,30 +17,22 @@
@RequiredArgsConstructor
public class CertService {

private final UserGeoService userGeoService;
private final UserCommonService userCommonService;

@Transactional
public Long certificate(Long tokenUserId, Long userId, int areaCode) {
User tokenUser = validateToken(tokenUserId);
validateCertificator(tokenUser, userId);
User user = validateToken(tokenUserId);
validateCertificator(user, userId);
Region region = validateAreaCodeCoverage(areaCode);
if (isPossibleCertification(userId, region)) {
userGeoService.updateUserGeo(userId, region);
}

user.updateRegion(region);
return userId;
}

private User validateToken(Long userId) {
return userCommonService.getUserById(userId);
}

// 사용자가 아직 동네 인증을 하지 않았거나, 새롭게 인증하려는 지역이 이미 인증된 지역과 다를 경우만 동네 인증 처리
private boolean isPossibleCertification(Long userId, Region region) {
Region userRegionInfo = userGeoService.getUserGeo(userId).getRegion();
return userRegionInfo == null || userRegionInfo != region;
}

private void validateCertificator(User tokenUser, Long userId) {
if (!tokenUser.getId().equals(userId)) {
throw new CertException(INVALID_CERT_INFORMATION);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,22 @@ public class GeoService {

public int getUserRegionInfoAboutCoordinates(Long tokenUserId, Double x, Double y) {
validateToken(tokenUserId);
validateCoordinates(x, y);
return validateCoordinatesCoverage(x, y);
return getRegionAboutCoordinates(x, y).getAreaCode();
}

public Region getRegionAboutCoordinates(Double x, Double y) {
// 해당 법정구역코드가 유효한 서비스 지역인지 검증
return validateAreaCodeCoverage(getAreaCodeAboutCoordinates(x, y));
}

public int getAreaCodeAboutCoordinates(Double x, Double y) {
// 해당 좌표가 유효한 서비스 지역 내 좌표인지 검증
validateAvailableCoordinates(x, y);
AddressDocument document = getAddressInfoAboutAreaCode(x, y);
return extractAreaCode(document);
}

public AddressDocument getAddressInfoAboutAreaCode(Double x, Double y) {
private AddressDocument getAddressInfoAboutAreaCode(Double x, Double y) {
String key = generateKey(kakaoProperties);
AddressInfoDto response = kakaoFeignClient.getAreaCodeAboutCoordinates(key, x, y);
return response.getDocuments()[0];
Expand All @@ -49,26 +55,22 @@ private int extractAreaCode(AddressDocument document) {
return Integer.parseInt(document.getCode().substring(0, 5));
}

private int validateCoordinatesCoverage(Double x, Double y) {
int areaCode = getAreaCodeAboutCoordinates(x, y);
validateCodeCoverage(areaCode);
return areaCode;
private void validateAvailableCoordinates(Double x, Double y) {
if (x < 123.0 || x > 132.0 || y < 32.0 || y > 39.0) {
throw new GeoException(INVALID_SERVICE_REGION);
}
}

private void validateCodeCoverage(int areaCode) {
if (Region.getByAreaCode(areaCode) == null) {
private Region validateAreaCodeCoverage(int areaCode) {
Region region = Region.getByAreaCode(areaCode);
if (region == null) {
throw new GeoException(INVALID_SERVICE_REGION);
}
return region;
}

private User validateToken(Long userId) {
return userCommonService.getUserById(userId);
}

private void validateCoordinates(Double x, Double y) {
if (x < 123.0 || x > 132.0 || y < 32.0 || y > 39.0) {
throw new GeoException(INVALID_SERVICE_REGION);
}
}

}
26 changes: 13 additions & 13 deletions src/main/java/io/oeid/mogakgo/domain/geo/domain/enums/Region.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@
@RequiredArgsConstructor
public enum Region {

JONGRO("서울특별시", "종로구", 11110),
JONGNO("서울특별시", "종로구", 11110),
JUNG("서울특별시", "중구", 11140),
YONGSAN("서울특별시", "용산구", 11170),
SEONGDONG("서울특별시", "성동구", 11200),
KWANGJIN("서울특별시", "광진구", 11215),
GWANGJIN("서울특별시", "광진구", 11215),
DONGDAEMUN("서울특별시", "동대문구", 11230),
JUNGRANG("서울특별시", "중랑구", 11260),
JUNGNANG("서울특별시", "중랑구", 11260),
SEONGBUK("서울특별시", "성북구", 11290),
KANGBUK("서울특별시", "강북구", 11305),
GANGBUK("서울특별시", "강북구", 11305),
DOBONG("서울특별시", "도봉구", 11320),
NOWON("서울특별시", "노원구", 11350),
EUNPYEONG("서울특별시", "은평구", 11380),
SEODAEMUN("서울특별시", "서대문구", 11410),
MAPO("서울특별시", "마포구", 11440),
YANGCHUN("서울특별시", "양천구", 11470),
KANGSEO("서울특별시", "강서구", 11500),
YANGCHEON("서울특별시", "양천구", 11470),
GANGSEO("서울특별시", "강서구", 11500),
GURO("서울특별시", "구로구", 11530),
GEUMCHUN("서울특별시", "금천구", 11545),
GEUMCHEON("서울특별시", "금천구", 11545),
YOUNGDEUNGPO("서울특별시", "영등포구", 11560),
DONGJAK("서울특별시", "동작구", 11590),
KWANAK("서울특별시", "관악구", 11620),
GWANAK("서울특별시", "관악구", 11620),
SEOCHO("서울특별시", "서초구", 11650),
KANGNAM("서울특별시", "강남구", 11680),
GANGNAM("서울특별시", "강남구", 11680),
SONGPA("서울특별시", "송파구", 11710),
KANGDONG("서울특별시", "강동구", 11740),
GANGDONG("서울특별시", "강동구", 11740),
BUNDANG("경기도 성남시", "분당구", 41135);

private final String depth1;
Expand All @@ -50,9 +50,9 @@ public static Region getByAreaCode(int areaCode) {

public static List<Region> getDefaultDensityRank() {
return List.of(
JONGRO, JUNG, YONGSAN, SEONGDONG, KWANGJIN, DONGDAEMUN, JUNGRANG, SEONGBUK, KANGBUK,
DOBONG, NOWON, EUNPYEONG, SEODAEMUN, MAPO, YANGCHUN, KANGSEO, GURO, GEUMCHUN,
YOUNGDEUNGPO, DONGJAK, KWANAK, SEOCHO, KANGNAM, SONGPA, KANGDONG
JONGNO, JUNG, YONGSAN, SEONGDONG, GWANGJIN, DONGDAEMUN, JUNGNANG, SEONGBUK, GANGBUK,
DOBONG, NOWON, EUNPYEONG, SEODAEMUN, MAPO, YANGCHEON, GANGSEO, GURO, GEUMCHEON,
YOUNGDEUNGPO, DONGJAK, GWANAK, SEOCHO, GANGNAM, SONGPA, GANGDONG
);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
package io.oeid.mogakgo.domain.profile.application;

import static io.oeid.mogakgo.exception.code.ErrorCode400.PROFILE_CARD_LIKE_ALREADY_EXIST;
import static io.oeid.mogakgo.exception.code.ErrorCode400.PROFILE_CARD_LIKE_NOT_EXIST;
import static io.oeid.mogakgo.exception.code.ErrorCode403.PROFILE_CARD_LIKE_FORBIDDEN_OPERATION;
import static io.oeid.mogakgo.exception.code.ErrorCode404.PROFILE_CARD_NOT_FOUND;

import io.oeid.mogakgo.common.base.CursorPaginationInfoReq;
import io.oeid.mogakgo.common.base.CursorPaginationResult;
import io.oeid.mogakgo.domain.profile.domain.entity.ProfileCard;
import io.oeid.mogakgo.domain.profile.domain.entity.ProfileCardLike;
import io.oeid.mogakgo.domain.profile.exception.ProfileCardLikeException;
import io.oeid.mogakgo.domain.profile.infrastructure.ProfileCardJpaRepository;
import io.oeid.mogakgo.domain.profile.infrastructure.ProfileCardLikeJpaRepository;
import io.oeid.mogakgo.domain.profile.presentation.dto.req.UserProfileLikeCancelAPIReq;
import io.oeid.mogakgo.domain.profile.presentation.dto.req.UserProfileLikeCreateAPIReq;
import io.oeid.mogakgo.domain.profile.presentation.dto.res.UserProfileLikeInfoAPIRes;
import io.oeid.mogakgo.domain.user.application.UserCommonService;
import io.oeid.mogakgo.domain.user.application.UserProfileService;
import io.oeid.mogakgo.domain.user.domain.User;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
Expand All @@ -23,68 +27,93 @@
public class ProfileCardLikeService {

private final ProfileCardLikeJpaRepository profileCardLikeRepository;
private final ProfileCardService profileCardService;
private final ProfileCardJpaRepository profileCardRepository;
private final UserCommonService userCommonService;
private final UserProfileService userProfileService;

@Transactional
public Long create(Long userId, UserProfileLikeCreateAPIReq request) {
User tokenUser = validateToken(userId);
validateSendor(tokenUser, request.getSenderId());
validateReceiver(userId);
validateLikeAlreadyExist(request.getSenderId(), request.getReceiverId());
User user = validateToken(userId);

User receiver = userCommonService.getUserById(request.getReceiverId());
ProfileCardLike profileCardLike = request.toEntity(tokenUser, receiver);
profileCardLikeRepository.save(profileCardLike);
ProfileCard profileCard = validateProfileCardExist(request.getReceiverId());

if (hasAlreadyExist(userId, request.getReceiverId())) {
throw new ProfileCardLikeException(PROFILE_CARD_LIKE_ALREADY_EXIST);
}

profileCardService.increaseTotalLikeAmount(receiver.getId());
userProfileService.decreaseAvailableLikeCount(userId);
profileCard.increaseLikeAmount();
user.decreaseAvailableLikeCount();

// 프로필 카드에 '찔러보기' 요청 생성
ProfileCardLike profileCardLike = request.toEntity(user, profileCard.getUser());
profileCardLikeRepository.save(profileCardLike);

return profileCardLike.getId();
}

@Transactional
public void cancel(Long userId, UserProfileLikeCancelAPIReq request) {
User user = validateToken(userId);
validateSender(user, request.getSenderId());

ProfileCard profileCard = validateProfileCardExist(request.getReceiverId());

if (!hasAlreadyExist(userId, request.getReceiverId())) {
throw new ProfileCardLikeException(PROFILE_CARD_LIKE_NOT_EXIST);
}

profileCard.decreaseLikeAmount();
user.increaseAvailableLikeCount();

// 프로필 카드에 '찔러보기' 요청 취소
ProfileCardLike profileCardLike = getBySenderAndReceiver(userId, request.getReceiverId());
profileCardLikeRepository.delete(profileCardLike);
}

// 나의 찔러보기 요청 수 조회
public Long getReceivedLikeCountForProfileCard(Long userId, Long id) {
User tokenUser = validateToken(userId);
validateSendor(tokenUser, userId);
validateSender(tokenUser, userId);

return profileCardLikeRepository.getLikeCount(id);
return profileCardLikeRepository.getReceivedLikeCount(id);
}

// 내가 보낸 찔러보기 요청 수 조회
public Long getSentLikeCountForProfileCard(Long userId, Long id) {
User tokenUser = validateToken(userId);
validateSendor(tokenUser, userId);
validateSender(tokenUser, userId);

return profileCardLikeRepository.getLikeCountByCondition(id, null);
}

public CursorPaginationResult<UserProfileLikeInfoAPIRes> getLikeInfoSenderProfile(
Long userId, Long id, CursorPaginationInfoReq pageable) {
User tokenUser = validateToken(userId);
validateSendor(tokenUser, userId);
validateSender(tokenUser, userId);

return profileCardLikeRepository.getLikeInfoBySender(id, pageable);
}

private ProfileCardLike getBySenderAndReceiver(Long senderId, Long receiverId) {
return profileCardLikeRepository.findBySenderAndReceiver(senderId, receiverId)
.orElseThrow(() -> new ProfileCardLikeException(PROFILE_CARD_LIKE_NOT_EXIST));
}

private User validateToken(Long userId) {
return userCommonService.getUserById(userId);
}

private void validateSendor(User tokenUser, Long userId) {
private void validateSender(User tokenUser, Long userId) {
if (!tokenUser.getId().equals(userId)) {
throw new ProfileCardLikeException(PROFILE_CARD_LIKE_FORBIDDEN_OPERATION);
}
}

private void validateReceiver(Long userId) {
userCommonService.getUserById(userId);
private ProfileCard validateProfileCardExist(Long receiverId) {
return profileCardRepository.findByUserId(receiverId)
.orElseThrow(() -> new ProfileCardLikeException(PROFILE_CARD_NOT_FOUND));
}

private void validateLikeAlreadyExist(Long userId, Long creatorId) {
if (profileCardLikeRepository.findBySenderAndReceiver(userId, creatorId).isPresent()) {
throw new ProfileCardLikeException(PROFILE_CARD_LIKE_ALREADY_EXIST);
}
private boolean hasAlreadyExist(Long userId, Long creatorId) {
return profileCardLikeRepository.findBySenderAndReceiver(userId, creatorId).isPresent();
}
}
Loading

0 comments on commit 5086100

Please sign in to comment.