[Spring] 좋아요 기능 구현

개발 환경

• Window
• SpringBoot 3.6.3
• MySQL
• JPA
• Elasticsearch 7.15.2

❗주의 : 이 게시글은 JPA + Spring Data Elastic 조합으로 User와 Heart정보는 MySQL에, 흔히 게시글로 구현하는 ‘Campagin’은 Elasticsearch에 있기 때문에 해당 Campagin(게시글) 테이블에 하트를 +1, -1 하는 로직은 없습니다. 대신 다른 방법을 소개합니다.

📌 시나리오

• 로그인 한 상태에서 유저가 좋아요 누르면 좋아요 정보 저장됨.
  • 해당 좋아요 (글 id + 유저 id) 레코드가 하나 생김
• 유저가 좋아요를 한번 더 누르면 좋아요가 취소됨.
  • 위에서 만들어진 레코드 삭제됨

ERD

📌 Entity

일단 유저 엔티티가 있어야 합니다. 원본 코드엔 권한(authority) 외 다른 잡다한 정보들이 있는데 좋아요 기능 구현하는 데에는 필요 없기 때문에 이 글에선 제외했습니다.

참고로 귀찮아서 MySQL에 테이블을 먼저 만들지 않고 엔티티 구현한 뒤에

application.yml

hibernate:
    ddl-auto: create-drop

옵션 이용해 테이블 자동생성하여 사용했습니다!

📄 User.java

@Getter
@Setter
@Builder
@Entity
@Table(name = "user")
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @Id
    private String id;

    @Column
    private String email;

    @Column
    private String password;

    @Column
    private String nickname;

    @Column(columnDefinition = "TIMESTAMP DEFAULT CURRENT_TIMESTAMP")
    private LocalDateTime create_date;

    @Column(columnDefinition = "TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP")
    private LocalDateTime modify_date;

    @OneToMany(
            mappedBy = "user",
            cascade = CascadeType.ALL,
            orphanRemoval = true,
            fetch = FetchType.LAZY)
    private List<Heart> hearts;
}

• cascade = CascadeType.ALL 옵션으로 User가 삭제될때 연관된 엔티티인 Heart도 같이 삭제되도록 설정해줍니다.

📄 Heart.java

@Entity
@Table(name = "heart")
@Getter
@Setter
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Heart {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    @Column(name = "campaign_id")
    @NonNull
    private String campaignId;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id")
    private User user;
}

• ‘좋아요’면서 like가 아니라 왜 heart냐 하실텐데 like가 MySQL의 예약어라 안됩니다.

📌 Dto

📄 HeartDto.java

@Getter
@Setter
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class HeartDto {
    private String campaignId;
    private String userId;
}

📌 Controller

📄 HeartController.java

@Slf4j
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/heart")
public class Heartcontroller {

    private final HeartService heartService;

    @PostMapping
    public ResponseEntity<HeartDto> heart(@RequestBody @Valid HeartDto heartDto) {
        heartService.heart(heartDto);
        return new ResponseEntity<>(heartDto, HttpStatus.CREATED);
    }

    @DeleteMapping
    public ResponseEntity<HeartDto> unHeart(@RequestBody @Valid HeartDto heartDto) {
        heartService.unHeart(heartDto);
        return new ResponseEntity<>(heartDto, HttpStatus.OK);
    }

}

• POST 로 보내면 좋아요, DELETE로 보내면 좋아요 취소입니다.

📌 Repository

📄 HeartRepository.java

public interface HeartRepository extends JpaRepository<Heart, Long> {

    Optional<Heart> findHeartByUserAndCampaignId(User user, String campaignId);
}

• campaignId(게시글) + user 조합으로 찾습니다.

📌 Service

📄 HeartSearvice.java

@Slf4j
@RequiredArgsConstructor
@Service
public class HeartService {

    private final HeartRepository heartRepository;
    private final UserRepository userRepository;

    public void heart(HeartDto heartDto) {

        // 이미 좋아요 된 캠페인일 경우 409 에러
        if (findHeartWithUserAndCampaignId(heartDto).isPresent())
            throw new CustomException(ALREADY_HEARTED);

        Heart heart = Heart.builder()
                .campaignId(heartDto.getCampaignId())
                .user(userRepository.findUserById(heartDto.getUserId()).get())
                .build();
        heartRepository.save(heart);
    }

    public void unHeart(HeartDto heartDto) {
        Optional<Heart> heartOpt = findHeartWithUserAndCampaignId(heartDto);

        if (heartOpt.isEmpty())
            throw new CustomException(HEART_NOT_FOUND);

        heartRepository.delete(heartOpt.get());
    }

    public Optional<Heart> findHeartWithUserAndCampaignId(HeartDto heartDto) {
        Optional<User> userOpt = userRepository.findUserById(heartDto.getUserId());
        if (userOpt.isEmpty())
            throw new CustomException(MEMBER_NOT_FOUND);

        return heartRepository.findHeartByUserAndCampaignId(userOpt.get(), heartDto.getCampaignId());
    }

}

• 중복을 막기 위해서 이미 좋아요 된 캠페인인지 확인합니다.
  • 이 과정에서 userId 와 일치하는 User가 없다면 MEMBER_NOT_FOUND 에러 (커스텀 에러 처리 함)
  • 이미 좋아요 된 캠페인일 경우 ALREADY_HEARTED 에러
• heart()는 Heart객체를 새로 만들어 저장합니다.
• unHeart()는 DB에서 Heart객체를 찾아 삭제합니다.
  • Heart가 없다면 없는 좋아요를 취소하는 것이기 때문에 HEART_NOT_FOUND 에러

📌 좋아요 여부와 좋아요 개수

앞에서 설명했듯이, Campagin(흔히 게시글) 정보는 MySQL에 없고 외부인 Elasticsearch에 있습니다. es에 직접 하트를 카운팅 하는것은 비효율적이라 생각이 들어, 이렇게 따로 구하는 로직을 추가했습니다.

CampaginService의 일부 입니다.

📍 좋아요 여부 :: isHeart

List<Heart> hearts = user.get().getHearts();
Page<Campaign> campaigns = campaignDto.getCampaigns();

for (Heart heart : hearts) {
    String campaignId = heart.getCampaignId();
    Optional<Campaign> campaignOpt = campaigns
            .stream().filter(campaign -> Objects.equals(campaign.getId(), campaignId))
            .findFirst();
    campaignOpt.ifPresent(campaign -> campaign.setIsHeart(true));
}

• 로그인을 했을 경우 에만 좋아요 여부를 체크합니다.
• 해당 유저의 모든 하트 리스트를 가져오고, 앞에서 여러 쿼리들로 처리하여 가져온 Campagin 리스트를 가져옵니다.
• 자바8의 stream()을 이용해 Heart의 campaginID와 일치하는 Campagin 객체를 찾아 isHeart를 true로 표시합니다.

📍 좋아요 개수 :: heartCount

List<Heart> hearts = heartRepository.findAll();

Map<String, List<Heart>> heartMap = hearts.stream()
        .collect(Collectors.groupingBy(Heart::getCampaignId));

heartMap.keySet().forEach(campaignId -> {
    int count = heartMap.get(campaignId).size(); // 해당 캠페인 좋아요 수
    Optional<Campaign> campaignOpt = campaignDto.getCampaigns().stream()
            .filter(v -> Objects.equals(v.getId(), campaignId))
            .findFirst();
    campaignOpt.ifPresent(campaign -> campaign.setHeartCount(count));
});

• 좋아요 개수는 로그인 여부와 상관없이 항상 세팅합니다.
• Collectors.groupBy() 로 campaignId 기준으로 하트 리스트들을 그룹핑(Map으로) 합니다.
• 그렇게되면 해당 campaign이 몇개의 하트가 있는지 알 수 있게됩니다.
• 아까 만들었던 Map의 key(campaginId들)의 for문을 돌며 갯수를 세팅합니다.

🩺 테스트

📄 HeartControllerTest

@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
@Import(JpaConfig.class)
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class HeartControllerTest {

    @Autowired
    private MockMvc mockMvc;
    @Autowired
    private CampaignRepository campaignRepository;

    ObjectMapper objectMapper = new ObjectMapper();
    Map<String, String> input = new HashMap<>();

    @BeforeEach
    void setBody() {
        Optional<Campaign> campaign = campaignRepository.findDistinctBySiteType("happybean");
        if (campaign.isEmpty()) {
            throw new ResourceNotFoundException("캠페인을 찾을 수 없음");
        }

        input.put("campaignId", campaign.get().getId());
        input.put("userId", "550e8400-e29b-41d4-a716-446655440000"); // testUser
    }

    @Test
    @Order(100)
    @DisplayName("좋아요 테스트 - 성공")
    public void doHeart() throws Exception {

        mockMvc
                .perform(post("/api/heart")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(input)))

                .andExpect(status().isCreated());
    }

    @Test
    @Order(101)
    @DisplayName("좋아요 테스트 - 실패 :: 이미 좋아요 된 캠페인")
    public void doHeartFailDuplicate() throws Exception {

        mockMvc
                .perform(post("/api/heart")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(input)))

                .andExpect(status().isConflict())
                .andExpect(jsonPath("$.code").value("ALREADY_HEARTED"))
                .andExpect(jsonPath("$.message").value("이미 좋아요 된 캠페인 입니다."));
    }

    @Test
    @Order(200)
    @DisplayName("좋아요 취소 테스트 - 성공")
    public void unHeart() throws Exception {

        mockMvc
                .perform(delete("/api/heart")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(input)))

                .andExpect(status().isOk());

    }

    @Test
    @Order(201)
    @DisplayName("좋아요 취소 테스트 - 실패 :: 없는 좋아요 취소 시도")
    public void unHeartFailNotFound() throws Exception {

        mockMvc
                .perform(delete("/api/heart")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(objectMapper.writeValueAsString(input)))

                .andExpect(status().isNotFound())
                .andExpect(jsonPath("$.code").value("HEART_NOT_FOUND"))
                .andExpect(jsonPath("$.message").value("해당 좋아요 정보를 찾을 수 없습니다."));


    }

}

테스트 성공

📸 DB 결과

좋아요 한 heart들이 잘 들어가있다.

참고자료

• https://velog.io/@ohjs813/Spring-FrameWork-좋아요기능-정리
• https://gimmesome.tistory.com/175

카카오페이로 커피사기 ❤️ 토스,계좌로 커피사기 ❤️