[BE] 핀(Pin) 패키지 코드 리팩터링(PinImage 기능 구현 포함)

backend/src/docs/asciidoc/pin.adoc

@@ -19,3 +19,10 @@ operation::pin-controller-test/update[snippets='http-request,http-response']
 === 핀 삭제
 
 operation::pin-controller-test/delete[snippets='http-request,http-response']
+
+=== 핀 이미지 추가
+
+operation::pin-controller-test/add-image[snippets='http-request,http-response']
+
+=== 핀 이미지 삭제
+operation::pin-controller-test/remove-image[snippets='http-request,http-response']

backend/src/main/java/com/mapbefine/mapbefine/auth/domain/AuthMember.java

@@ -30,4 +30,5 @@ protected AuthMember(
     public Long getMemberId() {
         return memberId;
     }
+
 }

backend/src/main/java/com/mapbefine/mapbefine/location/domain/Location.java

@@ -71,4 +71,12 @@ public double getLongitude() {
         return coordinate.getLongitude();
     }
 
+    public String getRoadBaseAddress() {
+        return address.getRoadBaseAddress();
+    }
+
+    public String getLegalDongCode() {
+        return address.getLegalDongCode();
+    }
+
 }

backend/src/main/java/com/mapbefine/mapbefine/pin/application/PinCommandService.java

@@ -9,63 +9,86 @@
 import com.mapbefine.mapbefine.member.domain.MemberRepository;
 import com.mapbefine.mapbefine.pin.domain.Pin;
 import com.mapbefine.mapbefine.pin.domain.PinImage;
+import com.mapbefine.mapbefine.pin.domain.PinImageRepository;
 import com.mapbefine.mapbefine.pin.domain.PinRepository;
 import com.mapbefine.mapbefine.pin.dto.request.PinCreateRequest;
+import com.mapbefine.mapbefine.pin.dto.request.PinImageCreateRequest;
 import com.mapbefine.mapbefine.pin.dto.request.PinUpdateRequest;
 import com.mapbefine.mapbefine.topic.domain.Topic;
 import com.mapbefine.mapbefine.topic.domain.TopicRepository;
 import java.util.NoSuchElementException;
+import java.util.Objects;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
 @Transactional
 @Service
 public class PinCommandService {
 
+    private static final double DUPLICATE_LOCATION_DISTANCE_METERS = 10.0;
+
     private final PinRepository pinRepository;
     private final LocationRepository locationRepository;
     private final TopicRepository topicRepository;
     private final MemberRepository memberRepository;
+    private final PinImageRepository pinImageRepository;
 
     public PinCommandService(
             PinRepository pinRepository,
             LocationRepository locationRepository,
             TopicRepository topicRepository,
-            MemberRepository memberRepository
+            MemberRepository memberRepository,
+            PinImageRepository pinImageRepository
     ) {
         this.pinRepository = pinRepository;
         this.locationRepository = locationRepository;
         this.topicRepository = topicRepository;
         this.memberRepository = memberRepository;
+        this.pinImageRepository = pinImageRepository;
     }
 
-    public Long save(AuthMember authMember, PinCreateRequest request) {
-        Coordinate coordinate = Coordinate.of(request.latitude(), request.longitude());
-        Topic topic = topicRepository.findById(request.topicId())
-                .orElseThrow(NoSuchElementException::new);
-        Member member = memberRepository.findById(authMember.getMemberId())
-                .orElseThrow(NoSuchElementException::new);
-        authMember.canPinCreateOrUpdate(topic);
-
-        Location pinLocation = locationRepository.findAllByCoordinateAndDistanceInMeters(
-                        coordinate, 10.0).stream()
-                .filter(location -> location.isSameAddress(request.address()))
-                .findFirst()
-                .orElseGet(() -> saveLocation(request, coordinate));
 
+    public long save(AuthMember authMember, PinCreateRequest request) {
+        Topic topic = findTopic(request.topicId());
+        validatePinCreateOrUpdate(authMember, topic);
+
+        Member member = findMember(authMember.getMemberId());
         Pin pin = Pin.createPinAssociatedWithLocationAndTopicAndMember(
                 request.name(),
                 request.description(),
-                pinLocation,
+                findDuplicateOrCreatePinLocation(request),
                 topic,
                 member
         );
+        pinRepository.save(pin);
+
+        return pin.getId();
+    }
+
+    private Topic findTopic(Long topicId) {
+        if (Objects.isNull(topicId)) {
+            throw new NoSuchElementException("토픽을 찾을 수 없습니다.");
+        }
+        return topicRepository.findById(topicId)
+                .orElseThrow(() -> new NoSuchElementException("토픽을 찾을 수 없습니다."));
+    }
 
-        for (String pinImage : request.images()) {
-            PinImage.createPinImageAssociatedWithPin(pinImage, pin);
+    private Member findMember(Long memberId) {
+        if (Objects.isNull(memberId)) {
+            throw new NoSuchElementException("회원 정보를 찾을 수 없습니다.");
         }
+        return memberRepository.findById(memberId)
+                .orElseThrow(() -> new NoSuchElementException("회원 정보를 찾을 수 없습니다."));
+    }
+
+    private Location findDuplicateOrCreatePinLocation(PinCreateRequest request) {
+        Coordinate coordinate = Coordinate.of(request.latitude(), request.longitude());
 
-        return pinRepository.save(pin).getId();
+        return locationRepository.findAllByCoordinateAndDistanceInMeters(coordinate, DUPLICATE_LOCATION_DISTANCE_METERS)
+                .stream()
+                .filter(location -> location.isSameAddress(request.address()))
+                .findFirst()
+                .orElseGet(() -> saveLocation(request, coordinate));
     }
 
     private Location saveLocation(PinCreateRequest pinCreateRequest, Coordinate coordinate) {
@@ -74,31 +97,61 @@ private Location saveLocation(PinCreateRequest pinCreateRequest, Coordinate coor
                 pinCreateRequest.address(),
                 pinCreateRequest.legalDongCode()
         );
-
         Location location = new Location(address, coordinate);
 
         return locationRepository.save(location);
     }
 
     public void update(
-            AuthMember member,
+            AuthMember authMember,
             Long pinId,
             PinUpdateRequest request
     ) {
-        Pin pin = pinRepository.findById(pinId)
-                .orElseThrow(NoSuchElementException::new);
-        member.canPinCreateOrUpdate(pin.getTopic());
+        Pin pin = findPin(pinId);
+        validatePinCreateOrUpdate(authMember, pin.getTopic());
 
         pin.updatePinInfo(request.name(), request.description());
+    }
 
-        pinRepository.save(pin);
+    private Pin findPin(Long pinId) {
+        return pinRepository.findById(pinId)
+                .orElseThrow(() -> new NoSuchElementException("존재하지 않는 핀입니다."));
     }
 
-    public void removeById(AuthMember member, Long pinId) {
-        Pin pin = pinRepository.findById(pinId)
-                .orElseThrow(NoSuchElementException::new);
-        member.canDelete(pin.getTopic());
+    public void removeById(AuthMember authMember, Long pinId) {
+        Pin pin = findPin(pinId);
+        validatePinCreateOrUpdate(authMember, pin.getTopic());
+
         pinRepository.deleteById(pinId);
+        pinImageRepository.deleteAllByPinId(pinId);
+    }
+
+    public void addImage(AuthMember authMember, PinImageCreateRequest request) {
+        Pin pin = findPin(request.pinId());
+        validatePinCreateOrUpdate(authMember, pin.getTopic());
+
+        PinImage pinImage = PinImage.createPinImageAssociatedWithPin(request.imageUrl(), pin);
+        pinImageRepository.save(pinImage);
+    }
+
+    public void removeImageById(AuthMember authMember, Long pinImageId) {
+        PinImage pinImage = findPinImage(pinImageId);
+        Pin pin = pinImage.getPin();
+        validatePinCreateOrUpdate(authMember, pin.getTopic());
+
+        pinImageRepository.deleteById(pinImageId);
+    }
+
+    private PinImage findPinImage(Long pinImageId) {
+        return pinImageRepository.findById(pinImageId)
+                .orElseThrow(() -> new NoSuchElementException("존재하지 않는 핀 이미지입니다."));
     }
 
+    private void validatePinCreateOrUpdate(AuthMember authMember, Topic topic) {
+        if (authMember.canPinCreateOrUpdate(topic)) {
+            return;
+        }
+
+        throw new IllegalArgumentException("핀 생성 및 수정 권한이 없습니다.");
+    }
 }

backend/src/main/java/com/mapbefine/mapbefine/pin/application/PinQueryService.java

@@ -5,6 +5,7 @@
 import com.mapbefine.mapbefine.pin.domain.PinRepository;
 import com.mapbefine.mapbefine.pin.dto.response.PinDetailResponse;
 import com.mapbefine.mapbefine.pin.dto.response.PinResponse;
+import com.mapbefine.mapbefine.topic.domain.Topic;
 import java.util.List;
 import java.util.NoSuchElementException;
 import org.springframework.stereotype.Service;
@@ -13,26 +14,37 @@
 @Transactional(readOnly = true)
 @Service
 public class PinQueryService {
+
     private final PinRepository pinRepository;
 
     public PinQueryService(PinRepository pinRepository) {
         this.pinRepository = pinRepository;
     }
 
-    public List<PinResponse> findAll(AuthMember member) {
+    // TODO: 2023/08/08 isDeleted 제외하고 조회하기
+    public List<PinResponse> findAllReadable(AuthMember member) {
         return pinRepository.findAll()
                 .stream()
                 .filter(pin -> member.canRead(pin.getTopic()))
                 .map(PinResponse::from)
                 .toList();
     }
 
-    public PinDetailResponse findById(AuthMember member, Long pinId) {
+    // TODO: 2023/08/08 isDeleted 제외하고 조회하기
+    public PinDetailResponse findDetailById(AuthMember member, Long pinId) {
         Pin pin = pinRepository.findById(pinId)
-                .filter(optionalPin -> member.canRead(optionalPin.getTopic()))
-                .orElseThrow(NoSuchElementException::new);
+                .orElseThrow(() -> new NoSuchElementException("존재하지 않는 핀입니다."));
+        validateReadAuth(member, pin.getTopic());
 
         return PinDetailResponse.from(pin);
     }
 
+    private void validateReadAuth(AuthMember member, Topic topic) {
+        if (member.canRead(topic)) {
+            return;
+        }
+
+        throw new IllegalArgumentException("조회 권한이 없습니다.");
+    }
+
 }

backend/src/main/java/com/mapbefine/mapbefine/pin/domain/Pin.java

@@ -35,13 +35,6 @@ public class Pin extends BaseTimeEntity {
     @Embedded
     private PinInfo pinInfo;
 
-    @ManyToOne
-    @JoinColumn(name = "member_id")
-    private Member creator;
-
-    @OneToMany(mappedBy = "pin", cascade = CascadeType.PERSIST)
-    private List<PinImage> pinImages = new ArrayList<>();
-
     @ManyToOne
     @JoinColumn(name = "location_id", nullable = false)
     private Location location;
@@ -50,10 +43,17 @@ public class Pin extends BaseTimeEntity {
     @JoinColumn(name = "topic_id", nullable = false)
     private Topic topic;
 
+    @ManyToOne
+    @JoinColumn(name = "member_id")
+    private Member creator;
+
     @Column(nullable = false)
     @ColumnDefault(value = "false")
     private boolean isDeleted = false;
 
+    @OneToMany(mappedBy = "pin", cascade = CascadeType.PERSIST)
+    private List<PinImage> pinImages = new ArrayList<>();
+
     private Pin(
             PinInfo pinInfo,
             Location location,
@@ -73,33 +73,40 @@ public static Pin createPinAssociatedWithLocationAndTopicAndMember(
             Topic topic,
             Member creator
     ) {
-        PinInfo pinInfo = PinInfo.of(name, description);
-
         Pin pin = new Pin(
-                pinInfo,
+                PinInfo.of(name, description),
                 location,
                 topic,
                 creator
         );
-
         location.addPin(pin);
         topic.addPin(pin);
         creator.addPin(pin);
+
         return pin;
     }
 
     public void updatePinInfo(String name, String description) {
-        pinInfo.update(name, description);
+        pinInfo = PinInfo.of(name, description);
     }
 
     public Pin copy(Topic topic, Member creator) {
-        return Pin.createPinAssociatedWithLocationAndTopicAndMember(
+        Pin copy = Pin.createPinAssociatedWithLocationAndTopicAndMember(
                 pinInfo.getName(),
                 pinInfo.getDescription(),
                 location,
                 topic,
                 creator
         );
+        copyPinImages(copy);
+
+        return copy;
+    }
+
+    private void copyPinImages(Pin pin) {
+        for (PinImage pinImage : pinImages) {
+            PinImage.createPinImageAssociatedWithPin(pinImage.getImageUrl(), pin);
+        }
     }
 
     public void addPinImage(PinImage pinImage) {

backend/src/main/java/com/mapbefine/mapbefine/pin/domain/PinImage.java

@@ -1,6 +1,8 @@
 package com.mapbefine.mapbefine.pin.domain;
 
+import com.mapbefine.mapbefine.common.entity.BaseTimeEntity;
 import com.mapbefine.mapbefine.common.entity.Image;
+import jakarta.persistence.Column;
 import jakarta.persistence.Embedded;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
@@ -11,11 +13,12 @@
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import org.hibernate.annotations.ColumnDefault;
 
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
-public class PinImage {
+public class PinImage extends BaseTimeEntity {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
@@ -28,7 +31,10 @@ public class PinImage {
     @JoinColumn(name = "pin_id")
     private Pin pin;
 
-
+    @Column(nullable = false)
+    @ColumnDefault(value = "false")
+    private boolean isDeleted = false;
+
     private PinImage(Image image, Pin pin) {
         this.image = image;
         this.pin = pin;
@@ -41,4 +47,8 @@ public static PinImage createPinImageAssociatedWithPin(String imageUrl, Pin pin)
         return pinImage;
     }
 
+    public String getImageUrl() {
+        return image.getImageUrl();
+    }
+
 }