공공데이터포털 서비스키 어떻게 쓰는건데... ( •᷄⌓•᷅ )

1. 공공데이터포털에서 제공하는 서비스키는 일단 인코딩된 키를 제공한다.

그래서 아래와 같이 %와 같이 변환되는 것을 볼 수 있다. 

 

// 기본적으로 제공하는 인코딩된 키(서비스키 일부 삭제)

https://apis.data.go.kr/1160100/service/GetMarketIndexInfoService/getStockMarketIndex?serviceKey=qfXqzDLVVPW1Ks0oWU%2Bm8Z9JphEfjCDxm7GMBUkVC4GoPQshE%2B8Uk%2BQ%3D%3D&

이렇게 포스트맨이나 공공데이터포털에서 테스트해보면 제대로 나오지만, 코드상으로는 나오지 않는다. 

다른 API도 같은 방식으로 사용하나 이건 제대로 나와서 더 왜 안되는지 잘 모르겠다.

 

 

 

 

-> 그럼 인코딩의 뜻이 정확하게 무엇이냐? 디코딩은?

Codable 프로토콜은 Encodable과 Decodable로 구성되었으며,class, struct, enum 에 채택이 가능하다.

 

 

 

 

 

 

 

 

2. 인코딩이 되어 있는 키라 %와 같은 특수 문자가 들어가 있다. 

 

3. url을 만들 때, 다시 한번 인코딩이 되기 때문에(?) 인코딩이 두번 돼서 키값이 바뀐다? 

 

4. 그렇다면 공공데이터포털에서는 왜 사람 힘들게 이렇게 서비스키를 인코딩해서 주는 것인가? 이유를 말해라,,,

 

5. 공공데이터포털 내에서 디코딩된 키도 제공하고 있다. 근데 안된다. 

 

 

 

---

1. 실제 서비스키를 사용하니 헷갈려서 임의로 내가 특수문자와 공백이 포함된 키값을 만들어보았다.

addingPercentEncoding을 사용하여 인코딩 했을 때 아래와 같이 나온다. 

 

 

 

2. endpoint가 네트워크매니저로 들어오고, urlComponents.queryItems를 찍어보았다. 

인코딩된 값이 제대로 들어온 것을 확인.

 

그리고 url 부분을 찍어보았을 때 추가적으로 인코딩이 또 된 것을 볼 수 있었다. 

즉, 인코딩이 2번 된 것. 

 

 

3. 그렇다면 서비스키와 비슷하게 상황을 다시 만들어본다. 

공공데이터포털에서 제공해준 인코딩된 키를 가정해본다. 

지금 인코딩이 2번 된 것이 문제였으므로 인코딩 된 서비스키를 디코딩하는 것부터 시작한다. 

디코딩이 제대로 된 것을 확인할 수 있다.

 

 

4. 네트워크매니저에서 url을 확인해보면 인코딩된 키가 url에 들어간 것을 볼 수 있다. 

 

 

인코딩이 두번 되는 상황에서 처음 디코딩을 해주면 url이 만들어지는 과정에서 인코딩 과정을 거치게 되어 올바르게 들어가는 것 같다. 

근데, 서비스키는 왜 안될까.

---

다시 돌아와서 서비스키로 다시 시도해본다. 

 

1. 인코딩이 된 키를 디코딩 한다.

 

 

2. urlComponents.queryItems을 확인해본다.

디코딩 된 서비스키가 들어온다 

 

 

3. url을 확인해보니 뭐가 바뀌긴 했다. 인코딩이 된 걸까...

근데 얘는 왜 +와 %와 같은 특수문자들이 또 들어가 있는걸까...

 

 

---

percentEncodedQuery와 addingPercentEncoding(withAllowedCharacters:)의 차이점이 뭘까

둘 다 인코딩과 관련된 기능을 하는 면에서 유사하지만 차이점이 있다. 

 

1. percentEncodedQuery

- ; 문자는 합법적인 경로 문자이지만, URL 호환성을 극대화하기 위해 퍼센트 인코딩하는 것이 권장됩니다. CharacterSet.urlQueryAllowed와 함께 String.addingPercentEncoding(withAllowedCharacters:) 메서드를 사용하면 ; 문자를 퍼센트 인코딩할 수 있습니다.

 

- getter

getter는 percentEncodedQuery의 값을 읽어올 때 호출되는 메서드.

즉, percentEncodedQuery 프로퍼티에 저장된 값을 요청하면, 이 값이 퍼센트 인코딩된 상태로 반환됨.

예를 들어, URL의 쿼리 문자열을 읽을 때, 이 문자열이 이미 퍼센트 인코딩된 형태로 저장되어 있다면 그대로 반환.

 

사용되는 상황: 해당 프로퍼티에 접근하여 값을 출력하거나 다른 변수에 할당하려고 할 때

// getter
// 퍼센트 인코딩된 형태로 저장
let query = urlComponents.percentEncodedQuery
print(query) // 퍼센트 인코딩된 쿼리 문자열을 반환

// 퍼센트 인코딩이 되지 않은 형태로 저장: 인코딩되지 않은 문자열 그대로 반환
urlComponents.percentEncodedQuery = "name=John Doe"
let query = urlComponents.percentEncodedQuery
print(query) // "name=John Doe" (퍼센트 인코딩이 적용되지 않음)

 

 

- setter

setter는 percentEncodedQuery 프로퍼티에 값을 설정할 때 호출되는 메서드.

이 경우, setter는 설정하려는 쿼리 문자열이 이미 퍼센트 인코딩되었다고 가정하고 값을 저장.

잘못된 인코딩이 된 문자열을 설정하려고 하면, fatalError가 발생할 수 있음. 

 

사용되는 상황: 프로퍼티의 값을 변경(새로운 값 할당)할 때

// setter
urlComponents.percentEncodedQuery = "name%20=John%20Doe" // 퍼센트 인코딩된 쿼리 문자열을 설정

 

 

**퍼센트인코딩은 URL에서 특정 문자를 안전하게 표현하기 위해 사용하는 인코딩 방식이다 

URL에 포함될 수 없는 특수문자(공백, #, &)를 사용할 경우 %와 ASCII코드 16진수로 인코딩한다. 

 

 

2. addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)

- 문자열에서 특정 문자를 퍼센트 인코딩할 때 사용

반환 값

퍼센트 인코딩된 문자열을 반환하며, 변환이 불가능한 경우 nil을 반환합니다.

 

설명

전체 URL 문자열은 퍼센트 인코딩될 수 없습니다. URL의 각 구성 요소마다 허용되는 문자가 다르기 때문입니다. 예를 들어, URL의 쿼리 구성 요소는 @ 문자를 허용하지만, 이 문자는 비밀번호 구성 요소에서는 퍼센트 인코딩되어야 합니다.

UTF-8 인코딩을 사용하여 올바른 퍼센트 인코딩 문자를 결정합니다. allowedCharacters에 포함된 7비트 ASCII 범위를 벗어나는 문자는 무시됩니다.

 

 

중요한 점

이미 퍼센트 인코딩된 문자열에서 이 메서드를 호출하면 안 됩니다. 이미 퍼센트 인코딩된 문자열에 대해 이 메서드를 호출하면 퍼센트 인코딩 시퀀스의 퍼센트 문자가 두 번 인코딩됩니다.

---

여기까지 보고 다시 만들어진 url을 봐보자,,,

%이외의 +와 같은 특수문자들이 보인다. 

 

 

첫번째 시도 방법

getter와 setter 개념을 적용해본다. -> 안됨

 

 

두번째 시도 방법 

궁금해서 시도 해봤음..ㅇㅇ

키값을 직접 문자열로 직접 입력해본다면...?? 그래도 안됨...

 

 

 

세번째 시도 방법

문자열을 인코딩 해보자 ... -> 안됨..ㅎㅎ

 

 

인코딩이 된 키를 urlComponents에서 url을 만드는 과정에서 한번 더 인코딩이 되는 문제

1. 처음부터 디코딩 된 키를 사용해서 url을 만든다 

2. 인코딩이 된 키를 디코딩한 후 url을 만든다