Springboot + SpringData Jpa搭建最简单的后台接口服务

前言

如果你想以最快的速度搭建一个后台的CRUD接口服务，SpringBoot+SpringData Jpa无疑是最好的选择，无需写sql即可完成基本的增删改查，方便快捷，下面我来给大家打个样演示一下。

常用软件下载链接（包括 IDEA、Mysql、JDK、Navicat等）：https://www.jianguoyun.com/p/Dc5ht0AQ4_2rCRirw-kD

本文代码下载地址：https://www.jianguoyun.com/p/DcfqSzgQnZWTChjb2qUE

创建工程

使用IDEA创建Springboot工程

sql

使用Mysql，创建 t_user表，DDL如下：

CREATE TABLE `t_user` (
  `id` int NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `age` int DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
)

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo1</name>
    <description>demo</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <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>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <!-- 热部署工具 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

application.yml

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test  # 你需要自己新建一个名字叫 test的数据库，并且运行上面的sql创建表 t_user
    username: root
    password: #填写你自己的数据库密码

User.java

package com.example.demo.entity;

import lombok.Data;

import javax.persistence.*;

@Data // lombok插件注解，相当于自动生成了 User的Get和Set方法
@Table(name = "T_USER")  // @Table注解指定此实体类对应的数据库名称
@Entity // 此注解标识这是一个 Entity，即映射数据库的实体类
public class User {

    @Id  // @Id标识这是主键
    @GeneratedValue(strategy = GenerationType.IDENTITY)  // 表示主键是数据库自动生成的，无需自己设置
    private Integer id;
    // name属性对应数据库的name字段，如果属性名字和数据库字段名称不同，可以使用 @Column 注解进行映射，如果相同，则无需 @Column注解
    @Column(name = "name")
    private String name;

    private Integer age;

    private String address;

}

数据接口UserRepository.java

package com.example.demo.repository;

import com.example.demo.entity.User;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;

public interface UserRepository extends JpaRepository<User, Integer> {

    @Query("select u from User u where u.name like %?1% and u.address like %?2%")
    Page<User> selectPage(String name, String address, Pageable pageable);

    Page<User> findAllByNameLikeAndAddressLike(String name, String address, Pageable pageable);
}

Web接口UserController.java

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.springframework.data.domain.*;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;

/**
 * 用户crud Controller
 */
@RestController
@RequestMapping("/user")
public class UserController extends BaseController{

    @Resource
    private UserRepository userRepository;

    /**
     * 新增或者更新，根据user对象是否有id来判断是新增还是更新
     * @param user user对象
     * @return 操作结果
     */
    @PostMapping
    public boolean save(@RequestBody User user) {
        userRepository.save(user);
        return true;
    }

    /**
     * 批量新增/更新
     * @param users user数组, example:
     * [
     *     {
     *     "name": "孙悟空",
     *     "age": 1000,
     *     "address": "花果山"
     *     },
     *     {
     *     "name": "猪八戒",
     *     "age": 800,
     *     "address": "高老庄"
     *     }
     * ]
     * @return 操作结果
     */
    @PostMapping("/batch")
    public boolean saveBatch(@RequestBody List<User> users) {
        userRepository.saveAll(users);
        return true;
    }

    /**
     * 根据id删除用户
     * @param id 参数id
     * @return 操作结果
     */
    @DeleteMapping("/{id}")
    public boolean delete(@PathVariable Integer id) {
        try {
            userRepository.deleteById(id);
        } catch (Exception e) {  // 删除的时候，如果发现没有这个id，会报错，这里我们catch一下错误，让他通过
            System.out.println(e.getMessage());
        }
        return true;
    }

    /**
     * 根据id批量删除用户
     * @param ids 参数id数组, example: [1,2,3]
     * @return 操作结果
     */
    @DeleteMapping("/batch")
    public boolean deleteBatch(@RequestBody List<Integer> ids) {
        for (Integer id : ids) {
            try {
                userRepository.deleteById(id);
            } catch (Exception e) {  // 删除的时候，如果发现没有这个id，会报错，这里我们catch一下错误，让他通过
                System.out.println(e.getMessage());
            }
        }
        return true;
    }

    /**
     * 根据id查询用户信息
     * @param id 参数id
     * @return User对象
     */
    @GetMapping("/{id}")
    public User getById(@PathVariable Integer id) {
        return userRepository.findById(id).orElse(null);
    }

    /**
     * 查询所有数据
     * @return userList
     */
    @GetMapping
    public List<User> list() {
        return userRepository.findAll();
    }

    /**
     * 分页查询 方式1：使用Jpa原生的api
     * 多条件查询
     * @param pageNum 当前页
     * @param pageSize 页码
     * @param name 查询条件：名称
     * @param address 查询条件：地址
     * @return Page User
     *
     * 返回的数据很多，我们所需要的数据只要下面2个：content表示查询结果list，totalElements表示查询结果总数
     * {
     *     "content": [],
     *     "totalElements": 2
     * }
     */
    @GetMapping("/page")
    public Page<User> findPage(@RequestParam(required = false, defaultValue = "1") Integer pageNum,
                               @RequestParam(required = false, defaultValue = "10") Integer pageSize,
                               @RequestParam(required = false, defaultValue = "") String name,
                               @RequestParam(required = false, defaultValue = "") String address) {
        return userRepository.findAllByNameLikeAndAddressLike(wrapStrLike(name), wrapStrLike(address),
                PageRequest.of(pageNum - 1, pageSize, Sort.by(Sort.Order.desc("id"))));
    }

    /**
     * 分页查询 方式2：使用 HQL语言查询
     * 多条件查询
     * @param pageNum 当前页
     * @param pageSize 页码
     * @param name 查询条件：名称
     * @param address 查询条件：地址
     * @return Page User
     *
     * 返回的数据很多，我们所需要的数据只要下面2个：content表示查询结果list，totalElements表示查询结果总数
     * {
     *     "content": [],
     *     "totalElements": 2
     * }
     */
    @GetMapping("/page2")
    public Page<User> findPage2(@RequestParam(required = false, defaultValue = "1") Integer pageNum,
                                @RequestParam(required = false, defaultValue = "10") Integer pageSize,
                                @RequestParam(required = false, defaultValue = "") String name,
                                @RequestParam(required = false, defaultValue = "") String address) {
        return userRepository.selectPage(name, address, PageRequest.of(pageNum - 1, pageSize, Sort.by(Sort.Order.desc("id"))));
    }


}

BaseController.java

package com.example.demo.controller;

public class BaseController {

    // 模糊查询，全模糊
    protected String wrapStrLike(String str) {
        if (str == null) str = "";
        return "%" + str + "%";
    }

    // 模糊查询  前缀模糊
    protected String wrapStrLikePrefix(String str) {
        if (str == null) str = "";
        return "%" + str;
    }

    // 模糊查询 后缀模糊
    protected String wrapStrLikeSuffix(String str) {
        if (str == null) str = "";
        return str + "%";
    }

}

启动类DemoApplication.java

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

工程结构

演示

1. 使用Postman测试分页查询接口：

2. 新增测试

3. 更新测试

4. 根据id查询测试

5. 根据id删除

6. 批量新增或者更新

7. 批量删除