====== 소켓통신(SocketIO) 디바이스API 가이드 프로그램 ======

===== 개요 =====

소켓통신(SocketIO) 가이드 프로그램은 디바이스 API 실행환경을 활용하여 하이브리드 앱을 개발 시 참고 및 활용될 수 있도록 구현된 전자정부 디바이스 API에 대한 가이드 앱으로써, 모바일 디바이스의 관련 기능을 JavaScript기반으로 구성 된 SocketIO DeviceAPI를 통하여 간단한 쳇팅 기능을 앱으로 연동하는 기능을 지원한다.

==== 특징 ====
본 가이드 프로그램에서는 JavaScript 모듈의 sockjs를 사용하여 웹서버의 websocket에 접속하여 양방향 데이터 처리(쳇팅) 기능을 제공하고 있다. \\
[참고] 소켓통신은 다른 모듈과 다르게 cordova plug-in을 사용하지 않고 현재 많이 쓰이는 sock.js JavaScript 라이브러리 사용한다.


==== 기능흐름도 ====
{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_flow.png?700|}}

==== 전제 조건 ====

^           구분            ^             내용             ^
|Local 디바이스 개발 환경| 전자정부표준프레임워크 개발환경3.6, Android SDK API 23(version 6.0 Marshmallow)|
|서버 사이드 개발 환경| 전자정부표준프레임워크 개발환경3.6|
|Mash up Open API 연계| N/A|
|테스트 디바이스 | Galaxy S3, G5|
|테스트 플랫폼 | Android 2.3, Android 6.0 |
|추가 라이브러리 적용|N/A|

==== 제약사항 ====

^           구분            ^             내용             ^
|지원 디바이스 및 플랫폼|N/A|
|크로스 도메인 사용|폰갭에서 특정 외부 도메인이나 외부 도메인의 하위 도메인을 사용해야할 경우,\\ Res/xml/config.xml에서 <access origin="" />에 외부 도메인 주소를 추가 설정해야 외부 도메인에 접속할 수 있다.|
|라이선스|N/A|

===== 설명 ===== 
소켓통신(SocketIO) 디바이스API 가이드 프로그램는 **대화명 입력**, **쳇팅하기**  기능으로 구성되어 있다.(관련기능 부분참조) \\

==== Device Application ====

=== 관련 소스 ===

^유형^대상소스명^비고^
|Activity|kr.go.egovframework.hyb.socketioapp.MainActivity|소켓통신 API 가이드 프로그램 Activity Class|
|CSS|assets/www/css/egovframwork/mbl/hyb/SocketIO.css |소켓통신 API 가이드 프로그램 주요 Cascading Style Sheets|
|IMAGE |assets/www/images/egovframwork/mbl/hyb/ |소켓통신 API 가이드 프로그램 주요 Image 폴더|
|JS |assets/www/js/egovframwork/mbl/hyb/SocketIO.js \\ assets/www/js/egovframwork/mbl/cmm/sockjs-1.1.1.min.js |소켓통신 API 가이드 프로그램 주요 JavaScript \\ sockjs-client JavaScript|
|RES |assets/www/res/ |소켓통신 API 가이드 프로그램 주요 Resource 폴더|
|XML |AndroidManiFest.xml |안드로이드 어플리케이션 설정 XML|
|HTML|assets/www/SocketIO.html|소켓통신 API 메인 페이지|
|HTML|assets/www/intro.html|소켓통신 API Intro 페이지|
|HTML|assets/www/license.html|소켓통신 API 라이센스 페이지|
|HTML|assets/www/overview.html|소켓통신 API 기능설명 페이지|

=== 활용 API ===

== SockJS 접속 ==
  * SockJS 클래스를 생성하고, 통신을 위하여 서버에 접속한다.

<code>
var sockjs = new SockJS(url);
</code>

^파라미터^설명^비고^
|url |통신을 위한 대상 URL | |

== sockjs.onopen == 
  * 서버와 연결이 성공적인 경우 콜백 함수
<code>
sockjs.onopen = function() {
     console.log('open');
 };
</code>

==  sockjs.onmessage == 
  * 서버로부터 전달 받을 메세지의 콜백 함수
<code>
sockjs.onmessage = function(e) {
     console.log('message', e.data);
 };
</code>

==  sockjs.onclose == 
  * 서버와 연결을 끊어진 경우 발생하는 콜백 함수
  [참고] close가 호출되면 발생하는 콜백 함수
<code>
sockjs.onclose = function() {
     console.log('close');
 };
</code>

==  sockjs.send == 
  * 서버에 메세지를 전달하는 함수
<code>
sockjs.send(message);
</code>

^파라미터^설명^비고^
|message |메세지 | text 타입|

==  sockjs.close == 
  * 서버와 연결을 끊는 함수
<code>
sockjs.close();
</code>

==== Server Application ====

=== 관련 소스 ===

^유형^대상소스명^비고^
|Config |egovframework.hyb.mbl.websocket.config.WsConfig.java |소켓통신 API 가이드 프로그램 Configurer class|
|ServiceHandler |egovframework.hyb.mbl.websocket.ws.ChatWebSocketHandler.java |소켓통신 API 가이드 프로그램  ServiceHandler class|
|Interceptor |egovframework.hyb.mbl.websocket.ws.HandshakeInterceptor.java |소켓통신 API 가이드 프로그램  Interceptor class|

===== 환경설정 ===== 

소켓통신(SocketIO) 디바이스API 가이드 프로그램에서 제공하는 간단한 쳇팅 기능을 활용하기 위하여 필요한 항목 및 그 환경 설정은 다음과 같다.

==== Device Application ====

=== SocketIO.html ===
  * 소켓통신 위해 html 파일에 sockjs.js JavaScript파일을 꼭! 추가하여야 한다.

<code xml>
<script type="text/javascript" src="js/egovframework/mbl/cmm/sockjs-1.1.1.min.js"></script>
</code>

=== res/values/serverinfo.xml ===

<code xml>
    <!--전자정부 Interface 디바이스 API에서 사용하기 위한 서버경로 설정-->
    <?xml version="1.0" encoding="utf-8"?>
    <resources>
	<string name="SERVER_URL">http://192.168.100.222:8080/DeviceAPIGuideTotal_Web</string>
    </resources>
</code>

=== AndroidManifest.xml ===

<code xml>    
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    
    <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
    <permission android:name="kr.go.egovframework.hyb.socketioapp.permission.C2D_MESSAGE" android:protectionLevel="signature" />
    <uses-permission android:name="kr.go.egovframework.hyb.socketioapp.permission.C2D_MESSAGE" />
</code>

==== Server Application ====

=== web.xml ===
<code xml>
<servlet>
    <servlet-name>ws-disp</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>webSocketContextConfigLocation</param-name>
      <param-value>
				egovframework.hyb.mbl.websocket.config.WsConfig
	  </param-value>
    </init-param> 
    <init-param>
      <param-name>contextClass</param-name>
      <param-value>
			org.springframework.web.context.support.AnnotationConfigWebApplicationContext
      </param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>ws-disp</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</code>

===== 관련기능 ===== 
소켓통신(SocketIO) API 가이드 프로그램은 간단한 쳇팅 앱으로 **대화명 입력** 및 **양방향 대화**를 할 수 있는 기능으로 구성되어 있다.

==== 대화명 입력 및 대화 참여 ====

=== 비즈니스 규칙 ===
  * 대화명 입력과 **입장하기** 버튼을 통하여 챗팅에 참여한다.

=== 관련 코드 ===

== 문서목록 조회 및 화면표시 ==
<code>
function connect() {
	
	$('#chatMessageArea').empty();
	
	wsocket = new SockJS(server_url+"/sockjs/chat");
	
	wsocket.onopen = onOpen;
	wsocket.onmessage = onMessage;
	wsocket.onclose = onClose;

	
	$.mobile.changePage("#chatZone", "slide", false, false);
	
}
</code>

=== 관련 화면 ===

^대화명 입력 화면 ^챗팅 참여 화면^
|{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_open1.png?320|}}|{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_open2.png?320|}}|

==== 대화하기 ====

=== 비즈니스 규칙 ===
  * 실시간으로 접속 대상자들에게 메세지를 전달한다.

=== 관련 코드 ===

== 메세지 전송 및 수신 ==
<code>
function send() {
	var nickname = $("#nickname").val();
	var msg = $("#message").val();
	wsocket.send("msg:"+nickname+":" + msg);
	$("#message").val("");
}

function onMessage(evt) {
	var data = evt.data;
	if (data.substring(0, 4) == "msg:") {
		appendMessage(data.substring(4));
	}
}

function appendMessage(msg) {
	$("#chatMessageArea").append(msg+"<br>");
	var chatAreaHeight = $("#chatArea").height();
	var maxScroll = $("#chatMessageArea").height() - chatAreaHeight;
	$("#chatArea").scrollTop(maxScroll);

}
</code>

^메세지 송신 화면 ^메세지 수신 화면^
|{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_message1.png?320|}}|{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_message2.png?320|}}|

==== 대화 나가기 (접속해제) ====

=== 비즈니스 규칙 ===
  * '나가기'를 통해 접속된 대화방의 연결을 끊는다.

=== 관련 코드 ===

== 해제 메세지 전달 및 연결 해제==
<code>
function disconnect() {
	wsocket.send("msg:" + $("#nickname").val() + "님이 연결을 끊었습니다.");
	wsocket.close();
}

function onClose(evt) {	
	console.log("연결을 끊었습니다");
}
</code>

^연결 해제 화면 ^
|{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_close.png?320|}}|

===== 컴파일 디버깅 배포 ===== 
==== 컴파일 ====

=== Device Applicaton 컴파일 방법 === 

  * 프로젝트 선택 > 오른쪽 클릭 > Run As > Android Application

{{:egovframework:hyb:guide:add:카메라_컴파일1.png?740|}}

  * 상단의 메뉴 > Run As > Android Application

{{:egovframework:hyb:guide:add:카메라_컴파일2.png?740|}}

 
  * 실행할 타겟 선택 > 에뮬레이터, 디바이스(디버깅모드)

{{:egovframework:hyb:guide:add:디바이스컴파일.png?740|}}

  * 디바이스를 이용한 실행 화면

{{:egovframework:hyb3.6:guide:mbl:socketio:socketio_run.png?320|}}

=== Server Applicaton 컴파일 방법 ===  

  * 서버사이드 가이드 프로그램의 실행은 프로젝트를 마우스 오른쪽 버튼을 클릭 한후 Run As>Run On Server 버튼을 통해 실행 할 수 있다.

{{:egovframework:hyb:guide:ios:서버실행.png?640|}}

  * 빌드가 성공적으로 수행 되면 이클립스의 콘솔 창에서 'Server Startup in xxx ms' 메시지를 확인 할 수 있다.
{{:egovframework:hyb:guide:add:서버실행결과_콘솔.png?840|}}

==== 디버깅 ====

디바이스 어플리케이션에서 발생한 오류 내용 확인 및 디버깅을 위해서는 폰갭 프레임워크에서 제공하는 console.log를 이용할 수 있다. console.log 함수는 자바스크립트 구문에서 사용할 수 있는 디버그 코드로 이클립스 및 Xcode에서 확인 할 수 있다.
 

console.log의 작성 방법의 예시는 다음과 같다.
<code>
function onError(e)
{
    ...
    console.log('Error status: ' + e.status + ' - Error message: ' + e.message);
    ...
}
</code>

 디버깅 코드가 실행 되면 아래와 같은 메시지를 개발도구의 콘솔 메시지 창에서 볼 수 있다.

 {{:egovframework:hyb:guide:add:FileReadWriteconsolelog.png|}}

==== 배포 ====
소켓통신(SocketIO) 디바이스 API 가이드 다운로드 : [[http://www.egovframe.go.kr/cop/bbs/selectBoardArticle.do?bbsId=BBSMSTR_000000000161&nttId=1291&menu=3&submenu=9|Click]] \\

===== 참고자료 ===== 
  * sockjs 정보 : sockjs/sockjs-client[[https://github.com/sockjs/sockjs-client|Click]] \\