SpringBoot+Vue.js+uni-app全栈开发（第1章 项目简介）（下）

💁‍♂️ 作者简介：码上言


📒 出版书：《Spring Boot + Vue.js + uni-app全栈开发》


✅ 专栏内容：个人博客系统


👉 微信公众号：码上言 👈

承接上篇文章

1.4 开发规范

在项目开发过程中，遵循编码规范显得尤为重要，特别是在团队多人协作的情况下。事前明确一些开发规范是必要的，这对于项目代码的可维护性和后续迭代都有着积极影响。本节依据阿里巴巴Java开发文档规范，有选择性的定制了本项目的开发规范，这些规范仅适用于本项目，并不适用于所有项目开发场景。

1.4.1 命名规范

Java的命名规范是编程中的重要部分，它有助于代码的可读性和维护性。以下是Java类命名规范的一些基本准则。

(1) 包名统一使用小写字母，点分隔符之间有且仅有一个自然语义的英语单词。变量、成员、方法名统一使用驼峰命名，例如：userMap。

(2) 类名的每个单词首字母大写，并使用UpperCamelCase风格，但以下情形例外：DO、BO、DTO、VO、AO、PO、UID 等。

(3) 接口实现类要有Impl标识。

(4) 枚举类要加Enum后缀标识，枚举成员名称需要全部大写，单词用下划线隔开。

(5) 工具类一般以Util或者Utils作为后缀。

(6) 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚。

1.4.2 注释

Java注释规范是一种编程实践，用于在代码中添加注释以提高代码的可读性、维护性和理解性。以下是一些常见的Java注释规范。

(1) 类、类属性、类方法的注释使用 Javadoc 规范，使用/*内容/格式，不使用行注释，例如：// xxx，代码如下：

/**
 * Java类注释
 * 
 * @author test
 * @since 2023-09-19
 */
public class ExampleClass {
    // 类的代码
}

(2) 注释要简单明了，并在一些关键的业务逻辑上加注释说明。

(3) 字段、属性加注释，代码如下：

	/**
     * 用户账号
     */
    private String username;

(4) 所有的枚举类型字段需要有注释，说明每个数据项的用途。

(5) 常用在Javadoc注解中的几个参数如下。

① @author标明开发该类模块的作者。

② @version标明该类模块的版本。

③ @param为对方法中某参数的说明。

④ @return为对方法返回值的说明。

⑤ @see为对类、属性、方法的说明参考转向。

1.4.3 接口规范

遵循Java接口规范并提供一致性的API设计，可以显著减少前后端对接过程中的沟通问题，甚至在某些情况下，前端开发人员可以根据约定的规范快速上手后端接口，而无需详细的接口文档。

(1) 接口请求地址要全部为小写字母，可以使用“_”分开。

(2) 接口、方法的形参数量最多5个，超出可以使用JavaBean对象作为形参。

(3) 本项目采用了“/业务模块/子模块/动作”形式的接口地址命名方式，而没有采用RESTful规范的URL命名方式。这是因为有时候，RESTful的URL结构可能不够直观，不容易一眼就理解接口的具体操作。

(4) 在明确接口职责的条件下，尽量做到接口单一，即一个接口只做一件事，而非两件以上。

(5) 接口基本访问协议：get(获取)、post(新增)、put(修改)和delete(删除)。

1.4.4 数据库设计规范

数据库设计规范是构建一个可靠、高效和可扩展数据库系统的关键部分，有助于满足业务需求并减少维护成本，以下是一些通用的数据库设计规范。

(1) 数据库命名采用全小写字母，通过下划线进行分隔，同时推荐在命名中加入版本号等信息，以便进行区分。

(2) 表名、字段名使用小写字母或数字，避免数字开头以及两个下划线中间只出现数字的情况。结合本项目，所有的表名都以lib_开头。例如用户表：lib_user。

(3) 表名不使用复数名词。

(4) 表设计的字段加上注释，说明该字段的作用。此外，应注意避免使用数据库保留字作为字段名，以免引发潜在的冲突和错误。

(5) 业务上具有唯一特性的字段，即使是多个字段的组合，也要建成唯一索引。

1.4.5 字典规范

为了确保属性定义的一致性，先统一定义部分通用属性名称的数据类型，见表1-1。

本章小结

本章介绍了项目的规划和基础架构，描述了如何通过本书学习项目开发，以及介绍了本书开发项目所使用的技术和一些日常的项目开发规范。