SSH项目,全称为Struts2、Spring和Hibernate的集成框架,是Java开发中常见的Web应用框架。本规范示例主要涉及SSH项目的代码组织、目录结构、命名规则、配置文件规范以及开发环境设置等方面,旨在提高代码可读性、可维护性和团队协作效率。 1. **项目命名与版本控制**: - 项目名称应清晰明了,如"E-commerce",表示电子商务项目。 - 版本号采用X.Y.Z.W模式,X.Y.Z为主版本号,W为副版本或扩展版本。 2. **包命名规则**: - 包结构反映了模块的划分,如action、service、service.impl、dao、dao.impl、model、dto、exception和util等。 - 包名遵循公司域名倒序加模块名的方式,如"net.jsdn.E-commerce.模块名"。 3. **模块命名**: - 核心模块通常命名为"core",其他模块根据功能用英文命名。 4. **配置文件命名与规范**: - 每个模块有自己的struts配置文件(struts_模块名.xml),并包含到主struts.xml中。 - hibernate.cfg.xml用于测试环境。 - beans.xml采用延迟初始化。 - 其他配置文件如jdbc.properties、log4j.properties、echo-hibernate.xml保持默认命名。 - 配置文件书写应注重可读性,避免过多的通配符配置。 5. **代码书写规范**: - 类名采用驼峰命名,如XxxAction、XxxService等。 - 接口设计要直观易懂。 - 使用IDE自动生成getter和setter,放置在逻辑方法后。 - 方法和变量命名遵循驼峰规则,私有变量用private声明。 - util类中的静态类和常量适当使用static和final修饰。 6. **开发环境设定**: - 字符集统一为UTF-8,定义为常量。 - 依赖库lib放在单独的目录下。 - 开发环境推荐使用JDK 6.0,兼容Java EE 5。 - 数据库支持MySQL 5、SQL Server 2005或Oracle 11g及以上,可根据需求选择。 - IDE推荐使用MyEclipse,版本不限。 - 测试框架为JUnit 4。 7. **单元测试**: - 测试类与被测试类同包,类名为被测试类名加Test。 - 测试方法命名以test开头,加上被测试方法名。 8. **页面设计**: - 前端使用HTML和JSP,尽量避免在JSP中混入大量业务逻辑,利用Struts的逻辑标签。 - 后端界面技术可选用Extjs或Flex,优先考虑Extjs。 - 每个模块对应一个文件夹,便于管理。 以上规范旨在确保项目结构清晰、代码规范,提升代码质量和团队合作效率。遵循这些规范,可以有效地降低维护成本,提高开发效率,同时也有利于软件的持续演进和扩展。
- 粉丝: 8
- 资源: 22
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助