JSP 代码规范
1 文件名
1.1 文件后缀 文件类别 文件后缀 ---------------------------------------------.java Java 源文件
Java 字节码文件 .class 动态页面 .jsp 静态页面 .html 脚本文件 .js 1.2
常用文件名 文件名 用途 -------------------------------------------------README 概述特定目录下所含内容的文件的首选文件名 1.3 文件类型的文件后缀推荐位置 File Type JSP 技术 File Suffix .jsp .css .js .html .gif, .jpg, etc. .tld Recommended Location
// /css/ /js/ // /images/ /WEB-INF/tld/
层叠样式表
JavaScript HTML 网络资源 Tag 标签库 1.4 jsp 命名规则
尽量使用通俗易懂的英文单词,实在不行则使用汉语拼音,避免拼音与英文 混用。 a. 统一:对于同一个概念,在程序中用同一种表示方法; b. 达意:标识符能准确的表达出它所代表的意义; c. 命名:首字母小写,单词间用首字母大写来分割。可以用动名词来表 示,比如: addNews.jsp。 d. 所有的 javascript 统一写在*.js 文件中,在页面中调用。
第 1 页 共 4 页
e. 在所有页面中所写的代码必须进行合理的缩进,保证代码格式的完整 性和代码的可读性。
2 缩进排版
4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空 格 vs.制表符) 。一个制表符等于 8 个空格(而非 4 个) 。
3 注释
Jsp 程序有两类注释:静态页面注释和 java 注释。 静态页面注释: Jsp 注释: <%-- express --%>
4 注意事项
1. 整个 jsp/jsp bean 表示层应当尽可能的瘦和简单化。 2. 牢记大多数的 JSP 都应当是只读的视图,而由页面 bean 来提供模型。 3. 应当一起设计 JSP 和 JSP bean 4. 在尽可能合理的情况下,把业务逻辑从 JSP 中移走。具体于 HTTP 的逻辑 (如,对 Cookie 的处理)属于 bean 或支持类中,而不是 JSP 中。 5. 尽量把条件逻辑放在控制器中而不是放在视图中。 6. 为 JSP、包含的文件、JSP Bean 和实现扩展标记的类使用遵循标准的命名 惯例。如: jsp 控制器 xxxxController.jsp 被包含的: jsp _descriptiveNameOfFragment.jsp jsp 页面模型 bean: Bean 如 loginBena.java xxxxSessionBean jsp 会话 bena: 标记类 : xxxxTag,xxxxTagExtraInfo 7. 应当在 JSP 中避免使用页面引入指令。 import 指令会促使类的实列化而不 是 jsp bean 的实例化: 不用:<%@ page import = "com.java.util.*" %> 而用:<% java.util.List l = new java.util.LinkedList(); %> 8. jsp 不应该直接去访问请求参数。bean 应当执行这样的处理过程并且输出 所处理的模型数据。 9. jsp 不应当访问属性文件,或者使用 JNDI。bean 可以访问属性。
第 2 页 共 4 页
10. 如果 jsp bean 具有的所有的属性不能够从页
面请求中被映射到,就要尽 力在xml:namespace prefix = jsp />标记中设置属性。 11. 应当避免设计既显示表单又处理结果的页面。 12. 在 jsp 中避免代码重复。把要重复的功能放在一个包含的 jsp、bean 或标 记扩展中,使得它能够被重用。 13. jsp bean 应当永远不要去产生 HTML 14. 在 jsp 中应该避免使用 out.pringln()发放来产生页面内容。 15. jsp 层不应该直接访问数据,这包括 JDBC 数据库访问和 EJB 访问。 16. 在长度上,scriptlests 的代码最好不要超过5行。 17. 除了 jsp bean 之外,jsp 不应当去实例化复杂的可读写的对象。如果这样 的话,就有可能在 jsp 中去执行不适当的业务逻辑。 18. jsp bean 中不应当包含大量的数据。 19. 如果使用了和, 并且必须使用简单类型的 值来与外部页面进行通讯的话,就应当使用一个或多个元素 20. 定制标记应当用在适当把逻辑从 jsp 中移走的地方。 21. 应当谨慎地使用标记,在 jsp 中它是一个等价的 goto。 22. 应当使用隐藏的注释来阻止输出的 HTML 过大。 23. 在 jsp 中避免进行异常处理 24. 每个 jsp 文件中都应当使用一个错误页面来处理不能够从中恢复的异常。