Common Naming Rules
All naming rules include the following common items.
1. Constraints
(1) Except for metadata provided by Meta, the use of English letters based on Korean pronunciation is restricted. Example) 직업 → Jikup
(2) The use of symbols and special characters other than English letters is restricted. Example) _, $
(3) Table names are an exception.
(4) Each component is named using a combination of standard word English abbreviations.
2. Standard Words
(1) Standard words are converted and used in the following camel case notation.
(2) Camel case conversion rules: From words separated by _(underscore)…
-
The first word is written entirely in lowercase.
-
From the second word onward, only the first letter is uppercase and the rest are lowercase.
-
Single-letter words are written in uppercase.
(3) Examples of standard word conversion using camel case notation
-
USR_NM → usrNm
-
DPST_AMT → dpstAmt
-
N_CASTING → nCasting
-
CUST_N_ID → custNId
3. Expressions
The expressions used in naming rules are as follows.
| Expression | Description | Composition | Example |
|---|---|---|---|
B |
B must exist. |
A + B + C |
ABC |
(B)* |
Zero or more B exist. |
A + (B)* + C |
AC, ABC, ABB…C |
(B)? |
B exists once or not at all. |
A + (B)? + C |
AC, AB |
(BC)* |
Zero or more BC exist. |
A + (BC)* + C |
AC, ABCC, ABCBC…C |
(B|C) |
B or C. |
A + (B|C) + C |
ABC, ACC |
(B|C)* |
Zero or more B or C exist. |
A + (B|C)* + C |
AC, ABC, ABCBC, etc. |
[0-9] |
A digit from 0 to 9 |
A + [0-9] + C |
A0C, |
[00-99] |
A number from 00 to 99 |
A + [00-99] + C |
A00C, …, A09C, …, A99C |
[A-Z] |
Alphabet A to Z |
A + [A-Z] + C |
AAC, …, |
[a-zA-Z] |
Alphabets from a-z or A-Z |
A + [a-zA-Z] + C |
AaC, AAC, …, AjC, …, AJC, …, AzC, …, AZC |
4. Prefix
Verbs used as prefixes are determined according to the role of the method.
4.1. Bean Method Prefix
Bean methods use the following prefixes according to the role of the method.
| Method role | prefix | Example |
|---|---|---|
Inquiry |
get |
getUser, getUserList, getUsers |
Set |
set |
setUser, setUserList, setUsers |
Add |
add |
addUser |
Remove |
remove |
removeUser |
Create/New |
create |
createUser |
Modify |
modify |
modifyUserInfo |
Initialize |
init |
initProcessor |
Authenticate/Validate |
validate |
validateUserInfo |
Check |
check |
checkId |
Process |
process |
processCalcuation |
Calculate |
calc |
calcInterest |
Has |
has |
hasUser, hasElement, hasId |
True/False |
is |
isTrue, isFalse |
Exist |
exist |
existUser, existed |
Call |
call |
callEAI0001, callRULE0001 |
4.2. DBIO Method Prefix
For DBIO methods, the following prefixes are used according to the statement type.
| Role | prefix | Example |
|---|---|---|
Single Inquiry |
selectOne |
selectOne01 |
Multiple Inquiry |
selectList |
selectList01 |
Paging Inquiry |
selectPage |
selectPage01 |
Single Inquiry Lock Update |
selectOneLock |
selectOneLock01 |
Multiple Inquiry Lock Update |
selectListLock |
selectListLock01 |
Insert |
insert |
insert01 |
Update |
update |
update01 |
Delete |
delete |
delete01 |