Develop to Main 릴리즈 (#111)

.github/workflows/action-develop-cd.yml

@@ -6,7 +6,7 @@ on:
     branches:
       - develop
 
- # 코드의 내용을 이 파일을 실행하여 action을 수행하는 주체(Github Actions에서 사용하는 VM)가 읽을 수 있도록 권한을 설정
+      # 코드의 내용을 이 파일을 실행하여 action을 수행하는 주체(Github Actions에서 사용하는 VM)가 읽을 수 있도록 권한을 설정
 permissions:
   contents: read
 

build.gradle

@@ -56,9 +56,12 @@ dependencies {
 
 	//spring doc 추가
 	dependencies {
-		implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
+		implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'
 	}
 
+	//Validation을 위해 추가! Spring Boot 2.3버전 이후부터는 web 의존성안에 있던 validation 관련 package가 아예 모듈로 빠짐
+	implementation 'org.springframework.boot:spring-boot-starter-validation'
+
 }
 
 test {

src/main/java/com/nainga/nainga/domain/report/api/ReportApi.java

@@ -0,0 +1,75 @@
+package com.nainga.nainga.domain.report.api;
+
+import com.nainga.nainga.domain.report.application.ReportService;
+import com.nainga.nainga.domain.report.domain.Report;
+import com.nainga.nainga.domain.report.dto.SaveNewStoreReportRequest;
+import com.nainga.nainga.domain.report.dto.SaveSpecificStoreReportRequest;
+import com.nainga.nainga.global.util.Result;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+@RestController
+@RequiredArgsConstructor
+public class ReportApi {
+    private final ReportService reportService;
+
+    //사용자의 신규 가게 등록 요청에 대한 제보를 저장
+    @Tag(name = "[New] 사용자 제보")
+    @Operation(summary = "사용자의 신규 가게 등록 요청에 대한 제보를 서버에 저장", description = "사용자의 신규 가게 등록 요청에 대한 제보를 서버에 저장합니다.<br><br>" +
+            "[Request Body]<br>" +
+            "storeName: 등록 요청하는 가게 이름<br>" +
+            "formattedAddress: 등록 요청하는 가게 주소<br>" +
+            "certifications: 가게가 가지고 있는 인증제들의 이름을 담은 리스트. 착한가격업소, 모범음식점, 안심식당이 아닌 경우 예외 발생<br>" +
+            "[Response Body]<br>" +
+            "등록된 reportId<br>")
+    @PostMapping("api/report/newStore/v1")
+    public Result<Long> saveNewStoreReport(@Valid @RequestBody SaveNewStoreReportRequest saveNewStoreReportRequest) {
+        Long reportId = reportService.saveNewStoreReport(saveNewStoreReportRequest);
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, reportId);
+    }
+
+    //사용자의 특정 가게에 대한 수정, 삭제 요청 정보를 저장
+    @Tag(name = "[New] 사용자 제보")
+    @Operation(summary = "사용자의 특정 가게에 대한 정보 수정 혹은 삭제 요청에 대한 제보를 서버에 저장", description = "사용자의 특정 가게에 대한 정보 수정 혹은 삭제 요청에 대한 제보를 서버에 저장합니다.<br><br>" +
+            "[Request Body]<br>" +
+            "dtype: 제보 종류를 구분하기 위한 값. fix는 수정 요청, del은 삭제 요청. fix나 del이 아닌 경우 예외 발생<br>" +
+            "storeId: 수정 혹은 삭제를 요청하는 가게 id<br>" +
+            "contents: 제보 내용<br>" +
+            "[Response Body]<br>" +
+            "등록된 reportId<br>")
+    @PostMapping("api/report/specificStore/v1")
+    public Result<Long> saveSpecificStoreReport(@Valid @RequestBody SaveSpecificStoreReportRequest saveSpecificStoreReportRequest) {
+        Long reportId = reportService.saveSpecificStoreReport(saveSpecificStoreReportRequest);
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, reportId);
+    }
+
+    //reportId를 가지고 사용자 제보 내용 조회
+    @Tag(name = "[New] 사용자 제보")
+    @Operation(summary = "reportId를 가지고 사용자 제보 내용 조회", description = "reportId를 가지고 사용자 제보 내용을 조회합니다.<br><br>" +
+            "[Request Body]<br>" +
+            "reportId: 검색할 사용자 제보의 reportId. 유효하지 않은 reportId의 경우 예외 발생<br>" +
+            "[Response Body]<br>" +
+            "해당 reportId로 검색된 사용자 제보 내용<br>")
+    @GetMapping("api/report/byId/v1")
+    public Result<Report> findById(@NotNull @RequestParam(value = "reportId") Long reportId) {
+        Report report = reportService.findById(reportId);
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, report);
+    }
+
+    //DB에 있는 모든 사용자 제보 내용 조회
+    @Tag(name = "[New] 사용자 제보")
+    @Operation(summary = "DB에 있는 모든 사용자 제보 내용 조회", description = "DB에 있는 모든 사용자 제보 내용을 조회합니다.<br><br>" +
+            "[Response Body]<br>" +
+            "DB에 있는 모든 사용자 제보 내용<br>")
+    @GetMapping("api/report/all/v1")
+    public Result<List<Report>> findAll() {
+        List<Report> reports = reportService.findAll();
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, reports);
+    }
+}

src/main/java/com/nainga/nainga/domain/report/application/ReportService.java

@@ -0,0 +1,76 @@
+package com.nainga.nainga.domain.report.application;
+
+import com.nainga.nainga.domain.report.dao.ReportRepository;
+import com.nainga.nainga.domain.report.domain.DelSpecificStoreReport;
+import com.nainga.nainga.domain.report.domain.FixSpecificStoreReport;
+import com.nainga.nainga.domain.report.domain.NewStoreReport;
+import com.nainga.nainga.domain.report.domain.Report;
+import com.nainga.nainga.domain.report.dto.SaveNewStoreReportRequest;
+import com.nainga.nainga.domain.report.dto.SaveSpecificStoreReportRequest;
+import com.nainga.nainga.global.exception.GlobalException;
+import com.nainga.nainga.global.exception.ReportErrorCode;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.List;
+import java.util.Optional;
+
+@Service
+@Transactional(readOnly = true)
+@RequiredArgsConstructor
+public class ReportService {
+    private final ReportRepository reportRepository;
+
+    @Transactional
+    public Long saveNewStoreReport(SaveNewStoreReportRequest saveNewStoreReportRequest) throws GlobalException {   //사용자의 신규 가게 등록 요청
+        List<String> certificationList = List.of("착한가격업소", "모범음식점", "안심식당");    //현재 App에서 사용중인 Certification 목록
+        for (String certification : saveNewStoreReportRequest.getCertifications()) {
+            if (!certificationList.contains(certification)) {
+                throw new GlobalException(ReportErrorCode.INVALID_CERTIFICATION);   //잘못된 인증제 값이 들어온 것이므로 예외 발생
+            }
+        }
+
+        NewStoreReport newStoreReport = NewStoreReport.builder()
+                .storeName(saveNewStoreReportRequest.getStoreName())
+                .formattedAddress(saveNewStoreReportRequest.getFormattedAddress())
+                .certifications(saveNewStoreReportRequest.getCertifications())
+                .build();
+
+        return reportRepository.save(newStoreReport);
+    }
+
+    @Transactional
+    public Long saveSpecificStoreReport(SaveSpecificStoreReportRequest saveSpecificStoreReportRequest) throws GlobalException {    //사용자의 특정 가게에 대한 수정, 삭제 요청
+        if (saveSpecificStoreReportRequest.getDtype().equals("fix")) {
+            FixSpecificStoreReport fixSpecificStoreReport = FixSpecificStoreReport.builder()
+                    .storeId(saveSpecificStoreReportRequest.getStoreId())
+                    .contents(saveSpecificStoreReportRequest.getContents())
+                    .build();
+
+            return reportRepository.save(fixSpecificStoreReport);
+        } else if (saveSpecificStoreReportRequest.getDtype().equals("del")) {
+            DelSpecificStoreReport delSpecificStoreReport = DelSpecificStoreReport.builder()
+                    .storeId(saveSpecificStoreReportRequest.getStoreId())
+                    .contents(saveSpecificStoreReportRequest.getContents())
+                    .build();
+
+            return reportRepository.save(delSpecificStoreReport);
+        } else {
+            throw new GlobalException(ReportErrorCode.INVALID_DTYPE);   //잘못된 DTYPE이 들어왔을 경우에 Custom GlobalException 처리
+        }
+    }
+
+    public Report findById(Long id) throws GlobalException {    //reportId를 가지고 report를 DB에서 조회하는 로직
+        Optional<Report> report = reportRepository.findById(id);
+        if (report.isEmpty()) {
+            throw new GlobalException(ReportErrorCode.INVALID_REPORT_ID);   //잘못된 reportId로 검색하는 경우에 Custom GlobalException 처리
+        } else {
+            return report.get();
+        }
+    }
+
+    public List<Report> findAll() { //DB에 있는 모든 Report 조회
+        return reportRepository.findAll();
+    }
+}

src/main/java/com/nainga/nainga/domain/report/dao/ReportRepository.java

@@ -0,0 +1,33 @@
+package com.nainga.nainga.domain.report.dao;
+
+import com.nainga.nainga.domain.report.domain.Report;
+import jakarta.persistence.EntityManager;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Repository;
+
+import java.util.List;
+import java.util.Optional;
+
+@Repository
+@RequiredArgsConstructor
+public class ReportRepository {
+
+    private final EntityManager em;
+
+    public Long save(Report report) {
+        em.persist(report);
+        return report.getId();
+    }
+
+    public Optional<Report> findById(Long id) {
+        List<Report> result = em.createQuery("select r from Report r where r.id = :id", Report.class)
+                .setParameter("id", id)
+                .getResultList();
+        return result.stream().findAny();
+    }
+
+    public List<Report> findAll() {
+        return em.createQuery("select r from Report r", Report.class)
+                .getResultList();
+    }
+}

src/main/java/com/nainga/nainga/domain/report/domain/DelSpecificStoreReport.java

@@ -0,0 +1,16 @@
+package com.nainga.nainga.domain.report.domain;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+import lombok.*;
+
+@Entity
+@Getter
+@Builder
+@DiscriminatorValue("del")
+@AllArgsConstructor
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class DelSpecificStoreReport extends Report {
+    private Long storeId;   //가게 id
+    private String contents;    //신고 내용
+}

src/main/java/com/nainga/nainga/domain/report/domain/FixSpecificStoreReport.java

@@ -0,0 +1,16 @@
+package com.nainga.nainga.domain.report.domain;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+import lombok.*;
+
+@Entity
+@Getter
+@Builder
+@DiscriminatorValue("fix")
+@AllArgsConstructor
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class FixSpecificStoreReport extends Report {
+    private Long storeId;   //가게 id
+    private String contents;    //신고 내용
+}

src/main/java/com/nainga/nainga/domain/report/domain/NewStoreReport.java

@@ -0,0 +1,21 @@
+package com.nainga.nainga.domain.report.domain;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.ElementCollection;
+import jakarta.persistence.Entity;
+import lombok.*;
+
+import java.util.List;
+
+@Entity
+@Getter
+@Builder
+@DiscriminatorValue("new")
+@AllArgsConstructor
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class NewStoreReport extends Report {
+    private String storeName;   //가게 이름
+    private String formattedAddress;    //가게 주소
+    @ElementCollection
+    private List<String> certifications;    //가게가 가지고 있는 인증제 이름 리스트
+}

src/main/java/com/nainga/nainga/domain/report/domain/Report.java

@@ -0,0 +1,16 @@
+package com.nainga.nainga.domain.report.domain;
+
+import jakarta.persistence.*;
+import lombok.*;
+
+@Entity
+@Getter
+@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
+@DiscriminatorColumn(name = "dtype")
+public abstract class Report {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "report_id")
+    private Long id;
+}

src/main/java/com/nainga/nainga/domain/report/dto/SaveNewStoreReportRequest.java

@@ -0,0 +1,27 @@
+package com.nainga.nainga.domain.report.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class SaveNewStoreReportRequest {
+    @NotEmpty
+    @Schema(defaultValue = "가게 이름", description = "새로 등록하고자 하는 가게 이름")
+    private String storeName;   //가게 이름
+    @NotEmpty
+    @Schema(defaultValue = "주소", description = "새로 등록하고자 하는 가게 주소")
+    private String formattedAddress;    //가게 주소
+    @NotEmpty
+    @Schema(defaultValue = "[\"착한가격업소\", \"모범음식점\", \"안심식당\"]", description = "새로 등록할 가게가 가지고 있는 인증제들의 이름을 담은 리스트. 착한가격업소, 모범음식점, 안심식당이 아닌 경우 예외 발생")
+    private List<String> certifications;    //가게가 가지고 있는 인증제 이름 리스트
+
+    public SaveNewStoreReportRequest(String storeName, String formattedAddress, List<String> certifications) {
+        this.storeName = storeName;
+        this.formattedAddress = formattedAddress;
+        this.certifications = certifications;
+    }
+}

src/main/java/com/nainga/nainga/domain/report/dto/SaveSpecificStoreReportRequest.java

@@ -0,0 +1,25 @@
+package com.nainga.nainga.domain.report.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+@Data
+public class SaveSpecificStoreReportRequest {
+    @NotEmpty
+    @Schema(defaultValue = "fix/del", description = "제보 종류를 구분하기 위한 값. fix는 수정 요청, del은 삭제 요청.")
+    private String dtype;   //Report 종류를 구분하기 위한 type
+    @NotNull
+    @Schema(defaultValue = "0", description = "수정 혹은 삭제를 요청하는 가게 id")
+    private Long storeId;   //가게 id
+    @NotEmpty
+    @Schema(defaultValue = "제보 내용", description = "제보 내용")
+    private String contents;    //신고 내용
+
+    public SaveSpecificStoreReportRequest(String dtype, Long storeId, String contents) {
+        this.dtype = dtype;
+        this.storeId = storeId;
+        this.contents = contents;
+    }
+}

src/main/java/com/nainga/nainga/domain/store/api/StoreApi.java

@@ -3,9 +3,11 @@
 import com.nainga.nainga.domain.store.application.GoodPriceGoogleMapStoreService;
 import com.nainga.nainga.domain.store.application.MobeomGoogleMapStoreService;
 import com.nainga.nainga.domain.store.application.SafeGoogleMapStoreService;
+import com.nainga.nainga.domain.store.application.StoreService;
 import com.nainga.nainga.domain.store.dto.CreateDividedGoodPriceStoresResponse;
 import com.nainga.nainga.domain.store.dto.CreateDividedMobeomStoresResponse;
 import com.nainga.nainga.domain.store.dto.CreateDividedSafeStoresResponse;
+import com.nainga.nainga.domain.storecertification.dto.StoreCertificationsByLocationResponse;
 import com.nainga.nainga.global.util.Result;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
@@ -15,12 +17,15 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
+import java.util.List;
+
 @RestController
 @RequiredArgsConstructor
 public class StoreApi {
     private final MobeomGoogleMapStoreService mobeomGoogleMapStoreService;
     private final SafeGoogleMapStoreService safeGoogleMapStoreService;
     private final GoodPriceGoogleMapStoreService goodPriceGoogleMapStoreService;
+    private final StoreService storeService;
 
     @Hidden
     @Tag(name = "초기 Data 생성")
@@ -78,5 +83,18 @@ public Result<CreateDividedGoodPriceStoresResponse> createDividedGoodPriceStores
         System.out.println("response = " + response);   //편하게 콘솔 로그에서 확인하기 위한 용도
         return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, response);
     }
+
+    //검색어를 이용해 가게 이름에 대해 검색하여 나온 검색 결과를 바탕으로 검색어를 자동 완성해서 최대 10개의 자동 완성된 검색어를 리턴
+    @Tag(name = "[New] 검색어 자동 완성")
+    @Operation(summary = "사용자의 검색 키워드를 바탕으로 검색어 자동 완성", description = "사용자의 검색 키워드를 바탕으로 DB에서 매칭되는 가게 이름을 조회하여 최대 10개까지 검색어를 자동으로 완성하여 반환해줍니다.<br><br>" +
+            "[Request Body]<br>" +
+            "searchKeyword: 사용자의 검색 키워드<br>" +
+            "[Response Body]<br>" +
+            "자동으로 완성된 최대 10개의 검색어<br>")
+    @GetMapping("api/store/autocorrect/v1")
+    public Result<List<String>> autocorrect(@RequestParam(value = "searchKeyword") String searchKeyword) {
+        List<String> autocorrectResult = storeService.autocorrect(searchKeyword);
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, autocorrectResult);
+    }
 }