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

명령 구성

유효성 검사부터 서버 요청과 출력까지, 명령으로 흐름을 구성합니다.

한국어 문서약 21분

BindCommand 객체는 유효성 검사, 서버 요청, 서버 응답과 관련된 MetaView와 콜백(hooking)함수로 구성되어 있으며 execute() 호출을 통해 실행됩니다.

주요 기능#

  • 유효성 검사 : 컬럼에 제약 조건을 설정하여 유효성 검사를 수행합니다. (valid)
  • 서버 요청 : 컬럼값을 서버로 요청합니다. (bind)
  • 응답 관리 : 서버의 응답 데이터를 MetaView에 바인딩합니다. (output)
  • 컬럼 추가 : HTMLColumn 객체를 추가하여 MetaTable의 데이터를 정의합니다.
  • 흐름 제어 : 단계별 콜백 함수를 사용하여 실행 흐름을 제어합니다.

Tip 흐름 제어란 execute() 호출 시 단계별로 실행되는 콜백 함수를 통해 작업 흐름을 제어하는 것을 말합니다. 주요 콜백 함수로는 cbBegin(실행 시작), cbValid(유효성 검사), cbBind(서버 요청), cbResult(서버 응답 처리), cbOutput(결과 출력), cbEnd(실행 완료)이 있습니다.

명령 추가#

명령(BindCommand) 객체는 모델(BindModel)의 처리 단위로, MetaView 타입의 valid, bind, output, misc 속성을 포함합니다.

Tip misc(MetaView)는 execute() 실행 시 아무런 처리를 하지 않습니다. 사용자가 컬럼 그룹화 등 특수한 목적으로 사용할 수 있도록 정의된 MetaView입니다.

ts
type OptionType = 'SEND' | 'VIEW' | 'ALL' | 'PICK'; // default 'SEND'
type SchemaType = 'AUTO' | 'DATA' | 'ENTITY';       // default 'AUTO'
type IndexType = number | number[]; // // default 0
type OutOptType = { option: OptionType, schema: SchemaType, index: IndexType }

declare function addCommand(
	cmdName: string, 
	outputOption?: OutOptType | OptionType | SchemaType | IndexType,
	bTable?: string | MetaTable
): BindCommand;
  • cmdName : 명령 이름입니다.
  • outputOption : output(MetaView)에 서버 응답 데이터를 바인딩하는 방식입니다.
    • SEND : 바인딩하지 않음. (기본값)
    • VIEW : 지정한 인덱스 데이터(rows)를 컬럼값(value)으로 설정합니다. (단일 데이터)
    • ALL : 응답 데이터를 모든 컬럼과 행으로 가져옵니다. (전체 데이터)
    • PICK : output.columns 컬렉션에 정의된 컬럼과 매칭되는 데이터를 가져옵니다. (지정 데이터)
    • number 타입은 VIEW 옵션 지정시 데이터(rows) 의 index 값입니다. (기본값 : 0)
  • bTable : 기본테이블을 지정합니다.

outputOption의 schema 속성을 지정하여 서버 응답 데이터의 형식을 설정할 수 있습니다.

참조 : JSON 스키마 가이드

Tip 명령(BindCommand)을 추가할 때 bTable을 지정하면, 해당 값이 _baseTable로 설정됩니다. 이에 따라 MetaView(valid, bind, output, misc)의 _baseEntity가 자동으로 지정됩니다. 이후 추가되는 컬럼(HTMLColumn)은 기본적으로 해당 MetaTable에 등록되며, 참조값은 MetaView에 등록됩니다.

addCommand()를 호출하여 명령(BindCommand) 객체를 생성하고, 이를 command 컬렉션에 등록합니다. 또한, outputOption 값을 지정하여 서버 응답 데이터를 output(MetaView)에 바인딩하는 방식을 설정할 수 있습니다.

js
const bm = new BindModel();

bm.addCommand('create');
bm.addCommand('read', 'ALL');

// bm.command['create'] instanceof BindCommand
// bm.command['read'] instanceof BindCommand
// bm.command['create'].outputOption.option == 'SEND'
// bm.command['read'].outputOption.option   == 'ALL'

// bm.cmd['create'] instanceof BindCommand
// bm.cmd['read'] instanceof BindCommand

Tip 추가된 명령(BindCommand) 객체는 command 컬렉션을 통해 접근할 수 있습니다. cmd 속성은 command 속성의 별칭입니다.

명령에서 컬럼 추가#

모델(BindModel)객체에서 컬럼을 추가하고 초기값을 설정할 수 있습니다.

ts
type viewsType = 'valid' | 'bind' | 'output' | 'misc' | string /* 추가 뷰*/;

declare function addColumn(
    column: string | MetaColumn, 
    views?: '$all' | viewsType | viewsType[], 
    bTable?: string | MetaTable
): BindCommand;

declare function addColumnValue(
    columnName: string, 
    value: string | number | boolean | { /* 컬럼속성 */ }, 
    views?: viewsType | viewsType[], 
    bTable?: string | MetaTable
): BindCommand;
  • addColumn() : 컬럼 객체 또는 이름으로 빈('') 컬럼을 추가합니다.
    • column : 추가할 컬럼 객체 또는 컬럼명 입니다.
    • views : 참조를 등록할 뷰(MetaView) 이름을 지정합니다.
    • bTable : 컬럼이 등록될 테이블(MetaTable)을 지정합니다.
  • addColumnValue() : 컬럼을 추가하고 초기값을 설정합니다.
    • columnName : 추가할 컬럼명 입니다.
    • value : 컬럼의 초기값입니다.
    • views : 참조를 등록할 뷰(MetaView) 이름을 지정합니다.
    • bTable : 컬럼이 등록될 테이블(MetaTable)을 지정합니다.

Tip views 값으로 $all 또는 undefined 지정하면 모든 뷰(valid, bind, output, misc)에 참조가 추가됩니다.

유효성 검사 컬럼 설정#

유효성 검사를 설정하려면 valid(MetaView)를 구성하고, 컬럼(MetaColumn)의 required 및 constraints 속성을 설정해야 합니다.

addColumnValue() 메서드를 호출하여 초기값과 함께 컬럼을 생성합니다.

생성된 컬럼은 BindModel 객체의 columns 컬렉션에 추가되며, 해당 명령(BindCommand)의 MetaView에 참조로 등록됩니다.

js
const bm = new BindModel();

bm.addCommand('create');  // 'create' 명령 추가

bm.command['create'].addColumnValue(
	'u_no', 
	{ required: true }, 
	'valid'
); 
bm.command['create'].addColumnValue(
	'u_name', 
	{ constraints: { regex: /[a-zA-Z]+/, msg: '이름은 영문자만 가능합니다.'} }, 
	'valid'
);



// bm.command['create'].valid instanceof MetaView
// bm.command['create'].valid.count === 2
// bm.columns['u_no'] === bm.cmd['create'].valid.columns['u_no']
// bm.columns['u_name'] === bm.cmd['create'].valid.columns['u_name']

u_no 컬럼 : 필수값입니다. (공백 입력시 실패)

  • u_name 컬럼 : 선택값입니다. 값을 입력시 영문 이외의 문자는 실패 합니다. (공백 입력시 성공)
    • 실패시 msg 는 cbFail 콜백함수를 통해 출력됩니다.

컬럼을 먼저 등록한 후, 필요한 속성은 나중에 지정할 수도 있습니다.

js
// 'valid' 뷰에 컬럼 등록
bm.command['create'].addColumnValue('u_no', 10, 'valid'); 
bm.command['create'].addColumnValue('u_name', 'Jane', 'valid');

// 컬럼 속성 설정
bm.columns['u_no'].required = true;
bm.columns['u_name'].constraints = { 
	regex: /[a-zA-Z]+/, msg: '이름은 영문자만 가능합니다.'
};

컬럼의 제약조건을 활용하여 다양하게 구성할 할 수 있습니다. #참조

참조 : 컬럼 관리 > 제약조건

Tip BindModel 객체에서는 서비스객체 주입, addColumn(), addColumnValue() 메서드를 사용하여 컬럼을 추가할 수 있습니다. 또한, 명령(BindCommand) 객체의 addColumn(), addColumnValue(), setColumn() 메서드를 통해 다양한 방식으로 유효성 검사 컬럼을 설정할 수 있습니다.

서버 요청 컬럼 설정#

서버 요청을 위해서는 bind(MetaView) 뷰를 구성해야 합니다.

명령에서 컬럼 등록하기#

명령(BindCommand)을 등록한 후, 해당 명령의 bind(MetaView) 뷰에 컬럼을 추가합니다.

js
const bm = new BindModel();

bm.addCommand('create');  // 'create' 명령 추가

// 'bind' 뷰에 컬럼 등록
bm.command['create'].addColumnValue('u_no', 10, 'bind');
bm.command['create'].addColumnValue('u_name','Jane', 'bind');

명령과 뷰 동시 등록하기#

컬럼을 등록하면서 동시에 명령(BindCommand)과 bind(MetaView) 뷰에 참조를 추가할 수도 있습니다.

js
const bm = new BindModel();

// 컬럼 등록과 함께 'create' 명령 및 'bind' 뷰에 참조 추가
bm.addColumnValue('u_no', 10, 'create', 'bind');
bm.addColumnValue('u_name','Jane', 'create', 'bind');

서버 응답 컬럼 설정#

서버 응답 데이터를 매핑하려면 outputOption을 설정하고, output(MetaView) 뷰를 구성해야 합니다.

Tip outputOption을 통해 응답 데이터를 output(MetaView)에 매핑하는 방식을 지정할 수 있습니다.

명령에 컬럼 등록하기#

명령(BindCommand)를 등록한 후, 해당 명령의 output(MetaView)에 컬럼을 추가합니다.

js
const bm = new BindModel();

bm.addCommand('list', 'VIEW');  // // 'list' 명령 추가 및 outputOption 설정

// 'output' 뷰에 컬럼 등록
bm.command['list'].addColumnValue('u_no', 10, 'output');
bm.command['list'].addColumnValue('u_name','Jane', 'output');

// bm.cmd['list'].outputOption.option === 'VIEW'

명령과 뷰 동시 등록하기#

컬럼을 등록하면서 동시에 명령(BindCommand)과 output(MetaView)에 참조를 추가할 수 있습니다.

js
const bm = new BindModel();

// 컬럼 등록과 함께 'list' 명령 및 'output' 뷰에 참조 추가
bm.addColumnValue('u_no',       10, 'list', 'output');
bm.addColumnValue('u_name', 'Jane', 'list', 'output');

// outputOption 설정
bm.command['list'].outputOption = 'VIEW';

// bm.cmd['list'].outputOption.option === 'VIEW'

출력 옵션의 종류#

outputOption을 설정하여 output(MetaView)의 데이터 바인딩 방식을 제어할 수 있습니다.

옵션 설명 비고
'SEND' 바인딩 안함 기본값
'VIEW' 정의된 컬럼의 데이터를 가져오고, 지정된 인덱스의 데이터를 컬럼값으로 설정합니다.
'ALL' 모든 컬럼의 데이터를 가져옵니다.
'PICK' 정의된 컬럼과 매칭되는 데이터를 가져옵니다.

옵션 'SEND' : 바인딩 안함#

bind(MetaView)의 값(value)은 서버로 전송되지만 응답데이터를 output(MetaView)에 데이터를 가져오지 않습니다.

js
const bm = new BindModel();

// 'create' 명령 추가 (옵션 'SEND' 설정)
bm.addCommand('create', 'SEND');

// 'aa' 컬럼 추가
bm.cmd['create'].addColumnValue('aa', 10);

// 명령 실행
bm.cmd['create'].execute();

// bm.columns.count == 1
// bm.columns['aa'].value == 10
// bm.cmd['create'].output.rows.count == 0

Tip 이 옵션은 등록, 수정, 삭제와 같이 응답 데이터가 필요 없는 경우에 주로 활용됩니다.

옵션 'VIEW' : 지정 데이터 + 컬럼값 설정#

응답 데이터에서 정의된 컬럼과 매칭되는 데이터를 가져오고, 지정된 인덱스의 데이터를 컬럼값으로 설정합니다.

json
{
	"rows": [
		{ "u_id": 10, "u_name": "Alice", "active": true, "age": 30 },
		{ "u_id": 20, "u_name": "Bob", "active": false, "age": 40 }
	]
}

응답 데이터에서 정의된 컬럼과 매칭되는 데이터만 가져오며, 인덱스 값의 rows 데이터를 컬럼값으로 설정합니다.

Tip 기본 인덱스 값은 0이며, 필요에 따라 outputOption.index = 1 과 같이 설정할 수 있습니다.

js
const bm = new BindModel();

// 'read' 명령 추가, 옵션 'VIEW' 사용
bm.addCommand('read', 'VIEW');

// 컬럼 추가
bm.cmd['read'].addColumn('u_id');
bm.cmd['read'].addColumn('u_name');
bm.cmd['read'].addColumn('active');

// 명령 실행
bm.cmd['read'].execute();

// bm.columns.count == 3
// bm.columns['u_id'].value == 10
// bm.columns['u_name'].value ==  "Alice"
// bm.columns['active'].value ==  true

Tip 이 옵션은 단일 조회 데이터를 컬럼값으로 설정할 때 유용합니다.

옵션 'ALL' : 모든 데이터#

응답 데이터를 output(MetaView)에 모두 가져옵니다.

컬럼을 사전에 정의하지 않아도 응답 데이터를 기반으로 동적으로 생성됩니다.

json
{
	"rows": [
		{ "u_id": 10, "u_name": "Alice", "active": true },
		{ "u_id": 20, "u_name": "Bob", "active": false }
	]
}

컬럼이 미리 정의되지 않더라도 응답 데이터에 기반하여 동적으로 생성됩니다.

js
var bm = new BindModel();

// 'list' 명령 추가 (옵션 'VIEW' 설정)
bm.addCommand('list', 'ALL');

// 명령 실행
bm.cmd['list'].execute();

// bm.columns.count == 3
// bm.cmd['list'].output.rows.count == 2
// bm.cmd['list'].output.rows[0]['u_id'] == 10
// bm.cmd['list'].output.rows[0]['u_name'] == "Alice"
// bm.cmd['list'].output.rows[0]['active'] == true
// bm.cmd['list'].output.rows[1]['u_id'] == 20
// bm.cmd['list'].output.rows[1]['u_name'] == "Bob"
// bm.cmd['list'].output.rows[1]['active'] == false
  • cmd 속성은 command 속성의 별칭입니다.

Tip 이 옵션은 목록 처리에 활용되며, 응답 데이터의 전체 구조를 확인하거나 cbOutput 콜백 함수에서 출력할 컬럼을 지정하는 데 사용할 수 있습니다.

옵션 'PICK' : 지정 데이터#

응답 데이터에서 output(MetaView)에 정의된 컬럼과 매칭되는 데이터만 가져옵니다.

json
{
	"rows": [
		{ "u_id": 10, "u_name": "Alice", "active": true },
		{ "u_id": 20, "u_name": "Bob", "active": false }
	]
}

응답 데이터에 키 값이 정의한 컬럼과 매칭되는 데이터만 가져옵니다.

js
var bm = new BindModel();

// 'list' 명령 추가 (옵션 'PICK' 설정)
bm.addCommand('list', 'PICK');

// 컬럼 'id', 'name' 추가
bm.cmd['list'].addColumn('u_id');
bm.cmd['list'].addColumn('u_name');

// 명령 실행
bm.cmd['list'].execute();

// bm.columns.count == 2
// bm.cmd['list'].output.rows.count == 2
// bm.cmd['list'].output.rows[0]['u_id'] == 10
// bm.cmd['list'].output.rows[0]['u_name'] == "Alice"
// bm.cmd['list'].output.rows[1]['u_id'] == 20
// bm.cmd['list'].output.rows[1]['u_name'] == "Bob"
  • rows 키가 active 인 데이터는 가져오지 않습니다.

Tip 이 옵션은 목록 처리에 유용하며, output(MetaView)에 정의된 컬럼의 데이터만 가져옵니다.

출력 옵션의 설정#

명령(BindCommand)의 서버 응답 데이터를 output(MetaView)에 매핑하는 방식을 설정합니다.

출력 옵션 타입#

ts
type OptionType = 'SEND' | 'VIEW' | 'ALL' | 'PICK'; // default 'SEND'
type SchemaType = 'AUTO' | 'DATA' | 'ENTITY';       // default 'AUTO'
type IndexType = number | number[]; // // default 0
type OutOptType = { option: OptionType, schema: SchemaType, index: IndexType }

type outputOption = OutOptType | OptionType | SchemaType | IndexType;
  • option : output(MetaView) 의 매칭 방식을 지정합니다. (기본값: 'SEND')
  • schema : 데이터의 스키마 모드를 지정합니다. (기본값: 'AUTO')
  • index : 컬럼(value)값에 설정할 rows 인덱스 위치를 지정합니다.(기본값: 0)

Tip outputOption을 Number 타입으로 지정하면, 해당 값이 index로 설정됩니다. outputOption을 string 타입으로 지정하면 option 또는 schema 가 설정됩니다. outputOption 속성의 별칭 속성 outOpt 을 사용할 수 있습니다.

명령 추가시 설정#

명령(BindCommand)을 추가할 때 outputOption 매개변수를 전달하여 설정할 수 있습니다.

js
const bm = new BindModel();

// 명령 추가 시 outputOption 설정
bm.addCommand('cmd1');   // default 'SEND'
bm.addCommand('cmd2', 'VIEW');
bm.addCommand('cmd3', { option: 'ALL', index: 3 });

// bm.cmd['cmd1'].outOpt === { option: 'SEND', index: 0, schema: 'AUTO' } 
// bm.cmd['cmd2'].outOpt === { option: 'VIEW', index: 0, schema: 'AUTO' }
// bm.cmd['cmd3'].outOpt === { option: 'ALL', index: 3, schema: 'AUTO' }

직접 설정#

명령(BindCommand) 객체의 outputOption 속성을 직접 설정할 수 있습니다.

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');
bm.addCommand('cmd2');
bm.addCommand('cmd3');

// outputOption 속성 설정
bm.command['cmd1'].outputOption = 'PICK';
bm.command['cmd2'].outputOption.option = 'ALL';
bm.command['cmd3'].outputOption = { option: 'VIEW', index: 1 };

// bm.cmd['cmd1'].outOpt === { option: 'PICK', index: 0, schema: 'AUTO' }
// bm.cmd['cmd2'].outOpt === { option: 'ALL', index: 0, schema: 'AUTO' }
// bm.cmd['cmd3'].outOpt === { option: 'VIEW', index: 1, schema: 'AUTO' }

응답 데이터 스키마#

서버 응답 데이터의 형식은 아래와 같습니다.

ts
type DataType = string | number | boolean;
type SingleEntity = { 
	rows: Record<string, DataType> | Record<string, DataType>[],
	columns?: Record<string, ColumnType>
};

type MultiEntity = SingleEntity[];
  • ColumnType 타입은 문서를 하세요.

참조 : 컬럼 관리 > 컬럼 주요 속성, 공통 컬럼 속성

아래와 같은 형식의 데이터를 가져올 수 있습니다.

Tip 서버 응답 데이터의 구조가 다를 경우, cbResult 콜백 함수를 사용하여 데이터 스키마로 변환할 수 있습니다.

객체 데이터#

json
{ "aa": 10 }
json
[ 
	{ "aa": 10 }, 
	{ "aa": 20 } 
] 

엔티티 데이터#

json
{ "rows": { "aa": 10 } }
json
{ "rows": [ 
		{ "aa": 10 }, 
		{ "aa": 20 } 
	]
}

Tip rows 속성은 object 또는 object[] 타입으로 지정할 수 있습니다.

복수 엔티티 데이터#

json
[
	{
	    "rows": [
	        { "aa": 10, "bb", 20, "cc": 30 },
	        { "aa": 11, "bb", 21, "cc": 31 }
	    ]
	},
	{
	    "rows": [
	        { "dd": 40, "ee", 50 },
	        { "dd": 41, "ee", 51 },
	        { "dd": 42, "ee", 52 }
	    ]
	}
]

자세한 내용은 JSON 스카미 가이드를 참조해주세요.

참조 : JSON 스키마 가이드, 명령 복수 출력 구성

서버 응답 데이터가 복수의 엔티티를 가지는 경우 "명령 복수 출력 구성" 을 참조하십시요.

검색어를 입력해 보세요.