251121_01_ENH : JWT 수정, CodeEnum 추가, API 통신 모듈 추가
This commit is contained in:
68
README.md
68
README.md
@@ -12,6 +12,74 @@ Spring Boot 기반 사내 서비스에서 공통으로 사용하는 기능들을
|
||||
- 스케줄링 활성화 (`com.kri.common.scheduling`)
|
||||
- 기본 logback 설정 (`logback-spring.xml`)
|
||||
|
||||
### 공용 HTTP 클라이언트: ExternalApiClient
|
||||
|
||||
외부 API와 통신하기 위한 경량 공용 모듈을 제공합니다. 추가 의존성 없이 Java 17의 `java.net.http.HttpClient`를 사용합니다.
|
||||
|
||||
- 패키지: `com.kri.common.http`
|
||||
- 주요 클래스: `ExternalApiClient`, `ExternalApiResponse`
|
||||
|
||||
지원 메서드(문자열 body 기반)
|
||||
- `ExternalApiResponse get(String url, Map<String,String> headers)`
|
||||
- `ExternalApiResponse post(String url, Map<String,String> headers, String body)`
|
||||
- `ExternalApiResponse put(String url, Map<String,String> headers, String body)`
|
||||
- `ExternalApiResponse patch(String url, Map<String,String> headers, String body)`
|
||||
- `ExternalApiResponse delete(String url, Map<String,String> headers)`
|
||||
|
||||
기본 동작
|
||||
- 연결 타임아웃: 10초, 요청 타임아웃: 30초
|
||||
- body가 있고 `Content-Type` 헤더가 없으면 자동으로 `application/json; charset=utf-8` 설정
|
||||
- 예외 발생 시 `RuntimeException`으로 래핑하여 전달하며, `InterruptedException` 발생 시 인터럽트 플래그를 복원
|
||||
|
||||
응답 객체(`ExternalApiResponse`)
|
||||
- 필드: `statusCode`(int), `headers`(Map<String, List<String>>), `body`(String)
|
||||
- 정적 팩토리: `ExternalApiResponse.of(int, HttpHeaders, String)`
|
||||
|
||||
간단 사용 예시
|
||||
|
||||
```java
|
||||
import com.kri.common.http.ExternalApiClient;
|
||||
import com.kri.common.http.ExternalApiResponse;
|
||||
import java.util.Map;
|
||||
|
||||
ExternalApiClient client = new ExternalApiClient();
|
||||
|
||||
// POST 예시
|
||||
ExternalApiResponse postResp = client.post(
|
||||
"https://api.example.com/items",
|
||||
Map.of("X-API-KEY", "your-key"),
|
||||
"{\"name\":\"sample\"}"
|
||||
);
|
||||
int status = postResp.getStatusCode();
|
||||
String body = postResp.getBody();
|
||||
|
||||
// GET 예시
|
||||
ExternalApiResponse getResp = client.get(
|
||||
"https://api.example.com/items/123",
|
||||
Map.of("Authorization", "Bearer token")
|
||||
);
|
||||
if (getResp.getStatusCode() == 200) {
|
||||
System.out.println(getResp.getBody());
|
||||
}
|
||||
```
|
||||
|
||||
고급 사용: 커스텀 HttpClient/타임아웃
|
||||
|
||||
```java
|
||||
import java.net.http.HttpClient;
|
||||
import java.time.Duration;
|
||||
|
||||
HttpClient httpClient = HttpClient.newBuilder()
|
||||
.connectTimeout(Duration.ofSeconds(5))
|
||||
.build();
|
||||
|
||||
ExternalApiClient client = new ExternalApiClient(httpClient, Duration.ofSeconds(15));
|
||||
```
|
||||
|
||||
주의사항
|
||||
- 메서드 시그니처는 문자열 기반 body를 사용하므로, JSON 외 포맷을 전송할 경우 적절한 `Content-Type`을 직접 지정하세요.
|
||||
- 대용량 응답이 예상된다면 현재 구현은 `BodyHandlers.ofString()`을 사용한다는 점에 유의하세요.
|
||||
|
||||
이 문서는 **KriCommon을 사용하는 서비스(`example-service`)** 기준으로 작성되었습니다.
|
||||
(WebSocket 관련 기능은 현재 포함하지 않았으며, 추후 필요 시 별도 확장 예정입니다.)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user