接口设计规范

首先，在阅读本文档前请务必确认您已经对面向对象的基本概念有所了解。

根据目前实验室所使用的系统架构，制定本文档，主要阐述一些service层和DAO层接口设计的基本原则和规范要求。

总体规范

1. 接口中方法的返回不能为void，至少也要通知调用者，操作是否成功
2. 接上条，凡是返回操作是否成功的方法，返回类型要设置为int而不是boolean
3. 方法名只能使用英文，尽量简单易懂，驼峰规则，首字母小写，不得含有数字
4. 方法名最好使用动宾结构。
5. 接口中所有方法都必须写注释
6. 接口中所有方法都必须是public的
7. 每个方法的位置应当是明确的，不要将不属于某接口的方法放入该接口中，也不要写功能重复的方法

service层接口规范

service层是每个模块逻辑处理的位置，一个service对应一个action和若干个DAO，service中每一个方法都来自页面功能的需求，所有service层的接口都必须继承自BaseService，所有方法都应当以BaseForm（或其子类）的对象作为参数，根据需要可以添加PageInfo的对象，其他参数一般不要添加。

以下方法是在BaseService中已经声明的：

/**  * 添加一条新数据  * @return 消息编码  */ public int addData(BaseForm thisForm);

/**  * 编辑一条数据  * @return 消息编码  */ public int editData(BaseForm thisForm);

/**  * 删除一条或多条数据  * @return 消息编码  */ public int removeData(BaseForm thisForm);

/**  * 返回一条数据，并用于页面展示  * @return BaseForm   */ public BaseForm showData(BaseForm baseForm);

实例：

/**  * 分页显示照片  */ public List<DataPhoto> getDataPhotoByConditionsInPage(PageInfo pageInfo, DataPhotoForm dataPhotoForm); /**  * 获取某个相册下的所有照片  */ public List<DataPhoto> getAllDataPhoto(DataPhotoForm dataPhotoForm); /**  * 删除某个相册下的所有照片  */ public int removeDataPhotoByGroup (DataPhotoForm dataPhotoForm); /**  * 获取某相册相片及回复  */ public Map<Integer, List<DataPhotoReply>> getDataPhotoAndReplyByGroup (DataPhotoForm dataPhotoForm);

DAO层接口规范

DAO层的作用是操作数据库，每一个接口对应数据库中的一个表，可以被多个service调用。DAO层接口中所有的方法都与数据库的“增删改查”相联系。所有的DAO层接口都必须继承自BaseDAO

以下是BaseDAO中已经声明的方法：

/**  * 将一个Model添加进数据库  */ public int insertModel(BaseModel model);

/**  * 更新Model  */ public int updateModel(BaseModel model);

/**  * 删除一条或多条数据  */ public int deleteModels(int[] ids);

实例：

/**  * 分页显示照片  */ public List<DataPhoto> getDataPhotoByConditionsInPage(PageInfo pageInfo, DataPhoto dataPhoto);

/**  * 获取某个相册下的所有照片  */ public List<DataPhoto> getAllDataPhotoByGroup(DataPhoto dataPhoto);

/**  * 删除某个相册下的所有照片  */ public int deleteDataPhotoByGroup(DataPhoto dataPhoto);

/**  * 获取相片及其回复  */ public Map<Integer, List<DataPhotoReply>> getDataPhotoAndReplyByGroup (DataPhoto dataPhoto);

/**  * 插入一条数据后，立刻返回该条数据id  */ public int getPhotoIdRightNow();