项目/代码规范与Apifox介绍使用

目录

目录

一、项目规范：

（一）项目结构：

（二）传送的数据对象体

二、代码规范：

（一）数据库命名规范：

（二）注释规范：

（三）命名规范：

（四）前后端规范：

（五）其他规范：

三、Apifox使用：

（一）下载与安装：

（二）新建项目与邀请你的队友：

（三）接口文档的书写规范

四、Debug功能（后端必须要会）

五、测试类

六、注意事项：

（一个人是打不了江山的！！！）

---

一、项目规范：

（一）项目结构：

其中具体的：

（1）Entity层：实体层，就是存放具体的对象实体，与数据库中的对象相对应。

（2）DAO层：（可以细分两层（dao的接口层与dao的实现层））就是与数据库进行交互的层，涉及到一些数据库的增删改查操作。

（3）Service层（可以细分两层（service的接口层与service的实现层））：主要负责业务模块的逻辑应用设计。

（4）Controller层：Controller层负责具体的业务模块流程的控制，controller层负责前后端交互，接受前端请求，调用service层，接收service层返回的数据，最后返回具体的页面和数据到客户端。

（5）Util层：工具层，放置常用的工具类，比如可以把一些通用的方法写成一个util的函数，然后可以简化整体的代码。

（6）Exception层：可以写一下统一的返回异常层。

（7）Filter层：过滤层，比如统一过滤一下身份验证，如果没有过滤通过，则只是游客模式。

（二）传送的数据对象体

DTO就是前端发送请求传来的数据结构体。

VO就是后端针对前端发送的请求进行返回的响应。

PO就是对象实体和数据库对象这个表的实际对应关系。

BO就是在业务处理过程中的对象实体。

二、代码规范：

要英文命名，不要汉语拼音。

要通俗易懂，不要花里胡哨。

要驼峰命名，不要平平范范。

要间隔换行，不要大段书写。

要注释注解，不要个人主义。

Java语言编码规范 - Java语言编码规范(中文版) - 在线文档 - JAVA 编程资料牛鼻站 (javanb.com)http://doc.javanb.com/code-conventions-for-the-java-programming-language-zh/index.html#312

不要用关键字、保留字等在java本身有特殊含义的 命名！！！

（一）数据库命名规范：

（1）表名是唯一的，不能多个表命名使用同一个名称。

（2）表名采用小写字母和下划线的组合形式，尽量避免使用大写字母或特殊字符，含义清晰，使用“user_info”类似这种,或者“tbl_user”,"tbl_user_info"这种。 

（3）不要与关键字冲突，禁用保留字，如 like、desc、range、match、delayed 等，请参考 MySQL 官方保留字。 

（4）数据库字段名：采用26个英文字母(区分大小写)加上下划线'_'组成，例如“user_id","user_name","user_password","user_register_time","user_login_time".

（5）主外键规范：

主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。

说明： pk_即 primary key；uk_即 unique key；idx_即 index 的简称。

主键：pk_+表名
例如：pk_main
外键：fk_+从表名+_+主表名
例如：fk_sub_main

（6）小数类型为 decimal，禁止使用 float 和 double。

（7）表必备三字段：id，create_time，update_time。

（二）注释规范：

（1）类注释：

   类注释(Class)主要用来声明该类用来做什么，以及创建者、创建日期版本、包名等一些信息:

/**
 * @version: V1.0
 * @author: fendo
 * @className: user
 * @packageName: user
 * @description: 这是用户类
 * @data: 2024-07-01 12:20
 **/

(2)方法注释(Constructor)：

      方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 /* */

注释，注意与代码对齐。所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数异常说明 外，还必须指出该方法做什么事情，实现什么功能。 方法注释(Constructor)还可以用来声明该类的参数、返回等信息:

/**
* @author:  fendo
* @methodsName: addUser
* @description: 添加一个用户
* @param:  xxxx
* @return: String
* @throws: 
*/

（3）代码块注释：解释你某一部分代码的用途

/**
 * 实例化一个用户
 * xxxxxxx
 */
User user=new User();

（4）单句注释：注释你单独的代码

User user=new User(); //实例化一个用户

（三）命名规范：

命名要让别人能看懂，驼峰命名，区分大小写。

（1）类名使用 UpperCamelCase 风格：

例如：UserController，FileController，BookService

（2）方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。

例如：getUserName(),userLogin(),getMessage();

（3）常量命名应该全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

例如：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

（4）抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾，测试类命名以它要 测试的类的名称开始，以 Test 结尾。

（5）包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数 形

式，但是类名如果有复数含义，类名可以使用复数形式。

（6）Service / DAO 层方法命名规约：

1）获取单个对