ssh,service,impl目录规范化

ssh,service,impl 目录规范化篇一：SSH 编码规范SSH 编码规范 一、项目设计 本项目分为 3 层，表现层（Struts2） 、业务层（） 、持久层（） 。由 Struts 来管理视图层并对异常进行捕获，由 Spring 来管理业务逻辑及事务的管理，Hibernate 封装了所有数据以及数据库的操作与分页等。 如图： 二、包的命名规范 包的命名规范总体来说主要是按照模块的名称来命名。并且每个包的名称都必须是小写的字母。一个系统中有用户模块、日志模块等，每个模块都是一个包，然后在包的下面包含此模块下所有的类。 譬如应用中有一个 test 模块，则在公共包下建立一个 test 包 例如： 在 test 包下包括如下子包 、action 包 该包放置各种 struts 的 action，此包的命名规范是必须以 Action 结尾，例如我们要写个登陆的 Action 那么这个类得名称是 LoginAction。 例如： 、service 包 该包放置业务操作类，譬如用户管理类，一般情况将该用户操作类提取一个接口，此接口以 Service 来结尾，并放入到 service 包下面，然后在 service 包下新建一个imp 包，在 imp 包中才放置用户操作接口的实现类，实现类以 ServiceImpl 来结尾。该接口实现类中调用 DAO 接口对数据库进行操作，而调用该实现类的方法在 struts 的action 中通过此类的父接口调用。 下面以 test 下面所有与用户相关的操作来定义一个业务类。接口：UserService；实现类：UserServiceImpl。 例如： 、dao 包 dao 层有一个接口是 BaseDao，里面有个BaseDaoImpl。这两个类之间的方法是一一对应的。在 dao包下面所有的接口都要继承 BaseDao，在包下所有的类都要实现对应的 dao 包下面的接口，继承 BaseDaoImpl 类，具体见示例。 例如： 以下是 包下的目录 以上是一个模块的规范 、entity 包 该包中放置 hibernate 反向工程生成的 bean 和该bean 对应的.文件。 例如： 、util 包（工具包） util 包个人理解是:在我们需要添加的功能不在以上所有包中，那么就可以写在 util 包。 如： MD5 加密。 登录图片验证。 （常量类） 通用非空判断? ? 例如： 三、配置文件的命名规范 Struts 和 Spring 都是通过模块名称来命名的，每个模块对应的一个 Struts 配置文件和一个 Spring 配置文件。Struts 和 Hibernate 都是通过 Spring（IOC）来注入对象的。 、配置文件 开发人员不允许私自动，如果需要写 servlet，过滤器等，需要在配置时，需要向项目组长说明，方可添加。 、Struts 配置文件 Struts 所有的配置文件放在 WEB-INF/struts-config目录下。开发人员不要新建 Struts 配置文件，所有配置Struts 配置文件都是由项目组长来添加。Struts 的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个 Struts 的配置文件。Struts 配置文件根据模块名称来命名。 例如：、Spring 配置文件 spring 所有的配置文件放在 WEB-INF/spring-config目录下。开发人员也不要新建 Spring 配置文件，所有Spring 配置文件都是由项目组长来添加。Spring 的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个 Spring 的配置文件。Spring 配置文件根据模块名称来命名。 例如：spring_ 、Spring 和 Struts 配置文件命名规范 1、Struts 配置文件 path 的命名规范 Struts 配置文件 path 的命名规范是由下划线“_”右面的部分加上本类所对应功能来命名。例如 struts_,所有的配置文件应该由 test 和类得功能来命名。并且每个action 都要写清楚注释。 例如： 2、spring 配置文件 id 的命名规范 注意一提的是 spring 中 id 的命名规范，在 spring_中 dao 对应的 id 的命名规范是此 dao 类得全称，并且第一个字母小写。例如 UserDao 在 spring_中的 id 应该是userDao。Service 层中在 spring 中配置文件第一个字母小写，例如 UserService 应该是 userService。 并且在 spring_中谁加的一定要写清楚注释。例如：spring_中 class=“ userService .UserServiceImpl“ spring_中 篇二：SSH 项目规范_SSH项目规范 1.项目规范说明 名词解释 （1）驼峰命名法：就是当变量名或函数名是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始；第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如 ：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。 （2）首字母大写的驼峰命名法：在驼峰命名法基础上首字母大写。 数据库中表、视图、字段的命 1) 数据库表命名需以 T 开头，后接表的英文简写（首字母大写的驼峰 命名法） ，如 TUser 表。 2) 视图命名需以 V 开头，后接表的英文简写或视图的目的（首字母大 写驼峰命名法） 。 3) 字段的命名需以有意义的英文单词组合，并加前缀 F，使用首字母大 写的驼峰命名法，如字段FUserName、FUserPassword。 数据字典维护 1）数据字典定期维护，修改表结构时一定先修改数据字典，数据字典和数据库要定期汇总，修改人像数据库负责人汇报，由数据库负责人进行统一汇总，汇总完成再统一分发给项目组成员。 2）建立的视图也要有说明，包括视图名称，创建的sql 语句，作者以及 视图大概的用途说明。 项目 java 代码架构：遵照 MVC 模式，分 5 层实现 使用基于 MVC 设计模式思想，分五层实现，总的原则是：“相邻两层之 间进行交互，不要夸层调用方法” 。且使用面向接口编程的方式实现，所以在 Service 和 DAO 层要先定义接口再写实现类。具体 5 个层次如下：1）视图层 展示页面，用户接口。 2）Action 层 控制器层，负责任务分发和页面跳转。负责接收视图层传递的参数，根据用户的请求调用相应的业务处理方法进行处理，并将处理结果返回给用户，跳转到结果的响应页面。 3）Service 层 业务逻辑层，所有的业务逻辑在该层实现，向 Action 层提供方法方法支持，主要调用 DAO 层和Model 层得一些方法。 4）DAO 层 数据持久层，只提供对应 Model 的数据持久化的操作（CRUD 等） ，不实现其它业务逻辑。 5）Model 层 系统中的实体对象，每一个 Model Bean对应数据库中的一张表或一个视图，这里的实体对象都是标准的 JavaBean。 所以 src 文件夹的结构如下图所示：其中“OrderItem”为 Model 层的一个 JavaBean，Util 包中存放的是一些工具类，例如分页的 PageListForHibernate 等。项目中 java 包、接口和类的命名规则：1 )类的名称要有意义，最好在 dao 层、service 层、以及 action 层中的类名称中能体现出与其相关联的 model层中的 JavaBean。 2 )顶层的包名为 com，有子工程或是子系统可以再有二级包名，像上图中的 example 包 3 )代码架构中每一层对应的包名分别是：model模型层、dao数据持久层、service业务逻辑层、action控制器层。 action 包其中存放的都是控制器类，类名后缀为 Action。dao 和 service 包下面直接放的是接口类，dao 层的接口以 dao 为后缀，service 层的接口以manager 为后缀，每个接口对应的实现类在 impl 子包下面，且实现类的名字为接口名字加 impl 后缀。可参考上图的示例。model 包下面的类规范见下文。 service 和 dao 层方法名定义规范 1）标准方法的定义：（这个地方一定要遵循规范） 添加一个对象：add*（） 修改一个对象：modify*（） 逻辑删除一个对象：delete*（） 彻底删除一个对象：deleAbso*（） 获得一个 Bean：getBy*（） 获得一个类的对象列表：getList*（） 判断一个对象是否存在：isExit*（） 其中 * 代表在 * 位置可以放置任意字符串或是不添加其他字符，最好使用有意义的单词，遵循容易理解的原则。 2）其他方法根据需要自己添加，同样要使用有意义的单词，应遵循容易理解的原则。 model 层 JavaBean 类名、属性和方法的命名 1）若该 Bean 与数据库有对应的表，则其类名为去掉前缀 T 的表名称，若没有则使用首字母大写的驼峰命名法。2）若该 Bean 与数据库有对应的表，则其属性名应于表中字段名称，前缀 F 保留。 3）setter 和 getter 方法中的后缀要遵循首字母大写的驼峰命名法。如：getFUserName （） 、setFUserName（） ； JSP 文件的写法 首页和登录页的 JSP 文件放在根目录下，其余文件按照英文含义放入响应的文件夹下，每个文件夹下包括了该模块的全部操作页面。文件夹的命名使用首字母大写的驼峰命名法。如下图所示： JS 和 CSS 文件放置 每个 JS 文件放到/js 文件夹下面，js 文件命名要是有有意义的单词，同时遵循首字母小写的驼峰命名法。CSS文件放到/css 文件夹下面，命名规则同 js 文件，如下图： 篇三：JSP_SSH 框架搭建(MyeclipseXX+Mysql) SSH 框架 + 编号：SSH-S2-S3-H4 版本： 环境说明 本文章是根据个人的搭建经验完成的轻量级 SSH 框架，也是实际应用中比较全面的基础框架。其中 SSH 指：Struts，Spring, Hibernate，是一个将 MVC 思想发挥的很好的 web 框架。 开发平台： Windows 7 + MyEclipse XX + Tomcat + JDK + Mysql 不同的版本大同小异。 其中 SSH 所需的包均直接使用 MyEclipseXX 内集成的jar 包，这样无需手动添加，比较方便。 建立工程目录 新建工程 打开 MyEclipse， 新建一个 web project: file - new - Web Project 如下图所示： 然后 next 两步，到下面时，修改一点： 之后直接 next 到 finish 即可， 建立后目录如下： 建立 src 目录 为了使得目录结构清晰，将不同层次的源程序放到不同包内，分别建立 如下 4 个目录： - :存放 Action 代码 - :存放 Service 代码 - :存放 Dao 代码 - :存放数据库实体类 直接右击 src, 然后 new - package 如下图： 然后直接 finishi 即可。同样的步骤建立剩下三个目录。这一步完成后的目录如下： 导入 Struts,Spring,Hibernate 环境 就是导入 SSH 环境了，这里使用的是 MyEclipse 集成的 jar 包 导入 Struts 过程：右击项目名 SSH 然后 MyEclipse -Project Facetscapabilities-Install Apache Struts Facet 初始图如下： next 到这步修改为第三项（重要）：之后一直到 fini