feat: 구글 스프레스 시트 연동 테스트 케이스 작성 및 기능 추가

hodoon · hodoon · commit 7c29b079f131 · 2025-02-25T00:04:04.000+09:00
diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,6 @@ out/
 
 ### dev ###
 application-dev.yml
+
+### google ###
+src/main/resources/credentials/dasomGoogle.json
diff --git a/src/main/java/dmu/dasom/api/domain/applicant/entity/Applicant.java b/src/main/java/dmu/dasom/api/domain/applicant/entity/Applicant.java
@@ -16,6 +16,7 @@
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 import java.time.LocalDateTime;
+import java.util.List;
 
 @AllArgsConstructor
 @Builder
@@ -82,6 +83,23 @@ public void updateStatus(final ApplicantStatus status) {
         this.status = status;
     }
 
+    public List<Object> toGoogleSheetRow(){
+        return List.of(
+                this.id,
+                this.name,
+                this.studentNo,
+                this.contact,
+                this.email,
+                this.grade,
+                this.reasonForApply,
+                this.activityWish,
+                this.isPrivacyPolicyAgreed,
+                this.status.name(),
+                this.createdAt.toString(),
+                this.updatedAt.toString()
+        );
+    }
+
     public ApplicantResponseDto toApplicantResponse() {
         return ApplicantResponseDto.builder()
                 .id(this.id)
diff --git a/src/main/java/dmu/dasom/api/domain/applicant/service/ApplicantServiceImpl.java b/src/main/java/dmu/dasom/api/domain/applicant/service/ApplicantServiceImpl.java
@@ -11,10 +11,12 @@
 import dmu.dasom.api.domain.common.exception.ErrorCode;
 import dmu.dasom.api.domain.email.enums.MailType;
 import dmu.dasom.api.domain.email.service.EmailService;
+import dmu.dasom.api.domain.google.service.GoogleApiService;
 import dmu.dasom.api.global.dto.PageResponse;
 import jakarta.mail.MessagingException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.stereotype.Service;
@@ -34,6 +36,7 @@ public class ApplicantServiceImpl implements ApplicantService {
 
     private final ApplicantRepository applicantRepository;
     private final EmailService emailService;
+    private final GoogleApiService googleApiService;
 
     // 지원자 저장
     @Override
@@ -46,13 +49,15 @@ public void apply(final ApplicantCreateRequestDto request) {
             if (!request.getIsOverwriteConfirmed())
                 throw new CustomException(ErrorCode.DUPLICATED_STUDENT_NO);
 
-            // 기존 지원자 정보 갱신 수행
-            applicant.get().overwrite(request);
+            Applicant existingApplicant = applicant.get();
+            existingApplicant.overwrite(request);
+
+            googleApiService.updateSheet(List.of(existingApplicant));
             return;
         }
 
-        // 새로운 지원자일 경우 저장
-        applicantRepository.save(request.toEntity());
+        Applicant savedApplicant = applicantRepository.save(request.toEntity());
+        googleApiService.appendToSheet(List.of(savedApplicant));
     }
 
     // 지원자 조회
@@ -77,7 +82,9 @@ public ApplicantDetailsResponseDto getApplicant(final Long id) {
     @Override
     public ApplicantDetailsResponseDto updateApplicantStatus(final Long id, final ApplicantStatusUpdateRequestDto request) {
         final Applicant applicant = findById(id);
+
         applicant.updateStatus(request.getStatus());
+        googleApiService.updateSheet(List.of(applicant));
 
         return applicant.toApplicantDetailsResponse();
     }
diff --git a/src/main/java/dmu/dasom/api/domain/common/exception/ErrorCode.java b/src/main/java/dmu/dasom/api/domain/common/exception/ErrorCode.java
@@ -24,7 +24,9 @@ public enum ErrorCode {
     MAIL_TYPE_NOT_VALID(400, "C015", "메일 타입이 올바르지 않습니다."),
     INVALID_DATETIME_FORMAT(400, "C016", "날짜 형식이 올바르지 않습니다."),
     INVALID_TIME_FORMAT(400, "C017", "시간 형식이 올바르지 않습니다."),
-    INVALID_INQUIRY_PERIOD(400, "C018", "조회 기간이 아닙니다.")
+    INVALID_INQUIRY_PERIOD(400, "C018", "조회 기간이 아닙니다."),
+    SHEET_WRITE_FAIL(400, "C019", "시트에 데이터를 쓰는데 실패하였습니다."),
+    SHEET_READ_FAIL(400, "C200", "시트에 데이터를 쓰는데 실패하였습니다."),
     ;
 
     private final int status;
diff --git a/src/main/java/dmu/dasom/api/domain/google/service/GoogleApiService.java b/src/main/java/dmu/dasom/api/domain/google/service/GoogleApiService.java
@@ -5,11 +5,12 @@
 import com.google.api.client.json.jackson2.JacksonFactory;
 
 import com.google.api.services.sheets.v4.Sheets;
-import com.google.api.services.sheets.v4.model.UpdateValuesResponse;
+import com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest;
+import com.google.api.services.sheets.v4.model.BatchUpdateValuesResponse;
 import com.google.api.services.sheets.v4.model.ValueRange;
-import com.google.auth.Credentials;
 import com.google.auth.http.HttpCredentialsAdapter;
 import com.google.auth.oauth2.GoogleCredentials;
+import dmu.dasom.api.domain.applicant.entity.Applicant;
 import dmu.dasom.api.domain.common.exception.CustomException;
 import dmu.dasom.api.domain.common.exception.ErrorCode;
 import lombok.RequiredArgsConstructor;
@@ -19,10 +20,9 @@
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.stereotype.Service;
 
-import java.io.ByteArrayInputStream;
 import java.io.IOException;
-import java.nio.charset.StandardCharsets;
 import java.security.GeneralSecurityException;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
@@ -33,19 +33,23 @@ public class GoogleApiService {
     private static final Logger logger = LoggerFactory.getLogger(GoogleApiService.class);
     private static final String APPLICATION_NAME = "Recruit Form";
     private static final JsonFactory JSON_FACTORY = JacksonFactory.getDefaultInstance();
-    @Value("${google.credentials.json}")
-    private String credentialsJson;
+    @Value("${google.credentials.file.path}")
+    private String credentialsFilePath;
+    @Value("${google.spreadsheet.id}")
+    private String spreadSheetId;
     private Sheets sheetsService;
 
     // Google Sheets API 서비스 객체를 생성하는 메소드
     private Sheets getSheetsService() throws IOException, GeneralSecurityException{
         if(sheetsService == null){
-            ByteArrayInputStream credentialsStream = new ByteArrayInputStream(credentialsJson.getBytes(StandardCharsets.UTF_8));
+            ClassPathResource resource = new ClassPathResource(credentialsFilePath);
             GoogleCredentials credentials = GoogleCredentials
-                    .fromStream(credentialsStream)
+                    .fromStream(resource.getInputStream())
                     .createScoped(Collections.singletonList("https://www.googleapis.com/auth/spreadsheets"));
 
-            sheetsService = new Sheets.Builder(GoogleNetHttpTransport.newTrustedTransport(), JSON_FACTORY, new HttpCredentialsAdapter(credentials))
+            sheetsService = new Sheets.Builder(GoogleNetHttpTransport.newTrustedTransport(),
+                    JSON_FACTORY,
+                    new HttpCredentialsAdapter(credentials))
                     .setApplicationName(APPLICATION_NAME)
                     .build();
         }
@@ -56,17 +60,118 @@ public void writeToSheet(String spreadsheetId, String range, List<List<Object>>
         try {
             Sheets service = getSheetsService();
             ValueRange body = new ValueRange().setValues(values);
-            UpdateValuesResponse result = service.spreadsheets().values()
+            service.spreadsheets().values()
                     .update(spreadsheetId, range, body)
                     .setValueInputOption("USER_ENTERED")
                     .execute();
-            logger.info("Updated rows: {}", result.getUpdatedRows());
-        }  catch (IOException e) {
-            logger.error("Failed to write data to the spreadsheet", e);
+        }  catch (IOException | GeneralSecurityException e) {
+            logger.error("구글 시트에 데이터를 쓰는 데 실패했습니다.", e);
             throw new CustomException(ErrorCode.WRITE_FAIL);
-        } catch (GeneralSecurityException e) {
-            logger.error("Failed to write data to the spreadsheet", e);
-            throw new CustomException(ErrorCode.INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    public void appendToSheet(List<Applicant> applicants) {
+        processSheetsUpdate(applicants, true);
+    }
+
+    public void updateSheet(List<Applicant> applicants) {
+        processSheetsUpdate(applicants, false);
+    }
+
+    private int findRowIndexByStudentNo(String spreadSheetId, String sheetName, String studentNo){
+        try {
+            List<List<Object>> rows = readSheet(spreadSheetId, sheetName + "!A:L"); // A열부터 L열까지 읽기
+
+            for (int i = 0; i < rows.size(); i++){
+                List<Object> row = rows.get(i);
+                if(!row.isEmpty() && row.get(2).equals(studentNo)){
+                    return i + 1;
+                }
+            }
+        } catch (Exception e) {
+            logger.error("구글시트에서 행 찾기 실패", e);
+        }
+        return -1;
+    }
+
+    public List<List<Object>> readSheet(String spreadsheetId, String range) {
+        try {
+            Sheets service = getSheetsService();
+            ValueRange response = service.spreadsheets().values()
+                    .get(spreadsheetId, range)
+                    .execute();
+
+            return response.getValues();
+        } catch (IOException | GeneralSecurityException e) {
+            logger.error("시트에서 데이터를 읽어오는데 실패했습니다.", e);
+            throw new CustomException(ErrorCode.SHEET_READ_FAIL);
+        }
+    }
+
+    public int getLastRow(String spreadsheetId, String sheetName) {
+        try {
+            List<List<Object>> rows = readSheet(spreadsheetId, sheetName + "!A:L"); // A~L 열까지 읽기
+            return rows == null ? 0 : rows.size(); // 데이터가 없으면 0 반환
+        } catch (Exception e) {
+            logger.error("Failed to retrieve last row from Google Sheet", e);
+            throw new CustomException(ErrorCode.SHEET_READ_FAIL);
+        }
+    }
+
+    public void batchUpdateSheet(String spreadsheetId, List<ValueRange> valueRanges) {
+        try {
+            Sheets service = getSheetsService();
+
+            // BatchUpdate 요청 생성
+            BatchUpdateValuesRequest batchUpdateRequest = new BatchUpdateValuesRequest()
+                    .setValueInputOption("USER_ENTERED") // 사용자 입력 형식으로 값 설정
+                    .setData(valueRanges); // 여러 ValueRange 추가
+
+            // BatchUpdate 실행
+            BatchUpdateValuesResponse response = service.spreadsheets().values()
+                    .batchUpdate(spreadsheetId, batchUpdateRequest)
+                    .execute();
+
+            logger.info("Batch update completed. Total updated rows: {}", response.getTotalUpdatedRows());
+        } catch (IOException | GeneralSecurityException e) {
+            logger.error("Batch update failed", e);
+            throw new CustomException(ErrorCode.SHEET_WRITE_FAIL);
+        }
+    }
+
+
+    private ValueRange createValueRange(String range, List<List<Object>> values) {
+        return new ValueRange()
+                .setRange(range)
+                .setMajorDimension("ROWS") // 행 단위로 데이터 설정
+                .setValues(values);
+    }
+
+    public void processSheetsUpdate(List<Applicant> applicants, boolean isAppend) {
+        try {
+            List<ValueRange> valueRanges = new ArrayList<>();
+            int lastRow = isAppend ? getLastRow(spreadSheetId, "Sheet1") : -1;
+
+            for (Applicant applicant : applicants) {
+                String range;
+                if (isAppend) {
+                    range = "Sheet1!A" + (lastRow + 1);
+                    lastRow++;
+                } else {
+                    int rowIndex = findRowIndexByStudentNo(spreadSheetId, "Sheet1", applicant.getStudentNo());
+                    if (rowIndex == -1) {
+                        logger.warn("구글시트에서 사용자를 찾을 수 없습니다. : {}", applicant.getStudentNo());
+                        continue;
+                    }
+                    range = "Sheet1!A" + rowIndex + ":L" + rowIndex;
+                }
+                valueRanges.add(createValueRange(range, List.of(applicant.toGoogleSheetRow())));
+            }
+
+            batchUpdateSheet(spreadSheetId, valueRanges);
+        } catch (Exception e) {
+            logger.error("구글시트 업데이트에 실패했습니다.", e);
+            throw new CustomException(ErrorCode.SHEET_WRITE_FAIL);
         }
     }
 
diff --git a/src/main/resources/application-credentials.yml b/src/main/resources/application-credentials.yml
@@ -32,6 +32,7 @@ jwt:
   refresh-token-expiration: ${JWT_REFRESH_TOKEN_EXPIRATION}
 google:
   credentials:
-    json: ${GOOGLE_CREDENTIALS_JSON}
+    file:
+      path: ${GOOGLE_CREDENTIALS_PATH}
   spreadsheet:
     id: ${GOOGLE_SPREADSHEET_ID}
diff --git a/src/test/java/dmu/dasom/api/domain/applicant/ApplicantServiceTest.java b/src/test/java/dmu/dasom/api/domain/applicant/ApplicantServiceTest.java
@@ -11,6 +11,7 @@
 import dmu.dasom.api.domain.common.exception.ErrorCode;
 import dmu.dasom.api.domain.email.enums.MailType;
 import dmu.dasom.api.domain.email.service.EmailService;
+import dmu.dasom.api.domain.google.service.GoogleApiService;
 import dmu.dasom.api.global.dto.PageResponse;
 import jakarta.mail.MessagingException;
 import org.junit.jupiter.api.DisplayName;
@@ -23,6 +24,7 @@
 import org.springframework.data.domain.PageImpl;
 import org.springframework.data.domain.PageRequest;
 
+import java.time.LocalDateTime;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
@@ -42,19 +44,43 @@ class ApplicantServiceTest {
     @InjectMocks
     private ApplicantServiceImpl applicantService;
 
+    @Mock
+    private GoogleApiService googleApiService;
+
     @Test
     @DisplayName("지원자 저장 - 성공")
     void apply_success() {
         // given
         ApplicantCreateRequestDto request = mock(ApplicantCreateRequestDto.class);
         when(request.getStudentNo()).thenReturn("20210000");
+
+        Applicant mockApplicant = Applicant.builder()
+                .name("홍길동")
+                .studentNo("20240001")
+                .contact("010-1234-5678")
+                .email("hong@example.com")
+                .grade(2)
+                .reasonForApply("팀 활동 경험을 쌓고 싶습니다.")
+                .activityWish("프로그래밍 스터디 참여")
+                .isPrivacyPolicyAgreed(true)
+                .status(ApplicantStatus.PENDING)
+                .createdAt(LocalDateTime.now())
+                .updatedAt(LocalDateTime.now())
+                .build();
+
+        when(request.toEntity()).thenReturn(mockApplicant);
         when(applicantRepository.findByStudentNo("20210000")).thenReturn(Optional.empty());
+        when(applicantRepository.save(any(Applicant.class))).thenReturn(mockApplicant);
+
+        // GoogleApiService의 appendToSheet() 동작을 가짜로 설정
+        doNothing().when(googleApiService).appendToSheet(anyList());
 
         // when
         applicantService.apply(request);
 
         // then
-        verify(applicantRepository).save(request.toEntity());
+        verify(applicantRepository).save(mockApplicant);
+        verify(googleApiService).appendToSheet(List.of(mockApplicant));
     }
 
     @Test
@@ -82,16 +108,17 @@ void apply_overwrite() {
         // given
         ApplicantCreateRequestDto request = mock(ApplicantCreateRequestDto.class);
         when(request.getStudentNo()).thenReturn("20210000");
-        Applicant applicant = mock(Applicant.class);
-        when(applicantRepository.findByStudentNo("20210000")).thenReturn(Optional.of(applicant));
+        Applicant existingApplicant = mock(Applicant.class); // 기존 Applicant 객체 모킹
+        when(applicantRepository.findByStudentNo("20210000")).thenReturn(Optional.of(existingApplicant));
         when(request.getIsOverwriteConfirmed()).thenReturn(true);
 
         // when
         applicantService.apply(request);
 
         // then
         verify(applicantRepository).findByStudentNo("20210000");
-        verify(applicant).overwrite(request);
+        verify(existingApplicant).overwrite(request);
+        verify(googleApiService).updateSheet(List.of(existingApplicant));
     }
 
     @Test
