[Java]API 호출해서 문자 보내기📨

문자 전송을 위해 사용한 웹사이트는 알리고이다.

 

근데 이 서비스의 문제는 인코딩 방식이 UTF-8이 아닌 EUC-KR라는 것이다. 

아예 spec에서 "통신사의 웹 문자 발송 시스템은 기본적으로 EUC-KR인코딩 방식을 따르고 있습니다"라고 못을 박았다.

이번이 처음으로 API 통신 로직을 짜는거라 제대로 된 설명의 포스팅이 필요했는데 없어서...ㅠ 

도움을 받아 코드를 작성하고 기능이 성공적으로 실행되는 것까지 확인할 수 있었다.

 

그러나 자바로 url을 만들고 api를 호출하는 것은 처음이라... 어쨌든 무슨 의미인지 공부는 해야 한다.

 

API 기본 호출 순서

1. URL 설정
2. 헤더(Header)설정
3. 바디(Body)설정
4. 요청 보내기

여기서도 잘 정리했으니 여기선 간단하게 정리한다.

 

1. 요청 파라미터 구성

    String url = "웹사이트에서 제공하는 호출 url"
    String response = "";

    // 바디 설정
    Map<String, String> params = new HashMap<>();
    params.put("key", 키값);
    params.put("user_id", 아이디값);
    params.put("sender", 발신자);
    params.put("receiver", 수신자);
    params.put("msg", "아잉뿌잉뿌잉@#$%^&*()_亞");
    params.put("msg_type", "SMS");
    params.put("testmode_yn", "Y");

자세한 사항은 알리고 스펙 규약서를 보면 되지만.. 일단 필수 값들은 위와 같다.

알리고는 msg_type가 필수값은 아니지만 명시해서 보내는 것을 권장하고 있다.

testmode_yn은 테스트 모드를 할것인지의 유무인데, 이걸 안하면 과금되므로 매우 주의....

 

<Map>계열은 key-value 한 쌍의 데이터를 이루고 있는 객체이다. <String, String>이므로 예를 들어

 

params.put("과자", "홈런볼")

 

과 같이 사용할 수 있을 것이다. 파라미터 구성할 때 개인적으로 유용하게 쓰고 있다.

뭔가 맵계열 사용하면 코딩 고수가 되는 느낌.... Map에 대한 자세한 설명은 예전에 정리한 이걸 클릭해서 확인하면 될듯..

 

➕주의! HashMap과 LinkedHashMap의 차이점: HashMap은 순서를 보장하지 않지만 LinkedHashMap은 입력순서를 보장한다.

2. URL 인코딩 처리

    StringBuilder formBody = new StringBuilder();
    try {
        for (Map.Entry<String, String> entry : params.entrySet()) {
            if (formBody.length() > 0) formBody.append("&");
            formBody.append(URLEncoder.encode(entry.getKey(), "UTF-8"));
            formBody.append("=");
            formBody.append(URLEncoder.encode(entry.getValue(), "UTF-8"));
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }

 

(1) StringBuilder : 자바에서 문자열을 효율적으로 조작하기 위한 클래스. 문자열을 반복적으로 변경해야하는 상황에서 성능을 최적화할 수 있따.

 

(2) Map.Entry<String, String> entry : params.entrySet()

• Map.Entry : Map에서 한 쌍씩 꺼 key-value(=Entry)  Map안에 있는 한 쌍(=key와 value)의 데이터를 의미한다. 

key-value 한 쌍을 아우르는 것이 "엔트리Entry"이다.

• entrySet() : Map에 포함된 모든 Entry를 담은 Set(묶음)으로 반환하는 메소드이다. 따라서 Map에 있는 모든 엔트리를 반환할 수 있다. "Map의 엔트리를 순회한다!"

3. HTTP 헤더 설정

    // 헤더 설정
    Map<String,String> headers = new HashMap<String,String>();
    headers.put("Content-Type", "application/x-www-form-urlencoded; charset=EUC-KR");

알리고는 json이 아닌 폼 형태로 보내라고 지시한다(나도 몰랐다가 개발하면서 알게됨)

글고 SMS문자를 보낼 땐 EUC-KR로 인코딩하라고 했다.

그래서 헤더의 content-type을 form-urlencoded, EUC-KR타입으로 인코딩했다.

4. API 호출 및 응답 처리

    try { 
        // context = @Autowired로 선언된 private ApplicationContext context이다.
        NetUtil.setApplicationContext(context);    
        Map<String, Object> res = NetUtil.requestWebClient(url, HttpMethod.POST, headers, formBody.toString(), NetUtil.REST_BASIC);
        String responseBody = String.valueOf(res.get("resStr"));

        ObjectMapper objectMapper = new ObjectMapper();
        JsonNode root = objectMapper.readTree(responseBody);
        String resoibseData = root.path("message").asText();

    } catch(Exception ex) {
        log.error("[ERROR]API 호출 실패, " + ex);
    }

 

 

위 코드에서 알아야할 것이 크게 2가지가 있다.

 

(1) 📌 ApplicationContext란?

 

Spring에선 애플리케이션의 구성과 빈(=객체)을 관리해야 하는데, 그걸 담당하는 것이 ApplicationContext이다. 

지피티 선생님 왈, 

---

"스프링이 만들어놓은 큰 공장(컨테이너)"
👉 이 공장이 하는 일: 스프링 애플리케이션에서 사용하는 모든 객체(Bean)를 생성, 관리, 보관, 제공하는 역할.

---

이라 말씀하셨다. ApplicationContext의 역할은 BeanFactory가 담당하는 Bean을 생성하고 관계설정과 같은 제어역할 뿐만 아니라 설정 정보를 통해 제어까지 담당한다는 것이다.

즉 NetUtil.setApplicationContext(context)은

• setApplicationContext(context)는 ApplicationContext를 NetUtil 클래스 내부에서 사용할 수 있도록 설정하는 메서드이다.
• 즉, NetUtil 클래스가 스프링의 빈을 참조하거나 특정 기능을 수행할 때 context를 활용할 수 있게 된다 = NetUtil 내부에서 빈(bean) 조회나 RestTemplate 같은 스프링 빈을 꺼내 쓸 수 있게 된다.

 

솔직히 무슨 소리인지 잘 이해가 안가는데... 이건 여기까지만 알고 넘어가자. ApplicationContext가 빈(Service, Controller 등과 같은 객체)을 Spring에서 공통적으로 관리하기 위해 NetUtil에 applicationContext를 등록한다는건 알았다.

즉 NetUtil에서 Spring의 Bean을 직접 관리하고 활용하기 위해 부른 코드이다!

 

Spring구조까지 알아야 하는데 그건 너무 복잡하고... 이 코드를 이해하기 위해선

• 빈(Bean) : Controller, Service, Repository와 같은 객체들인데, 평범한 객체가 아닌 Spring 컨테이너에 의해 관리되는 객체이다(=개발자가 아닌 Spring 프레임워크가 자동으로 생성하고 주입하는 객체)
• @Autowired : Spring에서 의존성 주입을 지원하기 위한 어노테이션. 이 어노테이션을 붙이면 스프링이 자동으로 필요한 의존성을 주입하여 객체 간의 관계를 설정한다(자바에서 생성자를 위해 new 사용하는거랑 똑같다) 
• 의존성 주입(Dependency Injection) : 객체(빈)을 Spring이 알아서 생성, 소멸시키는 행위이다.

Map<String, Object> res = NetUtil.requestRestTemplate(url, HttpMethod.POST, headers, formBody.toString(), NetUtil.REST_BASIC);

 

이어서 위 코드는 "어떤 서버에 HTTP POST 요청을 보내고, 그 결과(JSON)를 Map으로 받아오는 코드"이다.

이런식으로 가져와 준다고 한다. 즉, 서버에서 응답한 JSON을 Map 형태로 파싱해서 반환해준다.

파라미터로는 

• url : 호출할 url
• HttpMethod.POST : POST형식으로 보낼 것임을 알림
• headers : 헤더 설정
• formBody.toString() : 필요한 파라미터 설정 (알리고처럼 form일수도 있고, 보통은 json이다..)
• NetUtil.REST_BASIC : (내부 상수) 요청 모드, 인증방식 구분 등에 사용될 값

와 같다...

 

 

(2) 📌ObjectMapper, JsonNode란?

이건 사실 예전에 봐서 크게 낯설진 않다.

ObjectMapper objectMapper = new ObjectMapper();
JsonNode root = objectMapper.readTree(responseBody);

쉽게 말하면, "JSON 문자열을 읽어서 JsonNode 라는 트리 형태의 데이터로 변환하는 코드"라고 보면 된다.

• ObjectMapper : JSON 문자열 ↔ 자바 객체 변환 담당. Jackson 라이브러리에서 제공 (=JSON파서)
  • JSON을 파싱해서 내가 원하는 클래스 객체로 만들어주거나
  • 자바 객체를 JSON문자열로 변환해준다.
• JsonNode : 계층 구조로 JSON구조를 탐색할 수 있는 객체
• readTree() :  문자열 형태의 JSON을 JsonNode 트리 구조로 변환한다. 

예시로 보니까 너무 편안~~~~~~~하다

예전에 봐서 아주 막막하고 어려운건 아니지만 한번 더 복습 차원에서~

 

참고:

https://velog.io/@artp/Java-Map%EA%B3%BC-Entry%EC%9D%98-%EA%B4%80%EA%B3%84

[Java] Map과 Entry의 관계

https://velog.io/@gehwan96/Spring-Boot-ApplicationContext%EC%97%90-%EB%8C%80%ED%95%B4-%EC%95%8C%EC%95%84%EB%B3%B4%EC%9E%90

Spring Boot - ApplicationContext에 대해 알아보자.

https://www.notion.so/isSummary-1ac9d6b82d4549f9af5b97e4eeac13ac 

(이건 내꺼다)