开发指南专题三：JEECG微云快速开发平台项目编码规范

xyzone

开发指南专题三：JEECG微云快速开发平台项目编码规范




4. 项目编码规范




4.1. 项目编码规范

1. 项目编码格式为UTF-8(包括:java,jsp,css,js)

2. sevice接口命名：*Service

service实现命名：*ServiceImpl

entity命名：*Entity

page页面form命名：*Page

action命名：*Controller

项目没有DAO,  SQL写在Service层

代码层次目录按照自动生成目录

3. SQL文件目录和命名规范

(1).所有SQL必须大写，不允许用*,全部替换为字段

(2).SQL文件根目录为:sql跟接口目录Service是一个目录;

例如:src\sun\sql,子目录跟service必须保持一致

(3).SQL文件命名：[service名字]_[方法名字].sql

4.数据库表设计规范

(1).主键字段为id

(2).每个字段必须加备注

5.action中的方法

配置菜单的方法：以go开头（其他方法不允许以go开头）

触发业务逻辑的方法：以do开头

页面跳转的：以to开头

6.Entity和数据库自定命名规范

采用驼峰写法（每个单词首字母小写、其他字母小写的写法）转成中画线写法（所有字母小写，单词与单词之间以中画线隔开）




4.2. 详细说明

[1].SQL层讲解

A. 项目没有DAO SQL写在Service层，数据库取数和DB操作通过service层来实现

B.如果使用硬代码SQL,一个方法对应一个SQL的话，可以采用框架封装的方式来存储SQL文件（表示采用命名规范来存储SQL）

存储方式：

(1).所有SQL必须小写，不允许用*,全部替换为字段

(2).SQL文件根目录为:src\sun\sql,子目录跟service必须保持一致

(3).SQL文件命名：[service名字]_[方法名字].sql

读取方式：String sql = SqlUtil.getMethodSql(SqlUtil.getMethodUrl());

SQL定位方法：ctrl+shift+r 参数：方法名，前面加*

[2].Controller层页面数据封装

1.页面列表数据方法：datagrid

2.查询条件在ACTION 层datagrid(pram)方法执行前加




4.3. 举例讲解命名规范

例如：表名：jeecg_sys_demo

第一部分：代码文件命名规则如下：

首先：表名采用驼峰写法转换为Java代码使用单词  jeecg_sys_demo => JeecgSysDemo

[1].control命名 :JeecgSysDemoControl

[2].Servlice命名:JeecgSysDemoServiceI/JeecgSysDemoServiceImpl

[3].JSP命名：jeecg-sys-demo.jsp(表单页面)

                      jeecg-sys-demo-list.jsp（列表页面）

                      jeecg-sys-demo-*.jsp(新增表单页面例如：detail)

[4].control中方法命名：

页面触发业务方法以do*开头

页面跳转方法以go*开头

（方法标签注释需和方法名保持一致）

[5].page/entity字段定义必须是对象类型

     int --> Integer




5. JEECG目录结构




5.1. 配置文件目录结构

JEECG中的配置文件目录结构如图111所示。

图111 JEECG配置文件目录结构

5.2. Java源码目录结构

JEECG中的Java源码目录结构如图112所示。

       图  114 JSP页面目录结构