[소프트웨어 설계] 4장. 인터페이스 설계

027 시스템 인터페이스 요구사항 분석

◈ 시스템 인터페이스 요구사항 구성

  - 독립적으로 떨어져 있는 시스템들끼리 서로 연동하여 상호 작용하기 위한 접속 방법이나 규칙을 의미

  - 개발을 목표로 하는 시스템과 외부 시스템을 연동하는데 필요한 시스템 인터페이스에 대한 요구사항을 기술

  - 시스템 인터페이스 요구사항 명세서

   * 인터페이스 이름

   * 연계 대상 시스템

   * 연계 범위 및 내용

   * 연계 방식

   * 송신 데이터

   * 인터페이스 주기

   * 기타 고려사항

 

◈ 시스템 인터페이스 요구사항 분석

  - 요구사항 명세서에서 요구사항을 기능적 요구사항과 비기능적 요구사항으로 분류하고 조직화해 요구사항 명세를 구

체화하고 이를 이해관계자에게 전달하는 일련의 과정

  - 요구사항 분석은 소프트웨어 요구사항 분석 기법을 적절히 이용

  - 요구사항 분해 필요시 적절한 수준으로 세분화

  - 요구사항에 대한 상대적 중요도를 평가해 우선순위 부여

  - 요구사항 분석 시 누락된 요구사항이나 제한조건 추가

 

◈ 시스템 인터페이스 요구사항 분석 절차

   ① 소프트웨어 요구사항 목록에서 시스템 인터페이스 관련 요구사항 선별하여 별도로 시스템 인터페이스 요구사항 목록을 만듦

   ② 시스템 인터페이스와 관련된 요구사항 및 아키텍처 정의서, 현행 시스템의 대, 내외 연계 시스템 현황 자료 등 시스템 인터페이스 요구사항과 관련된 자료 준비

   ③ 시스템 인터페이스에 대한 요구사항 명세서를 확인하여 기능적인 요구사항과 비기능적인 요구사항으로 분류

   ④ 시스템 인터페이스 요구사항 명세서와 시스템 인터페이스 요구사항 목록 및 기타 관련 자료들을 비교하여 요구사항 분석하고 내용을 추가하거나 수정

   ⑤ 추가, 수정한 시스템 인터페이스 요구사항 명세서와 시스템 인터페이스 요구사항 목록을 관련 이해관계자에게 전달

 

028 인터페이스 요구사항 검증

◈ 요구사항 검증(Requirements Verification)

  - 사용자들의 요구사항이 요구사항 명세서에 정확하고 완전하게 기술되었는지 검토하고 개발 범위의 기준인 베이스라인을 설정

  - 인터페이스 설계 및 구현 중에 요구사항 명세서의 오류가 발견되어 이를 수정할 경우 많은 비용이 소모되므로 프로젝트에서 요구사항 검증은 매우 중요

  - 순서 : [요구사항 검토 계획 수립] → [검토 및 오류 수정] → [베이스라인 설정]

 

◈ 인터페이스 요구사항 검토 계획 수립

  - 프로젝트 이해관계자들이 프로젝트 품질 관리 계획을 참조하여 요구사항 검토 계획 수립

  - 검토 계획이 수립되면 인터페이스 요구사항 검토 참여자들에게 검토 관련 자료와 일정 등 전달

   * 검토 기준 및 방법 : 프로젝트 규모와 참여 인력, 검토 기간 등을 고려하여 검토 기준 및 방법 선정

   * 참여자 : 프로젝트 규모에 따라 이해관계자들을 파악하여 요구사항 검토 참여자를 선정

   * 체크리스트 : 완전성, 일관성, 명확성 등의 항목을 점검할 수 있는 체크리스트 작성

   * 관련 자료 : 인터페이스 요구사항 검토에 필요한 자료 준비

   * 일정 : 인터페이스 요구사항 검토 일정을 정함

 

◈ 인터페이스 요구사항 검토 및 오류 수정

  - 인터페이스 요구사항 검토는 검토 체크리스트의 항목에 따라 인터페이스 요구사항 명세서 검토

  - 검토 시 오류가 발견되면 오류를 수정할 수 있도록 오류 목록과 시정 조치서 작성

  - 오류 수정과 요구사항 승인 절차를 진행할 수 있도록 요구사항 검토 결과를 검토 관련자들에게 전달

  - 시정 조치서를 작성한 경우 시정 조치가 완료되었는지 확인되면 인터페이스 요구사항 검토 작업을 완료함

 

◈ 인터페이스 요구사항 베이스라인 설정

  - 검토를 통해 검증된 인터페이스 요구사항은 프로젝트 관리자와 주요 의사 결정자에게 승인 받음

  - 소프트웨어 설계 및 구현을 위해 요구사항 명세서의 베이스라인 설정

 

◈ 요구사항 검증 방법

 1)요구사항 검토 : 검토 담당자들이 수작업으로 분석

  - 동료검토(Peer Review) : 요구사항 명세서 작성자가 내용을 직접 설명, 동료들이 이름 들으면서 결함 발견

  - 워크스루(Walk Trough) : 검토 회의 전 요구사항 명세서를 미리 배포해 짧은 검토회의를 통해 결함 발견

  - 인스펙션(Inspection) : 요구사항 명세서 작성자를 제외한 다른 검토 전문가들이 결함 발견

 2) 프로토타이핑 : 실제 개발될 소프트웨어에 대한 견본품을 만들어 최종 결과물 예측

 3) 테스트 설계 : 테스트 케이스를 생성해 이후에 요구사항이 현실적으로 테스트 가능한지 검토

 4) CASE 도구 활용 : 일관성 분석을 통해 요구사항 변경사항의 추적 및 분석, 관리, 표준 준수 여부 확인

 

◈ 인터페이스 요구사항 검증의 주요 항목

  - 완전성 : 사용자의 모든 요구사항이 누락되지 않고 완전하게 반영되었는가?

  - 일관성 : 요구사항이 모순되거나 충돌되는 점 없이 일관성을 갖고 있는가?

  - 명확성 : 모든 참여자가 요구사항을 명확히 이해할 수 있는가?

  - 기능성 : 요구사항이 '어떻게'보다 '무엇을'에 중점을 두고 있는가?

  - 검증 가능성 : 요구사항이 사용자의 요구를 모두 만족하고, 사용자의 요구 내용과 일치하는지를 검증할 수 있는가?

  - 추적 가능성 : 요구사항 명세서와 설계서를 추적할 수 있는가?

  - 변경 용이성 : 요구사항 명세서의 변경이 쉽도록 작성되었는가?

 

029 인터페이스 시스템 식별

◈ 개발 시스템 식별

  - 인터페이스 관련 자료들을 기반으로 개발하고자 하는 시스템의 상세 식별 정보를 정의하고 목록 작성

  - 구분 / 시스템 한글명 / 시스템 영문명 / 시스템 설명 / 시스템 레벨 / 상위 시스템 / 설치 위치

 

◈ 내외부 시스템 식별

  - 인터페이스 관련 자료들을 기반으로 개발할 시스템과 연계할 내외부 시스템들의 상세 식별 정보를 정의하고 목록을 작성

  - 구분(내부, 외부) / 시스템 한글명 / 시스템 영문명 / 시스템 설명 / 시스템 레벨 / 상위 시스템 / 설치 위치

 

◈ 내외부 시스템 환경 및 관리 주체 식별

  - 인터페이스 관련 자료들을 기반으로 내외부 시스템의 실제 운용 환경과 하드웨어 관리 주체를 확인

  - 내외부 시스템 환경 : 연계할 시스템 접속에 필요한 IP, URL, Port 정보 등 시스템의 실제 운용 환경

  - 내외부 시스템 관리 주체 : 하드웨어를 실제적으로 관리하는 담당자

  - 구분(내부, 외부) / 시스템 ID / 시스템 한글명 / 시스템 영문명 / 시스템 설명 /... / IP(URL) / Port / 담당자

 

◈ 내외부 시스템 네트워크 연결 정보 식별

  - 인터페이스 관련 자료들을 기반으로 내외부 시스템을 연계하는데 필요한 네트워크 연결 정보를 확인

  - 내외부 시스템 네트워크 연결 정보 : 시스템 로그인 및 DB 정보

  - 구분(내부, 외부) / 시스템 ID / Hostname / IP / Port / Login ID / Password / DB type / DB  User ID / DB User PW 

 

◈ 인터페이스 식별

  - 인터페이스 요구사항 명세서, 목록 기반으로 개발할 시스템과 이와 연계할 내외부 시스템 사이의 인터페이스를 식별하고 인터페이스 목록 작성

  - 인터페이스 ID / 인터페이스명 / 설명 / 관련 요구사항

 

◈ 인터페이스 시스템 식별

  - 인터페이스에 참여하는 시스템들을 송수신 시스템으로 구분하여 작성

  - 인터페이스 ID / 인터페이스명 / 인터페이스 구분(대외, 대내) / 송신 시스템 / 수신 시스템

 

030 송·수신 데이터 식별

◈ 식별 대상 데이터

  - 송수신 시스템 사이에서 교환되는 데이터로, 규격화된 표준 형식에 따라 전송됨

  - 교환되는 데이터 종류 : 인터페이스 표준 항목, 송수신 데이터 항목, 공통 코드

 1) 인터페이스 표준 항목

  - 송수신 시스템을 연계하는데 표준적으로 필요한 데이터

  - 시스템 공통부 : 시스템 간 연동 시 필요한 공통 정보(인터페이스 ID, 전송 시스템 정보, 서비스 코드 정보, 장애 정보 등)

  - 거래 공통부 : 시스템들이 연동된 후 송수신 데이터를 처리할 때 필요한 정보(직원 정보, 승인자 정보, 기기 정보, 매체 정보 등)

 2) 송수신 데이터 항목

  - 송수신 시스템이 업무를 수행하는 데 사용하는 데이터

  - 전송되는 데이터 항목과 순서는 인터페이스별로 다름

 3) 공통 코드

  - 시스템들에서 공통적으로 사용하는 코드

  - 연게 시스템이나 연계 소프트웨어에서 사용하는 상태 및 오류 코드 등과 같은 항목에 대해 코드값과 코드명, 코드 설명 등을 공통 코드로 관리

 

◈ 정보 흐름 식별

  - 개발할 시스템과 내외부 시스템 사이에서 전송되는 정보들의 방향성을 식별

  - 개발할 시스템과 내외부 시스템에 대한 각각의 인터페이스 목록을 확인해 정보 흐름 식별

  - 식별한 정보 흐름을 기반으로 송수신 시스템 사이에서 교환되는 주요 데이터 항목이나 정보 그룹을 도출

 

◈ 송수신 데이터 식별

  - 개발할 시스템과 연계할 내외부 시스템 사이의 정보 흐름과 DB 산출물을 기반으로 송수신 데이터 식별

  - 송수신 데이터 종류 : 인터페이스 표준 항목에 대한 데이터 항목, 코드성 데이터 항목

  - 인터페이스 표준 항목과 송수신 데이터 항목 식별 : 송수신 시스템 사이의 교환 범위 확인, 인터페이스 표준 항목에 대해 송수신 데이터 항목 식별

  - 코드성 데이터 항목 식별 : 코드, 코드명, 코드 설명 등의 코드 정보 식별

  - 송신 시스템에서 사용하는 코드 정보와 수신 시스템에서 사용하는 코드 정보가 동일한 경우 공통 코드 정보를 확보함, 다른 경우 매핑 필요 대상으로 분류해 양쪽 시스템에서 사용하는 코드 정보 확보

 

031 인터페이스 방법 명세화

◈ 인터페이스 방법 명세화의 개념

  - 내외부 시스템이 연계하여 작동할 때 데이터를 주고받는 방법, 주고받는 데이터의 종류, 에러 발생 시 처리해야 할 내용들을 문서로 명확하게 정리

 

◈ 시스템 연계 기술

  - 개발할 시스템과 내외부 시스템을 연계할 때 사용되는 기술을 의미

  - DB Link : DB에서 제공하는 DB Link 객체를 이용하는 방식

  - API/Open API : 송신 시스템의 DB에서 데이터를 읽어 와 제공하는 애플리케이션 프로그래밍 인터페이스 프로그램

  - 연계 솔루션 : EAI 서버와 송수신 시스템에 설치되는 클라이언트를 이용

  - Socket : 서버는 통신을 위한 소켓을 생성해 포트를 할당하고 클라이언트의 통신 요청 시 클라이언트와 연결하여 통신

  - Web Service : 웹 서비스에서 WSDL, UDDI, SOAP 프로토콜을 이용해 연계

 

◈ 인터페이스 통신 유형

  - 개발할 시스템과 내외부 시스템 간 데이터를 송수신하는 형태

  - 단방향 : 시스템에서 거래를 요청만 하고 응답이 없는 방식

  - 동기 : 시스템에서 거래를 요청하고 응답이 올 때까지 대기하는 방식

  - 비동기 : 시스템에서 거래를 요청하고 다른 작업을 수행하다 응답이 오면 처리하는 방식

 

◈ 인터페이스 처리 유형

  - 송수신 데이터를 어떤 형태로 처리할 것인지에 대한 방식

  - 실시간 방식 : 사용자가 요청한 내용을 바로 처리해야 할 때 사용

  - 지연 처리 방식 : 데이터를 매건 단위로 처리할 경우 비용이 많이 발생할 때 사용

  - 배치 방식 : 대량의 데이터를 처리할 때 사용

 

◈ 인터페이스 발생 주기

  - 개발할 시스템과 내외부 시스템 간 송수신 데이터가 전송되어 인터페이스가 사용되는 주기

  - 업무의 성격과 송, 수신 데이터 전송량을 고려하여 매일, 수시, 주 1회 등으로 구분

 

◈ 송수신 방법 명세화

  - 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 연계 방식, 통신 및 처리 유형, 발생 주기 등의 송수신 방법을 정의하고 명세를 작성

  - 시스템 인터페이스 설계 시 작성한 아키텍처 정의서를 기반으로 업무 및 데이터의 성격, 연계 데이터의 발생 건수, 연계 시스템의 기술 구조, 시스템 간의 성능 등을 고려

 

◈ 송수신 데이터 명세화

  - 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스 시 필요한 송수신 데이터에 대한 명세를 작성

  - 인터페이스별로 테이블 정의서와 파일 레이아웃에서 연계하고자 하는 테이블 또는 파일 단위로 송수신 데이터에 대한 명세 작성

 

◈ 오류 식별 및 처리 방안 명세화

  - 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스 시 발생할 수 있는 오류를 식별하고 오류 처리 방안에 대한 명세를 작성

  - 오류 상황에 대해 오류 코드, 오류 메시지, 오류 설명, 해결 방법 등을 명세화

 

032 시스템 인터페이스 설계서 작성

◈ 시스템 인터페이스 설계서의 개요

  - 시스템의 인터페이스 현황을 확인하기 위해 시스템이 갖는 인터페이스 목록과 각 인터페이스의 상세 데이터 명세를 정의한 문서

  - 시스템 인터페이스 목록과 시스템 인터페이스 정의서로 구성

  - 인터페이스 송수신 방법과 인터페이스 송수신 데이터 명세화 과정에서 작성한 산출물을 기반으로 작성

  - 작성 후에는 시스템 인터페이스 목록에 있는 각각의 인터페이스를 시스템 인터페이스 정의서의 내용과 비교하여 누락되거나 보완이 필요한 경우 내용 수정

  - 내외부 모듈 간 공통적으로 제공되는 기능과 각 데이터의 인터페이스를 확인하는 데 사용

 

◈ 시스템 인터페이스 목록 작성

  - 업무 시스템과 내외부 시스템 간 데이터를 주고받는 경우에 사용하는 인터페이스에 대해 기술

  - 연계 업무와 연계에 참여하는 송수신 시스템의 정보, 연계 방식과 통신 유형 등에 대한 정보 기록

 

◈ 시스템 인터페이스 정의서 작성

  - 인터페이스별로 시스템 간의 연계를 위해 필요한 데이터 항목 및 구현 요건 등을 기술

  - 데이터 송수신 시스템 간 데이터 저장소와 속성 등 상세 정보 기록

  - 인터페이스 ID, 인터페이스명, 처리 유형, 통신 유형, 주기, 인터페이스 구분, 데이터 포맷은 인터페이스 목록을 참고하여 기재

  - 인터페이스 송수신 데이터 명세를 참조하여 기재

  - 코드 매핑 규칙 작성은 송수신 시스템의 항목이 단순 1:1이 아니기 때문에 병합, 변환 등 별도의 처리 로직이 필요한 경우 규칙 기재

 

033 미들웨어 솔루션 명세

◈ 미들웨어의 개념 및 종류

  - 운영체제에서 실행되는 응용 프로그램 사이에서 운영체제가 제공하는 서비스 이외에 추가적인 서비스를 제공하는 소프트웨어

  - 클라이언트와 서버간 통신을 효율적으로 수행하도록 도와주는 소프트웨어 

  - 통신 제공 방법이나 기능에 따라 DB, RPC, MOM, TP-Monitor, ORB, WAS로 구분

 1) DB

  - DB 벤더에서 제공하는 클라이언트에서 원격의 데이터베이스와 연결하기 위한 미들웨어

  - ODBC, IDAPI, Glue 등

 2) RPC(Remote Procedure Call)

  - 응용 프로그램의 프로시저를 사용해 원격 프로시저를 마치 로컬 프로시저처럼 호출하는 방식의 미들웨어

  - Entera, ONC/RPC 등

 3) MOM(Message Oriented Middleware)

  - 메시지 기반의 비동기형 메시지를 전달하는 방식의 미들웨어

  - 온라인 업무보다는 이기종 분산 데이터 시스템의 데이터 동기를 위해 많이 사용됨

 4) TP-Monitor(Transaction Processing Monitor)

  - 항공기나 철도 예약 업무 등과 같은 온라인 트랜잭션 업무에서 트랜잭션을 처리 및 감시하는 미들웨어

  - 사용자 수가 증가해도 빠른 응답 속도를 유지해야 하는 업무에 주로 사용

  - tuxedo, tmax 등

 5) ORB(Object Request Broker)

  - 객체 지향 미들웨어로 코바(CORBA) 표준 스펙을 구현한 미들웨어

  - TP-Monitor의 장점인 최근에는 트랜잭션 처리와 모니터링 등을 추가로 구현한 제품도 있음

  - Orbix, CORBA 등

 6) WAS(Web Application Server)

  - 정적인 콘텐츠를 처리하는 웹 서버와 달리 사용자의 요구에 따라 변하는 동적인 콘텐츠를 처리하기 위해 사용되는 미들웨어

  - 클라이언트/서버 환경보다는 웹 환경을 구현하기 위한 미들웨어

  - HTTP 세션 처리를 위한 웹 서버 기능뿐만 아니라 미션-크리티컬 한 기업 업무까지 JAVA, EJB 컴포넌트 기반으로 구현 가능

  - WebLogic, WebSphere 등

 

◈ 미들웨어 솔루션 식별

  - 개발 및 운영 환경에 사용될 미들웨어 솔루션을 확인하고 목록을 작성

  - 식별한 미들웨어 솔루션에 대해 시스템, 구분, 솔루션명, 버전, 제조사 등의 정보를 정리한 미들웨어 솔루션 목록 작성

 

◈ 미들웨어 솔루션 명세서 작성

  - 미들웨어 솔루션 목록의 미들웨어 솔루션 별로 관련 정보들을 상세하게 기술

  - 미들웨어 솔루션에 대한 상세 정보 및 제공 기능, 특징, 시스템 구성 환경 등에 대한 제약사항을 정리해 솔루션 명세서 작성