JavaWEB项目基本准则.doc

Java WEB项目基本标准 界面风格：字号、字体协调大方、图片典雅。 颜色搭配：字体颜色、图片颜色反差不能太大。 界面布局：菜单、图标、图片一定要方便操作且摆放端正严禁出现无样式布局。 样式要求：尽量使用外部公共的样式表 .css 且样式表的命名一定要顾名思义。 代码要求： JavaScript：页面公共的JavaScript 必须使用外部 .js 文件 ，且js 文件中的函数定义变量名定义一定要符合Java的编程规范 严禁出现 var a = “mmm”; 的变量名,关键代码和方法应有注释说明具体格式可参考以下格式。 /** * 删除记录提示主要用于提示“是否删除该条记录” * */ function onRemove(options) { var checked = false; if (!checked) { alert(opt.noneSelectedMsg); return; } } JSP： 在JSP 一个jsp文件的命名应该按照Java类中的方法命名规范首字母小写严禁使用汉语拼音缩写页面中。 HTML 应使用统一的小写且外部内部JavaScript和样式一定要在head/head标签内完成 。 HTML 元素的 name 和 id 一定要一致 不能出现 name=“abc” 其命名的属性值应该按照Java 命名规范中的类的成员变量命名严禁使用java 的关键字和敏感词 例如： form method=post name=save id=form1。 当HTML 元素例如input 标签 要用样式时尽量使用外部统一样式 为了保持代码干净少用style 属性本着这样一个原则：程序员和美工分家，程序员应该最大限度的去导入美工写好的东西而尽量不要出现一个文件既有美工的代码又有程序员的代码否则不利于样式的统一更换例如一个软件要换几套风格。 Jsp 页面中一些常用的组件如：日历控件、省市县 联动控件 建议封装成单独的jsp 页面或者是自定义标签，当某个页面引用时包含此文件即可。 强烈反对在Jsp 页面中使用绝对路径或者是半路径(../..)建议使用“${}”来取全路径例如：script type=text/javascriptsrc=${ctx}/scripts/extjs/diy/ColumnNodeUI.js/script 其页面定稿后一定要将文件格式化(ctrl+shift+f)。 具体格式严格按照如下代码 ： %@ page language=java contentType=text/html; charset=UTF-8 pageEncoding=UTF-8% %@include file=${ctx}/pages/common/extjs.jsp % html head script type=text/javascript src=${ctx}/scripts/extjs/diy/columnTreeLoader.js/script LINK href=${ctx}/pages/styles/column.css type=text/css rel=stylesheet title/title /head body /body /html Java :严格按照Java的编程规范见附件 Java其他： 某个对象的不为空且不是空字符串的判断。 集合的迭代。 集合是否为空集合的判断。 异常的捕获。 文件流、数据库连接、会话、线程 使用后是否及时关闭。 所有的Java类不能出现多余的import类或者包的导入。 所有的Java类文件必须是UTF-8 格式的编码方式 。 工程框架结构图： 数据库设计要求： 根据某一行业特点字段命名如有国标或者部颁标准时应采用其标准命名。 严禁使用无意义或者关键字或者拼音来命名字段。 在数据库层一定要设置主键和外键且不能用业务相关字段来做主外键。 尽量采用Java类来实现主键生成机制脱离数据库自有的主键生成 。 严格按照三范式的要求减少冗余。 项目测试基本要求： 检查界面是否完整。 检查样式是否应用到位每个界面。 检查界面是否出现错别字。 界面级验证、后台验证是否有效。 重点操作如：删除记录和更新记录 是否有确认提示。 输入测试用例检查数据库事务是否有效。 严禁无权限用户直接输入后台地址显示后台界面。 并发访问时检查数据库和服务器是否正常。 项目试运行基本要求： 项目试运行必须在WEB服务器下运行必须脱离开发环境。 在运行时异常信息不能直接抛到界面应转到相应的错误界面。 试运行时的数据保证是有效有意义的数据严禁出现“aaa 111”等。 项目数据库无数据记录时运行程序不应报运行异常。 界面中无用的按钮和链接一定要去掉。