下载掌阅APP，畅读海量书库
立即打开
本书摒弃了传统的技术实战的写作方式，重点凸显了基于项目实战开发流程的编写，并在实际操作中引入了项目服务线上部署的流程。此外，本书还深入地介绍了目前备受欢迎且不断发展壮大的自动化部署技术。通过从零开始引导读者逐步构建项目，一直到项目成功上线，本书的目标是帮助读者真正掌握学习实践的技能。
一个项目的开发工作远超过一本书所能详尽描述的范畴，在这个过程中，需要进行大量的开发工作等，但本书的价值不仅局限于项目开发本身，更注重对项目开发流程的深入思考，并提供全面的项目开发流程体验。
本书以图书管理系统作为示例项目贯穿全书，涵盖了从项目的基础搭建一直到项目服务上线的整个开发流程。在后端开发方面，主要采用Spring Boot作为主要开发框架，而在后台管理系统页面的开发上，采用Vue作为开发语言；另外，小程序的开发选用了uni-app。全书详细呈现了相对完整的企业开发流程，包括版本管理、代码规范等开发实践，采用了前后端分离的架构，以满足当前企业开发的技术要求。
项目基础架构如图1-1所示。
图1-1 项目基础架构
本书涵盖了广泛的技术知识要点，其中大多数采用了当前企业主流的开发技术。对于具备一定基础的初级开发者而言，使用本书作为学习项目开发的参考资料将是一个极佳的选择。书中详尽地展现了项目开发的全过程，并提供了丰富的示例代码，这些示例代码可作为有力的指导，帮助读者逐步领悟项目构建过程，并提供解决问题的方法，以及可以结合以下学习方法进行学习。
（1）在着手编码前，先预览本书的结构目录，以深入理解项目的总体架构及基础概念。掌握项目所需技术的基础知识，并对项目的目标与功能要点有明晰的认知。
（2）仔细阅读所提供的示例代码，并尝试逐行剖析，学习每个代码块的功能和彼此之间的关联。如果对部分代码段存在疑问，则可参考书中的解释或查阅相关资料，进行深入学习与研究，这也是一种持续学习的过程。
（3）遵循书中的步骤和指导，逐一实现项目的各个功能模块。每个阶段完成后，确保项目在该阶段的功能得以正常运行，并进行充分测试与调试。
（4）力求将书中的示例代码与个人实际项目需求有机融合。学习将书中所涵盖的概念和技术嫁接至实际情境，从而更富深度地理解和掌握所学的技术知识。
（5）对于没有项目开发经验的初学者，建议从本书的第1章开始按部就班地跟随开发流程进行项目开发。书中流程详尽，当出现问题时，可参照本书提供的解决方法。代码可充当辅助材料，在出现问题时，首先检查代码与书中提供代码是否一致，以本书作为参考，找出错误并解决。
学习项目开发是一个获取项目经验的过程，包括学习与积累。切勿畏惧问题或失误，关键在于能够从错误中吸取知识，并找到解决问题的途径。持续的学习与实践是关键，相信你能够成功地完成本项目的开发。
本节将项目使用的一些技术知识做了部分总结，供学习和参考，如图1-2所示。
图1-2 技术梳理
在项目的开发过程中，遵循编码规范尤为重要，特别是在团队多人协作的情况下。事前明确一些开发规范是必要的，这对于项目代码的可维护性和后续迭代都有着积极影响。本节依据阿里巴巴Java开发文档规范，有选择性地定制了本项目的开发规范，这些规范仅适用于本项目，并不适用于所有项目开发场景。
Java的命名规范是编程中的重要部分，它有助于代码的可读性和可维护性。以下是Java类命名规范的一些基本准则。
（1）包名统一使用小写字母，点分隔符之间有且仅有一个自然语义的英语单词。变量、成员、方法名统一使用驼峰命名，例如userMap。
（2）类名的每个单词首字母大写，并使用UpperCamelCase风格，但以下情形例外：DO、BO、DTO、VO、AO、PO、UID等。
（3）接口实现类要有Impl标识。
（4）枚举类要加Enum后缀标识，枚举成员名称需要全部大写，单词用下画线隔开。
（5）工具类一般以Util或者Utils作为后缀。
（6）常量命名全部大写，单词间用下画线隔开，力求语义表达完整清楚。
Java注释规范是一种编程实践，用于在代码中添加注释以提高代码的可读性、可维护性和可理解性。以下是一些常见的Java注释规范。
（1）类、类属性、类方法的注释使用Javadoc规范，使用/**内容*/格式，不使用行注释，例如//xxx，代码如下：
（2）注释要简单明了，并在一些关键的业务逻辑上加注释说明。
（3）字段、属性加注释，代码如下：
（4）所有的枚举类型字段需要有注释，说明每个数据项的用途。
（5）常用在Javadoc注解中的几个参数如下。
①@author标明开发该类模块的作者。
②@version标明该类模块的版本。
③@param为对方法中某参数的说明。
④@return为对方法返回值的说明。
⑤@see为对类、属性、方法的说明参考转向。
遵循Java接口规范并提供一致性的API设计，可以显著减少前后端对接过程中的沟通问题，甚至在某些情况下，前端开发人员可以根据约定的规范快速上手后端接口，而无须详细的接口文档。
（1）接口请求地址要全部为小写字母，可以使用“_”分开。
（2）接口、方法的形参数量最多5个，如果超出，则可以使用JavaBean对象作为形参。
（3）本项目采用了“／业务模块／子模块／动作”形式的接口地址命名方式，而没有采用RESTful规范的URL命名方式。这是因为有时RESTful的URL结构可能不够直观，不容易一眼就理解接口的具体操作。
（4）在明确接口职责的条件下，尽量做到接口单一，即一个接口只做一件事，而非两件以上。
（5）接口基本访问协议：GET（获取）、POST（新增）、PUT（修改）和DELETE（删除）。
数据库设计规范是构建一个可靠、高效和可扩展数据库系统的关键部分，有助于满足业务需求并减少维护成本，以下是一些通用的数据库设计规范。
（1）数据库命名采用全小写字母，通过下画线进行分隔，同时推荐在命名中加入版本号等信息，以便进行区分。
（2）表名、字段名使用小写字母或数字，避免数字开头及两个下画线中间只出现数字的情况。结合本项目，所有的表名都以lib_开头。例如用户表：lib_user。
（3）表名不使用复数名词。
（4）表设计的字段加上注释，说明该字段的作用。此外，应注意避免使用数据库保留字作为字段名，以免引发潜在的冲突和错误。
（5）业务上具有唯一特性的字段，即使是多个字段的组合，也要建成唯一索引。
为了确保属性定义的一致性，先统一定义部分通用属性名称的数据类型，见表1-1。
表1-1 统一属性名称
本章介绍了项目的规划和基础架构，描述了如何通过本书学习项目开发，以及介绍了本书开发项目所使用的技术和一些日常的项目开发规范。