以下是HeartBeat开发项目的一些规范,请大家自觉遵守。
1 .软件和版本信息的开发使用
* JDK 1.7.0_40
* Maven 3.1.0
* IDEA 11.1.3
* Tomcat 7.0.47
* MySQL 5.5
* Git 1.7.10
平台:win7(x64 )开发
(更多的开发软件和版本号在初次使用时指定)
[请务必使用相同的软件版本]
2 .一般构成和要求
计算机配置
*中,切换英语快捷键。 不能使用Ctrl空格键切换输入法
*不能任意更换* IDEA的所有快捷键
数据库开发
*“表”(table )和“字段”(column )以小写字母分隔,并用以下线条分隔: 例如user; 用户_详细信息; color_def
*所有SQL脚本都必须手写,不能通过工具导出生成
*请勿在任何字段中添加约束,但明确要求除外。 例如,非空约束
如果在项目数据库名称后加上_test,则为测试数据库名称。如果项目数据库为: hb,则测试数据库名称为: hb_test
IDEA配置
*代码的自动缩进(快捷键Ctrl Alt L ) ) ) )。
*有关其他配置,请访问intellij_templates.txt
Git使用要求
不要使用IDEA附带的git程序,单击菜单:文件-设置.在打开的窗口中搜索git,然后将路径到git执行程序的路径安装在计算机上
*每次提交代码时,尽量同时向仓库发送推送代码
*提交代码时必须写注释(Comment )。 内容是关于提交或更改的功能的说明
必须确保代码是本地编译的;尽可能完成一项功能,通过测试,并在review之后提交
3 .项目布局和要求
*所有程式码、档案、资料库、请求/回应等使用的字符编码都是UTF-8
*浏览器支持: HTML5支持
*DTO不能传递给Domain
*所有服务方法的参数和返回值必须是基本数据类型和DTO,不能是域
*服务层不做业务处理
*方法或生成器的参数尽量不超过4个
*方法名称和属性名称必须有意义,不能随意指定方法名称。 JSP文件和软件包(package )的命名可以包括例如companyform.jsp; com.andaily.service;
类名、方法名、属性名遵循驼峰命名约定。 例如,公司控制器
对于复杂的业务方法,域方法和数据库操作必须使用TestNG编写单元测试
通过Spring进行注释开发,控制器层为@Controller,服务层为@Service,Validator为@Component; 相互部署用@Autowired; 所需的bean可以配置为xml文件
*项目事务将添加到服务中。 例如,com.andaily.service包及其子包; Service方法中以load,is开头的方法只有只读事务,其他方法支持写事务
*URL设置要求
1 ) .所有URL设置都按模块划分目录。 例如,公司模块的顶层目录是/company。 所有公司的URL都在此目录下。 例如,公司的附加URL可以是/公司/添加;
公司的URL是/公司/编辑; 已删除的URL为/company/delete; Overview的URL为/company/overview。
其他URL根据其功能命名,例如导出到/company/export。 有参数的URL是/company/edit等吗? guid=1223-soed-d等。
2 )配置URL分时模块,结构清晰。
3 ) .页面上的URL使用相对路径或完整路径(包括上下文路径)
4 ).URL的配置尽量简单清晰,一看就知道其功能
如果要检索Spring容器中的实例,可以使用bean provider.get bean (class clazz )进行检索。 在域中检索存储库的方法如下:
privatetransientbacklogrepositorybacklogrepository=bean provider.get bean (backlog repository.class;
按以下方式使用:
公共语音服务更新(
后台存储库. save (this;
}
*前台使用JQUERY和相关插件,所有静态资源(js、css、image、html等)都位于resources目录中。
*新的存储库必须继承存储库接口。 MyBatis使用的存储库必须继承特定的子接口。 以下是一个例子。
publicinterfacecompanyrepositoryextendsrepository {
//代码
}
publicinterfacecompanyrepositorymybatisextendscompanyrepository {
//代码
}
4 .对比较复杂的业务方法,要编写辅导班完成其业务方法。 例如,保存/更新大型表单,编写XXXPersister类进行保存/更新。
(如果有未知或尚未明确的开发规格,请提交)