온라인 어플리케이션 명명규칙

1. 어플리케이션

어플리케이션 단위는 관리 주체가 다르고, 어플리케이션 간 기능 호출을 최소화 할 수 있는 단위로 구분 한다. 어플리케이션은 Studio의 'Bxm 어플리케이션' 메뉴를 통해 생성한다.

본 장에서 나오는 예시는 Bxm 표준 샘플 코드를 대상으로 하므로 프로젝트 상황에 따라 유동적으로 변경이 가능하다.

어플리케이션 명명
구분	설명
구성	L1코드 + L2코드 + L3코드
적용사례	BxmDftSmp
기본원칙	어플리케이션 이름 작성은 다음과 같은 표기법을 따른다. L1,L2,L3코드의 첫 번째 글자 대문자 표기 나머지 글자 소문자 표기 어플리케이션 이름은 중복되어서는 안되므로 전체 업무를 통틀어 유일한 이름을 갖도록 작성한다.

2. Service

Service는 Studio 의 'Service 클래스' 메뉴를 통해 생성 되며 Service의 클래스 이름과 Service 이름은 다음과 같이 작성한다.

구분 설명

구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online + . + service
Package - 적용사례	bxm.dft.smp.online.service
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 service를 쓴다.
클래스 - 구성	S + L3코드 + 화면번호 4자리(고유번호) + Service 구분 1자리(알파벳)
클래스 - 적용사례	SSMP1001A, SSMP1002S
클래스 - 기본원칙	Service 를 뜻하는 기호 'S' , L3코드 3자리, 화면번호 4자리로 이루어진다. Service 이름은 모두 대문자로 작성한다. Service 클래스는 @BxmService 어노테이션을 포함한다. @BxmService 어노테이션은 Service 이름을 가진다. Service 이름은 Service Wizard를 통해 생성 될 때 자동으로 생성 되며, 일반적으로 Service 이름과 클래스 이름은 일치한다. Service 이름은 어플리케이션 내에서 중복이 되면 안되므로 유일한 이름을 갖도록 한다. Service 구분 은 Service의 동작 구분을 말한다. A : 일반 Service S : 조회 Service 파일의 확장자는 java를 사용한다.
클래스 - 부가정보	부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다. @BxmCategory 는 필수 항목으로 작성한다. 부가정보는 다음과 같다. 논리명(logicalName) : Service의 논리명을 입력한다.
클래스 - 작성 예	`@BxmService("SMP1001A") /* Service 이름 / @BxmCategory(logicalName = "고객관리서비스") public class SMP1001A { / 클래스 이름 */ ... ... }`
오퍼레이션 - 구성	Service 명의 소문자 + 일련번호 3자리
오퍼레이션 - 적용사례	ssmp1001a001
오퍼레이션 - 기본원칙	Service 클래스의 메소드는 은 @BxmServiceOperation 어노테이션을 포함한다. @BxmServiceOperation 어노테이션은 Service 오퍼레이션 이름을 가진다. Service 오퍼레이션 이름은 Service 이름의 소문자, Service 구분 및 일련번호 3자리로 작성한다. Service 오퍼레이션은 Service에 여러 개 존재 할 수 있다. 메소드 이름은 Service 오퍼레이션명과 동일하다. 입력 IO는 1개의 IO를 사용해야 된다. 출력 IO는 1개의 IO를 사용해야 된다.
오퍼레이션 - 부가정보	부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다. @BxmCategory 는 필수 항목으로 작성한다. 부가정보는 다음과 같다. 논리명(logicalName): Service 오퍼레이션의 논리명을 입력한다.
오퍼레이션 - 작성 예	`@BxmServiceOperation("smp1001a001") @BxmCategory(logicalName="고객정보조회") public SMP1001A001OutDto smp1001a001(SMP1001A001InDto input) throws DefaultApplicationException { ... ... }`

Package - 구성

L1코드 + . + L2코드 + . +L3코드 + . + online + . + service

Package - 적용사례

bxm.dft.smp.online.service

Package - 기본원칙

Package 이름 작성은 모두 소문자로 한다.
분류는 "."로 구분한다.
Package의 마지막 세그먼트는 service를 쓴다.

클래스 - 구성

S + L3코드 + 화면번호 4자리(고유번호) + Service 구분 1자리(알파벳)

클래스 - 적용사례

SSMP1001A, SSMP1002S

클래스 - 기본원칙

Service 를 뜻하는 기호 'S' , L3코드 3자리, 화면번호 4자리로
이루어진다.
Service 이름은 모두 대문자로 작성한다.
Service 클래스는 @BxmService 어노테이션을 포함한다.
@BxmService 어노테이션은 Service 이름을 가진다. Service 이름은 Service Wizard를 통해 생성 될 때 자동으로 생성 되며, 일반적으로 Service 이름과 클래스 이름은 일치한다.
Service 이름은 어플리케이션 내에서 중복이 되면 안되므로 유일한 이름을 갖도록 한다.
Service 구분 은 Service의 동작 구분을 말한다.

A : 일반 Service

S : 조회 Service
파일의 확장자는 java를 사용한다.

클래스 - 부가정보

부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다.
@BxmCategory 는 필수 항목으로 작성한다.
부가정보는 다음과 같다.
1. 논리명(logicalName) : Service의 논리명을 입력한다.

클래스 - 작성 예

@BxmService("SMP1001A") /* Service 이름 */
@BxmCategory(logicalName = "고객관리서비스")
public class SMP1001A { /* 클래스 이름 */
    ... ...
}

오퍼레이션 - 구성

Service 명의 소문자 + 일련번호 3자리

오퍼레이션 - 적용사례

ssmp1001a001

오퍼레이션 - 기본원칙

Service 클래스의 메소드는 은 @BxmServiceOperation 어노테이션을
포함한다.
@BxmServiceOperation 어노테이션은 Service 오퍼레이션 이름을 가진다.
Service 오퍼레이션 이름은 Service 이름의 소문자, Service 구분 및
일련번호 3자리로 작성한다.
Service 오퍼레이션은 Service에 여러 개 존재 할 수 있다.
메소드 이름은 Service 오퍼레이션명과 동일하다.
입력 IO는 1개의 IO를 사용해야 된다.
출력 IO는 1개의 IO를 사용해야 된다.

오퍼레이션 - 부가정보

부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다.
@BxmCategory 는 필수 항목으로 작성한다.
부가정보는 다음과 같다.
1. 논리명(logicalName): Service 오퍼레이션의 논리명을 입력한다.

오퍼레이션 - 작성 예

@BxmServiceOperation("smp1001a001")
@BxmCategory(logicalName="고객정보조회")
public SMP1001A001OutDto smp1001a001(SMP1001A001InDto input) throws DefaultApplicationException {
    ... ...
}

3. Bean

프레임워크에서 BC(비즈니스 컴포넌트)는 Bean으로 사용되며 @BxmBean 어노테이션으로 정의 한다. BC는 Studio 의 'Bean 클래스' 메뉴를 통해 생성되며 BC의 이름은 다음과 같이 작성한다.

구분 설명

구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + bean
Package - 적용사례	bxm.dft.smp.online.bean
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 bean를 쓴다.
클래스 - 구성	M + L3코드 + (표준단어)* + (일련번호 2자리)?
클래스 - 적용사례	MSmpEmpInfMng, MSmpEmpInfMng01
클래스 - 기본원칙	Module를 뜻하는 기호 'M' , L3코드 3자리, 표준단어 영문약어의 조합으로 이루어진다. Bean의 메소드가 많아 분리가 필요한 경우 일련번호 2자리를 지정한다. L3코드는 첫 글자는 대문자, 나머지는 소문자로 표기한다. Bean은 @BxmBean 어노테이션을 포함한다. 파일의 확장자는 java를 사용한다.
클래스 - 부가정보	부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다. @BxmCategory 는 필수 항목으로 작성한다. 부가정보는 다음과 같다. 논리명(logicalName) : Bean의 논리명을 입력한다.
클래스 - 작성 예	`@BxmBean @BxmCategory(logicalName = "샘플직원정보관리") public class MSmpEmpInfMng { ... ... }`
메소드 - 구성	메소드 prefix + (표준단어)*
메소드 - 적용사례	getEmpInf - 샘플 직원정보를 얻는다. addEmpInf - 샘플 직원정보를 추가한다.
메소드 - 기본원칙	메소드 Prefix 는 메소드 Prefix 장을 참고하여 작성한다. 메소드 동작에 해당하는 Prefix를 선택한다. 표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다. 하나의 Bean에 Bean 메소드는 10개 이하로 작성한다. 하나의 Bean 메소드에 너무 많은 코드를 작성하지 않는다.
메소드 - 부가정보	부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다. @BxmCategory 는 필수 항목으로 작성한다. 부가정보는 다음과 같다. 논리명(logicalName): 메소드의 논리명을 입력한다.
메소드 - 작성 예	`@BxmCategory(logicalName = "단건 등록") public int addEmpInf(DSmpEmpTst000Dto input) throws DefaultApplicationException { ... ... }`

Package - 구성

L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + bean

Package - 적용사례

bxm.dft.smp.online.bean

Package - 기본원칙

Package 이름 작성은 모두 소문자로 한다.
분류는 "."로 구분한다.
Package의 마지막 세그먼트는 bean를 쓴다.

클래스 - 구성

M + L3코드 + (표준단어)* + (일련번호 2자리)?

클래스 - 적용사례

MSmpEmpInfMng, MSmpEmpInfMng01

클래스 - 기본원칙

Module를 뜻하는 기호 'M' , L3코드 3자리, 표준단어 영문약어의 조합으로 이루어진다.
Bean의 메소드가 많아 분리가 필요한 경우 일련번호 2자리를 지정한다.
L3코드는 첫 글자는 대문자, 나머지는 소문자로 표기한다.
Bean은 @BxmBean 어노테이션을 포함한다.
파일의 확장자는 java를 사용한다.

클래스 - 부가정보

부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다.
@BxmCategory 는 필수 항목으로 작성한다.
부가정보는 다음과 같다.
1. 논리명(logicalName) : Bean의 논리명을 입력한다.

클래스 - 작성 예

@BxmBean
@BxmCategory(logicalName = "샘플직원정보관리")
public class MSmpEmpInfMng {
    ... ...
}

메소드 - 구성

메소드 prefix + (표준단어)*

메소드 - 적용사례

getEmpInf - 샘플 직원정보를 얻는다.

addEmpInf - 샘플 직원정보를 추가한다.

메소드 - 기본원칙

메소드 Prefix 는 메소드 Prefix 장을 참고하여 작성한다. 메소드 동작에 해당하는 Prefix를 선택한다.
표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다.
하나의 Bean에 Bean 메소드는 10개 이하로 작성한다.
하나의 Bean 메소드에 너무 많은 코드를 작성하지 않는다.

메소드 - 부가정보

부가정보는 @BxmCategory 어노테이션을 사용하여 기입한다.
@BxmCategory 는 필수 항목으로 작성한다.
부가정보는 다음과 같다.
1. 논리명(logicalName): 메소드의 논리명을 입력한다.

메소드 - 작성 예

@BxmCategory(logicalName = "단건 등록")
public int addEmpInf(DSmpEmpTst000Dto input) throws DefaultApplicationException {
    ... ...
}

4. DBIO

DBIO는 데이터베이스에 직접 접근하는 객체로 Bean을 통해서만 호출이 가능하다. DBIO는 Studio 의 'DBIO' 메뉴를 통해 생성되며 DBIO의 이름은 다음과 같이 작성한다.

구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio
Package - 적용사례	bxm.dft.smp.online.dbio
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 dbio를 쓴다.
클래스 - 구성	PK CRUD : D + 테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000 그외 : D + 테이블 이름 + (001-999)
클래스 - 적용사례	PK CRUD : DSmpEmpTst000 그외 : DSmpEmpTst002
클래스 - 기본원칙	DBIO 이름은 사용하는 쿼리에서 DBIO를 뜻하는 기호 'D' 1자리, 주로 사용하는 테이블의 테이블명과 일련번호 3자리로 구성된다. 테이블 이름은 카멜 표기법으로 한다. 일련번호000은 PK로 CRUD를 하는 DBIO를 위한 번호이므로 개발자가 직접 작성/수정 하지 않는다.(Default DBIO 기능으로 자동 생성). 개발자는 일련번호 001부터 시작하는 DBIO를 작성한다. 파일의 확장자는 dbio를 사용한다.
클래스 - 부가정보	- DBIO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
SQL ID - 구성	DBIO prefix + (일련번호 2자리) DBIO Prefix + (표준단어)* 또는 DBIO Prefix + (표준단어)* + (일련번호2자리)
SQL ID - 적용사례	selectOne01 selectOneEmpNm selectOneEmpNm01
SQL ID - 기본원칙	DBIO SQL ID의 이름은 Prefix와 일련번호 2자리로 구성하거나 Prefix와 표준단어 조합, 또는 Prefix와 표준단어 조합에 일련번호 2자리로 구성할 수 있다. 표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다. 일련번호 00은 PK를 사용하는 쿼리를 위한 번호이므로 비워둔다. Prefix는 매핑 되는 SQL의 statement와 일치하게 작성한다. Prefix는 DBIO 메소드 Prefix 항목을 참고한다.

구분

설명

Package - 구성

L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio

Package - 적용사례

bxm.dft.smp.online.dbio

Package - 기본원칙

Package 이름 작성은 모두 소문자로 한다.
분류는 "."로 구분한다.
Package의 마지막 세그먼트는 dbio를 쓴다.

클래스 - 구성

PK CRUD : D + 테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000
그외 : D + 테이블 이름 + (001-999)

클래스 - 적용사례

PK CRUD : DSmpEmpTst000
그외 : DSmpEmpTst002

클래스 - 기본원칙

DBIO 이름은 사용하는 쿼리에서 DBIO를 뜻하는 기호 'D' 1자리, 주로 사용하는 테이블의 테이블명과 일련번호 3자리로 구성된다.
테이블 이름은 카멜 표기법으로 한다.
일련번호000은 PK로 CRUD를 하는 DBIO를 위한 번호이므로 개발자가 직접 작성/수정 하지 않는다.(Default DBIO 기능으로 자동 생성).
개발자는 일련번호 001부터 시작하는 DBIO를 작성한다.
파일의 확장자는 dbio를 사용한다.

클래스 - 부가정보

- DBIO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.

클래스 - 작성 예

소스코드를 직접 생성하지 않는다.

SQL ID - 구성

DBIO prefix + (일련번호 2자리)
DBIO Prefix + (표준단어)* 또는
DBIO Prefix + (표준단어)* + (일련번호2자리)

SQL ID - 적용사례

selectOne01

selectOneEmpNm

selectOneEmpNm01

SQL ID - 기본원칙

DBIO SQL ID의 이름은 Prefix와 일련번호 2자리로 구성하거나 Prefix와 표준단어 조합, 또는 Prefix와 표준단어 조합에 일련번호 2자리로 구성할 수 있다.
표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다.
일련번호 00은 PK를 사용하는 쿼리를 위한 번호이므로 비워둔다.
Prefix는 매핑 되는 SQL의 statement와 일치하게 작성한다.
Prefix는 DBIO 메소드 Prefix 항목을 참고한다.

5. Default DBIO

테이블을 기반으로 DBIO와 IO를 자동 생성 해주는 Studio의 편의 기능중 하나로 Default DBIO의 표준은 다음과 같다.

(1) 생성된 DBIO

구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio
Package - 적용사례	bxm.dft.smp.online.dbio
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 dbio를 쓴다.
클래스 - 구성	- D + 테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000
클래스 - 적용사례	- PK CRUD : DSmpEmpTst000
클래스 - 기본원칙	DBIO 이름은 사용하는 쿼리에서 DBIO를 뜻하는 기호 'D' 1자리, 주로 사용하는 테이블의 테이블명과 일련번호 000으로 구성된다. 테이블 이름은 카멜 표기법으로 한다. 파일의 확장자는 dbio를 사용한다.
클래스 - 부가정보	- DBIO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
SQL ID - 구성	메소드 Prefix + _ + PK 이름 메소드 prefix + _ + UK 이름 메소드 Prefix + _ + 인덱스 이름
SQL ID - 적용사례	selectOneLock_SYS_C0011417 insert_SYS_C0011417
SQL ID - 기본원칙	DBIO SQL ID의 이름은 Prefix와 테이블의 PK, UK 사용 여부, PK 또는 UK 이름으로 정해진다. 표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다. Prefix는 매핑 되는 SQL의 statement 와 일치하게 작성한다. Prefix는 DBIO 메소드 Prefix 항목을 참고한다.

구분

설명

Package - 구성

L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio

Package - 적용사례

bxm.dft.smp.online.dbio

Package - 기본원칙

Package 이름 작성은 모두 소문자로 한다.
분류는 "."로 구분한다.
Package의 마지막 세그먼트는 dbio를 쓴다.

클래스 - 구성

- D + 테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000

클래스 - 적용사례

- PK CRUD : DSmpEmpTst000

클래스 - 기본원칙

DBIO 이름은 사용하는 쿼리에서 DBIO를 뜻하는 기호 'D' 1자리, 주로 사용하는 테이블의 테이블명과 일련번호 000으로 구성된다.
테이블 이름은 카멜 표기법으로 한다.
파일의 확장자는 dbio를 사용한다.

클래스 - 부가정보

- DBIO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.

클래스 - 작성 예

소스코드를 직접 생성하지 않는다.

SQL ID - 구성

메소드 Prefix + _ + PK 이름
메소드 prefix + _ + UK 이름
메소드 Prefix + _ + 인덱스 이름

SQL ID - 적용사례

selectOneLock_SYS_C0011417

insert_SYS_C0011417

SQL ID - 기본원칙

DBIO SQL ID의 이름은 Prefix와 테이블의 PK, UK 사용 여부, PK 또는 UK 이름으로 정해진다.
표준단어는 메타시스템에 정의된 표준단어 영문약어의 조합을 사용한다.
Prefix는 매핑 되는 SQL의 statement 와 일치하게 작성한다.
Prefix는 DBIO 메소드 Prefix 항목을 참고한다.

(2) 생성된 DBIO의 IO

구분

설명

Package - 구성

L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio.dto

Package - 적용사례

bxm.dft.smp.online.dbio.dto

Package - 기본원칙

Package 이름 작성은 모두 소문자로 한다.
분류는 "."로 구분한다.
Package의 마지막 세그먼트는 dbio.dto를 쓴다.

클래스 - 구성

- 테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000 + Io

클래스 - 적용사례

SmpEmpTst000Io

클래스 - 기본원칙

테이블 이름 ( 본 가이드에선 SMP_EMP_TST 테이블 사용 ) + 000에 Io를 붙인다.
테이블 이름은 카멜 표기법으로 한다.
파일의 확장자는 omm를 사용한다.

클래스 - 부가정보

- IO 자바 소스는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.

클래스 - 작성 예

소스코드를 직접 생성하지 않는다.

6. IO

IO 이름은 다음의 경우에 따라 구분되어 작성된다. Bean 용 IO는 가급적 Service, DBIO의 IO를 재사용 하도록 하고 필요한 경우에만 따로 만든다.

(1) Service Input/Output: Service의 입출력을 위한 IO

(2) DBIO Input/Output: DBIO의 입출력을 위한 IO

(3) 인터페이스 Input/Output: EAI/MCI 등의 인터페이스를 위한 IO

(4) Bean Input/Output: Bean의 입출력을 위한 IO

IO는 'IO' 메뉴를 통해 생성되며 IO의 이름은 다음과 같이 작성한다.

6.1. Service Input/Output을 위한 IO 작성

Service IO 명명 규칙
구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + service.dto
Package - 적용사례	bxm.dft.smp.online.service.dto
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 service.dto를 쓴다.
클래스 - 구성	입력 IO: Service 오퍼레이션이름(대문자) + InDto 출력 IO: Service 오퍼레이션이름(대문자) + OutDto 입력 반복 IO: 입력IO이름 + Sub + 반복 IO명 출력 반복 IO: 출력IO이름 + Sub + 반복 IO명
클래스 - 적용사례	입력 IO: SMP1001A001InDto 출력 IO: SMP1001A001OutDto 입력 반복 IO: SMP1001A001InDtoSubGrid00 출력 반복 IO: SMP1001A001OutDtoSubGrid00
클래스 - 기본원칙	Service 오퍼레이션의 입출력에 사용되는 IO는 Service 오퍼레이션이름(대문자) 및 입출력 Suffix 로 이루어진다. Service의 In/Out 은 반드시 명시적으로 사용한다. 입력에 사용되는 IO는 Suffix 를 'InDto' 으로 사용한다. 출력에 사용되는 IO는 Suffix 를 'OutDto' 으로 사용한다. 입력에 사용되는 반복 IO 는 Suffix 를 [Sub + 반복 IO명]로 사용한다 출력에 사용되는 반복 IO 는 Suffix 를 [Sub + 반복 IO명]로 사용한다. 파일의 확장자는 omm 을 사용한다. Service 입출력에 사용되는 IO는 DBIO IO로 사용하지 않는다. DBIO IO를 Service의 반복IO 로 사용하지 않는다.
클래스 - 부가정보	- IO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
메소드 - 구성	IO는 자바 소스코드가 자동생성 되므로 개발자가 직접 메소드를 구성할 필요가 없다.

6.2. DBIO를 위한 IO 작성

DBIO IO 명명 규칙
구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + dbio.dto
Package - 적용사례	bxm.dft.smp.online.dbio.dto
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 dbio.dto를 쓴다.
클래스 - 구성	NAME: DBIO 이름 PK CRUD: NAME+ Dto 그 외 입력 IO: NAME + DBIO 메소드 이름 + InDto 출력 IO: NAME + DBIO 메소드 이름 + OutDto
클래스 - 적용사례	PK CRUD : DSmpEmpTst000Dto 그 외 입력 IO: DSmpEmpTst001selectPage01InDto 출력 IO: DSmpEmpTst001selectPage01OutDto
클래스 - 기본원칙	PK로 CRUD를 하는 일련번호 000의 DBIO IO는 개발자가 직접 작성 하지 않는다. 개발자가 작성하는 일련번호 001 이후의 DBIO 메소드의 입출력에 사용되는 IO는 DBIO이름, DBIO메소드 이름 및 입출력 Suffix 로 이루어진다. 입력에 사용되는 IO는 Suffix 를 'InDto' 으로 사용한다. 출력에 사용되는 IO는 Suffix 를 'OutDto' 으로 사용한다. 파일의 확장자는 omm 을 사용한다.
클래스 - 부가정보	- IO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
메소드 - 구성	IO는 자바 소스코드가 자동생성 되므로 개발자가 직접 메소드를 구성할 필요가 없다.

6.3. 인터페이스를 위한 IO 작성

인터페이스 IO 명명 규칙
구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + inf.dto
Package - 적용사례	bxm.dft.smp.online.inf.dto
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 inf.dto를 쓴다.
클래스 - 구성	입력 IO: 시스템구분 + 일련번호2자리 + 타겟거래코드 + InDto 출력 IO: 시스템구분 + 일련번호2자리 + 타겟거래코드 + OutDto 입력 반복 IO: 입력IO이름 + Sub + 반복 DTO명 출력 반복 IO: 출력IO이름 + Sub + 반복 DTO명
클래스 - 적용사례	입력 IO: EAI01SYER3101A400InDto 출력 IO: EAI01SYER3101A400OutDto 입력 반복 IO: EAI01SYER3101A400InDtoSubGrid00 출력 반복 IO: EAI01SYER3101A400OutDtoSubGrid00
클래스 - 기본원칙	시스템 구분, 일련번호 2자리, 타겟거래코드 및 Suffix로 이루어진다. 입력에 사용되는 IO는 Suffix 를 'InDto' 으로 사용한다. 출력에 사용되는 IO는 Suffix 를 'OutDto' 으로 사용한다. 입/출력 IO의 서브 IO는 Suffix 를 [Sub + 반복 IO명]로 사용한다. 파일의 확장자는 omm 을 사용한다.
클래스 - 부가정보	- IO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
메소드 - 구성	IO는 자바 소스코드가 자동생성 되므로 개발자가 직접 메소드를 구성할 필요가 없다.

6.4. Bean을 위한 IO 작성

Bean 메소드의 입력은 기본타입, 일반 객체를 자유롭게 사용할 수 있다. Bean
메소드의 IO가 필요한 경우에는 Service의 IO와 DBIO의 IO를 재사용한다.
재사용이 어려운 경우 다음을 참고하여 생성하여 사용한다.

Bean IO 명명 규칙
구분	설명
Package - 구성	L1코드 + . + L2코드 + . +L3코드 + . + online 또는 batch + . + bean.dto
Package - 적용사례	bxm.dft.smp.online.bean.dto
Package - 기본원칙	Package 이름 작성은 모두 소문자로 한다. 분류는 "."로 구분한다. Package의 마지막 세그먼트는 bean.dto를 쓴다.
클래스 - 구성	입력 IO: Bean 이름 + 일련번호2자리 + InDto 출력 IO: Bean 이름 + 일련번호2자리 + OutDto 입력 반복 IO: 입력 IO이름 + Sub + 반복 IO명 출력 반복 IO: 출력 IO이름 + Sub + 반복 IO명
클래스 - 적용사례	입력 IO: MSmpEmpInfMng01InDto 출력 IO: MSmpEmpInfMng01OutDto 입력 반복 IO: MSmpEmpInfMng01InDtoSubGrid00 출력 반복 IO: MSmpEmpInfMng01OutDtoSubGrid00
클래스 - 기본원칙	Bean의 입출력에 사용되는 IO는 Bean이름, 일련번호, 입출력 Suffix 로 이루어진다. 입력에 사용되는 IO는 Suffix 를 'InDto' 으로 사용한다. 출력에 사용되는 IO는 Suffix 를 'OutDto' 으로 사용한다. 입/출력 IO의 서브 IO는 Suffix 를 [Sub + 반복 IO명]로 사용한다. 파일의 확장자는 omm 을 사용한다.
클래스 - 부가정보	- IO는 소스코드 생성 방식으로 생성 되므로 사용자가 부가 정보를 입력하지 않는다.
클래스 - 작성 예	소스코드를 직접 생성하지 않는다.
메소드 - 구성	IO는 자바 소스코드가 자동생성 되므로 개발자가 직접 메소드를 구성할 필요가 없다.

7. Variables / Constants

Service, Bean 클래스의 멤버 변수로 사용되는 변수 명명 규칙에 대해 설명한다. 변수 및 상수 이름의 제한은 다음의 항목에 적용한다.

(1) 멤버 변수 선언

구분 설명

구분	설명
맴버변수 선언 - 구성	클래스 이름에서 첫 글자는 소문자
맴버변수 선언 - 적용사례	mSmpEmpInfMng
맴버변수 선언 - 기본원칙	클래스 이름에서 첫 글자는 소문자로 표기하고 나머지는 클래스 이름과 동일하게 사용한다. 클래스 본문에 작성한다(메소드 본문에 선언하지 않는다). Nested Class에 작성하지 않는다. get/set 메소드를 작성하지 않는다. private 로 접근 제한자를 선언 한다. final 및 static 으로 선언하지 않는다. new 로 직접 객체를 생성하지 않는다.
맴버변수 선언 - 작성 예	`private MSmpEmpInfMng msmpEmpInfMng;`

맴버변수 선언 - 구성

클래스 이름에서 첫 글자는 소문자

맴버변수 선언 - 적용사례

mSmpEmpInfMng

맴버변수 선언 - 기본원칙

클래스 이름에서 첫 글자는 소문자로 표기하고 나머지는 클래스 이름과 동일하게 사용한다.
클래스 본문에 작성한다(메소드 본문에 선언하지 않는다).
Nested Class에 작성하지 않는다.
get/set 메소드를 작성하지 않는다.
private 로 접근 제한자를 선언 한다.
final 및 static 으로 선언하지 않는다.
new 로 직접 객체를 생성하지 않는다.

맴버변수 선언 - 작성 예

    private MSmpEmpInfMng msmpEmpInfMng;

(2) Service 오퍼레이션 파라미터

구분 설명

구분	설명
Service 오퍼레이션의 파라미터 - 구성	Service 오퍼레이션의 input 파라미터 이름은 input + (일련번호 1자리)? 로 한다.
Service 오퍼레이션의 파라미터 - 적용사례	ssmp1001a001(SSMP1001A001InDto input)
Service 오퍼레이션의 파라미터 - 기본원칙	Service 오퍼레이션의 파라미터는 입력 파라미터 이므로 input 으로 표기한다. 파라미터에 final 키워드는 사용하지 않는다.
Service 오퍼레이션의 파라미터 - 작성 예	`/* ssmp1001a001 오퍼레이션의 input 파라미터 이름이 input이다 */ public SSMP1001A001OutDto ssmp1001a001(SSMP1001A001InDto input) throws DefaultApplicationException { ... ... }`

Service 오퍼레이션의 파라미터 - 구성

Service 오퍼레이션의 input 파라미터 이름은 input + (일련번호 1자리)? 로 한다.

Service 오퍼레이션의 파라미터 - 적용사례

ssmp1001a001(SSMP1001A001InDto input)

Service 오퍼레이션의 파라미터 - 기본원칙

Service 오퍼레이션의 파라미터는 입력 파라미터 이므로 input 으로 표기한다.
파라미터에 final 키워드는 사용하지 않는다.

Service 오퍼레이션의 파라미터 - 작성 예

/* ssmp1001a001 오퍼레이션의 input 파라미터 이름이 input이다 */
public SSMP1001A001OutDto ssmp1001a001(SSMP1001A001InDto input) throws DefaultApplicationException {
    ... ...
}

(3) 상수

구분 설명

구분	설명
상수 - 구성	표준단어 + (_ + 표준단어)*
상수 - 적용사례	MAX_NUM 시스템코드_CODE_NAME
상수 - 기본원칙	상수는 static final로 선언 되며 이름은 모두 대문자로 이루어진다(외부 공개가 필요한 상수는 public 키워드를 함께 사용). 각 단어는 _(언더바)로 구분한다. 상수 길이는 50글자 이내로 작성한다. 초기화는 static 블록에서 이루어진다.
상수 - 작성 예	`public static final int MAX_NUM; public static final String 시스템코드_CODE_NAME; static { MAX_NUM= 100; CODE_NAME= "BXM"; }`

상수 - 구성

표준단어 + (_ + 표준단어)*

상수 - 적용사례

MAX_NUM
시스템코드_CODE_NAME

상수 - 기본원칙

상수는 static final로 선언 되며 이름은 모두 대문자로 이루어진다(외부 공개가 필요한 상수는 public 키워드를 함께 사용).
각 단어는 _(언더바)로 구분한다.
상수 길이는 50글자 이내로 작성한다.
초기화는 static 블록에서 이루어진다.

상수 - 작성 예

public static final int MAX_NUM;
public static final String 시스템코드_CODE_NAME;
static {
    MAX_NUM= 100;
    CODE_NAME= "BXM";
}

8. Service 테스트 케이스

Service 테스트 케이스 규칙
구분	설명
폴더명 - 구성	testcases/serviceTest
파일명 - 구성	Test + Service 이름 + 일련번호3자리
파일명 - 적용사례	TestSSMP1001A003.case TestSSMP1001A001.case
파일명 - 기본원칙	Test prefix + Service이름과 일련번호 3자리로 이루어진다. 테스트 케이스의 Service 이름은 모두 대문자로 작성한다. 프로젝트의 testcases/serviceTest 폴더에 생성한다. 파일의 확장자는 case를 사용한다.
파일명 - 작성 예	Figure 1. 테스트 케이스 생성 모습

9. Module 테스트 케이스

Module 테스트 케이스 규칙
구분	설명
폴더명 - 구성	testcases/moduleTest
파일명 - 구성	Test + Bean 클래스 이름 + 일련번호3자리
파일명 - 적용사례	TestMSmpEmpInfMng001.mtest TestMSmpIntrLinkCall001.mtest
파일명 - 기본원칙	Test prefix + Bean 클래스 이름과 일련번호 3자리로 이루어진다. 프로젝트의 testcases/moduleTest 폴더에 생성한다. 파일의 확장자는 mtest를 사용한다.
파일명 - 작성 예	Figure 2. 테스트 케이스 생성 모습

10. 지역변수

메소드 내부에서 사용하는 지역변수의 이름은 따로 표준을 제공하지 않는다. 자유롭게 선언하여 사용하되 가급적 의미를 쉽게 파악할 수 있는 이름을 사용한다.

11. 명명규칙 예제

본 장에서 가이드 한 명명규칙을 지키면 다음 표와 같은 이름의 리소스가 생성 되어야 한다.

구분	설명
프로젝트	온라인 프로젝트 : BxmDftSmp 배치 프로젝트 : BxmDftSmpBatch
Service 클래스 이름 및 Package	Package : bxm.dft.smp.online.service 클래스 : SSMP1001A
Service IO 이름 및 Package	Package : bxm.dft.smp.online.service.dto Input IO : SSMP1001AInDto Output IO : SSMP1001AOutDto
Bean 이름 및 Package	Package : bxm.dft.smp.online.bean 클래스 : MSmpEmpInfMng01
Bean IO 이름 및 Package	Package : bxm.dft.smp.online.bean.dto Input IO : MSmpEmpInfMng01InDto Output IO : MSmpEmpInfMng01OutDto
DBIO 이름 및 Package	Package : bxm.dft.smp.online.dbio 클래스 : DSmpEmpTst001
DBIO IO 이름 및 Package	Package : bxm.dft.smp.online.dbio.dto Input IO : DSmpEmpTst001selectPage01InDto Output IO : DSmpEmpTst001selectPage01OutDto

구분

설명

프로젝트

온라인 프로젝트 : BxmDftSmp
배치 프로젝트 : BxmDftSmpBatch

Service 클래스 이름 및 Package

Package : bxm.dft.smp.online.service
클래스 : SSMP1001A

Service IO 이름 및 Package

Package : bxm.dft.smp.online.service.dto
Input IO : SSMP1001AInDto
Output IO : SSMP1001AOutDto

Bean 이름 및 Package

Package : bxm.dft.smp.online.bean
클래스 : MSmpEmpInfMng01

Bean IO 이름 및 Package

Package : bxm.dft.smp.online.bean.dto
Input IO : MSmpEmpInfMng01InDto
Output IO : MSmpEmpInfMng01OutDto

DBIO 이름 및 Package

Package : bxm.dft.smp.online.dbio
클래스 : DSmpEmpTst001

DBIO IO 이름 및 Package

Package : bxm.dft.smp.online.dbio.dto
Input IO : DSmpEmpTst001selectPage01InDto
Output IO : DSmpEmpTst001selectPage01OutDto

SWLab Bankware Global