之前在新建基于Springboot+MyBatis-Plus+MySQL框架的项目时,都是照着网上的博文一步一步搭建的博客,但是总感觉搭建时会出现各种各样的问题,于是决定自己记录一下完整的搭建过程,方便以后新建项目时进行参考。
具体需要的工具如下:
- 一个配置好的MySQL数据库
- IDEA(申请的学生的免费版)
第一步:新建项目
如下图所示,选择Spring Initializr以创建基于Springboot框架的项目,示例项目使用的是。值得一提的是,组往往使用的是公司名,工件通常填的是组件名。
然后选择一些必要的依赖(以下仅为个人选择,可以根据实际需要进行添加)
以下便是创建完后的文件结构:.idea为IDEA编译需要的一些基本的文件,.mvn则为maven框架需要用的文件,src内部则为我们主要需要处理的项目代码,pom.xml里面的是本项目的相关配置信息。我们可以删除一些不必要的内容(红色框内)。
第二步:配置项目
首先我们之前在创建项目的时候仅仅添加了MyBatis框架,但是如果想要用MyBatis-Plus的话需要添加MyBatis-Plus的依赖,如果需要MyBatis的话直接去配置src/resources文件夹下的配置文件即可。
添加MyBatis-Plus需要到pom.xml里面添加依赖,然后重新加载maven。
现在MySQL中创建一个该项目的数据库,然后将src/resources文件夹下的application.properties改为application.yml,并在里面添加如下的配置信息:
(url格式为:jdbc:mysql://IP地址:端口号/数据库名?时区)
然后需要添加一个MyBatis-Plus的配置类:
第三步:实现与数据库的连接
完成上述配置后,就可以去实现相关的代码了。首先就是创建一个实体类,下面以查看用户信息为例:
1. 首先实现一个User实体类
2. 创建映射用的mapper层,MyBatis-Plus能自动处理映射关系,无需做更多的实现。
3. 实现service层的服务接口
4. 实现service/impl的代码
5. 由于在前端从后端中获取信息的时候,会有异常和正常情况无法区分的情况,例如:异常情况返回数据为null,正常情况下查询结果也为null,返回给前端无法区分,因此需要返回异常信息。而为了统一规范,通常需要设计一个result类用于返回。考虑到本文仅为框架搭建,因此先不做该层的处理。
6. 实现controller层的接口
7. 完成以上操作后,我们启动Application,再根据我们设置的url来进行查询,结果如下:
(前提是数据库有数据!)
总结
至此,一个基本的后端项目框架就搭建完毕了,其文件架构如下:
我们可以基于此开始实现各种各样的功能,完成后端的开发。可以发现,在上述过程中使用了相当多的注解来帮助实现框架的搭建,这个便是Springboot框架的特性,自动化完成许多任务,提高开发效率。这些注解的底层原理在这篇文章就先不展开来说了,后续有空再跟着Springboot的底层原理一起补上。