后端开发规范、后台开发规范

1. 后端开发规范说明

小型业务系统: 如果您将要开发的系统不太大，可以直接在javamis-web工程下编写您自己的业务代码，比如：

后台代码写于：javamis-web/src/main/java/com/javamis/modular/business/目录下，
分层 controller、dao、mapping(放于dao包子目录，可选)、entity、service(可选)
前台静态文件(js/css/img)代码写于：javamis-web/src/main/resources/static/目录下
前台html文件代码写于：javamis-web/src/main/resources/views/business/目录下

大型业务系统: 如果您将要开发的系统比较大，可以根据javamis-core工程目录，新创建一套maven工程模块，比如：

后台代码写于：javamis-xxx/src/main/java/com/javamis/modular/business/目录下，
分层 controller、dao、mapping(放于dao包子目录，可选)、entity、service(可选)
前台静态文件(js/css/img)代码写于：javamis-xxx/src/main/resources/static/目录下
前台html文件代码写于：javamis-xxx/src/main/resources/views/business/目录下

温馨提示：如果您的工程特别大，根据业务需求，可以创建多个工程，如：javamis-xxx1、javamis-xxx2、javamis-xxx3、.... javamis-xxxN；
同样，按照以上方式被javamis-parent父工程管理包含，javamis-web工程pom.xml下增加依赖~

(图-1：小型业务系统，直接在javamis-web工程下写业务代码) (图-2：大型业务系统，在新创建的工程下写业务代码)

2.1 Entity层命名规范

功能	命名规则	举例说明
实体类指定关联的数据表	@TableName	@TableName("sys_user")
类名的定义	根据业务需求定义类名，力求简洁实用	User、Department(Dept)
主键	@TableId	@TableId(value="id",type= IdType.AUTO)
省去代码中大量的get() set()方法	@Data
指定数据表字段名称	@TableField	@TableField(value = "userName")
指定类属性不属于数据表字段	@TableField	@TableField(exist = false)
指定数据表时间字段格式	@DateTimeFormat	@DateTimeFormat(pattern = "yyyy-MM-dd")
其它	其它操作数据方法，请参考源代码

2.2 Dao层命名规范

2.3 Controller层命名规范

功能	命名规则	举例说明
类映射路径	/模块名称	/user
类名的定义	业务类名称 + Controller	UserController
方法映射路径	与方法名同名
查询列表方法	list	返回视图路径："system/user/list"
查询列表数据方法	listData
新增表单方法	form	返回视图路径："system/user/form"
新增表单保存数据方法	save
编辑表单映射路径	edit/{id}	@RequestMapping(value="edit/{id}") 返回视图路径："system/user/edit"
编辑表单方法	edit
删除方法	delete
其它	其它操作数据方法，请参考源代码