Skip to content

3.2. Naming Rules

TargetRuleExample
PackageLowercase, singularcom.tienipia.flowin.user
Class / InterfaceUpperCamelCaseUserService, Pageable
MethodlowerCamelCase, starts with a verbfindByEmail(), createUser()
VariablelowerCamelCaseuserName, totalCount
ConstantUPPER_SNAKE_CASEMAX_RETRY_COUNT, DEFAULT_PAGE_SIZE
Enum valueUPPER_SNAKE_CASEACTIVE, PENDING_APPROVAL
Test methodDescriptive naming permittedshould_find_user_by_email()

3.2.1. Class Suffix Rules

LayerSuffixExample
ControllerControllerUserController
ServiceServiceUserService
Service ImplementationServiceImplUserServiceImpl
RepositoryRepositoryUserRepository
DTO RequestRequestCreateUserRequest
DTO ResponseResponseUserResponse
ConfigurationConfigSecurityConfig
ExceptionExceptionUserNotFoundException

TIENIPIA QUALIFIED STANDARD