零基础认识java-后端项目结构搭建、目录概况

心已赠人 2024-03-16 11:49 46阅读 0赞

### 后端项目构建 ###

#### 1、创建数据库表 ####

![cff45d85b12941938c081f7c1c80447e.png][]

#### 2、创建项目 ####

打开 idea，新建一个项目，在 new 一个新项目的时候，选择 **Spring Initializr**，在选择项目依赖的时候勾选 **web**下的 Spring Web Starter 和 **SQL**下的 MySQL Driver 和 MyBatis Framework ，然后一直继续后会得到如下结构（总体分三层）。

![2b9591e77b23488389f04a99f20d1830.png][]

#### 3、配置文件 ####

1）application.properties

配置 **application.properties** 文件，用于连接数据库（代码见项目源码）。

2）generatorConfig.xml

利用 [MyBatis Generator][] 自动生成代码（实体类，Mapper接口和Mapper.xml文件），需要指定 **mysql-connector-java** （ `src/main/resources` 目录下）和生成文件的路径。在 `src/main/resources` 目录下创建 **generatorConfig.xml** 文件并配置（代码见项目源码）。

3）pom.xml

**pom.xml** 文件负责配置项目相关的依赖和插件，包括上面的 MyBatis Generator（项目plugins 标签中注视掉的代码是对 Mybatis-generator 插件的配置），在创建项目时，idea 已经帮我们引入了一些依赖，下面我们需要在 dependencies 标签中引入项目需要的一些依赖，配置的代码可以直接看代码，这里就不往出写了，下面对主要依赖进行下描述：

<table> 
 <thead> 
  <tr> 
   <th>package</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>mybatis-spring-boot-starter</td> 
   <td>MyBatis核心for Spring Boot</td> 
  </tr> 
  <tr> 
   <td>mysql-connector-java</td> 
   <td>java 与 mysql 连接的 jar 包驱动程序</td> 
  </tr> 
  <tr> 
   <td>fastjson</td> 
   <td>实现 json 对象与 JavaBean 对象的转换</td> 
  </tr> 
 </tbody> 
</table>

在 plugins 标签中对 Mybatis-generator 进行配置，用于自动生成代码。

至此，项目的配置就弄完了，在命令行执行 `./mvnw mybatis-generator:generate` 自动生成代码，得到的项目结构如下所示。此时会看到多生成了 **dao**、**domain**、**mapper** 目录及下面的文件。生成项目后，需要将上面 **pom.xml** 文件中 Mybatis-generator 插件的配置注视调，因为这个文件就是初始时候自动生成代码用的，如果不注视每次运行都会再生成一次，即覆盖之前的代码。![4c565f7e856d468dbf9093676d8e424f.png][]

#### 4、测试（以新建一个用户为例） ####

创建好项目之后先测试一下，首先在 `src/main/java/com/example/demo` 目录下创建 service 包，service 包下创建 ConsumerService 接口和 impl包，impl包下创建 ConsumerServiceImpl 类，具体创建这个干嘛下面写接口时候再介绍。

（1）ConsumerService 接口的代码如下

![b533b0f398044ccabdedadda73671c3e.png][]

ConsumerServiceImpl 类的代码如下![9e269ab028e14c49b82cc1201ba9cb04.png][]

（2）在 `src/main/java/com/example/demo` 下的 ConsumerMapper 接口中添加如下代码。![fa62881de76540828a345fcad7d99469.png][]

在 `src/main/resources/mapper` 下的 ConsumerMapper.xml 文件中将 insertSelective 改成 addUser![7822e9f559e149ad8df270f9a8efcaf6.png][]

（3）打开 SpringBoot 的启动类，加上 @MapperScan 注解，指向 dao 层接口所在的包路径。@MapperScan(“com.example.demo.dao”)

（4）然后在 `src/test/java/com/example/demo` 下的测试文件中写测试代码，如下，然后点如下所示运行，没有提示错误，且数据库中成功存入数据，说明项目构建成功，接下来就可以开始写接口了。![19baca023da9447cb796ef4666365f06.png][]

#### 5、开发接口（以返回所有用户信息为例） ####

在写接口之前，先对项目层次做一下介绍。项目层次我将主要根据 **domain**、 **DAO**、**Service**、**Controller** 这几层主要实现的功能和它们之间的联系进行介绍。

1）实体类（domain 目录下）

定义数据库表所对应的实体类。

2）Mapper 层 / DAO 层（dao、mapper 目录下）

数据操作层：向数据库发送 SQL 语句，完成数据库操作。

分为 Mapper 接口 和 Mapper 接口映射文件。 Mapper 接口在 dao 目录下，定义操作数据库的函数（函数不能直接去进行 CURD）， Mapper 接口映射文件在 mapper 目录下，完成对数据库的访问。

3）Service 层（service 目录下）

服务层：完成业务逻辑处理。调用 Mapper 层操作数据库。

分为 Service 接口 + Service 实现，用面向接口的编程思想，方便后续功能的解藕及扩展。

4）Controller 层（controller 目录下）

控制层：对请求和响应进行控制，调用 Service 层进行业务逻辑处理，最后将处理好的数据返回给前端。

5）实战（写一个返回所有用户信息的接口）

假如前端访问 [http://localhost:8888/allUser][http_localhost_8888_allUser] 就要拿到所有用户的信息，那么按照上面的层次我们可以这么写。

（1）访问的接口由 Controller 层来处理，所以这里这样定义，要返回所有用户信息，把它当一个命令，交给 Service 层去做。

![8bf29f745fc54c7c9122fbcf1226aa8a.png][] （2）到了 Service 层，Service 层的 ConsumerService 接口中先定义下面方法![d12083b44c184cdcaa82768e3cfc8558.png][]

然后在 ConsumerServiceImpl 类中这样去实现它。![5e512f52d40d467ababfa932caea02c6.png][]

（3）Service 层会让 dao 层的 ConsumerMapper 接口调 allUser 方法去返回数据，![74148b1061a04f6b8a9f860273c86e60.png][]

而 ConsumerMapper 接口操作数据库又要依赖 Mapper.xml 文件。![1fec38eb1a86431cb220c2cf79fdf50b.png][]

（4）这样，一个返回所有用户信息的接口就写完了，打开 Terminal 输入如下命令跑一下项目。如下所示

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>./mvnw spring-boot:run
</pre> </td> 
  </tr> 
 </tbody> 
</table>

![40519a53643749c3b1c7fc275a2c708c.png][]

在浏览器中输入 [http://localhost:8888/allUser][http_localhost_8888_allUser] 查看结果。![f9da94c081ca4e358d35e535d4d8eb92.png][]

知道一个接口怎么写，其他接口也类似，需要注意的地方有两点，第一个是解决跨域问题（可以查看代码 config 文件夹下面设置），第二个问题是关于静态资源的处理（这个就是最开始跑这个项目时候修改图片、音乐路径做的事情）。

6）总结

当前端要访问数据的时候后端就提供相应接口，接口的编写是通过 Controller 层监听请求， 数据的处理交给 Service 层，而 Service 层再通过 Mapper 层操作数据库，操作完成后数据再一层层往上走，最后返回给前端。

[cff45d85b12941938c081f7c1c80447e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/83e822a3e8d84fe8ba62c08002057574.png
[2b9591e77b23488389f04a99f20d1830.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/dbaf90dc2fc744008ff09d6793c5b7e7.png
[MyBatis Generator]: https://mapperhelper.github.io/docs/3.usembg/
[4c565f7e856d468dbf9093676d8e424f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/333b5416de664d8186e40393a059e795.png
[b533b0f398044ccabdedadda73671c3e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/d5722475368c45439017cf83c994a1aa.png
[9e269ab028e14c49b82cc1201ba9cb04.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/df3e2bd66f4c481bb8427982395d8f0c.png
[fa62881de76540828a345fcad7d99469.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/499edf56450e40408815323375746c46.png
[7822e9f559e149ad8df270f9a8efcaf6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/b50304cd8a0242d4b5af0d3fdae739b9.png
[19baca023da9447cb796ef4666365f06.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/6b78c4306e85450787929882fbb11d97.png
[http_localhost_8888_allUser]: http://localhost:8888/allUser
[8bf29f745fc54c7c9122fbcf1226aa8a.png]: https://img-blog.csdnimg.cn/8bf29f745fc54c7c9122fbcf1226aa8a.png
[d12083b44c184cdcaa82768e3cfc8558.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/4520d41c3b8244daa966d198cc828c6f.png
[5e512f52d40d467ababfa932caea02c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/b246206b1ad94c8680aa3d4e48cc079f.png
[74148b1061a04f6b8a9f860273c86e60.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/57dfef8fa7684416888a7997d5a6b61b.png
[1fec38eb1a86431cb220c2cf79fdf50b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/838fa56f687647f59cc71b3c1c876de7.png
[40519a53643749c3b1c7fc275a2c708c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/0b058089219b46a898d019e5abaede10.png
[f9da94c081ca4e358d35e535d4d8eb92.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/76e0692506c6480da58400068c369ca1.png