Struts2 Web层开发规范与平台介绍

"中期开发平台说明文档-Struts2 WEB层.doc" 本文档是关于中期开发平台的说明，重点聚焦在Struts2框架的WEB层应用，旨在为开发者提供清晰的系统架构设计、代码规范和部署流程。文档创建于2011年3月18日，由白玉杰编撰，内容涵盖了从概述到具体的代码编写规范，再到项目部署的详细步骤。 一、概述 文档的主要目的是解释开发平台的系统架构，特别是Business层和Struts2 Web层的交互，同时阐述了Java编程的代码规范，以确保代码质量与可维护性。文档还提供了名为"cmsdemo"的项目示例，帮助理解编码规范的实际应用。 二、架构介绍 系统架构基于Spring和Struts2技术，采用Spring的注解配置和调用来实现Business层与Web层之间的通信。这种设计模式强调了分层的清晰性和松耦合性，提高了系统的可扩展性和可维护性。 三、代码规范 1. Java命名约定 文档详细规定了Java代码中的命名规则，包括类、接口、变量、方法等的命名，强调使用全英文描述符，首字母大写的驼峰式命名，并且避免使用易混淆或过长的名称。此外，包名通常使用反转的互联网域名加上描述性的名称。 2. Java注释约定 文档要求良好的注释习惯，包括对功能、参数、返回值等的描述，注释内容应简洁明了，且应注释所有必要的部分，以便其他开发者理解和维护代码。 3. Java文件样式约定 文件的格式也有所规范，例如版权信息、包导入、类定义、字段声明、存取方法、构造函数、克隆方法、类方法、toString方法和main方法的编写顺序和格式。 4. 其他编码约定 还包括文档化、缩进、页宽、{}对、括号的使用规则，以及JSP文件和Servlet类的命名规范，旨在保持代码的一致性和整洁性。 四、项目简介 这部分简述了项目的整体情况，"cmsdemo"工程作为示例，展示了如何在实际开发中遵循这些规范。项目简介包括工程的基本信息和具体功能。 五、部署步骤 最后，文档列出了部署平台的详细步骤，指导开发者如何正确配置和启动项目，确保软件能够顺利运行。 总结来说，这份文档是开发团队在使用Struts2开发WEB应用时的重要参考，它不仅提供了架构设计的指导，还强调了编码质量和团队协作的规范，有助于提升开发效率和软件质量。