后端开拓实践系列——Spring Boot项目模板

在我的事变中，我从零开始搭建了不少软件项目，个中包括了基本代码框架和一连集成基本办法等，这些内容在火速开拓中凡是被称为“第0个迭代”要做的工作。可是，当项目运行了一段时刻之后再来反观，我总会发明一些不敷的处所，要么测试分类没有分好，要么根基的编码架子没有思量周全。

其它，我在事变中也会打仗到许多既有项目，公司内部和外部的都有，大都项目标编码实践我都是不满足的。好比，我曾经新插手一个项目标时辰，前前后后求教了3位同事才把该项目在当地运行起来;又好比在另一项目中，我发明前端哀求对应的Java类定名类型不同一，有被后缀为Request的，也有被后缀为Command的。

再者，事变了这么多年之后，我越来加倍明基本常识以及体系性进修的重要性。诚然，技能框架的成长使得我们可以快速地实现营业成果，可是当软件出了题目之后偶然却必要将各方面的常识交融意会并在大脑里综合回响才气找到办理思绪。

基于以上，我但愿清算出一套民众性的项目模板出来，旨在只管多地包括一般开拓之所需，镌汰开拓者的一再性事变以及提供一些最佳实践。对付后端开拓而言，我选择了当前被行业大量行使的Spring Boot，基于此清算出了一套民众的、基本性的实践方法，在团结了本身的履历以及其他项目标优越实践之后，总结出本文以飨开拓者。

本文以一个简朴的电商订单体系为例，源代码请会见：

• git clone https://github.com/e-commerce-sample/order-backend
• git checkout a443dace

所行使的技能栈首要包罗：Spring Boot、Gradle、MySQL、Junit 5、Rest Assured、Docker等。

第一步：从写好README开始

一份好的README可以给人以项目全景概览，可以使新人快速上手项目，可以低落雷同本钱。同时，README应该简明简要，层次清楚，提议包括以下方面：

• 项目简介：用一两句话简朴描写该项目所实现的营业成果;
• 技能选型：列出项目标技能栈，包罗说话、框架和中间件等;
• 当地构建：列出当地开拓进程中所用到的器材呼吁;
• 规模模子：焦点的规模观念，好比对付示例电商体系来说有Order、Product等;
• 测试计策：自动化测试怎样分类，哪些必需写测试，哪些没有须要写测试;
• 技能架构：技能架构图;
• 陈设架构：陈设架构图;
• 外部依靠：项目运行时所依靠的外部集成方，好比订单体系会依靠于会员体系;
• 情形信息：各个情形的会见方法，数据库毗连等;
• 编码实践：同一的编码实践，好比非常处理赏罚原则、分页封装等;
• FAQ：开拓进程中常见题目的解答。

必要留意的是，README中的信息也许跟着项目标演进而改变(好比引入了新的技能栈可能插手了新的规模模子)，因此也是必要一连更新的。固然我们知道，软件文档的一个痛点即是无法与项目现实盼望保持同步，可是就README这点信息来讲，照旧提议开拓者们不要小气那一点点敲键盘的时刻。

另外，除了保持README的一连更新，一些重要的架构抉择可以通过示例代码的情势记录在代码库中，新开拓者可以通过直接阅读这些示例代码快速相识项目标通用实践方法以及架构选择，请参考ThoughtWorks的技能雷达。

一键式当地构建

为了停止诸如前文中所提到的“求教了3位同事才当地构建乐成”的忧伤，为了镌汰“懒惰”的措施员们的手动操纵，也为了为全部开拓者提供一种同等的开拓体验，我们但愿用一个呼吁就可以完成全部的工作。这里，对付差异的场景我总结出了以下呼吁：

• 天生IDE工程：idea.sh，天生IntelliJ工程文件并自动打开IntelliJ
• 当地运行：run.sh，当地启动项目，自动启动当地数据库，监听调试端口5005
• 当地构建：local-build.sh，只有当地构建乐成才气提交接码

以上3个呼吁根基上可以完成一般开拓之所需，此时，对付新人的开拓流程大抵为：

1. 拉代替码;
2. 运行idea.sh，自动打开IntelliJ;
3. 编写代码，包括营业代码和自动化测试;
4. 运行run.sh，举办当地调试或须要的手动测试(本步调不是必须);
5. 运行local-build.sh，完成当地构建;
6. 再次拉代替码，担保local-build.sh乐成，提交接码。

究竟上，这些呼吁剧本的内容很是简朴，好比run.sh文件内容为：

#!/usr/bin/env bash 
./gradlew clean bootRun 

然而，这种显式化的呼吁却可以镌汰新人的惊骇感，由于他们只必要知道运行这3个呼吁就可以搞开拓了。其它，一个小小的细节：当地构建的local-build.sh呼吁原来可以重定名为更简朴的build.sh，可是当我们在呼吁行中行使Tab键自动补全的时辰，会发明自动补全到了build目次，而不是build.sh呼吁，并不利便，因此定名为了local-build.sh。细节虽小，可是却浮现了一个宗旨，即我们但愿给开拓者一种极简的开拓体验，我把这些看似微不敷道的对象称作是对措施员的“人文眷注”。

目次布局

Maven所倡导的目次布局当前已经成为究竟上的行业尺度，Gradle在默认环境下也回收了Maven的目次布局，这对付大都项目来说已经足够了。另外，除了Java代码，项目中还存在其他范例的文件，好比Gradle插件的设置、器材剧本和陈设设置等。无论怎样，项目目次布局的原则是简朴而有层次，不要随意地增进多余的文件夹，而且也必要实时重构。

在示例项目中，顶层只有2个文件夹，一个是用于安排Java源代码和项目设置的src文件夹，另一个是用于安排全部Gradle设置的gradle文件夹，另外，为了利便开拓职员行使，将上文提到的3个常用剧本直接放到根目次下：

└── order-backend 
    ├── gradle // 文件夹，用于安排全部Gradle设置 
    ├── src // 文件夹，Java源代码 
    ├── idea.sh //天生IntelliJ工程 
    ├── local-build.sh // 提交之前的当地构建 
    └── run.sh // 当地运行 

（编辑：湖南网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!