diff --git a/build.gradle b/build.gradle index 5276203..08d3a83 100644 --- a/build.gradle +++ b/build.gradle @@ -46,8 +46,9 @@ dependencies { // OAuth2 login implementation 'org.springframework.boot:spring-boot-starter-oauth2-client' - //WebCilent + //WebFlux implementation 'org.springframework.boot:spring-boot-starter-webflux' + } tasks.named('test') { diff --git a/src/main/java/com/example/umc7th/global/config/SecurityConfig.java b/src/main/java/com/example/umc7th/global/config/SecurityConfig.java index 586b281..81fdef7 100644 --- a/src/main/java/com/example/umc7th/global/config/SecurityConfig.java +++ b/src/main/java/com/example/umc7th/global/config/SecurityConfig.java @@ -41,8 +41,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception{ http .authorizeHttpRequests(request -> request .requestMatchers(allowUrl).permitAll() - .anyRequest().authenticated()) //다른 요청들은 인증이 필요하도록 할 때 설정 -// .anyRequest().permitAll()) +// .anyRequest().authenticated()) //다른 요청들은 인증이 필요하도록 할 때 설정 + .anyRequest().permitAll()) .addFilterBefore(jwtFilter(), UsernamePasswordAuthenticationFilter.class) .formLogin(AbstractHttpConfigurer::disable) .httpBasic(HttpBasicConfigurer::disable) diff --git a/src/main/java/com/example/umc7th/openAPI/controller/OpenApiController.java b/src/main/java/com/example/umc7th/openAPI/controller/OpenApiController.java new file mode 100644 index 0000000..e81dd26 --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/controller/OpenApiController.java @@ -0,0 +1,27 @@ +package com.example.umc7th.openAPI.controller; + +import com.example.umc7th.global.apiPayload.CustomResponse; +import com.example.umc7th.global.apiPayload.exception.CustomException; +import com.example.umc7th.openAPI.dto.OpenApiResponseDTO; +import com.example.umc7th.openAPI.service.OpenApiQueryService; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequiredArgsConstructor +public class OpenApiController { + + private final OpenApiQueryService openApiQueryService; + + @GetMapping("/searchStay") + public CustomResponse controller( + @RequestParam(name = "arrange", defaultValue = "A") String arrange, + @RequestParam(name = "page", defaultValue = "1") int page, + @RequestParam(name = "offset", defaultValue = "10") int offset) { + + return CustomResponse.onSuccess(openApiQueryService.searchStay(arrange, page, offset)); + } + +} diff --git a/src/main/java/com/example/umc7th/openAPI/dto/OpenApiResponseDTO.java b/src/main/java/com/example/umc7th/openAPI/dto/OpenApiResponseDTO.java new file mode 100644 index 0000000..435db6f --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/dto/OpenApiResponseDTO.java @@ -0,0 +1,45 @@ +package com.example.umc7th.openAPI.dto; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.List; + +public class OpenApiResponseDTO { + @Builder + @NoArgsConstructor + @AllArgsConstructor + @Getter + // 해당 어노테이션으로 json 값을 Parsing할 때 필드가 없는 경우 무시하여 에러가 터지는 것을 방지, 한번 없이 돌려보시면 이해가 더 잘 되실겁니다. + @JsonIgnoreProperties(ignoreUnknown = true) + public static class SearchStayResponseDTO { + // 아래 변수는 Api 명세서의 응답을 보고 그대로 받고 싶은 값들만 똑같은 이름으로 만들어줍니다. + private String addr1; + private String title; + private String tel; + private String contentid; + private String contenttypeid; + private String createdtime; + private String firstimage; + private String firstimage2; + private String mapx; + private String mapy; + } + + @Builder + @NoArgsConstructor + @AllArgsConstructor + @Getter + public static class SearchStayResponseListDTO { + private List item; + + public static SearchStayResponseListDTO from(List list) { + return SearchStayResponseListDTO.builder() + .item(list) + .build(); + } + } +} diff --git a/src/main/java/com/example/umc7th/openAPI/exception/OpenApiErrorCode.java b/src/main/java/com/example/umc7th/openAPI/exception/OpenApiErrorCode.java new file mode 100644 index 0000000..c171ff3 --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/exception/OpenApiErrorCode.java @@ -0,0 +1,17 @@ +package com.example.umc7th.openAPI.exception; + +import com.example.umc7th.global.apiPayload.code.BaseErrorCode; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor +public enum OpenApiErrorCode implements BaseErrorCode { + UNSUPPORTED_LANGUAGE(HttpStatus.NOT_FOUND, "OPENAPI400", "제공되지 않는 언어입니다."), + ; + + private final HttpStatus status; + private final String code; + private final String message; +} diff --git a/src/main/java/com/example/umc7th/openAPI/exception/OpenApiException.java b/src/main/java/com/example/umc7th/openAPI/exception/OpenApiException.java new file mode 100644 index 0000000..f10df05 --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/exception/OpenApiException.java @@ -0,0 +1,10 @@ +package com.example.umc7th.openAPI.exception; + +import com.example.umc7th.global.apiPayload.code.BaseErrorCode; +import com.example.umc7th.global.apiPayload.exception.CustomException; + +public class OpenApiException extends CustomException { + public OpenApiException(BaseErrorCode code) { + super(code); + } +} diff --git a/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryService.java b/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryService.java new file mode 100644 index 0000000..a2bb6d7 --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryService.java @@ -0,0 +1,9 @@ +package com.example.umc7th.openAPI.service; + +import com.example.umc7th.openAPI.dto.OpenApiResponseDTO; + +public interface OpenApiQueryService { + + OpenApiResponseDTO.SearchStayResponseListDTO searchStay(String arrange, int page, int offset); + OpenApiResponseDTO.SearchStayResponseListDTO toSearchStayResponseListDTO(String response); +} diff --git a/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryServiceImpl.java b/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryServiceImpl.java new file mode 100644 index 0000000..39979bb --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/service/OpenApiQueryServiceImpl.java @@ -0,0 +1,81 @@ +package com.example.umc7th.openAPI.service; + +import com.example.umc7th.openAPI.dto.OpenApiResponseDTO; +import com.example.umc7th.openAPI.webClient.OpenApiWebClient; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Service; +import org.springframework.web.reactive.function.client.WebClient; +import reactor.core.publisher.Mono; + +import java.util.ArrayList; +import java.util.List; + +@Slf4j +@RequiredArgsConstructor +@Service +public class OpenApiQueryServiceImpl implements OpenApiQueryService{ + + // WebClient를 가져오기 위한 빈 주입 + private final OpenApiWebClient openApiWebClient; + + @Value("${openapi.tour.serviceKey}") + private String serviceKey; // 인증 키 + + @Override + public OpenApiResponseDTO.SearchStayResponseListDTO searchStay(String arrange, int page, int offset) { + // Web Client 가져오기 + WebClient webClient = openApiWebClient.getTourWebClient("korean"); + Mono mono = webClient.get() // get method 사용 + // UriBuilder를 이용하여 Endpoint와 Query Param 설정 + .uri(uri -> uri + .path("/searchStay1") + .queryParam("numOfRows", offset) + .queryParam("pageNo", page) + .queryParam("MobileOS", "ETC") + .queryParam("MobileApp", "AppTest") + .queryParam("_type", "json") + .queryParam("arrange", arrange) + .queryParam("serviceKey", serviceKey) + .build()) + // 응답을 가져오기 위한 method (.onStatus()를 이용해서 Http 상태코드에 따라 다르게 처리해줄 수 있음) + .retrieve() + // 응답에서 body만 String 타입으로 가져오기 (ResponseEntity 중 Object만 String 형식으로 가져오기) + .bodyToMono(String.class) + // String 값을 메소드로 매핑하여 OpenApiResponseDTO.SearchStayResponseListDTO로 변경하기 + .map(this::toSearchStayResponseListDTO) + // 에러가 발생한 경우 log를 찍도록 + .doOnError(e -> log.error("Open Api 에러 발생: " + e.getMessage())) + // 성공한 경우에도 log를 찍도록 + .doOnSuccess(s -> log.info("관광 정보를 가져오는데 성공했습니다.")) + ; + + // block()을 사용해서 응답을 바로 가져오도록 + return mono.block(); + } + + @Override + public OpenApiResponseDTO.SearchStayResponseListDTO toSearchStayResponseListDTO(String response) { + ObjectMapper objectMapper = new ObjectMapper(); + try { + // item으로 담을 list 선언 + List list = new ArrayList<>(); + // JsonNode 형식으로 응답을 읽고 item이 담긴 배열만 읽고 싶기에 item이 있는 배열까지 들어가기 + JsonNode jsonNode = objectMapper.readTree(response).path("response").path("body").path("items").path("item"); + // item 하나씩 처리 + for (JsonNode node : jsonNode) { + // item 하나씩 읽어서 OpenApiResponseDTO.SearchStayResponseDTO로 변경해서 List에 추가 + list.add(objectMapper.convertValue(node, OpenApiResponseDTO.SearchStayResponseDTO.class)); + } + // 응답을 만들어서 반환 + return OpenApiResponseDTO.SearchStayResponseListDTO.from(list); + } catch (Exception e) { + // 에러 처리 + e.fillInStackTrace(); + } + return OpenApiResponseDTO.SearchStayResponseListDTO.from(null); + } +} diff --git a/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClient.java b/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClient.java new file mode 100644 index 0000000..26b2c83 --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClient.java @@ -0,0 +1,11 @@ +package com.example.umc7th.openAPI.webClient; + + +import org.springframework.web.reactive.function.client.WebClient; + +public interface OpenApiWebClient { + WebClient getTourWebClient(String language); +// WebClient getEnglishTourWebClient(); + + WebClient getWebClient(String baseUrl); +} diff --git a/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClientImpl.java b/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClientImpl.java new file mode 100644 index 0000000..142191c --- /dev/null +++ b/src/main/java/com/example/umc7th/openAPI/webClient/OpenApiWebClientImpl.java @@ -0,0 +1,57 @@ +package com.example.umc7th.openAPI.webClient; + +import com.example.umc7th.openAPI.exception.OpenApiErrorCode; +import com.example.umc7th.openAPI.exception.OpenApiException; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.client.reactive.ReactorClientHttpConnector; +import org.springframework.stereotype.Component; +import org.springframework.web.reactive.function.client.WebClient; +import org.springframework.web.util.DefaultUriBuilderFactory; +import reactor.netty.http.client.HttpClient; + +import java.time.Duration; + +@Component +@Slf4j +public class OpenApiWebClientImpl implements OpenApiWebClient{ + + + @Override + public WebClient getTourWebClient(String language) { + if (language.equals("korean")) { + return getWebClient("https://apis.data.go.kr/B551011/KorService1"); + } + else if (language.equals("english")) { + return getWebClient("https://apis.data.go.kr/B551011/EngService1"); + } + else { + throw new OpenApiException(OpenApiErrorCode.UNSUPPORTED_LANGUAGE); + } + } + + // 영문 API를 추가한 경우 +// @Override +// public WebClient getEnglishTourWebClient() { +// return getWebClient("https://apis.data.go.kr/B551011/EngService1"); +// } + + @Override + public WebClient getWebClient(String baseUrl) { + HttpClient httpClient = HttpClient.create() + .responseTimeout(Duration.ofMillis(20000)); + + // Uri를 build하는 factory 생성 (baseUrl을 WebClient 대신 여기에 포함하도록) + DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl); + // Uri factory에 인코딩 모드를 NONE으로 바꾸어 인코딩하지 않도록해줍니다. + factory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.NONE); + + return WebClient.builder() + .uriBuilderFactory(factory) + .clientConnector(new ReactorClientHttpConnector(httpClient)) + .filter((request, next) -> { + log.info("Web Client Request: "+ request.url()); + return next.exchange(request); + }) + .build(); + } +}