今天进入可开发前的准备阶段。在开发项目前，要求每位开发小组成员都必须先阅读以下约定，严格按以下约定来进行开发。
系统框架
·系统总框架采用SUN J2EE框架，使用JAVA/XML技术和组件技术， 基于Application server开发。
·项目中的程序必须严格按J2EE1.3规范来编码，EJB建议采用2.0规范编码，尽可能多使用EJB 模式设计，参考技术文档如下：
1.《J2EE Tutorial》
j2ee-1_3-doc-tutorial-draft5.pdf
2.《JBoss 3.0Quick Start Guide》
3.《EJB Design Patterns》
开发环境
·测试用Application server采用JAS，JAS 配置于Linux OS下，IP地址：192.168.0.6。登录用户名：J2EEOA，密码：J2EEOA。登录ftp工具建议使用SSH Secure Shell或LeapFTP，ftp地址为192.168.0.6:22。
·项目开发源码目录为/home/local/jboss/applications/J2EEOA/src，项目开发文档目录为/home/product/J2EEOA/。
· 数据库服务器IP为192.168.0.222，数据库采用Mysql，管理工具为phpadmin，登录数据库的用户名为test，密码为test。
源代码目录规范
每位开发小组成员一定要绝对遵守以下创建源代码目录的规范。
项目开发目录结构简图：
\
|--apps
|--J2EEOA
|--admin
|--components
|--a component
|--modules
|--a module
|--lib
|--ant
|--build.properties
|
图片6 项目开发目录结构图
项目开发目录结构说明：
\ (说明：根目录)
|--apps (说明：此目录下放应用程序的代码)
|--J2EEOA (说明：此目录为放J2EEOA应用程序的代码)
|--admin (说明：此目录为放项目的admin应用程序的代码)
|--components (说明：此目录下放应用程序组件的代码)
|--a component (说明：此目录为放一个组件的代码)
|--modules (说明：此目录下放应用程序模块的代码)
|--a module (说明：此目录为放一个模块的代码)
|--lib (说明：此目录下放项目开发工具)
|--ant (说明：Ant工具，包括bin和lin目录)
|--build.properties
(说明：此文件定义项目开发共用的环境变量，
如jboss.home、jboss.configuration、servlet-lib.path等)
|
模块、组件开发目录结构简图：
\
|--build
|--etc
|--multi-langs
|--lib
|--docs
|--ejb
|-- META-INF
|--j2ee
|--META-INF
|--web
|--WEB-INF
|--src
|--ejb
|--javabean
|--servlet
|--web
|--build.bat
|--build.sh
|--build.xml
|
图片7 模块、组件目录结构图
说明：src、etc目录和build.bat、build.sh、build.xml为开发人员建立的目录，build和lib目录为由ant工具生成的目录。
模块、组件开发目录结构说明
\ (说明：一个模块或一个组件的根目录)
|--build (说明：保存由ant工具生成的扩展名为jar、war、ear等文件)
|--etc
(说明：存放部署文件，如web.xml、ejb-jar.xml、application.xml、
jaws.xml、jbosscmp-jdbc.xml等)
|--multi-langs (说明：存放多语言资源文件，扩展名为properties，)
|--lib (说明：保存由ant工具生成的API文件、class文件等)
|--docs
|--api
|--ejb
|-- META-INF
|--j2ee
|--META-INF
|--web
|--WEB-INF
|--src (说明：存放源代码，包括java和jsp代码，下面有四个目录。)
|--ejb (说明：采用EJB进行开发，存放EJB和Helper Classes源代码。)
|--javabean (说明：采用Javabean进行开发，存放Javabean和Helper Classes源代码。)
|--servlet (说明：存放Servlet源代码。)
|--web (说明：存放JSP源代码。)
|--build.bat (说明：在Window OS下，进行build的文件。)
|--build.sh (说明：在Unix OS下，进行build的文件。)
|--build.xml (说明：Ant工具要build的目标文件。)
|
应用程序开发目录结构简图：
\
|--build
|--etc
|--lib
|--docs
|--ejb
|-- META-INF
|--j2ee
|--META-INF
|--web
|--WEB-INF
|--team
|--a member
|--ejb
|--javabean
|--web
|--build.bat
|--build.sh
|--build.xml
|--build.properties
|
图片8 应用程序目录结构图
应用程序开发目录结构
1. 由于项目由多个程序员一起来进行编码，所以应用程序开发目录结构和模块、组件开发目录结构的不一样。
2. 应用程序开发目录结构没有src目录，但多了一个team目录，此目录存放所有程序员的classes和Jsp代码。
3. 应用程序开发目录结构下build.xml和模块、组件开发目录结构下的build.xml有很大不同。
4. 由项目组长负责管理etc目录、build.xml、build.bat、build.sh、build.properties，程序员分别管理team目录下的属于自己的目录，如程序员tom管理team/tom目录。
build.xml编码规范
· 应用程序目录下的build.xml
源代码：应用程序目录下的build.xml规范模板
说明：在建立build.xml时，组长只需修改创建的时间和变量ProjectName等。
模块、组件目录下的build.xml
源代码：模块、组件目录下的build.xml规范模板
说明：在建立build.xml时，开发人员只需修改创建的时间和和变量ProjectName、componentName等。
编码规范
· 项目中的JAVA源代码必须按《JAVA开发规范》。
·项目中的JSP代码必须按《JSP开发规范》。
· 每位开发小组成员在开发项目时都严格按此规范来进行编写程序，让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。
· 每位开发小组成员一定要绝对遵守这个规范。当实际应用与下面的规范相抵触时，记录下原因、潜在后果，以及符合规范需要的条件，但必须是在让程序有良好的可读性的前提下。
功能模块
在做业务逻辑模块前，先把一些准备工作做出来：
建立一些公用的bean（项目中称为系统控制器controller），包名为com.cwap.oa.controller.*，提供给系统各模块使用。包括对时间、字符的操作，调试器，软件国际化，多语言版本，系统的WEB外壳，MVC模式的Servlet和Action，对WEB页面显示的控制如树结构、路径结构；等等。
建立一个序列发生器，包名为com.cwap.oa.sequencegenerator.*，提供给bean使用，它用来产生一个唯一的ID，而且也可用来计数，也就是把它当成计数器使用。介绍如何取id的方法的文字要写在bean的代码内，以便生成API后供其它开发人员参阅。
建立一个ServerFacade，它为EJB Home提供统一的接口。ServerFacade为程序要用到的所有EJB的home handle提供缓存，提高访问效率。以后查找JNDI Name的方法都应写在接口里，调用时直接从接口调用。
建立一个翻页控制器，包名为com.cwap.oa.controller.web.page*，用来进行分页显示的管理，以后页面中的分页都由翻页控制器管理。
异常处理和日志
· 程序中所有的异常处理使用统一的调试器，bean的名称为com.cwap.oa.controller.util.Debug，用法见项目API。
· 程序中所有的日志使用Jakarta-log4j管理，包的名称为log4j-1.2.5.jar
官方URL：http://jakarta.apache.org/log4j/docs/index.html
Session
· 放在session中的变量统一放在一个bean里存储，不直接把session变量名称放在JSP、Servlet或Bean内，存储session变量名称的bean为com.cwap.oa.controller.web.util.WebKeys，取session变量名的方法为getXX()。
· 取session变量的值的方法统一放在一个bean里，bean的名称为com.cwap.oa.controller.web.util.JSPUtil，取session变量值的方法为getXX()，之后要取session变量值就调用JSPUtil中对应的方法。
· 当前系统中已知的session变量名有"userid"、"userName"、"locale"、"skin"等，userid为用户标识，userName为用户名称，locale为用户选择的地域，skin为用户选择的界面风格。
DAO
使用DAO封装SQL语言对数据库的直接操作，DAO采用Factory模式编写。
组件
所有的业务逻辑使用组件技术。每个组件内同时提供EJB版本和DAO版本两种的方法,不推荐直接使用EJB版本和DAO版本的方法。
多语言版本
· Bean、Servlet、JSP中的多语言文字采用分离技术，将多语言文字放在资源文件中，保存目录为/WEB-INF/classes/multi-langs或其它目录。
· 当前支持的语言有三种：简体中文（zh_CN）、繁体中文（zh_HK）、英文（en_US）。
· 多语言管理器的名称为com.cwap.oa.controller.util.MultiLangsString，使用方法见本项目API。
WEB外壳
· JSP页面中的图片、CSS、JS等文件都应放在统一目录，目录为/skin/skinName/skinLanguage，其中skinName为外壳名称，skinLanguage为外壳语言版本，例如/skin/green/zh_CN
· 图片放在images目录里，CSS文件放在css目录里，JS脚本放在js目录里，其它资源(如声音、视频、Flash文件等)存放方法见项目API。
· 外壳管理器为com.cwap.oa.controller.web.skin.WebSkin，调用方法统一接口为com.cwap.oa.controller.web.util.JSPUtil。
在线帮助
· 在线帮助管理器为com.cwap.oa.help.*，调用方法统一接口为com.cwap.oa.help.client.HelpClientHelper。
· 每一个JSP页面中提供一个在线帮助链接，用户点击它直接进入到在线帮助中心。
用户管理
· 建立一个取用户名称的页面，功能包括只取一个用户和取多个用户。
· 打开取用户名称页面的方法，使用页面脚本，"javascript:return openWinToGetEmployee(frame,id,name,num)"，当num为0，代表可以取多个用户，否则，只能取1个用户。
权限管理
· 调用方法统一接口为com.cwap.oa.controller.web.util.JSPUtil，检查用户是否有权限的方法为JSPUtil.isPermission(userid, permissions)
· JSP中检验用户身份采用include方式，include的文件为checkUser.jsp
检验用户身份是否是一般用户，调用方法为
<jsp:include page="../include/checkUser.jsp">
<jsp:param name="type" value="user" />
</jsp:include>
|
检验用户身份是否是管理员，调用方法为
<jsp:include page="../include/checkUser.jsp">
<jsp:param name="type" value="manager" />
</jsp:include>
|
检验用户身份是否是超级管理员，调用方法为
<jsp:include page="../include/checkUser.jsp">
<jsp:param name="type" value="administrator" />
</jsp:include>
|
摘自赛迪网:http://developer.ccidnet.com/art/322/20021014/27601_1.html, http://developer.ccidnet.com/art/322/20021014/27601_2.html
posted on 2006-09-27 14:48
Warren.Wu 阅读(236)
评论(0) 编辑 收藏