diff --git a/build.gradle b/build.gradle index 568efab..876ff42 100644 --- a/build.gradle +++ b/build.gradle @@ -1,41 +1,44 @@ plugins { - id 'org.springframework.boot' version '2.7.4' - id 'io.spring.dependency-management' version '1.0.14.RELEASE' - id 'java' + id 'org.springframework.boot' version '2.7.4' + id 'io.spring.dependency-management' version '1.0.14.RELEASE' + id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' -sourceCompatibility = '17' +sourceCompatibility = '11' configurations { - compileOnly { - extendsFrom annotationProcessor - } + compileOnly { + extendsFrom annotationProcessor + } } repositories { - mavenCentral() + mavenCentral() } ext { - set('springCloudVersion', "2021.0.4") + set('springCloudVersion', "2021.0.4") } dependencies { - implementation 'org.springframework.boot:spring-boot-starter-web' - implementation 'org.springframework.cloud:spring-cloud-starter-openfeign' - compileOnly 'org.projectlombok:lombok' - annotationProcessor 'org.projectlombok:lombok' - testImplementation 'org.springframework.boot:spring-boot-starter-test' + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.springframework.cloud:spring-cloud-starter-openfeign' + implementation group: 'io.github.openfeign', name: 'feign-gson', version: '11.0' + implementation 'org.springframework.boot:spring-boot-starter-data-mongodb' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + } dependencyManagement { - imports { - mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" - } + imports { + mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" + } } tasks.named('test') { - useJUnitPlatform() + useJUnitPlatform() } diff --git a/src/main/java/com/example/schoolapibackend/SchoolApiBackendApplication.java b/src/main/java/com/example/schoolapibackend/SchoolApiBackendApplication.java index 6a07848..168bffb 100644 --- a/src/main/java/com/example/schoolapibackend/SchoolApiBackendApplication.java +++ b/src/main/java/com/example/schoolapibackend/SchoolApiBackendApplication.java @@ -2,12 +2,14 @@ import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.openfeign.EnableFeignClients; +@EnableFeignClients @SpringBootApplication public class SchoolApiBackendApplication { - public static void main(String[] args) { - SpringApplication.run(SchoolApiBackendApplication.class, args); - } + public static void main(String[] args) { + SpringApplication.run(SchoolApiBackendApplication.class, args); + } } diff --git a/src/main/java/com/example/schoolapibackend/client/SchoolFeignClient.java b/src/main/java/com/example/schoolapibackend/client/SchoolFeignClient.java new file mode 100644 index 0000000..a4bd5fa --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/client/SchoolFeignClient.java @@ -0,0 +1,19 @@ +package com.example.schoolapibackend.client; + +import com.example.schoolapibackend.config.FeignConfig; +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; + +@FeignClient(name = "schoolFeignClient", url = "https://open.neis.go.kr/hub", configuration = FeignConfig.class) +public interface SchoolFeignClient { + @RequestMapping(method = RequestMethod.GET, value = "/schoolInfo") + SchoolInfoDto getSchoolInfo( + @RequestParam(value = "KEY") String key, + @RequestParam(value = "Type") String type, + @RequestParam(value = "pIndex") int pIndex, + @RequestParam(value = "pSize") int pSize); +} diff --git a/src/main/java/com/example/schoolapibackend/common/Decoder.java b/src/main/java/com/example/schoolapibackend/common/Decoder.java new file mode 100644 index 0000000..2394a0a --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/common/Decoder.java @@ -0,0 +1,36 @@ +package com.example.schoolapibackend.common; + +import feign.FeignException; +import feign.Response; +import feign.codec.DecodeException; +import feign.gson.GsonDecoder; +import lombok.extern.slf4j.Slf4j; +import java.io.IOException; +import java.lang.reflect.Type; + +@Slf4j +public class Decoder implements feign.codec.Decoder { + + /** 커스텀 디코드 함수 + * 헤더 체크가 필요하거나 리턴 데이터 파싱시 특정 로직을 추가하고 싶은경우 사용. + * */ + @Override + public Object decode(Response response, Type type) throws IOException, DecodeException, FeignException { + //이상없음 + if(response.status() == 200){ + + log.info("===============응답 200 정상==============="); + + log.info("============Type 정보 -> "); + log.info(type.getTypeName().toString()); + + log.info("============Header 정보 -> "); + log.info(response.headers().toString()); + + }else{ + log.info("===============응답 확인필요" + String.valueOf(response.status()) + "==============="); + } + + return new GsonDecoder().decode(response,type); + } +} diff --git a/src/main/java/com/example/schoolapibackend/config/FeignConfig.java b/src/main/java/com/example/schoolapibackend/config/FeignConfig.java new file mode 100644 index 0000000..719979f --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/config/FeignConfig.java @@ -0,0 +1,22 @@ +package com.example.schoolapibackend.config; + +import com.example.schoolapibackend.common.Decoder; +import feign.Logger; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class FeignConfig { + + /** feign 로깅 처리*/ + @Bean + Logger.Level feignLoggerLevel() { + return Logger.Level.FULL; + } + + /** feign custom decoder */ + @Bean + feign.codec.Decoder feignDecoder(){ + return new Decoder(); + } +} diff --git a/src/main/java/com/example/schoolapibackend/controller/SchoolController.java b/src/main/java/com/example/schoolapibackend/controller/SchoolController.java new file mode 100644 index 0000000..11189e9 --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/controller/SchoolController.java @@ -0,0 +1,32 @@ +package com.example.schoolapibackend.controller; + +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import com.example.schoolapibackend.service.SchoolFeignService; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequiredArgsConstructor +public class SchoolController { + + private final SchoolFeignService schoolFeignService; + + @GetMapping("/schoolInfo") + public SchoolInfoDto getSchoolInfo( + @RequestParam(value = "KEY") String key, + @RequestParam(value = "Type") String type, + @RequestParam(value = "pIndex") int pIndex, + @RequestParam(value = "pSize") int pSize) { + + return schoolFeignService.getSchoolInfo(key, type, pIndex, pSize); + } + + @PostMapping("/schoolInfo") + public void saveSchoolInfo() { + schoolFeignService.saveSchoolInfo(); + } +} diff --git a/src/main/java/com/example/schoolapibackend/domain/SchoolInfo.java b/src/main/java/com/example/schoolapibackend/domain/SchoolInfo.java new file mode 100644 index 0000000..b8e57e2 --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/domain/SchoolInfo.java @@ -0,0 +1,54 @@ +package com.example.schoolapibackend.domain; + +import com.google.gson.annotations.SerializedName; +import lombok.*; +import org.springframework.data.annotation.Id; +import org.springframework.data.mongodb.core.index.Indexed; +import org.springframework.data.mongodb.core.mapping.Document; + +@Document +@NoArgsConstructor +@Getter +@AllArgsConstructor +@Setter +@ToString +public class SchoolInfo { + + @Id + private String id; + + @Indexed + private String educationOfficeCode; + @Indexed + private String educationOfficeName; + @Indexed + private String schoolCode; + @Indexed + private String schoolName; + @Indexed + private String schoolType; + @Indexed + private String locationName; + @Indexed + private String address; + @Indexed + private String addressDetail; + @Indexed + private String coeducationName; + @Indexed + private String highSchoolType; + @Indexed + private String industryClassExist; + @Indexed + private String highSchoolTypeDetail; + @Indexed + private String specialHighSchoolCurriculum; + @Indexed + private String entranceExamPeriod; + @Indexed + private String dayNightType; + @Indexed + private String establishmentDate; + @Indexed + private String schoolAnniversary; +} diff --git a/src/main/java/com/example/schoolapibackend/dto/SchoolInfoDto.java b/src/main/java/com/example/schoolapibackend/dto/SchoolInfoDto.java new file mode 100644 index 0000000..34e3d8e --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/dto/SchoolInfoDto.java @@ -0,0 +1,169 @@ +package com.example.schoolapibackend.dto; + +import com.example.schoolapibackend.domain.SchoolInfo; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import lombok.Getter; +import lombok.ToString; + +import java.time.LocalDate; +import java.util.Date; +import java.util.List; + +@ToString +@Getter +public class SchoolInfoDto { + + private List schoolInfo; + + @ToString + @Getter + public static class SchoolInfoResponse { + private List head; + private List row; + } + + @ToString + @Getter + public static class Row { + /** + * 시도교육청 코드 + */ + @SerializedName("ATPT_OFCDC_SC_CODE") + private String educationOfficeCode; + /** + * 시도교육청명 + */ + @SerializedName("ATPT_OFCDC_SC_NM") + private String educationOfficeName; + /** + * 표준학교코드 + */ + @SerializedName("SD_SCHUL_CODE") + private String schoolCode; + /** + * 학교명 + */ + @SerializedName("SCHUL_NM") + private String schoolName; + /** + * 영문학교명 + */ + @SerializedName("ENG_SCHUL_NM") + private String EnglishSchoolName; + /** + * 학교종류명 + */ + @SerializedName("SCHUL_KND_SC_NM") + private String schoolType; + /** + * 소재지명 + */ + @SerializedName("LCTN_SC_NM") + private String locationName; + /** + * 관할조직명 + */ + @SerializedName("JU_ORG_NM") + private String jurisdictionName; + /** + * 설립명 + */ + @SerializedName("FOND_SC_NM") + private String establishmentName; + /** + * 도로명 우편번호 + */ + @SerializedName("ORG_RDNZC") + private String postcode; + /** + * 도로명주소 + */ + @SerializedName("ORG_RDNMA") + private String address; + /** + * 도로명상세주소 + */ + @SerializedName("ORG_RDNDA") + private String addressDetail; + /** + * 전화번호 + */ + @SerializedName("ORG_TELNO") + private String tellNumber; + /** + * 홈페이지 주소 + */ + @SerializedName("HMPG_ADRES") + private String homepage; + /** + * 남녀공학 구분명 + */ + @SerializedName("COEDU_SC_NM") + private String coeducationName; + /** + * 팩스 번호 + */ + @SerializedName("ORG_FAXNO") + private String faxNumber; + /** + * 고등학교 구분명 + */ + @SerializedName("HS_SC_NM") + private String highSchoolType; + /** + * 산업체 특별학급 존재여부 + */ + @SerializedName("INDST_SPECL_CCCCL_EXST_YN") + private String industryClassExist; + /** + * 고등학교 일반/실업 구분명 + */ + @SerializedName("HS_GNRL_BUSNS_SC_NM") + private String highSchoolTypeDetail; + /** + * 특수목적고등학교 계열명 + */ + @SerializedName("SPCLY_PURPS_HS_ORD_NM") + private String specialHighSchoolCurriculum; + /** + * 입시전후 구분명 + */ + @SerializedName("ENE_BFE_SEHF_SC_NM") + private String entranceExamPeriod; + /** + * 주/야 구분명 + */ + @SerializedName("DGHT_SC_NM") + private String dayNightType; + /** + * 설립일자 + */ + @SerializedName("FOND_YMD") + private String establishmentDate; + /** + * 개교기념일 + */ + @SerializedName("FOAS_MEMRD") + private String schoolAnniversary; + /** + * 수정일 + */ + @SerializedName("LOAD_DTM") + private String editDate; + } + + @ToString + @Getter + public static class Head { + private int list_total_count; + private Result result; + } + + @ToString + @Getter + public static class Result { + private String code; + private String message; + } +} diff --git a/src/main/java/com/example/schoolapibackend/repository/SchoolInfoRepository.java b/src/main/java/com/example/schoolapibackend/repository/SchoolInfoRepository.java new file mode 100644 index 0000000..0beeeae --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/repository/SchoolInfoRepository.java @@ -0,0 +1,10 @@ +package com.example.schoolapibackend.repository; + +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import org.springframework.data.mongodb.repository.MongoRepository; +import org.springframework.data.repository.CrudRepository; + +public interface SchoolInfoRepository extends CrudRepository { + +} diff --git a/src/main/java/com/example/schoolapibackend/service/SchoolFeignService.java b/src/main/java/com/example/schoolapibackend/service/SchoolFeignService.java new file mode 100644 index 0000000..b123131 --- /dev/null +++ b/src/main/java/com/example/schoolapibackend/service/SchoolFeignService.java @@ -0,0 +1,47 @@ +package com.example.schoolapibackend.service; + +import com.example.schoolapibackend.client.SchoolFeignClient; +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import com.example.schoolapibackend.repository.SchoolInfoRepository; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; + +@Slf4j +@Service +@RequiredArgsConstructor +public class SchoolFeignService { + + private final SchoolFeignClient schoolFeignClient; + private final SchoolInfoRepository schoolInfoRepository; + + public void saveSchoolInfo() { + int pSize = 100; + SchoolInfoDto schoolInfoDto = this.getSchoolInfo("109d00c3cf35465f99a8ea341d822795", "json", 1, 1); + int list_total_count = schoolInfoDto.getSchoolInfo().get(0).getHead().get(0).getList_total_count(); + + for (int j = 1; j <= list_total_count / 100 + 1; j++) { + if (j == list_total_count / 100 + 1) pSize = list_total_count % 100; + schoolInfoDto = this.getSchoolInfo("109d00c3cf35465f99a8ea341d822795", "json", j, pSize); + for (int i = 0; i < pSize; i++) { + List row = schoolInfoDto.getSchoolInfo().get(1).getRow(); + SchoolInfo schoolInfo = new SchoolInfo(); + schoolInfo.setAddress(row.get(i).getAddress()); + schoolInfo.setSchoolCode(row.get(i).getSchoolCode()); + schoolInfo.setSchoolName(row.get(i).getSchoolName()); + schoolInfoRepository.save(schoolInfo); + } + } + } + + public SchoolInfoDto getSchoolInfo(String key, String type, int pIndex, int pSize) { + SchoolInfoDto schoolInfo = schoolFeignClient.getSchoolInfo(key, type, pIndex, pSize); + List row = schoolInfo.getSchoolInfo().get(1).getRow(); + + return schoolFeignClient.getSchoolInfo(key, type, pIndex, pSize); + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties deleted file mode 100644 index 8b13789..0000000 --- a/src/main/resources/application.properties +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..5c58d17 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,11 @@ +spring: + data: + mongodb: + uri: mongodb://localhost:27017/test +feign: + client: + config: + feignName: + connectTimeout: 5000 + readTimeout: 5000 + loggerLevel: full diff --git a/src/test/java/com/example/schoolapibackend/SchoolInfoServiceTests.java b/src/test/java/com/example/schoolapibackend/SchoolInfoServiceTests.java new file mode 100644 index 0000000..b9e14ff --- /dev/null +++ b/src/test/java/com/example/schoolapibackend/SchoolInfoServiceTests.java @@ -0,0 +1,24 @@ +package com.example.schoolapibackend; + +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import com.example.schoolapibackend.service.SchoolFeignService; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +public class SchoolInfoServiceTests { + + @Autowired + private SchoolFeignService schoolFeignService; + + @Test + void test() { + SchoolInfoDto json = schoolFeignService.getSchoolInfo("109d00c3cf35465f99a8ea341d822795", "json", 1, 100); + System.out.println("json = " + json.toString()); + SchoolInfoDto.Row row = new SchoolInfoDto.Row(); + int list_total_count = json.getSchoolInfo().get(0).getHead().get(0).getList_total_count(); + System.out.println("list_total_count = " + list_total_count); + } +} diff --git a/src/test/java/com/example/schoolapibackend/repository/SchoolInfoRepositoryTest.java b/src/test/java/com/example/schoolapibackend/repository/SchoolInfoRepositoryTest.java new file mode 100644 index 0000000..0f5e9a7 --- /dev/null +++ b/src/test/java/com/example/schoolapibackend/repository/SchoolInfoRepositoryTest.java @@ -0,0 +1,42 @@ +package com.example.schoolapibackend.repository; + +import com.example.schoolapibackend.domain.SchoolInfo; +import com.example.schoolapibackend.dto.SchoolInfoDto; +import com.example.schoolapibackend.service.SchoolFeignService; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; + +import java.util.List; + +import static org.junit.jupiter.api.Assertions.*; + +@SpringBootTest +class SchoolInfoRepositoryTest { + + @Autowired + SchoolInfoRepository schoolInfoRepository; + + @Autowired + SchoolFeignService schoolFeignService; + + @Test + void test() { + int pSize = 100; + SchoolInfoDto schoolInfoDto = schoolFeignService.getSchoolInfo("109d00c3cf35465f99a8ea341d822795", "json", 1, 1); + int list_total_count = schoolInfoDto.getSchoolInfo().get(0).getHead().get(0).getList_total_count(); + + for (int j = 1; j <= list_total_count / 100 + 1; j++) { + if (j == list_total_count / 100 + 1) pSize = list_total_count % 100; + schoolInfoDto = schoolFeignService.getSchoolInfo("109d00c3cf35465f99a8ea341d822795", "json", j, pSize); + for (int i = 0; i < pSize; i++) { + List row = schoolInfoDto.getSchoolInfo().get(1).getRow(); + SchoolInfo schoolInfo = new SchoolInfo(); + schoolInfo.setAddress(row.get(i).getAddress()); + schoolInfo.setSchoolCode(row.get(i).getSchoolCode()); + schoolInfo.setSchoolName(row.get(i).getSchoolName()); + schoolInfoRepository.save(schoolInfo); + } + } + } +} \ No newline at end of file