인터페이스 구성요소
| 구성요소 | 설명 | 비고 |
|---|---|---|
| 송신 시스템 | 인터페이스할 서비스, 데이터 또는 파일을 생성하여 전달하고 인터페이스 응답결과를 받아서 프로그램을 처리하는 시스템으로 인터페이스를 기동시킨다. | 소스 시스템 |
| 중계 시스템 | 송신 시스템과 수신 시스템 사이에서 데이터를 변환, 송/수신하고 송/수신 현황을 모니터링하고 인터페이스 처리흐름, 유량을 제어, 관리하는 시스템 | 인터페이스 솔루션이 적용됨 |
| 수신 시스템 | 수신받은 서비스, 데이터 또는 파일을 받은 후 요청사항에 대해서 응답을 하거나 데이터 또는 파일을 저장하는 시스템 | 타깃 시스템 |
| 프로토콜 | 인터페이스 시 데이터를 전송하는 네트워크 프로토콜 | HTTP, FTP, TCP/IP 등 |
| 데이터 포맷 | 인터페이스 시 전송되는 데이터의 형식으로 데이터 항목, 데이터 값을 구분한다. | JSON, XML, 데이터 스트림 등 |
인터페이스 데이터 구조 표준
기업 내 인터페이스 데이터 구조는 기업 내 인터페이스에 대해 로그 확인 및 오류 발생 시 추적 관리를 위해서 정의된 공통 데이터 구조를 말한다. 인터페이스 데이터 구조는 공통 정보를 관리하는 헤더부와 업무별 데이터를 전송하는 데이터부로 구분한다.
JSON (JavaScript Object Notation)
JSON은 속성-값 쌍으로 이루어진 데이터 객체를 전달하기 위한 텍스트 기반의 개방형 표준 데이터 포맷이다.
| 구분 | 내역 | 설명 |
|---|---|---|
| 수 | - 정수 - 실수 | 기본자료형, 8진수나 16진수 표현방법은 지원하지 않음 |
| 문자열 | "1234","Test","문자","\","json\" | 큰 따옴표로 묶음, \는 특수 기호 문자를 표현 |
| 배열 | [10,{"A":20},[30,"다음"]] | 배열은 대괄호로 나타냄, 배열의 각 요소는 기본 자료형이거나 배열, 객체임, 각 요소는 쉼표로 구분됨 |
| 객체 | {"test2":50, "test3"; "값3","test1":true} | 객체는 이름 : 값 쌍의 집합으로 중괄호를 사용함, 이름은 문자열이기 때문에 반드시 따옴표로 표현하며 값은 기본 자료형임 |
XML의 주요 특징
| 구분 | 예시 |
|---|---|
| 유니코드 문자 | xml은 유니코드를 지원하며, 거의 모든 문자를 표현가능 |
| xml 파서 | xml 문서 내 마크업 구조를 분석하고 필요 정보를 추출하여 프로그램에 추출결과를 넘긴다. |
| 마크업과 내용 | xml문서는 마크업과 콘텐츠로 구분되며 간단한 문법 규칙을 갖고 있다. 마크업으로 구성되는 문자열은 "<>"로 끝나거나 '&'로 시작하여 문자 ';'로 끝난다. |
| 엘리먼트 | 문서의 논리 요소, 구분 항목으로 태그 "<>"로 작성된다. 자식 엘리먼트를 포함될 수 있다. |
| 어트리뷰트 | 엘리먼트의 문서상의 속성정보이다. |
| xml 선언 | xml 문서는 맨 상단에 문서에 대한 정보를 선언 |
인터페이스 공통기능의 구성
시스템 간 인터페이스를 구현하고 런타임 환경에서 동작 시 발생하는 오류를 적절하게 예외처리를 하기 위해서는 다음과 같은 공통기능이 필요하다.
1. 예외처리 > 2. HTTP변환 > 3. 메시지 검사 > 4. 메시지 매핑 > 5. 원격호출 > 6. 응답코드 정의 > 7. 응답메시지 검사 > 8. HTTP 매핑 > 9. 메시지응답 매핑 > 10. HTTP 응답 > 11. 예외처리
데이터 통신을 사용하는 인터페이스 동작 간 실패 시 예외처리 방안을 정의
JSON, XML 등 인터페이스 객체를 이용하여 인터페이스를 구현하고 동작 간 실패할 때에는 송신, 수신 측면에서 각각 예외처리 방안을 정의한다.
오류코드
| 구분 | 오류코드 | 설명 |
|---|---|---|
| HTTP | 401 403 404 501 503 | 로그인을 하지 않아 요청 권한이 없음 금지된 페이지, 접근할 수 없음 찾을 수 없는 페이지, NOT FOUND 해당 요청을 처리하는 기능이 만들어지지 않음 수신 프로그램 내부 오류 |
애플리케이션에 보안 기능을 적용
-
비인가자 접근 권한 관리
- 객체 접근 권한을 고려하여 구현한다.
- 변수를 직접 핸드링할 수 없게 하고 접근 권한을 가진 함수만 접근할 수 있게한다.
-
악의적 코드 삽입 금지
- 특수 문자를 통한 SQL변조 시도 등 악의적인 공격 패턴을 입력하지 못하도록 사전 방지한다.
인터페이스 주요 공통 기능
송신 프로그램 내 처리
- 예외처리 : 인터페이스 응답값에 따라서 성공, 실패를 판단하고 실패 시 예외처리 로직을 구현
송신 어댑터
- 프로토콜 변환 : 요청 받은 메시지를 수신 시스템에 전달 가능한 프로토콜 형태로 변환
- 메시지 검사 : 인터페이스 데이터 항목 작성 시 작성한 속성값을 기반으로 요청 메시지의 유효성을 검사함
- 메시지 매핑 : 요청 메시지의 데이터 값을 인터페이스 데이터 항목 구조체로 매핑
- 프로토콜 응답 : 송신 프로그램이 응답을 받는 프로토콜로 응답 메시지를 전송함
수신 프로그램 내 처리
- 응답코드 : 인터페이스 요청에 대한 응답 시 처리 결과에 대한 상태를 코드화하여 결과를 전송함
수신 어댑터
- 원격 호출 : 리모트상에 떨어진 수신 시스템의 호출 대상 서비스, 기능을 호출함
- 응답 메시지 검사 : 수신 프로그램을 통해서 전달받은 응답 메시지의 유효성을 검사함
- 프로토콜 매핑 : 응답받은 메시지를 송신시스템이 처리 가능한 프로토콜 형태로 변환
- 메시지 응답 매핑 : 응답 메시지의 데이터 값을 인터페이스 데이터 항목 구조체로 매핑
유리