'웹/웹.도움말'에 해당되는 글 21건

웹 개발자를 위한 Naming Rule 가이드

웹/웹.도움말

웹 개발자를 위한 Naming Rule 가이드

이 글은 웹 응용 프로그램을 개발할 때, 필요한 Naming Rule 을 정리한 것이다. 개발자들 사이의 커뮤니케이션과 관리를 위해서 가능한 규칙을 따르는 것이 좋다고 생각한다. 이 규칙들은 정답은 아니지만, 컨설팅을 수행하면서 어느 정도의 시행착오를 거쳐서 정리한 내용이고 웹 개발자들에게 참고가 되기를 바란다. 이 규칙을 각자의 개발 환경에 맞게 보완해서 사용한다면 도움이 될 거라 생각된다.


분류

대상

비고

 

Presentation Services(ASP)

ASP File Name, HTML File Name, Image File Name, Session Level Variable Name(PascalCasing Naming Conversion or CamelCasing Naming Conversion), Script Variable Name, Tag Name, Cookie Name

 

Business
Services
(Component)

Project File Name(DLL Name), Class Name, Interface(Method, Property) Name

 

Data Services
(Database)

Table Name, Field Name, Stored Procedure Name, View Name, Trigger Name

 


 

모든 이름은 Hungarian 표기법과 PascalCasing Naming Convention을 따르는 것을 원칙으로 한다.


Presentation Services Naming Rule

1. ASP File NameASP 파일 명은 관리를 쉽게 할 수 있도록 업무에 관련된 이름을 부여한다.
) 웹메일 시스템의 자유 게시판의 ASP 파일 명은 wm_FreeBoard.asp로 명명한다. 시스템 단축 명은 프로젝트 관리자가 부여한다.



2. HTML File NameHTML 파일 명은 관리를 쉽게 할 수 있도록 업무에 관련된 이름을 부여하며, HTML 파일의 확장자는 htm로 명명한다.
[
명명 규칙] 시스템단축명_기능.htm
) 웹메일 시스템의 자유 게시판의 HTML 파일 명은 wm_FreeBoard.htm으로 명명한다. 시스템 단축 명은 프로젝트 관리자가 부여한다.



3. Image File NameImage 파일 명은 다음과 같은 이름 부여 규칙을 사용한다.
[
명명 규칙] 업무단축명_위치_기능.gif



업무 단축명은 가능하다면 ASP 파일의 단축 명을 사용한다.
위치 : (t), (m), (b), (l), (m), (r)
1) 웹메일 시스템의 자유 게시판의 우측상단에 있는 목록보기 이미지는 fb_tr_list.gif로 명명한다. 여기서 fb FreeBoard의 단축 명이다.
2) 메인 페이지의 좌측 중앙에 있는 로그온 이미지는 main_ml_LogOn.gif로 명명한다.웹 응용 프로그램 전반에 공통적으로 사용되는 이미지는 명명 규칙에위치를 포함하지 않으며
,
업무단축명으로 “cn_”을 사용한다
.
3) 메인 화면에 사용하는 읽기에 대한 공통 이미지는 cn_read.gif로 명명한다.



4. Application Level Variable NameApplication Level의 변수는 다음과 같은 이름 부여 규칙을 사용한다.
[
명명 규칙] ap_기능
) 웹 사이트 방문자 수를 나타내는 Application Level 변수는 ap_VisitCount로 명명한다.



5. Session Level Variable NameSession Level의 변수는 다음과 같은 이름 부여 규칙을 사용한다.
명명 규칙] se_기능
) 사용자 계정을 나타내는 Session Level 변수는 se_UserID로 명명한다.



6. Script Variable Name스크립트 변수 명은 변수의 Scope에 따라 접두어(“g_” 전역, “l_” 로컬, “p_” 매개변수)를 붙인다.
, 로컬 변수인 경우에는 Scope를 나타내는 접두어는 생략 가능하다.
[
명명 규칙] 접두어_기능
) 사용자가 선택한 색상을 저장하는 로컬 변수는 “l_Color” 이다.
스크립트에서는 모든 데이터 타입이 Variant이기 때문에, 변수 명에 데이터 형을 표기하지 않는다.



7. Tag Name
태그 명은 태그의 종류를 나타내는 접두어와 기능으로 이름을 부여한다.
[
명명 규칙] 접두어_기능
태그는 종류별로 다음과 같은 접두어를 붙인다.
접두어 태그

frm


btn_
버튼

txt_
텍스트 박스

mtx_
멀티라인 텍스트 박스
lbl_
라벨

chk_
체크박스

opt_
옵션버튼



이미지 파일은 확장자로 알 수 있기 때문에 태그의 접두어를 사용하지 않는다. 여기서는 주로 많이 사용하는 태그들의 이름 부여 규칙만을 정의하며,
그 외의 태그들은 개발자가 임의로 이름을 부여해서 사용한다.) 사용자 이름을 입력하는 텍스트 박스의 명은 txt_UserName으로 명명한다.



8. Cookie NameCookie 명은 관리를 쉽게 할 수 있도록 업무에 관련된 이름을 부여한다.
[
명명 규칙] 시스템단축명_기능
) 웹메일 시스템의 사용자 이름을 저장하는 쿠키의 명은 wm_UserName으로 명명한다.
서브 쿠키 명은 개발자가 임의로 부여한다.

Business Services Naming Rule

1. Visual Basic Project File Name (DLL File Name)DLL
파일 명은 관리를 쉽게 할 수 있도록 업무에 관련된 이름을 부여한다.
[
명명 규칙] 시스템단축명_기능.dll
) 웹메일 시스템의 자유 게시판을 구현하는 DLL의 파일 명은 wm_FreeBoard.dll로 명명한다. 시스템 단축 명은 프로젝트 관리자가 부여한다.



2. Class Name
비주얼 베이직 프로젝트에 포함된 클래스 파일의 이름은 기본적으로 Query Modify로 분류하고,
별도의 비즈니스 로직을 포함하는 클래스는 프로젝트 관리자와 협의 후 부여한다.Query 클래스는 조회용 메서드를 포함하는 클래스의 명칭이며,

Modify
클래스는 삽입, 수정, 삭제와 같은 트랜잭션이 발생하는 메서드를 포함하는 클래스의 명칭이다.
[
명명 규칙] Query, Modify, 업무명
) 웹메일 시스템의 자유 게시판의 글을 읽는 클래스 파일의 이름은 Query로 명명하며,
ASP
에서 사용하기 위한 이 클래스의 ProgID wm_FreeBoard.Query이다. 일반적으로 Query Modify 이외의 클래스 명을 요하는 경우는 거의 발생하지 않는다.



3. Interface Name (Method, Property)
인터페이스 명은 메서드에 대해서만 기술한다. MS COM+에 등록되는 컴포넌트는 Stateless한 컴포넌트이어야 하기 때문에, 일반적인 경우에는 Property를 사용하지 않는다.개발팀 별로 메서드에 대한 공통 인터페이스를 정의해야 하며, 정의된 공통 인터페이스를 기준으로 메서드의 이름을 부여해야 한다.

다음은 공통 인터페이스의 몇 가지를 정리한 것이다.


메서드 명

설명

Insert

하나의 레코드를 삽입하는 기능

Update

하나의 레코드를 수정하는 기능

Delete

하나의 레코드를 삭제하는 기능

Save

여러 개의 레코드를 삽입, 수정, 삭제하는 기능

SelectByWhere

하나의 조건으로 데이터를 조회하는 기능

SelectByName

이름으로 데이터를 조회하는 기능

SelectByCode

코드로 데이터를 조회하는 기능


 


발생 가능한 모든 메서드를 Brainstorming을 통해서 추출한 후, 협의를 통해서 공통 인터페이스를 정의해야 한다.
Data Services Naming Rule

데이터베이스 명은 별로의 이름 부여 규칙을 정하지 않고 프로젝트 관리자가 시스템에 적합하게 부여한다.
1. Table Name
테이블 명은 관리를 쉽게 할 수 있도록 업무에 관련된 이름을 부여하며,
레코드들의 집합이기 때문에 복수형으로 부여한다
.
[
명명 규칙] 기능의 복수형
) 웹메일 시스템의 자유 게시판의 테이블 명은 FreeBoards로 명명한다.



2. Field Name
필드 명은 기능과 관련된 의미로 부여하며, 업무에 관련된 의미는 테이블 명에서 이미 표기하였기 때문에 업무에 관련된 의미는 부여하지 않는다.
[
명명 규칙] 기능

) 웹메일 시스템의 자유 게시판의 날짜 필드 명은 Date로 명명한다.
FreeBoardDate
로 표기하지 않도록 주의한다.



3. Stored Procedure Name저장 프로시저 명은 기준이 되는 테이블 명과 기능과 관련된 의미로 부여한다.
시스템 저장 프로시저와 구별하기 위해서 접두어 “up_”를 붙인다.
[
명명 규칙] up_테이블명_기능
) 웹메일 시스템의 자유 게시판의 쓰기 기능의 저장 프로시저 명은 up_FreeBoards_Insert로 명명한다.



4. View Name뷰 명은 기준이 되는 테이블 명을 단수형으로 부여한다. 뷰를 나타내기 위해서 접두어 “view_”를 붙인다.
[
명명 규칙] view_테이블명의단수형
) 웹메일 시스템의 자유 게시판의 데이터를 일자를 조건으로 조회하기 위해서 사용될 뷰의 명은 view_FreeBoard로 명명한다.



5. Trigger Name
트리거 명은 기준이 되는 테이블 명과 기능으로 부여한다.
[
명명 규칙] 테이블명_기능) 웹메일 시스템의 자유 게시판의 데이터를 삭제할 경우에 발생할 트리거의 명은 FreeBoards_Delete로 명명한다

Name
Password
Homepage
Secret

그누보드3 설치하기 | 오토셋 올가 4.2.x

웹/웹.도움말
오토셋에 그누보드 3 버전을 설치하시려면, 본 글에 첨부된 파일을 이용하세요.

그누보드 3 버전을 MySQL 4.1 버전 이상, EUC-KR 환경에서 작동가능하도록 수정한 파일입니다.

  - mysql_connect() 함수 호출 후, set names euckr 쿼리를 실행하도록 수정
  - MySQL 의 password() 를 old_password() 함수로 대체함.

수정된 파일 목록

gnu3\index.php
gnu3\bbs\gbsecret.php
gnu3\bbs\gbupdate.php
gnu3\bbs\gbupdate.php
gnu3\bbs\mbpasswdforget3.php
gnu3\bbs\mbupdate.php
gnu3\gnu3\bbs\mbupdate.php
gnu3\gnu3\bbs\mbupdate.php
gnu3\bbs\mbupdate.php
gnu3\bbs\admin\memberupdate.php
gnu3\install\installfinish.php
gnu3\lib\sql.lib.php

설치 방법

홈 디렉토리에 압축을 풀고, http://localhost/압축푼 폴더명/ 으로 접속하여 설치합니다.

그누보드 3 기술지원

http://www.sir.co.kr 을 통해서 받으십시오.

Name
Password
Homepage
Secret

굿모닝샵 프리 설치하기 | 오토셋 올가 4.2.x

웹/웹.도움말

1. 설치 준비

http://webprogram.co.kr 또는 아래의 주소에서 굿모닝샵 프리 버전을 다운로드 받습니다.
http://www.phpschool.com/gnuboard4/bbs/board.php?bo_table=download&wr_id=13992&page=1


2. 설치하기

다운로드 받은 gm_free.tar.tar 파일의 압축을 저는 D:\autoset\public_html\gmfree\ 에 풀었습니다. 그리고 gmfree.demo.autoset.org 라는 도메인을 가상 호스트에 등록하고, 홈 디렉토리를 저 경로에 맞춰줬습니다.


굿모닝샵 프리 버전은 별도의 설치 프로그램이 없기 때문에, 직접 수정할 곳은 수정하고 DB 덤프파일을 복원시켜줌으로써 설치를 완료하게 됩니다. 압축해제한 폴더(여기서는 gmfree) 안에 보시면 lib 폴더가 있습니다.


폴더에 들어가면, db_info.php 와 solution.sql 파일이 있습니다. 이 2개의 파일을 수정하게 됩니다.
먼저, db_info.php 파일을 메모장이나 EditPlus 등의 텍스트 편집기로 엽니다.




그리고 14 번째 줄의 정보를 오토셋의 정보로 맞춰줍니다.
호스트명과 포트번호는 모두 동일합니다. localhost 와 3306 을 입력합니다.

DB 명은 여러분이 직접 생성한 DB 든, 아니면 기본 제공되는 mydb 또는 mydb_euckr 을 적습니다.
mydb_euckr 에 설치하실 것을 권장하며, 4.2.0 버전 이상에만 이 DB 가 있습니다. 그리고 아이디에는 4.0.0 ~ 4.1.3 버전의 사용자께서는 root 를 입력하거나 혹은 추가한 사용자ID를 4.2.0 버전 이상의 사용자께서는 sa 를 입력합니다. (혹은 root 를 입력해도 됩니다)

그리고 패스워드에 autoset 을 입력합니다. 역시, 패스워드를 변경했다면 변경하신 패스워드를 입력하시면 됩니다. 변경을 하셨으면, 저장하시고, 다음 파일을 엽니다. 이번에 열 파일은 solution.sql 파일입니다.



다른 것 없습니다. " set names euckr; " 을 제일 첫 줄에 추가만 해주시고, 저장합니다.
여기서 주의하실 점은 마지막에 세미콜론(;)이 있다는 것에 유의해주세요.
자, 이제 DB 를 MySQL 서버에 복원(생성)합니다. 오토셋을 켜주시고, [백업] 메뉴의 [SQL 파일 실행]을 클릭합니다.



그리고 적용될 데이터베이스를 " mydb_euckr " 을 선택합니다. 앞서 db_info.php  에서 입력한 DB 명을 입력해주시면 됩니다. 그리고 [파일 선택] 을 클릭해서 solution.sql 파일을 선택하고, [열기(O)] 버튼을 클릭합니다. 그 다음, [선택된 SQL 파일 실행] 을 클릭합니다.




실행하겠냐는 질문에 [ 예(Y) ]  버튼을 눌러 실행을 합니다.



실행이 완료되면, 적용되었다는 메시지가 나오게 됩니다.
** 문제가 발생했나요? **
Q : SQL 파일이 정상적으로 실행되지 않았습니다.
   DB 를 살펴보니 전혀 굿모닝샵 관련 테이블이 생성되어 있지 않습니다.
A : 2가지를 점검해봅니다.
첫번째, solution.sql 파일 첫번째 줄에 삽입한 set names euckr 다음 세미콜론(;) 이 누락된게 아닌지 확인합니다. 두번째, [도구 > 오토셋 설정 > 오토셋 설치 정보] 메뉴에서 기본 사용자ID가 root 이고,
사용자 패스워드가 autoset 혹은 변경한 패스워드로 설정되어 있는지 확인합니다.

다음으로, 한글이 깨지는 현상을 해결하기 위해 2군데 코드를 추가 삽입합니다.
여실 파일은 lib 폴더에 보시면 db_conn.php 파일이 있습니다.
역시 메모장이나 EditPlus 같은 텍스트 편집기를 엽니다.



그리고 52번째 줄, 58번째 줄의 $this->conn = @mysql_connect 부분 다음 줄에
mysql_query("set names euckr"); 을 추가합니다.
여기까지 하면, 설치가 완료된 것입니다.


3. 사용하기


이제, 관리자 모드를 한번 들어가볼까요? http://설치한 도메인/admin/ 으로 접속합니다.

저 같은 경우에는 gmfree.demo.autoset.org 라는 가상호스트를 추가하고 설치했기 때문에 http://gmfree.demo.autoset.org/admin 으로 접속했습니다만, localhost 로 혹은 IP주소로만 확인가능한 경우에는 http://localhost 또는 IP주소/gmfree/admin/ 으로 접속해야겠지요.

여기서 gmfree 는 public_html 폴더 안의 폴더명이자, 압축을 푼 폴더명입니다.


기본 사용자 아이디와 패스워드가 모두 admin 입니다.
입력하고, Login 버튼을 누릅니다.




관리자 화면으로 접속이 되고, 첫 화면이 주문 관리군요.
다음으로 방금 주소 창에 입력했던 주소에서 admin 만 빼면 내 쇼핑몰 주소가 됩니다.
저 같은 경우 http://gmfree.demo.autoset.org 로 접속하면 되겠지요.
혹은 http://localhost/gmfree 또는 http://IP주소/gmfree 로 접속하면 됩니다.


쇼핑몰 프로그램 사용과 관련해서 궁금한게 있다면, http://webprogram.co.kr 에 방문해서 문의해보시기 바라며, 이렇게 쇼핑몰을 구축하실 수 있습니다.

Name
Password
Homepage
Secret

그누보드 4 (ANSI/EUC-KR 버전 설치하기) | 오토셋 올가 4.2.x

웹/웹.도움말
사용자 삽입 이미지

그누보드 홈페이지에서 그누보드 4 최신 버전을 다운로드 받습니다.
http://www.sir.co.kr/bbs/board.php?bo_table=g4_pds
본 글에서는 UTF-8 이 아닌 ANSI 버전(흔히 EUC-KR라 말하는..) 설치방법을 소개합니다.



사용자 삽입 이미지

홈 디렉토리에 다운로드 받은 gnuboard4.tgz 파일의 압축을 해제합니다.
"현재폴더에 압축풀기"를 하시면 매우 편합니다.




사용자 삽입 이미지

그리고 이 글에 첨부된 gnuboard4_for_autoset.zip 파일을 다운로드 받아
알집으로 압축풀기를 합니다.



사용자 삽입 이미지

압축이 풀리는 곳을 gnuboard4 폴더로 지정합니다.
그리고 압축풀기 버튼을 클릭합니다.




사용자 삽입 이미지

이미 같은 파일이 있으므로, 위와 같은 확인 메시지가 나옵니다.
"모든 파일에 적용" 을 체크하시고 "예" 버튼을 클릭합니다.
이제, MySQL 4.1 이상의 유니코드를 기반으로 하는 MySQL 버전대에서
그누보드를 설치하기 위한 패치가 완료되었습니다.
** 패치된 내용은 본 글에 첨부된 압축파일에 있는 README_AUTOSET.txt 를 참고하세요. **



사용자 삽입 이미지

설치하기전, 서버 작동을 확인합니다.



사용자 삽입 이미지

그리고 http://localhost/gnuboard4/install 로 접속합니다.



사용자 삽입 이미지

User 에는 sa 또는 root 혹은 여러분이 직접 생성해두신 사용자 계정명을 입력합니다.
그리고 Password 는 sa 와 root 의 경우 패스워드를 변경하지 않았다면 autoset 을 입력하고,
설정된 MySQL 패스워드를 입력합니다.
DB 는 mydb_euckr 을 입력합니다.
혹은 euckr_korean_ci 를 콜레이션으로 하여 직접 생성하신 DB 명을 입력합니다.
그리고 최고관리자 정보를 입력하시고, "다음" 버튼을 누릅니다.



사용자 삽입 이미지

설치가 완료되고, "메인화면" 버튼을 눌러 이동합니다.



사용자 삽입 이미지

앞서 입력한 ID 와 패스워드를 입력하고 로그인합니다.
그리고 우측 상단의 "Admin" 버튼을 눌러 관리자 화면으로 이동하여, 게시판을 추가합니다.



사용자 삽입 이미지

추가된 게시판에 게시글을 남긴 화면입니다.
단 2줄만 수정해주시면 MySQL 4.1 이상의 버전에서 한글깨짐없이 사용하실 수 있습니다.


Name
Password
Homepage
Secret

제로보드 4 (zeroboard 4) 설치 & 글 쓰기 | 오토셋 올가 4.2.x

웹/웹.도움말

1. 설치 준비하기

http://www.nzeo.com 에서 제로보드 설치 파일을 다운로드 받습니다. 그리고 이 게시물에 첨부된 zb4pl8_patch_autoset.zip 파일도 다운로드 받습니다. public_html 폴더에 다운로드 받으시면 편리합니다.


다운로드 받은 파일 제로보드 설치 파일(zb41pl8.zip)을 현재폴더에 압축풀기로 압축을 풉니다. 그리고 압축이 풀리면 zb41pl8 이라는 폴더가 생기며, 폴더 안으로 들어가면 bbs 라는 폴더가 있습니다. 이 폴더를 아래의 그림과 같이 '잘라내기' 합니다.




아래의 그림과 같이 public_html 에 붙여넣기 합니다.



이 게시물에 첨부된 zb4pl8_patch_autoset.zip 파일을 bbs 폴더 안으로 옮깁니다.




그리고 zb4pl8_patch_autoset.zip 파일을 압축을 푸는데, 현재 폴더에 압축풀기로 압축을 풀어줍니다.
그러면, 아래와 같이 같은 파일이 있다며 어떻게 할지 묻게 되는데 이때 [예] 을 모두 해주셔야 합니다.

Q: zb4pl8_patch_autoset.zip 파일은 어떤 것이 수정된 파일인가?
A:

zb4pl8_patch_autoset.zip 에는 오토셋에서 문제 없이 작동하게 하기 위해 수정된 파일들이 있습니다.

1.  수정된 내용은 MySQL 4.0 버전 이하의 password 함수가 MySQL 4.1 버전 이상에서는 다르게 쓰이므로,
기존의 password 함수를 사용할 수 있도록 변경 작업. password() -> old_password() 로..

2.  MySQL 접속 시, euckr 모드를 사용하도록 코드 추가. mysql_connect 다음 줄에 코드 1줄 추가

3.  한글 파일 다운로드가 되도록 download.php 파일을 수정

4.  schema.sql 파일에서 primary key 로 선언된 필드에서 default 값이 0 이 지정된 것 삭제





2. 제로보드 설치하기


# 자, 이제 http://자기 도메인/bbs/install.php 로 접속하여 설치합니다. 도메인이 없으신 분은 http://localhost/bbs/install.php 로 접속하여 설치하시면 됩니다. 라이센스에 동의 표시하신 후, [설치 시작] 을 누릅니다.



Host Name : localhost
SQL User ID : sa              ☞ root 사용자로 설치해도 되지만, 일반 사용자 sa 로 설치합니다.
Password : autoset          ☞ 기본 패스워드 autoset 을 입력합니다. 변경한 경우, 변경한 패스워드를 입력합니다.
DB Name : mydb_euckr     ☞ 콜레이션을 euckr(한국어) 을 사용하는 DB 에 설치합니다.




제로보드 관리자 정보를 입력 하시고, [정보 입력 완료] 버튼을 눌러 설치를 완료합니다.



3. 게시판 생성하기




http://자기 도메인 혹은 localhost/bbs/admin.php 로 접속하여, 설치 시 입력한 관리자 정보를 입력하고 [Administrator Login] 버튼을 클릭합니다.




[새 그룹 추가] 버튼을 누릅니다.




그룹 이름을 입력하고, confirm 버튼을 누릅니다.




demo 그룹에 게시판을 추가합니다.
[추가] 버튼을 누릅니다.




게시판 이름(영어, 숫자로 입력)을 입력하고, 기타 필요한 기능을 선택/해제 한 후,
[confirm] 버튼을 누릅니다.
게시물에 첨부파일을 넣을 수 있도록 하려면, 자료실 기능에 체크합니다.




생성된 게시판 목록에서 미리보기 열의 View 링크를 누릅니다.




생성된 게시판의 목록이 나오며,
[글 쓰기]링크를 누릅니다.






간단한 글과 첨부 자료(한글이름을 사용한 파일, 영문 이미지 파일)를 선택하고 [장소 완료] 를 합니다.




등록된 게시물을 확인하면, 위와 같이 잘나오고,
첨부된 이미지도 미리보여줍니다.
한글파일명을 사용한 파일의 다운로드도 아래와 같이 잘 됩니다.



Name
Password
Homepage
Secret