Guide 개발 Naming 규칙

[Draft]

Table of Contents

• Java
  1. Package
  2. Class
  3. Method
• JSP
• Angular JS
  1. Module (JS)
  2. Template (HTML)
• 변수 (공통)

## Java > Service의 Class 와 Method의 Naming은 **Transaction에 영향**을 주기 때문에 **Naming Rule을 엄수**해야 합니다. > > [/WEB-INF/confgi/spring/spring-mybatis.xml](https://github.com/okjsp/okmakeover/blob/master/src/main/webapp/WEB-INF/config/spring/spring-mybatis.xml) 의 _transactionManager_ 부분 참조. ### Package

소문자로만 이루어진 최소 단위의 명사형 단어 (부득이 단어 조합이 될 경우에도 소문자만을 이용하여 단어 조합)

   Ex) member / casestudy / boardtype

### Class 대문자로 시작하는 CamelCase Style의 명사형 단어에 접미어 조합. ``` Ex) MemeberController / CaseStudyService / BoardTypeDao / QnaServiceImpl ```

각 Layer 별 접미어

• Model : 접미어 없음
• Controller : *Controller
• Service Interface : *Service
• Service Implement : *ServiceImpl
• Dao Interface : *Dao

//Example Member
net.okjsp.member.MemberController
net.okjsp.member.model.Member
net.okjsp.member.service.MemberService
net.okjsp.member.service.MemberServiceImpl
net.okjsp.member.dao.MemberDao

//Example CaseStudy
net.okjsp.casestudy.CaseStudyController
net.okjsp.casestudy.model.CaseStudy
net.okjsp.casestudy.service.CaseStudyService
net.okjsp.casestudy.service.CaseStudyServiceImpl
net.okjsp.casestudy.dao.CaseStudyDao

### Method 소문자로 시작하는 cameCase Style의 동사+명사의 조합. ``` Ex) getMemberInfo / createMember / insertMember / updateCaseStudyStatus ```

기능별 접두어 정의

• Service
  • Create : create* 또는 add*
  • Retrieve : get* 또는 check*
  • Update : modify* 또는 change*
  • Destroy : destroy* 또는 remove*

//Example MemberService

public List<Member> getList();
public Member getOne(int id):
public boolean checkDuplicate(String loginId);
public boolean create();
public boolean modify(int id);
public boolean destroy(int id);
public boolean addAuth(int id);
public boolean removeAuth(int id);

• Dao
  • Insert : insert*
  • Select : select*
  • Update : update*
  • Delete : delete*

//Example MemberDao

public List<Member> selectList();
public Member selectOne(int id):
public int selectCount(String loginId);
public boolean insert();
public boolean update(int id);
public boolean updateStatus(int id);
public boolean delete(int id);
public boolean insertAuth(int id);
public boolean deleteAuth(int id);

## JSP * File 과 Folder 모두 동일하게 소문자 Under score(_) 구분의 명사 조합. * Folder 는 단위 프로그램 기준으로 최소단위의 단어 사용. * File은 File 명 만으로도 해당 프로그램을 알 수 있게 `프로그램명_액션명.jsp` 조합으로 작성.

/member/member_list.jsp   
/member/member_form.jsp 
/case_study/case_study_list.jsp
/case_study/case_study_result.jsp

## Angular JS ### APP (JS)

Module Name

Module 및 하위 프로그램 명은 대문자로 시작하는 CamelCase Style의 명사형 단어에 접미어 조합.

• Module : *App
• Factory : 접미어 없음
• Controller : *+액션명+Ctrl
• Provider : *Provider
• Service : *Service

    // Module
    var sampleApp = angular.module('SampleApp', ...);

    // Factory
    sampleApp.factory('Sample', function(){...});

    // Provider
    sampleApp.provider('SampleProvider', function() {...});

    // Service
    sampleApp.provider('SampleService', function() {...});

    // Controller
    sampleApp.controller('SampleListCtrl', function() {...});
    sampleApp.controller('SampleViewCtrl', function() {...});
    sampleApp.controller('SampleCreateCtrl', function() {...});

File Name

• angular JS의 module 은 모듈명을 Under score(_) 로 변환. SampleApp > sample_app.js

/member/member_app.js   
/case_study/case_study_app.js

### Template (HTML) * File 과 Folder 모두 동일하게 소문자 Under score(_) 구분의 명사 조합. * Folder 는 단위 프로그램 기준으로 최소단위의 단어 사용. * IDE 의 Syntax Highlight 를 위해 확장자는 `.html` 사용. * File은 File 명 만으로도 해당 프로그램을 알 수 있게 `프로그램명_액션명.html` 조합으로 작성.

/member/member_list.html   
/member/member_form.html 
/case_study/case_study_list.html
/case_study/case_study_view.html
/case_study/case_study_result.html

## 변수 (공통) * 지역변수는 소문자로 시작하는 cameCase Style의 명사의 조합. `count / memberAuth / caseStudy / isValid / checkYn` * 전역변수는 대분지 Under score(_) 구분의 명사의 조합. `SITE_CODE / SYSTEM_ID / REAL_FILE_PATH`