从 0 开始实现一个 SpringBoot + Vue 项目

从 0 开始实现一个 SpringBoot + Vue 项目

软件和工具

• 后端开发软件：IntelliJ IDEA
• 前端开发软件：Visual Studio Code
• 后端框架：SpringBoot
• 后端语言：Java
• 前端框架：Vue

这是后面要用的妙妙小工具：

• 服务器连接工具：Termius
• 数据库：MySQL
• 数据库管理工具：Navicat Premium
• 数据库连接工具：MyBatis
• API 文档生成工具：Swagger
• API 文档美化工具：Knife4j
• UI 组件库：Element
• 网络请求库：Axios
• 字体处理库：Sfntly
• JSON 处理工具：Fastjson
• Java 工具库：Lombok

可以不必全部用这些来做，有很多类似的产品可以替代。

创建 SpringBoot 后端项目

首先我们打开 IDEA，点击新建项目，选择 Spring Initializr，然后在右侧填写项目名称，类型选择 Maven，JDK 版本选择1.8，如下图所示，然后点击下一步。

在新的页面中选择 SpringBoot 版本 3.0.2，引入一些依赖，点击创建。

后面在 pom.xml 中把 Java 版本改回 1.8，SpringBoot 版本改回 2.7.6。

项目结构：

可以看到 SpringBoot 的基础结构有三个文件：

• src/main/java 下的程序入口：DreamHouseApplication
• src/main/resources 下的配置文件：application.properties
• src/test 下的测试入口：DreamHouseApplicationTests

在运行类 DreamHouseApplication 同级目录下创建 controller、service、mapper、model 四个目录:

controller 层：控制层

• 作用是请求和响应控制。
• 负责前后端交互，接受前端请求，调用 service 层，接收 service 层返回的数据，最后返回具体的页面和数据到客户端。

service 层：业务逻辑层

• 作用是完成功能设计。
• 调用 mapper 层接口，接收 mapper 层返回的数据，完成项目的基本功能设计。

mapper 层：数据持久层，也被称为 dao 层

• 作用是访问数据库，向数据库发送 sql 语句，完成数据的增删改查任务。

model 层：数据库实体层，也被称为 entity 层、pojo 层

• 用于存储数据库中的数据，类属性与数据库表字段对应。
• 通常情况下，Model 层使用 ORM（对象关系映射）技术，如 JPA，MyBatis 等与数据库进行交互。

在项目目录中的 pom.xml 配置文件中引入本次项目中需要用到的相关依赖：

        <!--MyBatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

        <!--Swagger3-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

        <!--knife4j-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-ui</artifactId>
            <version>3.0.3</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <!--JSON-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.15</version>
        </dependency>

        <!--MySQL-->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>8.0.31</version>
            <scope>runtime</scope>
        </dependency>

        <!--Lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

将这些依赖放到<dependencies></dependencies>标签内，就接着 SpringBoot 自带的一些依赖下面就行了。

稍微解释一下这些依赖:

• Lombok：可以通过注解的方式为 Java 类生成许多常用的方法，例如 getter、setter、toString、equals 等，省去了手写这些方法的代码。

• Swagger：开源的 API 文档生成工具，可以根据代码中的注释自动生成 API 文档。

• Knife4j：用来美化 Swagger 生成的 API 文档。

• MyBatis：持久层框架，主要用于简化数据库操作，提高代码可读性，降低数据访问代码的维护难度，提高效率。

• MySQL：MySQL 官方提供的 Java 用的 JDBC 驱动，它允许 Java 程序通过 JDBC API 连接到 MySQL 数据库。

• JSON：用来将 json 数据序列化和反序列化的，主要是觉得 SpringBoot 自带的 json 工具不好用。

创建 MySQL 数据库

安装 MySQL 这里就不讲了，这里用 Navicat Premium 连接数据库。

填写连接名、主机IP、端口、用户名和密码等，然后点击连接。

可以先点测试连接，显示连接成功，在点确定。

连接上数据库之后，新建数据库–>新建表–>添加 id、ip、province、time、str、likes 六个字段。

表名为 dream，具体内容如下所示：

这里有两个细节：

1. id 要设置自动递增
2. likes 设置为无符号

友情链接：mysql自增navicat_navicat怎么设置主键自增

配置文件

让我们回到 SpringBoot，打开刚刚介绍到的配置文件 application.properties 进行项目配置：

server.port = 8087

spring.mvc.pathmatch.matching-strategy = ant_path_matcher

# Swagger
swagger.enabled = true

# MySQL
spring.datasource.url = jdbc:mysql:(服务器IP地址):3306/(数据库名)
spring.datasource.username = (用户名)
spring.datasource.password = (密码)
spring.datasource.driver-class-name = com.mysql.cj.jdbc.Driver

稍微解释一下：

• server.port：指定项目使用 8087 端口，默认 8080 端口。

• spring.mvc.pathmatch.matching-strategy：指定 Spring MVC 框架中 URL 路径匹配策略的实现类的类名，ant_path_matcher 是一种路径匹配策略，使用 Ant 风格的通配符来匹配 URL 路径。

• swagger.enabled：启用 Swagger 工具。

• spring.datasource.url：指定 MySQL 数据库的 URL。这里的服务器 IP 地址就是主机名，我的是 localhost（前面要带//），数据库名是 dreamhouse，完整格式：jdbc:mysql://localhost:3306/dreamhouse。

• spring.datasource.username：指定连接 MySQL 数据库使用的用户名。我的是 root。

• spring.datasource.password：指定连接 MySQL 数据库使用的密码。

• spring.datasource.driver-class-name：指定连接 MySQL 数据库使用的 JDBC 驱动程序的类名。

这里可能会有注释中文乱码问题，在设置中可以解决，全部换成 UTF-8：

友情链接：【SpringBoot2】读取配置application.properties文件乱码问题解决

第一次用要安装点驱动啥的，点一下就安装好了，没截到图。

配置好以后，可以测试连接：

也可以在 IDEA 看到数据库：

实现增删改查接口

Model 层

回顾一下 model 层：数据库实体层，也被称为 entity 层、pojo 层

• 用于存储数据库中的数据，类属性与数据库表字段对应。
• 通常情况下，Model 层使用 ORM（对象关系映射）技术，如 JPA，MyBatis 等与数据库进行交互。

在 model 目录下新建 Data 类：

package com.example.dream_house.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.model
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-17 16:29:49
 */
 
@lombok.Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel("数据库字段")
public class Data {
   

    @ApiModelProperty(value = "信息所属ID", required = true, example = "1")
    private int id;

    @ApiModelProperty(value = "信息来源IP地址", required = true, example = "127.0.0.1")
    private String ip;

    @ApiModelProperty(value = "信息来源所属省份", required = true, example = "广东")
    private String province;

    @ApiModelProperty(value = "内容发布时间", required = true, example = "2023-12-17 16:58:00")
    private String time;

    @ApiModelProperty(value = "梦想内容", required = true, example = "环游世界！")
    private String str;

    @ApiModelProperty(value = "点赞数", required = true, example = "52")
    private int likes;
}

接下来说一下这段代码中的各个注解的作用：

• @lombok.Data：这是 Lombok 框架提供的注解，它会自动生成 getter、setter、toString、equals、hashCode 等方法。使用该注解可以简化代码，并提高开发效率。

• @NoArgsConstructor：这也是 Lombok 提供的注解，它会生成一个无参构造器，可以避免手动编写无参构造器。这个注解常用于一些框架或工具的实例化。

• @AllArgsConstructor：同样是 Lombok 提供的注解，它会生成一个全参构造器，可以避免手动编写全参构造器。这个注解也常用于一些框架或工具的实例化。

• @ApiModel：这是 Swagger 框架提供的注解，用于描述一个模型类。这个注解的作用是将模型类描述为一个 API 文档的模型，可以通过该注解指定模型类的名称和描述信息。

• @ApiModelProperty：也是 Swagger 框架提供的注解，用于描述模型类中的属性信息。该注解可以设置属性的名称、描述、是否必需等信息，以便在 Swagger 生成的 API 文档中显示。

  • value：属性的描述信息，用于在 API 文档中显示该属性的作用。

  • required：属性是否必需。当该值为 true 时，表示该属性必须包含在请求中；当该值为 false 时，表示该属性可以为空或者不包含在请求中。

  • example：属性的示例值。用于在 API 文档中显示该属性的样例值，方便开发者理解该属性的类型和取值范围。

mapper 层

回顾一下 mapper 层：数据持久层，也被称为 dao 层

• 作用是访问数据库，向数据库发送 sql 语句，完成数据的增删改查任务。

在 mapper 目录下新建 DataMapper 接口：

package com.example.dream_house.mapper;

import com.example.dream_house.model.Data;
import org.apache.ibatis.annotations.*;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.mapper
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-17 16:36:57
 */

@Mapper
public interface DataMapper {
   

    /**
     * 信息来源IP地址
     * @param ip
     * 信息来源省份
     * @param province
     * 信息发出时间
     * @param time
     * 信息内容
     * @param str
     * 点赞数
     * @param likes
     *
     * @return
     */
    @Insert("insert into dream (4ip, province, time, str, likes) values(#{id}, #{ip}, #{province}, #{time}, #{str}, #{likes})")
    int insert(@Param("ip") String ip,
               @Param("province") String province,
               @Param("time") String time,
               @Param("str") String str,
               @Param("likes") int likes);

    /**
     * 信息id
     * @param id
     *
     * @return
     *
     * property属性对应Data对象中的成员名，column对应select出的字段名。
     */
    @Results({
   
            @Result(property = "id", column = "id"),
            @Result(property = "ip", column = "ip"),
            @Result(property = "province", column = "province"),
            @Result(property = "time", column = "time"),
            @Result(property = "str", column = "str"),
            @Result(property = "likes", column = "likes")
    })
    @Select("select * from dream where id = #{id}")
    Data findById(@Param("id") int id);

    /**
     * 用Data对象来作为传参,这样语句中的#{id}、#{ip}等数据就分别对应Data对象中的id和ip等属性。
     *
     * @param data
     */
    @Update("update dream set ip=#{ip}, province=#{province}, time=#{time}, str=#{str}, likes=#{likes} where id=#{id}")
    void update(Data data);

    /**
     * 删除该id对应的信息
     *
     * @param id
     */
    @Delete("delete from dream where id =#{id}")
    void delete(int id);

}

相关注解的作用：

• @Mapper：是 MyBatis 框架提供的注解，用于标记一个 Java 接口，该接口用于定义数据访问方法。在使用 @Mapper 注解后，MyBatis 会自动扫描该接口，为其创建一个代理对象。该代理对象可以将接口方法与 MyBatis 的 SQL 映射文件中的 SQL 语句进行绑定，并完成数据访问的操作。

• @Insert：也是 MyBatis 框架提供的注解，该注解的值为 SQL 语句，用于指定插入操作的具体逻辑。该 SQL 语句使用了预处理语句，从而避免了 SQL 注入的问题。

• @Param：

  • /** */中的内容是 JavaDoc（Java文档注释），它用于对方法进行说明、描述和文档化。

  • 在方法中的 @Param 注解用于指定参数的名称，以便在 SQL 语句中使用相应的占位符。

• @Results：用于定义从查询结果集中将查询结果映射为 Java 对象的过程。

• @Select：同样是 MyBatis 框架提供的注解，该注解的值为 SQL 语句，用于指定查询操作的具体逻辑。

• @Update：MyBatis 框架提供的注解，用于指定更新操作的 SQL 语句。

• @Delete：MyBatis 框架提供的注解，用于指定删除操作的 SQL 语句。

service 层

简单回顾一下 service 层：业务逻辑层

• 作用是完成功能设计。
• 调用 mapper 层接口，接收 mapper 层返回的数据，完成项目的基本功能设计。

在 service 目录下新建 DataService 类：

package com.example.dream_house.service;

import com.example.dream_house.mapper.DataMapper;
import com.example.dream_house.model.Data;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.service
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-17 17:04:45
 */

@Service
public class DataService {
   

    @Autowired
    private DataMapper dataMapper;

    /**
     * 新增信息
     *
     * @param ip
     * @param province
     * @param time
     * @param str
     * @param likes
     * @return
     */
    public String insert(String ip, String province, String time, String str, int likes) {
   
        dataMapper.insert(ip, province, time, str, likes);
        return "succeed";
    }

    /**
     * 查询id对应的信息
     *
     * @param id
     * @return
     */
    public Data findById(int id) {
   
        return dataMapper.findById(id);
    }

    /**
     * 更新信息
     *
     * @param data
     */
    public void update(Data data) {
   
        dataMapper.update(data);
    }

    /**
     * 删除id对应的信息
     *
     * @param id
     */
    public void delete(int id) {
   
        dataMapper.delete(id);
    }
}

相关注解的作用：

• @Service：用于标注一个类为 Spring 框架中的一个服务类，该类中通常包含了业务逻辑的实现。使用该注解可以使 Spring 框架自动扫描并将该类实例化，并将其作为服务类注册到容器中，以供其他组件使用。当我们需要在其他类中使用该服务类时，只需要通过依赖注入的方式获取该类的实例即可。

• @Autowired：用于实现 Spring 框架中的自动装配功能，将需要使用的 Bean 对象注入到指定的属性中。通过使用该注解，可以避免手动创建 Bean 实例和手动注入对象的麻烦。

controller 层

简单回顾一下 controller 层：控制层

• 作用是请求和响应控制。
• 负责前后端交互，接受前端请求，调用 service 层，接收 service 层返回的数据，最后返回具体的页面和数据到客户端。

在 controller 目录下新建 DataController 类：

package com.example.dream_house.controller;

import com.example.dream_house.model.Data;
import com.example.dream_house.service.DataService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.controller
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-17 17:17:36
 */

@Api(tags = "API接口")
@RestController
@CrossOrigin(origins = "*", maxAge = 3600)
public class DataController {
   
    @Autowired
    private DataService dataService;

    @ApiOperation("添加完整信息")
    @PostMapping("/insert")
    public String insert(@RequestBody Data data) {
   
        // @RequestBody注解用来绑定通过http请求中application/json类型上传的数据
        return dataService.insert(data.getIp(), data.getProvince(), data.getTime(), data.getStr(), data.getLikes());
    }

    @ApiOperation("查询id对应的信息")
    @GetMapping("/findById/{id}")
    public Data findById(@PathVariable int id) {
   
        return dataService.findById(id);
    }

    @ApiOperation("更新信息")
    @PutMapping("/update")
    public void update(@RequestBody Data data) {
   
        dataService.update(data);
    }

    @ApiOperation("删除指定id的信息")
    @DeleteMapping("/delete/{id}")
    public void deleteUser(@PathVariable int id) {
   
        dataService.delete(id);
    }

}

相关注解的作用：

• @Api：Swagger 的注解之一，用于对 API 接口进行注释和说明。tags 属性是 Swagger 文档中的一个重要属性，可以用来将 API 接口进行分类，方便管理和查找。

• @RestController：Spring MVC 中的注解之一，用于标识该类是一个基于 RESTful 风格的 Web 服务类。

• @CrossOrigin：Spring 中的一个注解，用于支持跨域请求。跨域请求通常指在一个域名下的页面中使用 AJAX 技术向不同的域名或端口号的 Web 服务发送请求。

• @ApiOperation：Swagger 的注解之一，用于对 API 接口中的具体操作进行注释和说明。

• @PostMapping：Spring MVC 中的注解之一，表示该方法接收 POST 请求。

• @RequestBody：Spring MVC 中的注解之一，表示该方法接收的请求参数为请求体中的数据。

• @GetMapping：Spring MVC 中的注解之一，表示该方法接收 GET 请求。

• @PathVariable：Spring MVC 中的注解之一，表示该方法接收的请求参数为路径参数。

• @PutMapping：Spring MVC 中的注解之一，表示该方法接收 PUT 请求。

• @DeleteMapping：Spring MVC 中的注解之一，表示该方法接收 DELETE 请求。

这里要引入 Spring Web，不然在使用这些注解的时候报错无法解析。

测试

预先设置一些数据库内容：

在把上面的四层架构都处理完之后，我们直接启动项目。

运行 DreamHouseApplication，或者运行它的 main 方法。

踩坑 1：Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstre

切换“跳过测试”模式：

友情链接：解决:Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstre

踩坑点2：Consider defining a bean of type ‘com.example.dream_house.mapper.DataMapper’ in your configuration.

18:10:27.233 [Thread-1] DEBUG org.springframework.boot.devtools.restart.classloader.RestartClassLoader - Created RestartClassLoader org.springframework.boot.devtools.restart.classloader.RestartClassLoader@6d1a5149

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.7.6)

2023-12-17 18:10:27.843  INFO 11824 --- [  restartedMain] c.e.dream_house.DreamHouseApplication    : Starting DreamHouseApplication using Java 1.8.0_192 on LAPTOP-P25TKBR2 with PID 11824 (C:\Users\81228\Documents\Program\Java Project\DreamHouse\dream_house\target\classes started by 81228 in C:\Users\81228\Documents\Program\Java Project\DreamHouse\dream_house)
2023-12-17 18:10:27.844  INFO 11824 --- [  restartedMain] c.e.dream_house.DreamHouseApplication    : No active profile set, falling back to 1 default profile: "default"
2023-12-17 18:10:27.975  INFO 11824 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
2023-12-17 18:10:27.975  INFO 11824 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : For additional web related logging consider setting the 'logging.level.web' property to 'DEBUG'
2023-12-17 18:10:29.551  WARN 11824 --- [  restartedMain] o.m.s.mapper.ClassPathMapperScanner      : No MyBatis mapper was found in '[com.example.dream_house]' package. Please check your configuration.
2023-12-17 18:10:30.264  INFO 11824 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8087 (http)
2023-12-17 18:10:30.265  INFO 11824 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : An older version [1.2.24] of the Apache Tomcat Native library is installed, while Tomcat recommends a minimum version of [1.2.30]
2023-12-17 18:10:30.265  INFO 11824 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : Loaded Apache Tomcat Native library [1.2.24] using APR version [1.7.0].
2023-12-17 18:10:30.265  INFO 11824 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : APR capabilities: IPv6 [true], sendfile [true], accept filters [false], random [true], UDS [false].
2023-12-17 18:10:30.265  INFO 11824 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : APR/OpenSSL configuration: useAprConnector [false], useOpenSSL [true]
2023-12-17 18:10:30.283  INFO 11824 --- [  restartedMain] o.a.catalina.core.AprLifecycleListener   : OpenSSL successfully initialized [OpenSSL 1.1.1g  21 Apr 2020]
2023-12-17 18:10:30.295  INFO 11824 --- [  restartedMain] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-12-17 18:10:30.295  INFO 11824 --- [  restartedMain] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.69]
2023-12-17 18:10:30.507  INFO 11824 --- [  restartedMain] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-12-17 18:10:30.507  INFO 11824 --- [  restartedMain] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 2531 ms
2023-12-17 18:10:30.645  WARN 11824 --- [  restartedMain] ConfigServletWebServerApplicationContext : Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'dataController': Unsatisfied dependency expressed through field 'dataService'; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'dataService': Unsatisfied dependency expressed through field 'dataMapper'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.example.dream_house.mapper.DataMapper' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
2023-12-17 18:10:30.651  INFO 11824 --- [  restartedMain] o.apache.catalina.core.StandardService   : Stopping service [Tomcat]
2023-12-17 18:10:30.679  INFO 11824 --- [  restartedMain] ConditionEvaluationReportLoggingListener : 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2023-12-17 18:10:30.751 ERROR 11824 --- [  restartedMain] o.s.b.d.LoggingFailureAnalysisReporter   : 

***************************
APPLICATION FAILED TO START
***************************

Description:

Field dataMapper in com.example.dream_house.service.DataService required a bean of type 'com.example.dream_house.mapper.DataMapper' that could not be found.

The injection point has the following annotations:
	- @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'com.example.dream_house.mapper.DataMapper' in your configuration.

解决方法：在 dataService.java 的 private DataMapper dataMapper; 的上面的@Autowired 改成 @Autowired(required = false)。

友情链接：Consider defining a bean of type问题解决

运行成功后，在浏览器中访问 http://127.0.0.1:8087/doc.html 页面，该页面是 Swagger 生成的 API 文档经过 knife4j 美化过后的 API 文档页面。

点击左侧的 “API接口” 可以看到出现了四个熟悉的接口，就是我们刚刚写的 “增删改查” 对应的接口，该 API 文档的好处就是可以在线对接口进行测试。

首先测试添加接口，依次点击并填写数据信息：

然后点击发送，看到响应内容 succeed 说明添加成功了：

我们前往 Navicat Premium 查看数据库内容有没有变化，刷新一下页面，可以看到在最下面的数据出现了我们刚刚添加进去的内容：

其次测试查询接口，依次点击并填写 id 信息，然后点击发送。

可以看到响应内容成功拿到数据：

然后测试更新接口，依次点击并填写信息，然后点击发送：

由于没有设置返回值，所以响应内容为空。

我们直接去看数据库的内容变化，刷新一下数据库，可以看到该条数据已经发生了变化：

最后测试删除接口，点击并填写 id 信息，然后点击发送：

由于没有设置返回值，所以还是直接前往数据库查看，刷新数据库，发现 id 为 4 的这条数据不见了，说明接口没问题：

经过测试，“增删改查”四个接口全部都能够正常使用。

实现项目功能接口

上面详细介绍了编写 “增删改查” 四个接口，下面给出其他项目功能接口。

代码

model 层之前写的一个 Data 的实体类就继续保留，我们再增加一个 getUser 类，用来作为前端从接口获取到的信息的类。

原理与 Data 类相同，这里就不再进行讲解了，直接上代码：

package com.example.dream_house.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.model
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-17 22:25:14
 */

@lombok.Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel("获取信息内容")
public class getUser {
   

    @ApiModelProperty(value = "信息所属ID", required = true, example = "1")
    private int id;

    @ApiModelProperty(value = "信息来源所属省份", required = true, example = "湖北")
    private String province;

    @ApiModelProperty(value = "梦想内容", required = true, example = "环游世界")
    private String str;

    @ApiModelProperty(value = "点赞数", required = true, example = "52")
    private int likes;

}

其实就是 Data 类去掉了 ip 和 time。

mapper 层我们需要在 DataMapper 接口中添加新的内容，新增的方法有：

• 查询点赞数前 50 名的信息。
• 查询最新的 50 条信息。
• 查询随机的 50 条信息。
• 更新指定 id 的点赞数 + 1。
• 更新指定 id 的点赞数 - 1。

方法的原理还是与之前相同，只是改变了 SQL 语句。

    /**
     * 查询点赞数前50名的信息
     */
    @Results({
   
            @Result(property = "id", column = "id"),
            @Result(property = "province", column = "province"),
            @Result(property = "str", column = "str"),
            @Result(property = "likes", column = "likes")
    })
    @Select("SELECT * FROM dream ORDER BY likes DESC LIMIT 50")
    List<getUser> findByLikes();

    /**
     * 查询最新的50条信息
     */
    @Results({
   
            @Result(property = "id", column = "id"),
            @Result(property = "province", column = "province"),
            @Result(property = "str", column = "str"),
            @Result(property = "likes", column = "likes")
    })
    @Select("SELECT * FROM dream ORDER BY time DESC LIMIT 50")
    List<getUser> findByTime();

    /**
     * 查询随机的50条信息
     */
    @Results({
   
            @Result(property = "id", column = "id"),
            @Result(property = "province", column = "province"),
            @Result(property = "str", column = "str"),
            @Result(property = "likes", column = "likes")
    })
    @Select("SELECT * FROM dream ORDER BY rand() DESC LIMIT 50")
    List<getUser> findByRand();

    /**
     * 更新指定id的点赞数+1
     */
    @Update("UPDATE dream SET likes = likes + 1 WHERE id = #{id}")
    void increaseLikesById(int id);

    /**
     * 更新指定id的点赞数-1
     */
    @Update("UPDATE dream SET likes = likes - 1 WHERE id = #{id}")
    void decreaseLikesById(int id);

service 层在这里增加的内容比较多，因为是业务逻辑层，需要完成功能设计。

首先在 service 目录下新建 getIP、getProvince、getTime 三个类，分别用来获取用户 IP 地址、用户所在省份、内容发送时间。

getIP 类代码如下，可以从用户的请求头中筛选出用户真实的IP地址：

package com.example.dream_house.service;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.service
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-18 09:12:22
 */
public class getIP {
   

    public String getIp(HttpServletRequest request, HttpServletResponse response) {
   
        response.setContentType("text/html;charset=utf-8");
        // 设置响应头允许ajax跨域访问，星号表示所有的异域请求都可以接受
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Methods", "GET,POST");
        return getIpAddr(request);
    }

    public String getIpAddr(HttpServletRequest request) {
   
        // 获取请求头"x-forwarded-for"对应的value
        String ip = request.getHeader("x-forwarded-for");
        // 如果获取的ip值为空
        if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
   
            // 则获取请求头"Proxy-Client-IP"对应的value
            ip = request.getHeader("Proxy-Client-IP");
        }
        // 如果获取的ip值仍为空
        if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
   
            //则获取请求头"WL-Proxy-Client-IP"对应的value
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        // 如果以上方式获取的ip值都为空
        if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
   
            //则直接获取ip地址
            ip = request.getRemoteAddr();
        }
        // 返回ip地址
        return ip;
    }
}

getProvince 类代码如下，可以调用外部 API 来检测出用户 ip 地址所属的省份：

package com.example.dream_house.service;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.service
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-18 09:23:34
 */
public class getProvince {
   

    /**
     * @param ip
     * @return
     */
    public String get_Province(String ip) {
   
        // 设置api的url
        String url = "https://ip.useragentinfo.com/json?ip=" + ip;

        RestTemplate template = new RestTemplate();

        // 发起一个HTTP GET请求，获取指定URL的响应实体，String.class表示要获取的响应实体的类型是字符串类型
        ResponseEntity<String> response = template.getForEntity(url, String.class);

        // 将Spring类型转换为JSON类型
        JSONObject json = JSON.parseObject(response.getBody());
        // 取出json中的数据
        String province = json.getString("province");

        return province;
    }
}

getTime 类代码如下，直接调用 Java 自带的包就行：

package com.example.dream_house.service;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @BelongsProject:dream_house
 * @BelongsPackage:com.example.dream_house.service
 * @Author:Uestc_Xiye
 * @CreateTime:2023-12-18 09:29:50
 */
public class getTime {
   

    public String get_Time() {
   
        // 设置日期格式
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        // 获取当前系统时间
        String date = simpleDateFormat.format(new Date());

        return date;
    }
}

接下来修改 DataService 类的内容，需要新增以下方法：

    /**
     * 获取用户数据并调用mapper层上传数据库
     *
     * @param request
     * @param response
     * @param str
     * @return
     */
    public String Add(HttpServletRequest request, HttpServletResponse response, String str) {
   

        getIP getIP = new getIP();
        getProvince getProvince = new getProvince();
        getTime getTime = new getTime();

        // 获取信息的IP地址
        String ip = getIP.getIp(request, response);
        // 获取信息所属省份
        String province = getProvince.get_Province(ip);
        // 获取当前时间
        String time = getTime.get_Time();
        // 设置当前点赞数为0
        int currentLikes = 0;
        // 上传数据
        dataMapper.insert(ip, province, time, str, currentLikes);

        return "succeed";
    }

    /**
     * 查询点赞数排名前50的信息
     *
     * @return
     */
    public List<getUser> findByLikes() {
   
        return dataMapper.findByLikes();
    }

    /**
     * 查询最新的50条信息
     *
     * @return
     */
    public List<getUser> findByTime() {
   
        return dataMapper.findByTime();
    }

    /**
     * 查询随机的50条信息
     *
     * @return
     */
    public List<getUser> findByRand() {
   
        return dataMapper.findByRand();
    }

    /**
     * 更新指定id对应的点赞数+1
     *
     * @param id
     * @return
     */
    public String increaseLikesById(int id) {
   
        dataMapper.increaseLikesById(id);

        return "succeed";
    }

    /**
     * 更新指定id对应的点赞数-1
     *
     * @param id
     * @return
     */
    public String decreaseLikesById(int id) {
   
        dataMapper.decreaseLikesById(id);

        return "succeed";
    }

controller 层需要新增以下接口：

    @ApiOperation("上传信息接口")
    @PostMapping("/Add/{str}")
    public String Add(HttpServletRequest request, HttpServletResponse response, @PathVariable String str) {
   
        return dataService.Add(request, response, str);
    }

    @ApiOperation("查询点赞数前50名的信息")
    @GetMapping("/findByLikes")
    public List<getUser> findByLikes() {
   
        return dataService.findByLikes();
    }

    @ApiOperation("查询最新的50条信息")
    @GetMapping("/findByTime")
    public List<getUser> findByTime() {
   
        return dataService.findByTime();
    }

    @ApiOperation("查询随机的50条信息")
    @GetMapping("/findByRand")
    public List<getUser> findByRand() {
   
        return dataService.findByRand();
    }

    @ApiOperation("更新指定id对应的点赞数+1")
    @PutMapping("/increaseLikesById/{id}")
    public String increaseLikesById(@PathVariable int id) {
   
        return dataService.increaseLikesById(id);
    }

    @ApiOperation("更新指定id对应的点赞数-1")
    @PutMapping("/decreaseLikesById/{id}")
    public String decreaseLikesById(@PathVariable int id) {
   
        return dataService.decreaseLikesById(id);
    }

测试

启动项目，访问 API 文档页面 http://127.0.0.1:8087/doc.html，可以看到我们编写的接口都在这里：