ECSC编码规范.docVIP

ECSC编码规范 简介 概述 本文提供一整套编写高效可靠的代码的标准、约定和规范。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。 最根本的原则：运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时侯运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少的。目的 本规范是使本项目能以标准的、规范的方式设计和编码使自己养成了良好的编码风格增强代码的可维护性的代码注释风格有助于提高代码注释的可读性，同时为使用自动化工具进行开发文档提取工作提供一致的基础数据。参考资料 《Java 编程指南》见RUP（Rational Unified Process）中文版。 《Java技术手册》(Java in a Nutshell) Ecsc项目采用maven来管理，规范如下： groupId：固定为com.eayun artifactId：eayun-xxx。举例：eayun-common，eayun-mail packaging： packaging 说明 jar java业务工程 eayun-common，eayun-base为底层 只包含html，js，xml，配置文件，不含java程序，根据业务需要依赖一些jar工程一些固定的工程 工程名 说明 eayun-common eayun-base 所有的model+dao eayun-xxx jar业务工程，只包含这个工程的Service和Controller类 Java规范 包名和类名 类型 规范 举例 Controller 包名：com.eayun.system.controller 类名：LoginController Service 接口包名：com.eayun.模块名.service 实现类包名：com.eayun.模块名.service.impl 接口名：XXService 实现类名：XXServiceImpl 接口包名：com.eayun.system.service 实现类包名：com.eayun.system.service.impl 接口名：LoginService 实现类名：LoginServiceImpl DAO 包名：com.eayun.模块名.dao 接口名：XXDao 包名：com.eayun.system.dao 接口名：UserDao Model 包名：com.eayun.模块名.model 实体类名：BaseXX 普通类名：XX 包名：com.eayun.system.model 实体类名：BaseUser 普通类名：User Job 包名：com.eayun.模块名.job 类名：XXJob 包名：com.eayun.system.job 类名：UserSyncJob Controller 一组业务操作一个类 @Scope(prototype) 每个public方法匹配一个.do跳转，并返回一个Json对象 只负责组织request传入的数据，并调用一个Service方法并返回结果（记录日志操作除外） Service 一组业务操作一个类 @Scope(prototype) 涉及数据库操作的一个Service方法是一个事务 @Transactional 可以调用任意多个DAO，也允许调用其他Service Service的方法不允许对异常进行处理，如有try-catch块，异常必须往上抛出 Dao 一张数据表一个类，也可以额外根据业务要求建类 接口类，继承mon.dao.IRepository 用标签的方式扩展HQL 所有可变条件用预编译方式传参 Model 实体类中，类名和表名对应，每个属性对应一个字段（类名和属性名遵从驼峰命名法） 普通类继承对应的实体类，并扩展自己的属性 使用BeanUtils.copyPropertiesByModel实现BaseXXX和XXX之间的转换 Job 继承QuartzJobBean的计划任务 常量 全大写，单词间用下划线分隔，比如：MY_NAME 变量和方法名 变量和方法名必须有业务含义，禁用比如flag，list1等业务含义模糊的命名 第一个字母小写，遵循驼峰命名法则，比如：myName 字符串拼接 SQL，HQL的拼接禁止使用String类，要用StringBuffer类实现拼接。 Dao规范 整体规范 接口，继承Irepository 如需扩展方法，用标签的方式写SQL HQL:增，改 Object saveEntity(final Object entity) void saveOrUpdate(final Object entity) int executeUpdate(final String hql, final O