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

모델 구성

모델을 생성하고 명령, 컬럼, 서버 연결을 구성합니다.

한국어 문서약 22분

BindModel은 프레임워크의 핵심 객체로, 비즈니스 로직과 데이터 흐름을 관리하는 중심 역할을 수행합니다.

주요 기능

  • 명령 추가 : BindCommand 객체를 추가하여 다양한 명령을 관리합니다.
  • 컬럼 추가 : HTMLColumn 객체를 추가하여 MetaTable 데이터를 정의합니다.
  • 테이블 추가 :  데이터 구조를 정의하는 MetaTable 객체를 추가합니다.
  • 기본 콜백함수 제공 : 단계별 기본 콜백함수를 제공합니다. (6단계)
  • 서비스 객체 주입 : 서비스 객체를 주입하여 BindModel 객체를 구성합니다.

참조 : 명령 구성, 컬럼 관리, 테이블 관리, 흐름 제어

모델 객체 생성#

BindModel 클래스는 비즈니스 로직과 데이터 흐름을 정의하는 중심 객체로, 웹 애플리케이션의 명령 실행과 데이터 바인딩을 구조적으로 관리할 수 있도록 설계되었습니다.

ts
declare class BindModel {
	constructor(service?: ServiceType);
}
  • service 선택적이며, 서비스 객체를 주입 할 수 있습니다.

기본 생성#

js
const bm = new BindModel();
  • 인자를 전달하지 않을 경우, 빈 상태로 초기화됩니다.

서비스 객체를 통한 초기 구성#

js
const bm = new BindModel({
	tables: ['second', 'three'],
});
  • tables 속성을 포함한 서비스 객체를 생성자에 전달함으로써 초기 설정이 반영됩니다.
  • 서비스 객체는 tables, items, command, mapping 의 속성을 포함하는 객체로 구성됩니다.

참조 : 서비스 객체 구성

명령 추가#

BindModel 객체는 addCommand() 메서드를 통해 명령(Command)을 동적으로 등록할 수 있습니다. 등록된 명령은 내부적으로 BindCommand 인스턴스로 생성되며, 명령 실행 시 사용되는 outputOption 값을 함께 지정할 수 있습니다.

사용 예시 1: 기본 명령 등록#

js
const bm = new BindModel();

bm.addCommand('create');

// bm.command['create'] instanceof BindCommand === true
// bm.command['create'].outputOption === { option: 'SEND', schema: 'AUTO', index: 0 } === true
  • create라는 이름의 명령이 등록됩니다.
  • 명령 객체는 BindCommand 타입으로 생성됩니다.
  • outputOption의 기본값은 { option: 'SEND', schema: 'AUTO', index: 0 }로 설정됩니다.

사용 예시 2: 명령 등록 시 옵션 지정#

js
const bm = new BindModel();

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

// bm.cmd['read'] instanceof BindCommand === true
// bm.cmd['read'].outOpt === { option: 'ALL', schema: 'AUTO', index: 0 } === true
  • outputOption은 명령 실행 시 서버와의 통신 또는 뷰 갱신 방식에 영향을 미칩니다.

참조

  • JSON 스키마 가이드
  • 명령 구성 > 출력 옵션 설정
  • 명령 복수 출력 구성 > 복수 출력 인덱스

관련 속성 및 메서드 요약#

항목 설명
addCommand(name) 명령 이름만으로 명령을 추가하며 기본 옵션은 'SEND'입니다.
addCommand(name, outOpt) 명령 이름과 함께 outputOption을 지정할 수 있습니다.
command 또는 cmd 명령 객체들이 저장되는 속성으로, 등록된 각 명령에 접근할 수 있습니다.
outputOption 또는 outOpt 명령 실행 시 처리 방식(SEND, VIEW, ALL, PICK)을 지정합니다.

참조 : 명령 구성

컬럼 추가#

BindModel에서는 데이터를 구성하는 핵심 단위인 컬럼(Column) 을 정의하고, 각 명령과 뷰(valid, bind, output)에 적절히 연결할 수 있습니다.

1. 셀렉터 기반 컬럼 추가#

addSelector()는 HTML 요소의 셀렉터를 기반으로 컬럼을 추가합니다. 사용자는 명령 이름과 역할(뷰)을 함께 지정하여 데이터 처리 흐름을 제어할 수 있습니다.

js
const bm = new BindModel();

bm.addSelector('aa', '#u_id');
bm.addSelector('bb', '#email', 'cmd1');  // 전체 뷰 매핑
bm.addSelector('cc', '#gender', 'cmd2', ['valid', 'bind']);

// bm.columns.count === 3  ('aa', 'bb', 'cc')
// bm.command['cmd1'].valid.columns.count === 1  ('bb')
// bm.command['cmd1'].bind.columns.count === 1   ('bb')
// bm.command['cmd1'].output.columns.count === 1 ('bb')

// bm.command['cmd2'].valid.columns.count === 1  ('cc')
// bm.command['cmd2'].bind.columns.count === 1   ('cc')
// bm.command['cmd2'].output.columns.count === 0
  • aa 컬럼은 명령에 매핑하지 않습니다.
  • 각 컬럼은 columns 컬렉션에 등록됩니다.
  • 셀렉터(#u_id, #email, #gender)를 통해 DOM의 값을 참조합니다.
  • bb 컬럼은 전체 뷰에 매핑되고, cc 컬럼은 지정한 뷰(valid, bind)에 매핑됩니다.

2. 값 기반 컬럼 추가#

addColumnValue()를 사용하면 HTML 요소 없이 직접 값을 지정하여 컬럼을 추가할 수 있습니다.

js
const bm = new BindModel();

bm.addColumnValue('aa', 100);
bm.addColumnValue('bb', 'BB', 'cmd1');  // 전체 뷰 매핑
bm.addColumnValue('cc', 'CC', 'cmd2', ['valid', 'bind']);

// bm.columns.count === 3  ('aa', 'bb', 'cc')
// bm.command['cmd1'].valid.columns.count === 1  ('bb')
// bm.command['cmd1'].bind.columns.count === 1   ('bb')
// bm.command['cmd1'].output.columns.count === 1 ('bb')

// bm.command['cmd2'].valid.columns.count === 1  ('cc')
// bm.command['cmd2'].bind.columns.count === 1   ('cc')
// bm.command['cmd2'].output.columns.count === 0
  • 'aa' 컬럼에는 숫자 100, 'bb'는 문자열 'BB', 'cc'는 문자열 'CC'가 초기값으로 지정됩니다.
  • 명령과 뷰의 연결 구조는 셀렉터 방식과 동일하게 반영됩니다.

3. 빈 값 기반 컬럼 추가#

addColumn()을 사용하면, 컬럼의 기본값(value)은 빈 문자열('')로 설정되어 추가됩니다.

js
const bm = new BindModel();

bm.addColumn('aa');
bm.addColumn('bb', 'cmd1');  // 전체 뷰 매핑
bm.addColumn('cc', 'cmd2', ['valid', 'bind']);

// bm.columns.count === 3  ('aa', 'bb', 'cc')
// bm.command['cmd1'].valid.columns.count === 1  ('bb')
// bm.command['cmd1'].bind.columns.count === 1   ('bb')
// bm.command['cmd1'].output.columns.count === 1 ('bb')

// bm.command['cmd2'].valid.columns.count === 1  ('cc')
// bm.command['cmd2'].bind.columns.count === 1   ('cc')
// bm.command['cmd2'].output.columns.count === 0
  • aa, bb, cc 컬럼의 value 속성은 모두 빈 문자열('')로 설정되어 있습니다.
  • 컬럼의 구조를 먼저 정의한 뒤, selector 속성 등을 활용하여 해당 컬럼을 HTML 요소에 바인딩할 수 있습니다.

4. 컬럼 및 명령 일괄 등록#

setMapping() 메서드는 컬럼과 명령별 역할(뷰)을 일괄 등록하는 기능을 제공합니다.

js
const bm = new BindModel();          // 기본 생성

bm.setMapping({
	aa: {},
	bb: { cmd1: '$all' },  // 전체 뷰 매핑
	cc: { cmd2: ['valid', 'bind']  }
});

// bm.columns.count === 3  ('aa', 'bb', 'cc')
// bm.command['cmd1'].valid.columns.count === 1  ('bb')
// bm.command['cmd1'].bind.columns.count === 1   ('bb')
// bm.command['cmd1'].output.columns.count === 1 ('bb')

// bm.command['cmd2'].valid.columns.count === 1  ('cc')
// bm.command['cmd2'].bind.columns.count === 1   ('cc')
// bm.command['cmd2'].output.columns.count === 0
  • bb 컬럼은 'create' 명령의 모든 뷰(valid, bind, output)에 자동으로 등록됩니다.
  • cc 컬럼은 'update' 명령의 valid 및 bind 뷰에만 설정됩니다.

Tip setMapping() 메서드는 컬럼 정의, 명령 추가, 뷰 매핑을 한 번에 처리하여 설정 작업을 간소화할 수 있습니다.

메서드 설명
addSelector(name, selector, cmd?, views?, bTable?) HTML 요소와 연동되는 컬럼을 추가
addColumnValue(name, value, cmd?, views?, bTable?) 직접 값을 지정하여 컬럼을 추가
addColumn(name, cmd?, views?, bTable?) 빈 값을 갖는 컬럼 추가
setMapping(service) 컬럼과 명령 간 매핑 구조 일괄 등록

참조 : 컬럼 관리

기본 콜백함수#

BindModel 객체는 명령(BindCommand)의 실행 흐름을 제어하기 위해 단계별 콜백 함수를 정의할 수 있습니다. 이 중 기본 콜백 함수(Base Callback) 는 특정 명령에 콜백이 명시되지 않았을 경우 자동으로 호출됩니다.

구분 기본 콜백<br>(BindModel) 명령 콜백<br>(BindCommand) 설명
1:시작<br> cbBaseBegin cbBegin 명령 실행이 시작될 때 호출됩니다.
2:유효성 검사 cbBaseValid cbValid valid 단계에서 MetaView의 유효성 검사 전에 호출됩니다.
3:서버 요청 cbBaseBind cbBind bind 단계에서 서버 요청 직전에 호출됩니다.
4:응답 결과 cbBaseResult cbResult 서버 응답을 받은 후, 데이터 처리 단계에서 호출됩니다.
5:결과 출력 cbBaseOutput cbOutput output 단계에서 MetaView에 매핑 후 호출됩니다. ('VIEW', 'ALL', 'PICK' 일 경우)
6:종료 cbBaseEnd cbEnd 명령 실행이 끝났을 때 호출됩니다.

execute()가 호출되면, 해당 명령의 실행 흐름 중 가장 처음에 호출되는 콜백입니다.

js
// 명령 시작 전 URL 설정
bm.cbBaseBegin = function(model, cmd) {
    cmd.url = '/member/1';
};

참조 : 흐름 제어 >시작 콜백

execute()가 실행되면, valid(MetaView)의 유효성 검사가 진행되기 전에 해당 콜백이 먼저 호출됩니다.

js
// 유효성 검사 전 사용자 검사
bm.cbBaseValid = function(valid, cmd, model) { 
    if (valid.colums.count > 0) return true;
    alert('valid(MetaView) 컬럼이 없습니다.');
};

참조 : 흐름 제어 > 유효성 검사 콜백

execute()가 호출되면, bind(MetaView) 컬럼의 값을 서버에 요청하기 전에 콜백이 먼저 실행됩니다. bind(MetaView)의 value 값은 config.data 속성에 지정되며, 이는 axios 요청 시 config 설정으로 사용됩니다.

js
// 유효성 검사 전 사용자 검사
bm.cbBaseBind = function(bind, cmd, config) { 
    // bind.columns['aa'].value === config.data['aa']
};

execute()가 실행된 후 서버로부터 응답을 수신하면, 해당 콜백이 호출되어 응답 데이터를 처리합니다.

js
// 서버 응답을 데이터를 받은 후 처리
bm.cbBaseResult = function(data) {
    return {
        rows: data
    };
};

// data = [
//   { name: 'Neo', gender: 'M' }, { name: 'Jane', gender: 'W' }
// ]  
// 
// return { rows: [
//   { name: 'Neo', gender: 'M' }, { name: 'Jane', gender: 'W' }
// ]}

참조 : 흐름 제어 > 응답 처리 콜백, 명령 구성 > 응답 데이터 스키마

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

js
// 콘솔 출력
bm.cbBaseOutput = function(outputs) {
	outputs[0].rows.forEach((row, i) => {
	    console.log(i, row['name'], row['gender']);
	});
};

// 0  Neo   M
// 1  Jane  W
  • DOM 을 활용할 경우, 출력 형식에 맞게 변경하여 사용할 수 있습니다.

참조 : 흐름 제어 > 출력 콜백

Tip 기본 콜백 함수란, 명령(BindCommand)의 단계별 콜백 함수가 명시적으로 정의되지 않았을 때 실행되는 함수입니다. 예를 들어, cbBaseBegin은 execute() 호출 시 해당 명령에 cbBegin이 정의되어 있지 않다면 대신 호출됩니다. 명령 간의 일관성을 유지하거나 반복적인 공통 처리를 간소화할 수 있습니다.

서비스 객체 주입#

서비스 객체(Service Object)는 BindModel 객체의 설정 정보를 구조화된 형태로 전달하여 손쉽게 주입할 수 있도록 도와주는 기능입니다. 이를 통해 코드의 가독성을 높이고, 여러 인스턴스 간 구성의 일관성을 유지할 수 있습니다.

서비스 객체에는 다음과 같은 속성을 포함할 수 있습니다.

  • url, baseConfig : 서버 요청 경로와 axios 설정 객체(config)를 정의합니다.
  • tables : 메타 테이블의 이름을 배열 형태로 정의합니다.
  • items : 각 컬럼의 공통 속성(초기값, 제약 조건 등)을 설정합니다.
  • command : 각 명령에 대한 설정 정보(예: outputOption, url, 콜백 함수 등)를 정의합니다.
  • mapping : 컬럼에 대해 명령별로 어떤 뷰(valid, bind, output 등)에 매핑할지를 정의합니다.
js
const svc = {
	// 기본 요청 URL 경로
	url: '/user',
	
	// 추가 테이블
	tables: ['second', 'three'],  
	
	// 컬럼 공통 속성
	items: {
        aa: 'AA',
        bb: 1000,
        cc: { required: true }
    },

	// 명령 구성
	command: {
		create: {
			url: '/register'
		},
		update: {
			outputOption: 'VIEW',
			cbValid: function(valid, cmd) {
			    return confirm ('수정하시겠습니까?');
			}
		}
	},

	// 컬럼과 명령의 뷰간의 매핑 설정
	mapping: {
	    aa: { create: 'valid' },
	    bb: { create: ['valid', 'bind'], update: 'output' },
	    cc: { update: 'output' }
    }
};
const bm1 = new BindModel(svc);  // 객체 생성시 서비스 객체 설정
const bm2 = new BindModel();

bm2.setService(svc); // 서비스 객체 설정

// bm1.equal(bm2) === true
// bm.command['create'].valid.columns.count === 2  ('aa', 'bb')
// bm.command['create'].bind.columns.count === 1   ('bb')
// bm.command['create'].output.columns.count === 0

// bm.command['update'].valid.columns.count === 0
// bm.command['update'].bind.columns.count === 0
// bm.command['update'].output.columns.count === 2 ('bb', 'cc')
  • 기본 서버 요청 경로는 '/user'이며, 'create' 명령의 요청 경로는 '/register'입니다.
  • 'create' 명령의 option은 'SEND'이고, 'update' 명령의 option은 'VIEW'입니다.
  • 아이템은 items 컬렉션에 등록되며, 각 컬럼의 공통 속성으로 사용됩니다.
  • 'aa', 'bb', 'cc' 컬럼은 'create' 및 'update' 명령에 지정된 뷰에 매핑됩니다.
  • bm1과 bm2는 동일한 구성 요소와 속성 구조를 갖는 BindModel 객체입니다.
  • 객체 생성 시 서비스 객체를 인자로 전달하거나, setService() 메서드를 통해 점진적으로 주입할 수도 있습니다.

Tip 서비스 객체를 활용하여 BindModel 객체를 구성할 수 있으며, 이는 비즈니스 로직의 분리와 재사용에 유용합니다.

참조 : 서비스 객체 주입

서버 요청 경로 설정#

기본 경로 설정하기#

url 속성은 서버 요청에 사용될 기본 URL 경로를 설정하는 데 사용됩니다.

단, 명령(BindCommand) 객체에 별도로 url 경로가 설정된 경우, BindModel의 url 값은 무시됩니다.

js
var bm = new BindModel();

bm.url  = '/user';  // 기본 URL 경로 설정

Tip BindModel의 url 속성은 내부적으로 baseConfig.url 값을 참조합니다. 이때 baseConfig 속성은 'axios' 모듈이 서버에 요청할 때 사용하는 설정(config) 객체로 활용됩니다.

명령별 경로 설정하기#

각 명령(BindCommand)에 대해 개별적으로 url을 설정할 수 있습니다.

명령(BindCommand)에 url이 설정되지 않은 경우에는 BindModel에 정의된 기본 url 값이 사용됩니다.

js
var bm = new BindModel();

bm.url = '/list'
// 명령 추가
bm.addCommand('cmd1');
bm.addCommand('cmd2');

// 명령별 URL 경로 설정
bm.command['cmd2'].url = '/user/1';

// bm.command['cmd1'].execute() : '/list'
// bm.command['cmd2'].execute() : '/user/1'

명령(BindCommand)의 url 속성은 내부적으로 config.url 값으로 설정됩니다.

Tip 명령(BindCommand)의 config 객체는 모델의 baseConfig 객체와 병합되어 axios 요청의 최종 config 객체로 사용됩니다. 이때, 병합 시 명령의 config 객체가 baseConfig보다 우선적으로 적용됩니다.

동적 경로 설정#

명령(BindCommand)이 execute()로 호출될 때, 실행 흐름에 따라 단계별 콜백 함수가 순차적으로 호출됩니다.

이 중 가장 먼저 호출되는 콜백은 cbBegin이며, 해당 명령에 cbBegin이 정의되지 않은 경우에는 cbBaseBegin이 대신 호출됩니다.

특정 명령에 따라 요청 경로(url)를 동적으로 변경해야 하는 경우, cbBegin 또는 cbBaseBegin 콜백 함수 내에서 url 값을 설정할 수 있습니다.

기본 동적 경로 설정하기#

모델 객체의 cbBaseBegin 콜백 함수를 활용하여 모델(BindModel)의 기본 경로(url)를 설정합니다.

js
const bm = new BindModel();

bm.addColumnValue('idx', 10, 'cmd1');  // idx 컬럼 추가 및 'cmd1' 명령에 등록

bm.cbBaseBegin = function(model, cmd) {
	let idx = model.columns['idx'].value;  // 10
	model.url = `/user/${idx}`;    
};

bm.command['cmd1'].execute();

// bm.url === '/user/10'
  • bm.addColumnValue() : idx 이름의 컬럼을 추가하고, cmd1 명령의 모든 뷰에 매핑합니다.
  • 함수 내 model 인자 : execute() 실행 시 현재 모델(BindModel) 객체를 가리킵니다.
  • 함수 내 cmd 인자 : execute() 실행 시 현재 명령(BindCommand) 객체를 가리킵니다.
  • 함수 내 model.columns : 모델(BindModel)의 columns 컬렉션을 가르킵니다.

참조 : 흐름 제어

명령별로 동적 경로 설정하기#

명령(BindCommand)별로 cbBegin 콜백 함수를 활용하여 개별적으로 경로(url)를 설정합니다.

js
const bm = new BindModel();
 
bm.addColumnValue('idx', 10, 'cmd1');  // idx 컬럼 추가 및 'cmd1' 명령 등록

bm.command['cmd1'].cbBegin = function(model, cmd) {
	let idx = model.columns['idx'].value;  // 10
	cmd.url = `/user/${idx}`;
};

bm.command['cmd1'].execute();

// bm.url === '/user/10'
  • bm.command 속성 : 모든 명령(BindCommand)객체의 컬렉션 키를 제공합니다.

Tip cbBegin 콜백 함수는 cbBaseBegin보다 우선순위가 높습니다. 두 콜백 함수가 모두 설정된 경우, cbBegin만 호출됩니다.

axios 환경 설정#

모델(BindModel)은 HTTP 통신을 위해 axios 모듈을 사용합니다.

기본 환경 설정하기#

모델(BindModel) 객체의 baseConfig 속성은 axios 요청 설정(config) 객체로 사용됩니다.

js
const bm = new BindModel();

bm.baseConfig.baseURL = 'https://api.example.com';
bm.baseConfig.url = '/user';    // 기본 URL 설정 (참고: bm.url)
bm.baseConfig.method = 'post';  // 요청 메서드 (기본값: 'get')
  • url : 요청에 사용될 서버 URL 입니다.
  • method : 요청 방식을 설정합니다. (종류 : 'get', 'post', 'patch', 'delete')
  • baseURL : url이 절대값이 아닌 경우 baseURL은 URL 앞에 붙습니다. 상대 경로를 사용하는 요청을 쉽게 구성하려면 baseURL 설정이 유용합니다.

참조 : axios config 설정 #참조

명령별 환경 설정 하기#

명령(BindCommand) 객체의 config 속성은 명령별로 개별적인 axios 요청 설정(config) 객체로 사용됩니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

bm.command['cmd1'].config.baseURL = 'https://api.example.com';
bm.command['cmd1'].config.url = '/user'; 
bm.command['cmd1'].config.method = 'get';
  • 위 설정에 따라 서버 요청 경로는 https://api.example.com/user가 됩니다.

검색어를 입력해 보세요.