헤르메스 LIFE

[펌] Java & JSP 코딩 가이드 본문

문서

[펌] Java & JSP 코딩 가이드

헤르메스의날개 2020. 12. 17. 00:17
728x90

출처 : http://ebizdocs.springnote.com/pages/1110314

 

  1. Introduction
    1. Objectives
    2. Target Audience
    3. 참고 문서
  2. Basic rules
    1. 포맷 규칙(Formatting rule)
      1. 들여쓰기 및 탭 문자 사용
      2. 블록의 시작 및 끝
      3. 라인의 작성 기준
      4. 줄바꿈 및 여백 활용 기준
    2. 클래스 이름 부여 규칙
      1. 클래스 명칭의 접두 문자
      2. 클래스 명칭의 첫번째 단어
      3. 클래스의 접미 단어
    3. 변수 이름 부여 규칙
      1. 변수명의 접두사
      2. 변수명의 첫번째 어절
      3. 변수명의 두번째 어절
    4. 함수 이름 부여 규칙
      1. 일반 함수명의 첫번째 어절 및 나머지 어절
      2. 멤버 함수인 경우
    5. 상수명 부여 규칙
      1. 대문자 사용 원칙
    6. 소스 파일 작성 규칙
      1. 소스 파일 설명
      2. 헤더 파일 설명
    7. Java 코딩 규칙
      1. Description
    8. 주석
      1. 항목 뒤에 붙이는 주석
      2. 항목 위에 붙이는 주석
    9. 영역 (area)
      1. 패키지 선언
      2. 임포트(import) 선언
      3. 클래스 선언
      4. 상수 선언
      5. 변수 선언
      6. 생성자(constructor)  선언
      7. property 선언
      8. public 메소드 선언
      9. protected, private 메소드 선언
  3. JSP 프로그램 코딩 규칙
    1. 머리말(header)
    2. 주석(comment)
      1. 영역에 대한 주석
      2. 한 줄에 대한 주석
      3. 여러 줄에 대한 주석
      4. 항목 뒤에 붙이는 주석
    3. 블록 설정 시 코딩 형식
      1. 명령문이 한줄이 경우
      2. 명령문이 한줄이고 else가 있을 경우
      3. 명령문이 2줄이상이고 else가 있을 경우
    4. 영역 (area)
      1. 설명문(description) 서술
      2. 지시어(directive) 서술
      3. 각종 빈(bean) 선언
      4. 빈(bean)의 속성(property) 설정
      5. 선택적 JSP 선언문
      6. 각종 상태 점검 및 초기화 코드 작성
      7. HTML 태그 서술
      8. <HEAD> </HEAD> 블록 서술
      9. <BODY> </BODY> 블록 기술
  4. 참고 자료

 

Introduction#

Objectives#

프로그램 소스의  표준화를  통해서 코딩의 규격화와 효율성 및  가독성을  증대시키고, 유지 보수를  원
활히 하는데 목적이 있다.
소프트웨어  제품 개발에 사용되는 언어가 다양하므로 특정  언어  및  환경에 의존적이지 않는  일반적
인  표준  코드  서술  규범을  먼저  기술하고  특정  언어  및  환경을  위한  서술  규범은  별도로  기술한다.
또한,  이 문서에 기술되지 않았거나 문서의  기준을 적용하기  곤란한 부분에  대해서는 헝가리안 표기
법 및 관습적인 코딩 규약을 사용할 것을 권장한다.

 

Target Audience#

웹 개발자 및 ActiveX 개발자

 

참고 문서#

Sun  microsystem에서  권장하는  자바  코딩  관습  문서는  “http://java.sun.com/docs/codeconv/”에서  찾아볼 수 있다.

 

Basic rules#

포맷 규칙(Formatting rule)#

들여쓰기 및 탭 문자 사용#

들여쓰기는  코드에서  블록의  시작과  끝을  쉽게  알아볼  수  있게  해준다.  들여쓰기  되었을  때,  더욱
읽기  좋고,  더  많은  단계의  블록이  다른  블록  내부에  포함되어  있을  때,  들여쓰기의  필요성은  더욱
강조된다. 들여쓰기  및  탭  크기는  기본적으로  4  글자로 한다.  탭  문자는  사용하지 않는  것을  원칙으
로 한다. 다음은 들여쓰기 예이다.

 

  1. <myTagLib:forEach var="client" items="${clients}">
        <myTagLib:mail value="${client}" />
    </myTagLib:forEach>

 

연속 들여쓰기는  이전  줄의 적당한  지점에서  시작한다. 연속  들여쓰기의 공백은  기본 들여쓰기 공백
의 배수이다. (4개의 공백문자의 배수):

 

  1. <%@ page    attribute1="value1"
                attribute2="value2"
                ...
                attributeN="valueN"
    %>

 

블록의 시작 및 끝#

중괄호”{“  와  중괄호”}”  는  항상  수직선상에  위치하도록  한다  또한  항상  블록의  시작에서는 4칸  들
여쓰기를  한다.  자바  진영의  주된  경향(흐름)은  시작하는  괄호를  코드의  끝에  위치ㅅ키는  것이지만,
시각적 효과를 위해 수직 정렬을 표준으로 채택하였다.

  1.     main() {
            for( ; ; ) {
            }
        }


라인의 작성 기준#

1024*768 화면 기준으로 각 라인은  한 화면에  가급적 전부 보이도록 100 컬럼이내로  짧게  작성하며,
코드의 길이가 긴 라인은 두 줄에 걸쳐서 작성한다. 한 줄에 꼭 하나의 명령문만을 기술하여야 한다.
복잡한 수식을 가진 긴 라인이라면 여러 개의 작은 수식으로 분할하여 작성한다.

double length = Math.sqrt( Math.pow(Math.random(),2.0) + Math.pow(Math.randown(),2,0) ) ; 은 아래와 같이
분리한다.

 

  1.     double xSquared = Math.pow(Math.random(), 2.0 ) ;
        double ySquared = Math.pow(Math.random(), 2, 0 ) ;
        double length    = Math.sqrt(xSquared + ySquared) ;


줄바꿈 및 여백 활용 기준#

 각 코드 블록(code block)간의 여백은 한 줄을 띄우는 것을 원칙으로 하며, 함수 혹은 각 영역(area)간의 간격은 두 줄을 원칙으로 한다.
  각각의  생성자  그리고  각각의  메소드와  같은  클래스의  부분들(parts)  사이에  적어도  하나  이상의  빈줄을삽입하라.
  메소드 내부에서 지역 변수의 선언 이후에, 그리고 코드의 다른 영역들 사이에 빈 줄을 삽입하라.
  연산자( =, /, * 등)의 양 옆에 공백을 삽입하라. 그러나 증가(++), 감소(--), 부정(!) 같은 복합연산자에는 공백을 이용해서는 안된다
  for  구문의  부분들을  공백으로  구분하여라.  초기화,  검사,  증가  부분을  구분하는  세미콜론(;)  다음에  공백을 준다.
  메소드의 인자(parameter)  목록의 쉼표(comma)와 뒤의 공백은 각각의 인자의 시작과 끝을 명확하게 만들어준다.

클래스 이름 부여 규칙#

클래스 명칭의 접두 문자#

클래스 명칭의 첫번째 문자는 클래스를  뜻하는  대문자  ‘C’로 시작하거나,  알파벳  대문자로 사용한다.

 

클래스 명칭의 첫번째 단어#

클래스  명칭의  접두  문자  이후의  첫번째  단어는  클래스의  성격을  잘  나타낼  수  있는  명사  혹은  형용사를 사용하며, 단어의 첫 글자는 대문자로 시작하며, 나머지는 소문자로 기술하여야 한다.

 

클래스의 접미 단어#

클래스의 종류를 나타내는 접미사를 붙여주는 것을 권장한다.

  → 다이얼로그  : Dlg
  → 윈도우      : Wnd
  → 문서        : Doc
  → 자바 빈     : Bean
  → 커스텀 태그 : Tag

 

변수 이름 부여 규칙#

 

변수명의 접두사#

클래스의 멤버 변수일 때는 m을 접두사로서 붙여준다.
함수의 전역 변수인 경우에는 g를 접두사로 붙이고, static 변수인 경우에는 s를 붙이도록 한다.
변수명의 접두사는 항상 소문자를 쓰도록 한다.

 

변수명의 첫번째 어절#

변수명의  접두사  이후에 위치하는  첫번째 어절은 변수의 타입을 쓴다.

 

[ Table 1 ]  변수 유형에 따른 표기 방법

변수타입 변수타입

정수 (integer)            n

문자 (char)               c

NULL 종료 문자열      sz

배열 (array)              arr

실수 (float)          f

문자열 (String)     str

논리형 (Boolean)  b or is

더블 (double)       d

변수명의 두번째 어절#

변수명의  두번째  어절은  첫번째  문자만  대문자로  사용하고  나머지는  소문자로  표시하며,  변수의  의
미 및 용도를 잘 나타낼 수 있는 명사를 선택한다.

 

함수 이름 부여 규칙#

일반 함수명의 첫번째 어절 및 나머지 어절#

함수명을 구성하는 각 어절의 첫 문자는 대문자로 시작하고, 나머지 문자는 소문자로 기술한다.
어절의 첫번째 문자를 대문자로 기술하는 것은 단어를 시각적으로 구별하기 쉽게하는 효과가 있다.

 

멤버 함수인 경우#

클래스의  멤버  함수의  경우에는  첫번째  어절의  첫  문자를  소문자로  기술해야  하며,  개체의  속성
(property)을  나타내는  멤버  함수일  경우에는  get  이라는  접두사를  붙이고,  속성을  지정하는  함수일
경우 set이라는 접두사를 붙인다. (단, MS  계열 개발 언어에서는 메소드의 명칭이 대문자로 시작하는
관습이 통용되고 있다.)

상수명 부여 규칙#

대문자 사용 원칙#

상수 이름은  항상 대문자를 사용하되 각 단어 혹은 어절의  사이에는 밑줄(_)로 연결한다. 상수에  대문자를 사용하는 것은 다른 종류의 명칭들과 구별하기 위함이다.

 

소스 파일 작성 규칙#

소스 파일 설명#

.html,  .js, .java  등  소스  파일은  파일의  최상위 부분에 그 파일에  대한 정보를  표시해주어야 하며  다음과 같은 주석을 작성한다.

  1.   /*
       * 작성일자 : 2001-05-25
       * 작 성 자 : 홍길동
       * 파일이름 : file.cpp
       * 수정이력 : 2001-05-25 최초 작성
       * 작성목적 : 프로젝트명, 프로그램명, 소스 용도, 공통 시스템 혹은 단위 시스템 여부.
       */

 

헤더 파일 설명#

.h 등 헤더 파일에는 다음과 같은 주석을 작성한다.

  1.   /*
       * 작성한날 : 2001-05-25
       * 작 성 자 : 최정현
       * 파일이름 : file.h
       * 수정이력 : 2001-05-25 최소 작성
       * 작성목적 : 프로젝트명, 프로그램명, 소스 용도, 라이브러리 여부
       */

 

Java 코딩 규칙#

 

Description#

머리말은 모든  소스 파일의 처음  부분에  기술하는 소스에 대한 설명이다. Java  프로그램의 머리말은 다음과 같은 형식으로 작성한다.

  1. /**
     * <PRE>
     * 프 로 그 램 명 : UserRegisterBean.java
     * 작    성    자 : 곽중선
     * 작    성    일 : 2001/09/24
     * 설          명 : 사용자 관리를 위한 register bean
     * 수  정  이  력 : 2004/02/22
                         - 각종 메소드를 가상함수로 전환, SimpleUserRegisterBean 추가
     *                 2004/05/08 - 가상함수 제거, 일반 클래스로 전환
     * ver            : 1.1
     * 검  토  사  항 : - 사용자 역할 변경 시 관련 문서함 자동 생성
     * </PRE>
     */

 

주석#

항목 뒤에 붙이는 주석#

소스  한  라인에  대한  주석문  혹은  변수의  선언  후에  변수에  대한  설명을  짧게  적을  경우에  문자의 오른편에 기술한다.

  1. private PageContext pageContext;  // JSP페이지의 모든 객체정보를 가지고 있다.
    private long          startTime;    // 시스템의 현재의 시간을 가져온다.

 

항목 위에 붙이는 주석#

주석을  항목 위에  붙이는  경우는  두  라인 이상의 명령문에  대한  해석이나 메소드에  대한 설명을 붙이는 경우이다. 주석 내용의 위 아래에 단일선으로 시작과 끝을 표시하도록 한다.

  1. /**
     * 디버그 빈이 실행된 시간을 가져온다.
     */
    public DebugBean()
    {
       startTime = System.currentTimeMillis();
    }

 

영역 (area)#

영역이란 소스 파일을 기술하는 내용의 성격에 따라서 분류하는 것을 의미하며 다음과 같은 순서에 따라 서술하도록 한다.

 

패키지 선언#

자바 클래스가 위치한 패키지 명을 가장 우선 선언한다.

  1. package gw;

 

임포트(import) 선언#

자바 표준 API 패키지를 먼저 기술하고, 커스텀 패키지를 나중에 기술한다.

  1.  import java.util.*;
     import javax.servlet.*;
     import javax.servlet.http.*;
     import javax.servlet.jsp.*;

 

클래스 선언#

클래스의 명칭과 공개 여부 등을 선언한다.

  1.     public class DebugBean

 

상수 선언#

  1.     static private final boolean   TRACE_FLAG = true;
        static private final String     LINE_FEED =
    System.getProperty("line.separator");

 

변수 선언#

public, protected, pritvae 순으로 변수를 선언한다.

 

  1.  private PageContext     pageContext;  // JSP페이지의 모든 객체를 가지고 있다.
     private long              startTime;    // 시스템의 현재의 시간을 가져온다.
     private String           debugType;
     private ServletContext context;

 

생성자(constructor)  선언#

클래스의 생성자 메소드를 가장 우선적으로 기술한다.

  1.     /**
         * [생성자]
         *  기본 디버그 방식은 로그 파일 저장으로 설정한다.
         **/
        public DebugBean()
        {
            m_strDebugType = "log";
        }

 

property 선언#

클래스의 외부에서 사용할 수 있는 모든 property는 생성자 및 파괴자 다음에 기술해야 한다.

  1.  /**
       * [set debugType property]
       *   m_strDebugType값을 설정한다.
       */
        public void setDebugType(String strDebugType)
        {
            m_strDebugType = strDebugType;
        }

 

public 메소드 선언#

모든 public 메소드는  private 메소드 보다  우선적으로  기술하여야 하며, 다른  메소드를 호출  혹은 이용하는 메소드를 앞서서 기술해야 한다.

  1. /**
     * 디버그 빈이 실행된 시간을 가져온다.
     */
     public DebugBean()
     {
         startTime = System.currentTimeMillis();
     }

 

protected, private 메소드 선언#

  1.     /**
          * 디버그 메시지를 로그에 남기거나 또는 콘솔로 출력을 한다.
          */
        private void log(String propName, Hashtable values)
        {
            log( propName, toTabbedTable(values) );
        }

 

JSP 프로그램 코딩 규칙#

구조가 잘 갖춰진 소스 코드 파일은 읽기 쉽고, 파일 사이에 정보를 더 빨리 놓아둘 수 있다.
JSP 파일은 다음의 섹션들이 나열한 순서대로 구성된다:

  도입 주석
  JSP 페이지 지시자(directive)
  선택적 태그 라이브러리 지시자
  선택적 JSP 선언문
  HTML 과 JSP 코드

 

머리말(header)#

JSP의 머리말은 다음과 같은 형식으로 작성한다. 이 주석은 서버측에서만 볼 수 있다. JSP 변환 과정
에서 제거되기  때문이다.  여기에는  웹 개발자를  위한 JSP에  대한 작성자,  일자,  개정판의 저작권,  증
명과 설명이 포함된다.

 

  1. <%--
        단위 시스템 명 : admin
        서브 시스템 명 : 없음
        프 로 그 램 명 : page.jsp
        작    성    자 : 곽중선
        작    성    일 : 2001/10/18
        설          명 : 이 프로그램은 Page를 출력하기 위한 프로그램입니다.
        ver            : 1.0
    --%>

 

주석(comment)#

JSP에서의 주석은 다음과 같은 세가지 유형을 사용할 수 있다.

 

영역에 대한 주석#

  1.  <%------------------------------------------------------------------
       comment area
       ------------------------------------------------------------------%>

 

한 줄에 대한 주석#

  1.     <% //   comment area   %>

 

여러 줄에 대한 주석#

  1.     <% /*
         comment area
        */ %>

 

항목 뒤에 붙이는 주석#

변수 선언에는 반드시 주석을 서술한다.

  1.     String  str_count;          // 전체 행수를 취득
        String  str_jsql;           // 행수 취득 sql
        int i_boardPage    = 1;  //  선택 page
        int i_MAX_list     = 3;  //  모든 열수
        int i_total_row     = 0;  // 모든 행수
        int i_dspTotalPage = 4;  // 보여 줄 전체 page

 

블록 설정 시 코딩 형식#

명령문이 한줄이 경우#

  1. if (str_Page != null )
        i_boradPage = Integer.parseInt(str_Page);

 

명령문이 한줄이고 else가 있을 경우#

  1.  if ( (I_total_row % i_MAX_list ) > 0 )
         i_totalPage = i_tempPage + 1;
     else
         i_totalPage = i_tempPage + 1;

 

명령문이 2줄이상이고 else가 있을 경우#

  1.  if ( (i_total_row % i_MAX_list ) > 0 )
     {
         i_totalPage = i_tempPage + 1;
         ……
     }
     else
     {
         i_totalPage = i_tempPage + 1;
          ……
     }

 

영역 (area)#

영역이란 소스 파일을 기술하는 내용의 성격에 따라서 분류하는 것을 의미한다.
다음과 같은 5가지 영역으로 분할하여 순서대로 서술하도록 한다.

 

설명문(description) 서술#

소스의  관련 시스템 명,  작성자,  작성  이력,  기능에  대한 설명 등을  서술한다.  JSP  머리말 작성  방법을 참고하라.

 

지시어(directive) 서술#

JSP  페이지 지시자는  JSP  변환  시점에  관련된 속성을 정의한다. JSP 스펙은  같은 페이지에  JSP  페이지  지시자의  수량을 제한하지 않는다.  페이지에  사용할  스크립트  언어, 세션 트래킹의  사용  여부, 그리고 오류를 기록할 페이지 정보, JAVA import 경로, file include,  커스텀 태그 라이브러리 등을 선언한다.

  1. ① <%@ page language="java" contentType="text/html" %>
    ② <%@ page errorPage="/public/script/errorPage.jsp" %>
    ③ <%@ taglib uri="/WEB-INF/ufTagLib.tld" prefix="uftag" %>
       <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="jstlc" %>
       <%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="jstlfn" %>
    ④ <%@ page import="java.util.List" %>
       <%@ page import="jsp.sql.DataSourceManager" %>
       <%@ page import="jsp.sql.ConnectionWrapper" %>
       <%@ page import="jsp.beans.security.*" %>

 

① JSP에서 사용하는 언어, 컨텐츠 타입을 정의한다.
② 페이지 내부에서 예외가 발생할 경우, 오류를 처리할 페이지 주소를 나타낸다.
③ 태그 라이브러리 지시자는 JSP 에서 사용하는 커스텀 태그 라이브러리를 선언한다. 짧은 지시자는 하나의 줄에 선언할 수 있다. 여러 개의 태그 라이브러리 지시자들은 한 곳에 같이 모아둔다:
④ import하는 외부 클래스들을 선언한다. 가급적 ".*" 를 이용해 패키지를 import하지 말고, 클래스를 일일이 선언한다.

 

각종 빈(bean) 선언#

JSP 페이지 내에서 참조하거나 생성하는 모든 bean에 대한 선언을 기술한다.

  1. <%-- 디버깅 빈 적재 --%>
    <jsp:useBean id="debug" class="jsp.beans.util.DebugBean" >
        <jsp:setProperty name="debug" property="pageContext" value="<%=pageContext %>" />
        <jsp:setProperty name="debug" property="debugType" value="log" />
    </jsp:useBean>
  2.  
  3. <%-- 코드 관리 빈(bean) 적재 --%>
    <jsp:useBean id="codeRegistry" scope="session" class="jsp.beans.registry.CodeRegistryBean">
        <jsp:setProperty name="codeRegistry" property="dataSource" value="admDB" />
    </jsp:useBean>

 

빈(bean)의 속성(property) 설정#

앞서 선언한 빈(bean)의 속성을 설정하는 코드를 기술한다.

  1. <jsp:setProperty name="codeRegistry" property="pageContext" value="<%=pageContext %>" />
    <jsp:setProperty name="codeRegistry" property="codeId" />
    <jsp:setProperty name="codeRegistry" property="codeName" />
    <jsp:setProperty name="codeRegistry" property="codeExplain" />
    <jsp:setProperty name="codeRegistry" property="codeDate" />

    <jsp:setProperty name="debug" property="debugLog" value='<%=request.getParameter("operation") %>' />

 

선택적 JSP 선언문#

JSP  선언문은  JSP에서  소속된  메소드와  변수를  선언한다.  이들  메소드와  변수는  자바  프로그램에서의 선언문과 다를바 없다. 선언문은 <%! ... %> JSP 선언문 블록 하나에 모두 몰아서 한 곳에 집중해 놓는 것이 좋다.

 

  1. <%!
         private int hitCount;
         private Date today;

         public int getHitCount() {
             return hitCount;
         }
    %>

 

각종 상태 점검 및 초기화 코드 작성#

사용자 로그인 상태 체크, 페이지 파라미터 점검 등의 작업을 수행하는 코드를 기술한다.

  1. <%-- 사용자 로그인 확인 --%>
    <pubtag:validateSession name="userBean" />

 

HTML 태그 서술#

HTML  소스의 시작을 표시하는  <HTML>  태그를  기술한다.  비즈니스  로직(business  logic)만을  처리하며, 화면에 내용을 표시하지 않는 페이지일 경우에는 생략한다.

 

<HEAD> </HEAD> 블록 서술#

HTML 페이지에서 머리말(header)에 해당하는 블록이며, 이 부분에는 다음과 같은 내용을 서술한다.

HTML 페이지의 간단한 제목, <TITLE> 태그
CSS(Cascading Stytle Sheet) 기술
CSS를 사용해서 헤딩, 테이블 등의 공통적인 특성을 중앙에서 제어하도록 한다. 이 방법은 사용자들에게  프리젠테이션의  일관성을  향상시키고,  유지보수  노력과  JSP  페이지의  코드  사이즈를  줄여준다.
가급적 아래의 예제 중에서 앞선 방식을 권장한다.

 

  1.  <LINK REL=StyleSheet HREF="../css/common.css">

또는,

  1.  <STYLE TYPE="text/css">
     .ic {
         font-family: webdings;
         color: #999900;
     }
     </STYLE>

 

클라이언트 자바스크립트(Client-side Javascript) 함수 기술

자바 스크립트가  제대로  돌아가기  위해서는  자바스크립트는  브라우저  타입의 특성과 관계없어야  된다.  또한  동작을  한다면,  JSP에서  자바스크립트  코드를  독립적인  파일로  분리하고,  다음과  같이  JSP에서 자바스크립트를 불러쓰는 방식을 권장한다.
이렇게  하면  자바스크립트의  재사용성도  향상되고,  여러  JSP  사이에  일관된  습성의  자바스크립트를 유지할 수 있고, JSP 페이지의 복잡성을 줄여준다.

 

  1. <SCRIPT LANGUAGE="JavaScript" SRC="./Lib/jsc/gwMenu.jsc"></SCRIPT>
    <SCRIPT LANGUAGE="JavaScript">
       function goSubMenu( url )
       {
           var thisForm = document.forms[0];
           thisForm.action = url;
           thisForm.submit();
       }
    </SCRIPT>

 

<BODY> </BODY> 블록 기술#

HTML 코드 작성시 HTML 태그 혹은 예약어는 모두 대문자로 서술하는 것을 원칙으로 한다.

 

JSP 스크립틀릿 JSP Scriptlets

가급적,  태그라이브러리로  동일한  기능을  구현할  수  있으면,  JSP  스클립틀릿은  피하기  바란다.  이렇
게  하면 페이지  가독성도 높이고, 유지보수도 쉬워진다. 비지니스  로직을  프리진테이션  로직에서 분
리하는데 일조하며, JSP 2.0 스타일의 페이지로 쉽게 옮겨갈 수 있다. (JSP 2.0도 스크립틀릿을 지원하
지만  덜 강조한다). 다음  예제는  customers  표시  방법이 데이터  형에  따라서  다른  스크립틀릿을  사용
하는 것을 보여준다:

customers 는 Customers의 배열

  1. <table>
        <%  for ( int i=0; i<customers.length; i++ ) { %>
            <tr>
                <td><%= customers[i].getLastName() %></td>
                <td><%= customers[i].getFirstName() %></td>
            </tr>
        <%  } %>
    </table>


customers 는 Enumeration 형

  1. <table>
        <%  for ( Enumeration e = customers.elements();
                e.hasMoreElements(); ) {
                Customer customer = (Customer)e.nextElement();
        %>
            <tr>
                <td><%= customer.getLastName() %></td>
                <td><%= customer.getFirstName() %></td>
            </tr>
        <%  } %>
    </table>

 

그러나,  공통  태그라이브러리를  사용하면,  customers  의  데이터  형이  달라도  보다  높은  유연성이  생긴다. 예를 들어서,  JSTL  에서는customers 를 나타내기  위해서 배열과  Enumeration  양쪽 모두  지원하는 다음과 같은 코드로 표시할 수 있다:

 

  1. <table>
        <c:forEach var="customer" items="${customers}">
            <tr>
                <td><c:out value="${customer.lastName}"/></td>
                <td><c:out value="${customer.firstName}"/></td>
            </tr>
        </c:forEach>
    </table>

 

비지니스  로직과  프리젠테이션 층과의 결합도을  줄이기  위한  모델-뷰-컨트롤러(MVC)  디자인  패턴을 적용하려고  한다면,  JSP  스크립틀릿은  비지니스  로직을  구현하기  위해서  사용되어서는  안된다.  오히려,  JSP  스크립틀릿은  클라이언트의  요청을  처리한  뒤에  나오는  데이터("가치  객체  value  objects"로
불리는)를 적절한 클라이언트의  준비된  형식에  전송하기 위해  필요하다면  사용된다.  심지어  그럴 경우에도, 프론트 컨트롤러 서블릿이나 커스텀 태그로 하는 게 더 낫다.

 

JSP 표현식 JSP Expressions

JSP 표현식은 JSP scriptlet처럼 가능하면 삼가는 것이 좋다. 동일한 작업을 수행하는 다음 3가지 예제가 잘 설명해준다.  가급적 나중에 기술될 코드 스타일을 권장한다.

  1. Example 1 (자바 코드 사용):
        <%= myBean.getName() %>

    Example 2 (JSP 태그 사용):
        <jsp:getProperty name="myBean" property="name" />

    Example 3 (JSTL 태그 사용):
        <c:out value="${myBean.name}" />

 

프로그래밍 습관 Programming Practices

일반적으로,  다음과  같은  이유로  JSP  페이지에  자바  코드(선언문,  스크립틀릿,  표현식)  쓰기를  피한다:

 JSP  페이지의  자바 코드 문법  에러는 페이지가 배치되기 전까지 발견되지 않는다. 반면에, 태그 라이브러리와 서블릿에 있는 문법 에러는 배치 이전에 발견된다.
  JSP 페이지 내의 자바 코드는 디버깅하기 힘들다.
  JSP 페이지 내의 자바 코드는 유지보수하기 힘들다.
  보통 복잡한 비즈니스  로직과  프리젠테이션 로직을 섞어놓지  않는 것이  납득이  가는 습관이다. JSP는 우선적으로 프리젠테이션 로직을 목적으로 한다.
  자바 코드가 포함된 코드와 HTML과 다른 스크립트 명령어가 섞여있다면 읽기 어렵다.
  JSP  2.0  은  더  단순한  표현  언어(EL)  덕분에  scriptlet의  중요도를  낮추었다.  JSP  에서JSP 2.0 스타일로 쉽게 옮기기 위해서는 자바 코드를 사용하지 않는 것이 좋다.

JSP 내장 객체 JSP Implicit Objects

API  호출을  통해서  객체를  참조하기  보다는  JSP  내장  객체를  직접  사용하는  것이  좋다.  그래서 ServletContext  인스턴스에  의해  제공되는  초기  파라미터에  접근하기  위해  다음을  쓰는  대신에  다음의 코딩 스타일 중 가급적 나중 방식을 권장한다.

 

  1. getServletConfig().getServletContext().getInitParameter("param")

    application.getInitParameter("param")

    <c:out value="${initParam['param']}" />

 

인용부호 (Quoting)

일정한 인용부호의 사용을 채택한다. 인용부호는 작은따옴표 ' 대신 큰따옴표 " 를 사용한다.

[ Table 2 ]  인용 부호 표기법

불규칙한 인용부호 좋은 인용부호
<%@ page import='javabeans.*'%> <%@ page import="javabeans.*" %>

예외적인 경우는  작은따옴표가  필요할 때이다.  예를  들어서 스크립트 언어에서 큰따옴표를  사용하는
경우를 들 수 있다:

  1. <jsp:include page='<%= getFoodMenuBar("Monday") %>' />

 

커스텀 태그 사용하기 Using Custom Tags

만일 커스텀태그가 몸체가  없다면,  컨텐트는 (생략해서  "JSP"  기본값으로 하지 말고)  empty라고 명확
하게 선언되어야 한다. 태그 라이브러리 설명서에서 다음과 같이 정해준다:

  1. <tag>
        <name>hello</name>
        <tag-class>com.mycorp.util.taglib.HelloTagSupport</tag-class>
        <body-content>empty</body-content>
        ...
    </tag>

이렇게  하면  JSP 컨테이너는 태그  몸체가 무조건 비어야 되며 파싱할 어떤 JSP  문법도  포함하지  않아야 된다고  인식한다. 효과는 빈  몸체를 파싱하기 위해서 불필요하게  자원의 할당이  이뤄지는 것을 제거한다.
빈  태그는,  가독성향상을  위해  열고  닫는  XML  엘리먼트  쌍으로  표시하기보다는,  짧은  XML  엘리먼트로 표시한다. 그래서,

 

  1. <myTag:hello />

 

라고 표기하는 것이 아래보다 낫다.

 

  1. <myTag:hello></myTag:hello>

 

스크립트 엘리먼트의 들여쓰기 Indentation of Scripting Elements

JSP  스크립트  엘리먼트(선언문,  스크립틀릿,  표현식과  같은)가  한  줄에  맞지  않는  경우,  스크립트  언
어의 들여쓰기 작성요령이  엘리먼트  내에  적용된다. 몸체는  엘리먼트의  여는  기호  <%=와 같은  줄에
서  시작한다.  다음줄의  기준도  여는  기호  <%=가  된다.  몸체의  끝은  다른  줄에  있는  엘리먼트의  닫
는 기호(%>)로 마무리된다. 예제이다:

  1. <%= (Calendar.getInstance().get(Calendar.DAY_OF_WEEK)
       = Calendar.SUNDAY) ?
         "Sleep in" :
         "Go to work"
    %>

첫줄과  마지막  줄을  제외한  몸체의  가운데  줄들은  단위  들여쓰기  공백(앞  예제에서   로  보인다)이 앞에 있기 때문에 나머지 JSP 보다 확연히 드러나게 된다.

 

JSP, HTML, JAVA의 복합 들여쓰기 (Compound Indentation with JSP, HTML and Java)

자바의  스크립트  코드와  템플릿  텍스트(HTML)가  섞여있는  JSP  엘리먼트를  위해서  복합  들여쓰기가 필요한  이유는  JSP  소스를  이해하기  위해  드는  노력을  덜어주기  위해서이다.  기존의  들여쓰기  요령은 JSP 소스파일을 더 알아보기 어렵게 할 수 있기 때문이다.
보편적인  규칙에  따라서,  다른  소스  사이에  끼어  있을  경우마다  보통  들여쓰기에  특별한  단위를  할당한다.  클라이언트에  보여지는  들여쓰기에  영향을 준다. 추가적인  들여쓰기는 (브라우저에  의해) 보통  무시되고,  브라우저에  나타나는  결과는  차이가  없다.  예를  들어,  <TABLE>  태그  앞에  공백이  몇개  더  추가된다고  해서,  브라우저에서  보여지는  테이블의  위치가  달라지는  것은  아니다.  그래서  이러한 작성요령을 사용하는 것이 더 좋아 보인다:

  1. <table>
        <%  if { tableHeaderRequired ) { %>
            <tr>
                <th>Last Name</th>
                <th>First Name</th>
            </tr>
        <%  } %>
        <c:forEach var="customer" items="${customers}">
            <tr>
                <td><c:out value="${customer.lastName}"/></td>
                <td><c:out value="${customer.firstName}"/></td>
            </tr>
        </c:forEach>
    </table>

 

위 방식보다는 아래 방식이 낫다:

 

  1. <table>
        <%  if { tableHeaderRequired ) { %>
        <tr>
            <th>Last Name</th>
            <th>First Name</th>
        </tr>
        <% } %>
        <c:forEach var="customer" items="${customers}">
        <tr>
            <td><c:out value="${customer.lastName}"/></td>
            <td><c:out value="${customer.firstName}"/></td>
        </tr>
        </c:forEach>
    </table>

 

참고 자료#

JavaCodeConventions.pdf   한글

java_CodingStyle.pdf   영문

program_coding_rule.pdf   한글 참조

Code_Conventions.mht   한글

728x90

'문서' 카테고리의 다른 글

[펌] 웹코딩 가이드 #2  (0) 2020.12.17
[펌] 웹코딩 가이드 #1  (0) 2020.12.17
Naver Smart Editor의 사용 참고  (0) 2015.03.24
KIDA 암호이용 활성화 < 패스워드 선택 및 이용 안내서 >  (0) 2013.07.02
[Spring] DispatcherServlet UML Sequence Diagram #2  (0) 2012.06.08
'문서' Related Articles more