이 페이지의 내용
문서기능 가이드
기능 가이드02

흐름 제어

콜백 라이프사이클과 오류 처리로 실행 흐름을 제어합니다.

한국어 문서약 13분

콜백 라이프 사이클#

다음은 BindCommand 실행 시의 콜백 함수 라이프사이클을 도식화한 것입니다. 각 단계에서 호출되는 콜백 함수와 관련 동작이 나열되어 있습니다.

graph TD
	E1("1.onExecute 이벤트") --> C1("2.cbBegin")
	
	subgraph client_area
		C2("3.cbValid") --> V1("4.valid:유효성검사")
	end
	C1 --> C2
	C1 --> |cbValid 없을경우| V1
	V1 --> C3("6.cbBind")
	client_area --> |논리적 실패| F1("5.cbFail")
	subgraph callback_area
		C3 --> V2("7.bind:서버전송")
		V2 --> C4("8.cbResult")
		C4 --> |outOpt > 0| V3("9.output:바인딩")
		V3 --> C5("10.cbOutput")
	end
	callback_area --> |오류| F2("11.cbError")
	C5 --> C6("12.cbEnd")
	C4 --> |outOpt == 0| C6
	F1 --> C6
	F2 --> C6
	C6 --> E2("13.onExecuted 이벤트")
	
	style C1 fill:gray,color:#fff	
	style C2 fill:gray,color:#fff	
	style C3 fill:gray,color:#fff	
	style C4 fill:gray,color:#fff	
	style C5 fill:gray,color:#fff	
	style C6 fill:gray,color:#fff
	style E1 fill:green,color:#fff
	style E2 fill:green,color:#fff
	style F1 fill:orange,color:#fff
	style F2 fill:orange,color:#fff

구조와 흐름을 설명하는 다이어그램
  1. onExecute 이벤트
    • 명령 실행 시작 시 발생하는 이벤트입니다.
  2. cbBegin
    • 실행 시작 콜백. 초기 설정이나 검증 전에 호출됩니다.
  3. cbValid
    • 유효성 검사를 위한 콜백. valid: MetaView에 설정된 조건을 확인합니다.
    • cbValid가 없을 경우, 바로 유효성 검사로 넘어갑니다.
  4. valid: MetaView 유효성 검사
    • 컬럼의 제약조건(required, constraints)을 검사합니다.
  5. cbFail
    • 유효성 검사 실패 시 호출되는 콜백함수를 호출합니다.
  6. cbBind
    • 서버 요청 전 데이터를 호출되는 콜백함수를 호출합니다.
  7. bind: MetaView 요청
    • 서버 요청을 실행합니다.
  8. cbResult
    • 서버 응답 데이터를 처리하는 콜백함수를 호출합니다.
  9. output: MetaView 바인딩
    • outputOption.option = 'SEND' 가 아닌 경우
    • 응답 데이터를 output: MetaView에 바인딩합니다.
  10. cbOutput
    • output: MetaView에 데이터를 바인딩한 후 호출되는 콜백입니다.
  11. cbError
    • 실행 중 오류가 발생하면 호출되는 콜백함수를 호출합니다.
  12. cbEnd
    • 명령 실행이 완료된 후 호출되는 콜백함수를 호출합니다.
  13. onExecuted 이벤트
    • 명령 실행 종료 시 발생하는 이벤트입니다.

실패 및 에러 처리#

cbError와 cbFail 콜백함수는 기본값을 제공합니다. 필요에 따라 커스터마이징하여 사용할 수 있습니다.

js
cbFail = function(msg, valid) { 
	console.warn('Failed. Err:'+ msg); 
};

cbError = function(msg, status, response) { 
	console.error('An error has occurred. : '+ msg); 
};

오류 콜백(cbError)#

execute() 실행 중에 발생한 모든 오류를 처리합니다.

ts
type cbError = (msg: string, status: number, response: object) => void;
  • msg : 에러 메세지
  • status : 에러 번호
  • response : 응답 객체

예제 : 유효성 검사 실패시 경고창을 표시합니다.

js
bm.cbError = function(msg, status, res) { 
    alert('Err: '+ msg); 
};

Tip execute()는 내부적으로 try문으로 감싸져 있어 예외를 던지지 않습니다. 예외 처리를 위해서는 cbError에서 직접 구현해야 합니다.

실패 콜백#

execute() 실행 중 유효성 검사가 실패했을 때 호출됩니다.

ts
type cbFail = (msg: string, valid: MetaView) => void;
  • msg : 실패 메세지
  • valid : 유효성 검사 대상 MetaView

예제 : 유효성 검사 실패시 경고창을 표시합니다.

js
bm.cbFail = function(msg, valid) { 
    alert('Failed: '+ msg); 
};

콜백 함수 호출 순서#

명령(BindCommand)의 execute() 호출 시 단계별로 실행되는 콜백 함수는 다음과 같습니다.

구분 기본콜백<br>(BindModel) 명령콜백<br>(BindCommand) 설명
시작 cbBaseBegin cbBegin 명령 실행 시작 시 호출됩니다.
유효성 검사 cbBaseValid cbValid valid: MetaView 유효성 검사 전에 호출됩니다.
서버 요청 cbBaseBind cbBind bind: MetaView 요청 전에 호출됩니다.
응답 결과 cbBaseResult cbResult 서버 응답 데이터를 처리한 후 호출됩니다.
결과 출력 cbBaseOutput cbOutput output: MetaView에 데이터 매핑 후 호출됩니다.
종료 cbBaseEnd cbEnd 명령 실행 종료 시 호출됩니다.

명령 콜백이 정의된 경우, 기본 콜백은 무시됩니다. 예를 들어, cbBegin 콜백함수가 정의되어 있으면 cbBaseBegin 콜백함수는 실행되지 않습니다.

1. 시작 콜백#

execute() 호출 시 가장 먼저 실행되는 콜백입니다.

cbBaseBegin은 모델(BindModel)의 기본 콜백함수이며, cbBegin은 각 명령(BindCommand)의 콜백함수입니다.

ts
type BeginType = (model: BindModel, cmd: BindCommand) => void;

type cbBaseBegin = BeginType;
type cbBegin = BeginType;
  • model : 현재 모델(BindModel) 객체 입니다.
  • cmd : 실행 대상 명령(BindCommand) 객체입니다.

예제 : 기본 시작 콜백과, list 명령(BindCommand) 시작 콜백을 설정

js
bm.cbBaseBegin = function(model, cmd) {
	cmd.url = '/member/1';
};

bm.command['list'].cbBegin = function(model, cmd) { 
    cmd.url = '/member/1'; 
};

Tip 시작 콜백은 동적으로 서버 요청 경로를 설정하거나 초기화를 수행하는 데 유용합니다.

2. 유효성 검사 콜백#

execute() 호출시 valid(MetaView)에 대한 유효성 검사 전에 호출됩니다.

cbBaseValid은 모델(BindModel)의 기본 콜백함수이며, cbValid는 각 명령(BindCommand)의 콜백함수입니다.

ts
type ValidType = (valid: MetaView, cmd: BindCommand, model: BindModel) => boolean | undefined;

type cbBaseValid = ValidType;
type cbValid = ValidType;
  • valid : 유효성 검사 대상 MetaView
  • cmd : 실행 대상 명령(BindCommand)
  • model : 현재 모델(BindModel) 객체 입니다.
  • return
    • true : 유효성 검사를 통과하고 다음 단계를 진행합니다.
    • false : 유효성 검사가 실패하며, cbFail 콜백함수가 호출됩니다.
    • undefined : 유효성 검사가 실패하지만 cbFail 콜백함수가 호출되지 않습니다

Tip 유효성 검사 콜백에서 return 값으로 undefined를 반환하면, 오류 메시지 출력 등의 처리를 콜백 내부에서 직접 수행하며, 별도로 cbFail 콜백 함수를 호출하지 않습니다.

예제 : 기본 유효성 검사 콜백과, list 명령(BindCommand) 유효성 검사 콜백을 설정

js
bm.cbBaseValid = function(valid, cmd, model) { 
    if (valid.colums.count > 0) return true;
    alert('valid(MetaView) 컬럼이 없습니다.');
};

bm.command['list'].cbValid = function(valid, cmd, model) {
    return confirm ('삭제하시겠습니까?');
};
  • cbBaseValid : 실패 시 undefined를 반환하여 cbFail 콜백함수가 호출되지 않습니다.
  • cbValid : confirm 결과가 false 면 cbFail 콜백함수가 호출됩니다.

Tip 유효성 검사 콜백은 선택창 확인이나 추가 검증 로직에 주로 활용됩니다.

3. 서버 요청 콜백#

execute() 호출시 bind(MetaView) 컬럼값을 서버로 요청하기 전에 호출됩니다.

cbBaseBind 은 모델(BindModel)의 기본 콜백이며, cbBind는 각 명령(BindCommand) 콜백함수입니다.

ts
type BindType = (bind: MetaView, cmd: BindCommand,config: object) => void;

type cbBaseBind = BindType;
type cbBind = BindType;
  • bind : 요청할 데이터가 포함된 MetaView
  • cmd : 실행 대상 명령(BindCommand)
  • config : axios 설정 객체

Tip 서버 요청 콜백은 전송 데이터 타입 설정, 인증 토큰 추가, 암호화 처리 등에 활용됩니다.

4. 응답 처리 콜백#

execute() 호출시 서버에서 응답을 받은 후에 호출됩니다.

cbBaseResult 은 모델(BindModel)의 기본 콜백이며, cbResult 는 각 명령(BindCommand) 콜백함수입니다.

ts
type ResultType = (data: object,cmd: BindCommand,response: object) => object;

type cbBaseResult = ResultType;
type cbResult = ResultType;
  • data : 서버 응답 데이터
  • cmd : 실행 대상 명령(BindCommand)
  • response : axios 응답 객체
  • return : 반환 데이터 (return 값이 없으면 data 객체로 대체 됩니다)

예제 : 기본 응답 결과 콜백과, list 명령(BindCommand) 응답 결과 콜백을 설정

js
// data = { aa: 1, bb: 2 }
bm.cbBaseResult = function(data) {
    return {
        rows: data
    };
};

bm.command['list'].cbResult = function(data) {
    return {
        rows: data
    };
};

Tip 서버 응답 데이터를 스키마 구조로 변환하는 데 주로 활용됩니다. #참조

5. 출력 콜백#

execute() 호출시 응답 데이터를 output(MetaView)에 매핑한 후 호출됩니다.

cbBaseOutput은 모델(BindModel)의 기본 콜백이며, cbOutput는 각 명령(BindCommand)의 콜백함수입니다.

Tip 명령(BindCommand)의 outputOption 이 0 일 경우에는 출력 콜백은 무시됩니다.

ts
type OutputType = (
	outputs: MetaViewColleciton, 
	cmd: BindCommand,
	response: object
) => void;

type cbBaseOutput = OutputType;
type cbOutput = OutputType;
  • outputs : MetaView 컬렉션. (output === _outputs[0])
  • cmd : 실행 대상 명령(BindCommand).
  • response : axios 응답 객체.

Tip output(MetaView) 는 _outputs[0] 컬렉션 을 참조합니다. 여러개의 출력 결과를 받을때 addOutput() 을 사용하여 추가할 수 있습니다. #참조

json
// SERVER DATA
[
	{ "u_name":  "Neo", "gender": "M" },
	{ "u_name": "Jane", "gender": "W" },
]

예제 : list 명령(BindCommand) 출력 콜백을 설정

js
bm.command['list'].cbOutput = function(outputs) {
	outputs[0].rows.forEach((row, i) => {
	    console.log(i, row['name'], row['gender']);
	});
};

// 0  Neo   M
// 1  Jane  W

Tip 출력 콜백은 데이터를 화면에 출력하거나 추가 처리를 수행할 때 유용합니다.

6. 종료 콜백#

execute() 호출시 실행이 완료된 후 호출됩니다.

cbBaseEnd 은 모델(BindModel)의 기본 콜백이며, cbEnd 는 각 명령(BindCommand) 콜백함수입니다.

ts
type EndType = (status: number, cmd: BindCommand,response: object) => void;

type cbBaseEnid = EndType;
type cbEnd = EndType;
  • status : 응답 상태 코드.
  • cmd : 실행 대상 명령(BindCommand).
  • response : axios 응답 객체.

예제 : 기본 종료 콜백과, list 명령(BindCommand) 종료 콜백함수를 설정

js
bm.cbBaseEnd = function(status, cmd, res) {
    alert('처리가 완료되었습니다.');
};

bm.command['list'].cbEnd = function(status, cmd, res) {
    bm.command['read'].execute(); // // 'read' 명령 실행 (체이닝)
}

Tip 종료 콜백은 결과 메시지 표시, 리다이렉트, 명령 체인 실행 등에 활용됩니다.

검색어를 입력해 보세요.