아키텍처 설계서 항목 -아키텍트 이야기 중-

아키텍처 설계서 항목

1. 아키텍처 개요

  1.1 시스템 범위

    - 시스템 범위의 경우 기존 존재하는 레거시 시스템과 현재 개발을 할 새로운 시스템간의 상호 관계를 그림으로 표현

    - 시스템 개요에서 내부 구조까지 시스템을 연속선상에 놓고 이해하는 능력을 키우는 것이 필요

  1.2 미들웨어

  1.3 J2EE

  1.4 스터러츠

  1.5 EJB

2. 서브 시스템 분할 방침

3. 클래스 분할 방침

  3.1 시스템 내 공통 모듈 추출

  3.2 배포 단위

  3.3 서브 시스템 내 공통코듈 추출

4. 패키징 규칙

  4.1 시스템 공통

  4.2 서브시스템

  4.3 배포

5. 코딩 교칙

  5.1 기본 규칙

  5.2 들여쓰기 규칙

  5.3 명명 규칙

  5.4 범위

  5.5 주석처리

  내 경험상 코딩 규칙은 IDE를 사용하는 경우에는 별도의 코딩 규칙이 필요하지 않았다. (사실 코딩 규칙을 배우거나 읽어보는데만 해도 시간이 많이 소모되고, 자신과 다른 코딩 규칙을 가진 개발자의 반발이 만만치 않다.). 그러나 다음과 같이 코딩 영역을 지정해주면 상당히 도움이 되었다.

-----------------------------------------------------------------------------------------------------

 ----------------------------------------------------------------------------------------------------

  상단과 같이 기 들어갈 내용을 주석으로 처리해주고, 그 내부에 어떠한 코딩을 이용하라.

  그리고 시작 태그와 종료 태그를 위해 주식을 다음과 같이

 ----------------------------------------------------------------------------------------------------<!- - 로그인 시작 - ->

내용....

<!- -로그인 종료 - ->

 ----------------------------------------------------------------------------------------------------

6. 예외사항

  6.1 예외사항 분류

  6.2 예외사항을 throw한 경우

  6.3 예외 사항을 catch한 경우

7. 로그

  7.1 로그 출력 형식

  7.2 로그 출력 수준

-----------------------------------------------------------------------------------------------------

 public static String getLogHead(String function)
 {
  return "[UID:" + UID + " UTS:" + function + "] ";
 }

-----------------------------------------------------------------------------------------------------

와 같이 로그의 경우 Log4J를 이용하고, 로깅되는 시점에 어떤이가, 어떠한 함수를 이용하다가 에러가 났는지에 대한 정보를 나타내 주는는경우 로그파일을 검색하기 매우 쉽다.

8. DB 접속 프레임워크

  8.1 주요 컴포넌트

  8.2 애플리케이션의 이용

  8.3 예외사항 처리