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

ゞ浴缸里的玫瑰 2022-05-28 13:54 247阅读 0赞

开发指南专题三：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所示。

![SouthEast][]

图111 JEECG配置文件目录结构

## 5.2. Java源码目录结构 ##

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

![SouthEast 1][]

图  114 JSP页面目录结构

[SouthEast]: /images/20220528/f04f1a2a13234aa29d3741b18d5949b3.png
[SouthEast 1]: /images/20220528/51c5ba0b366342eda23d58f332b371fa.png

发表评论取消回复

表情：

评论列表（有 0 条评论，247人围观）

还没有评论，来说两句吧...

相关阅读

相关项目开发中的编码规范

1.规范存在的意义：好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；好的编码规范可以改善软件

迈不过友情╰/ 2024年02月17日 14:38/ 0 赞/ 37 阅读

相关开发指南专题十七-JEECG图表配置说明

图表配置可以通过在线配置，无需编写代码生成图形报表页面。使用highcharts.js实现，可以运行在任何现代浏览器,包括移动终端以及IE6。目前支持曲线图、柱状图等基础报表。

╰+哭是因爲堅強的太久メ/ 2022年05月28日 13:56/ 0 赞/ 206 阅读

相关开发指南专题六：JEECG微云快速开发平台代码生成

开发指南专题六：JEECG微云快速开发平台代码生 1.1. 代码生成扫描路径配置用代码生成器生成代码后，需要进行相关配置配置，扫描注入control、serv

Dear 丶/ 2022年05月28日 13:55/ 0 赞/ 434 阅读

相关开发指南专题五：JEECG微云快速开发平台代码生成器

开发指南专题五：JEECG微云快速开发平台代码生成器 1.1. Maven开发环境搭建在搭建jeecg的maven开发环境之前，需要先配置好本机的mav

叁歲伎倆/ 2022年05月28日 13:55/ 0 赞/ 203 阅读

相关开发指南专题四：JEECG微云快速开发平台--JEECG开发环境搭建

开发指南专题四：JEECG微云快速开发平台开发环境搭建 1. JEECG开发环境搭建 JEECG推荐的开发环境为Myeclipse8.5/Ecl

灰太狼/ 2022年05月28日 13:54/ 0 赞/ 317 阅读

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

开发指南专题三：JEECG微云快速开发平台项目编码规范 4. 项目编码规范 4.1. 项目编码规范 1. 项目编码格式为UTF-8(包括:java,jsp

ゞ浴缸里的玫瑰/ 2022年05月28日 13:54/ 0 赞/ 248 阅读

相关开发指南专题二：JEECG微云快速开发平台JEECG框架初探

开发指南专题二：JEECG微云快速开发平台JEECG框架初探 2.JEECG框架初探 2.1演示系统打开浏览器输入JEECG演示

谁借莪１个温暖的怀抱￠/ 2022年05月28日 13:54/ 0 赞/ 290 阅读

相关开发指南专题一: JEECG微云快速开发平台前言

JEECG微云快速开发平台-前言 1. 前言 1.1. 技术背景随着WEB UI 框架(Ea

刺骨的言语ヽ痛彻心扉/ 2022年05月28日 13:54/ 0 赞/ 191 阅读

相关开发指南专题五：JEECG微云快速开发平台代码生成器

<table style="table-layout:fixed;width:756.8px;color:rgb(68,68,68);font-family:Tahoma, H

小咪咪/ 2022年05月28日 13:54/ 0 赞/ 342 阅读

相关 JEECG_v3基于代码生成器快速开发平台简介

![online_member.gif][] 发表于 2013-3-2 12:35:02 | [只看该作者][Link 1] | [倒序浏览][Link 2] <tab

逃离我推掉我的手/ 2022年05月28日 13:54/ 0 赞/ 326 阅读