Spring Boot CrudRepository 示例

原创 已于 2022-05-10 13:11:28 修改 · 1.4k 阅读 · 3 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
标签
#java #spring #开发语言
于 2022-05-10 13:03:13 首次发布
本文详细介绍了SpringBoot的特性，如避免XML配置、简化REST端点创建及内置Tomcat服务器。重点讲解了如何利用CrudRepository进行CRUD操作，包括save、findById、findAll、count和deleteById等方法，并通过一个示例展示了如何在SpringBoot项目中集成H2数据库、创建实体、定义存储库接口、服务和控制器。

Spring Boot 建立在 Spring 之上，包含了 Spring 的所有特性。并且由于其快速的生产就绪环境使开发人员能够直接专注于逻辑而不是为配置和设置而苦苦挣扎，如今它正成为开发人员的最爱。Spring Boot 是一个基于微服务的框架，在其中制作可用于生产的应用程序只需要很少的时间。以下是 Spring Boot 的一些特性：

  • 它允许避免在 spring 中存在的 XML 的繁重配置
  • 它提供易于维护和创建 REST 端点
  • 它包括嵌入式 Tomcat 服务器
  • 部署非常简单，war和jar文件可以轻松部署在tomcat服务器中

更多信息请参考这篇文章：Spring Boot 简介。在本文中，我们将讨论如何使用 CrudRepository 来管理 Spring Boot 应用程序中的数据。

Crud存储库 

Spring Boot 中有一个名为 CrudRepository 的接口，其中包含用于 CRUD 操作的方法。它在存储库上提供通用的 Crud 操作。它在包org.springframework.data.repository中定义，它扩展了 Spring Data Repository接口。如果有人想在 Spring Boot 应用程序中使用 CrudRepository，他/她必须创建一个接口并扩展 CrudRepository 接口。 

句法： 

public interface CrudRepository<T, ID> extends Repository<T, ID>

在哪里：

  • T：存储库管理的域类型（通常是实体/模型类名）
  • ID：存储库管理的实体的 ID 类型（通常是在 Entity/Model 类中创建的 @Id 的包装类）

插图：

public interface DepartmentRepository extends CrudRepository<Department, Long> {}

现在让我们讨论一下 CrudRepository 中可用的一些最重要的方法，如下所示：

方法一：save()：保存给定的实体。使用返回的实例进行进一步的操作，因为保存操作可能已经完全改变了实体实例。

句法：

 <S extends T> S save(S entity)
  • 参数：实体——不能为空。
  • 返回：保存的实体；永远不会为空。
  • 抛出： IllegalArgumentException - 如果给定实体为空。

方法 2： findById()：通过 id 检索实体。

句法：

Optional<T> findById(ID id)
  • 参数： id - 不能为空。
  • 返回：具有给定 id 的实体，如果没有找到，则返回 Optional#empty()。
  • 抛出异常：如果“id”为空，则抛出 IllegalArgumentException。

方法三：findAll()：返回该类型的所有实例。

句法： 

Iterable<T> findAll()

返回类型：所有实体

方法四： count()：返回可用实体的数量。

句法：

long count()

返回类型：实体的数量。

方法 5： deleteById()： 删除具有给定 id 的实体。

句法：

void deleteById(ID id)

参数：Id（不能为空）

抛出异常：如果给定的 id 为空，则发生IllegalArgumentException。

例子

以下 Spring Boot 应用程序使用 CrudRepository 管理 Department 实体。数据保存在 H2 数据库中。我们使用 RESTful 控制器。

第一步：参考这篇文章如何使用 IntelliJ IDEA创建 Spring Boot 项目并创建一个 Spring Boot 项目。 

第二步：添加以下依赖

  • 春季网络
  • H2 数据库
  • 龙目岛
  • 春季数据 JPA

下面是pom.xml文件的完整代码。请检查您是否遗漏了什么。

  • XML

<?xml version="1.0" encoding="UTF-8"?>
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.amiya</groupId>
    <artifactId>Spring-Boot-Demo-Project</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>Spring-Boot-Demo-Project</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>11</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
  
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
  
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
  
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
  
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
  
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </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>

第 3 步：创建 4 个包并在这些包中创建一些类和接口，如下图所示

  • 实体
  • 存储库
  • 服务
  • 控制器

注意：

  • 绿色圆形图标“I”按钮是界面
  • 蓝色圆形图标“C”按钮是类

第 4 步：在实体包内

在 Department.java 文件中创建一个简单的POJO 类。下面是Department.java文件的代码

  • 爪哇

package com.amiya.springbootdemoproject.entity;
  
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
  
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
  
@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class Department {
  
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long departmentId;
    private String departmentName;
    private String departmentAddress;
    private String departmentCode;
}

第 5 步：在存储库包中

创建一个简单的接口并将接口命名为 DepartmentRepository。正如我们上面讨论 的那样，这个接口将扩展CrudRepository 。

  • 爪哇

// Java Program to Illustrate DepartmentRepository.java File
  
// Importing package module to this code
package com.amiya.springbootdemoproject.repository;
// Importing required classes
import com.amiya.springbootdemoproject.entity.Department;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;
  
// Annotation
@Repository
  
// Class
public interface DepartmentRepository
    extends CrudRepository<Department, Long> {
}

第 6 步：在服务包内

在包中创建一个名为 DepartmentService 的接口和一个名为DepartmentServiceImpl的类。下面是DepartmentService.java文件的代码。

示例 1-A

  • 爪哇

package com.amiya.springbootdemoproject.service;
  
import com.amiya.springbootdemoproject.entity.Department;
  
import java.util.List;
  
public interface DepartmentService {
    // save operation
    Department saveDepartment(Department department);
  
    // read operation
    List<Department> fetchDepartmentList();
  
    // update operation
    Department updateDepartment(Department department, Long departmentId);
  
    // delete operation
    void deleteDepartmentById(Long departmentId);
}

示例 1-B 

  • 爪哇

// Below is the code for the DepartmentServiceImpl.java file.
package com.amiya.springbootdemoproject.service;
  
import com.amiya.springbootdemoproject.entity.Department;
import com.amiya.springbootdemoproject.repository.DepartmentRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
  
import java.util.List;
import java.util.Objects;
  
@Service
public class DepartmentServiceImpl implements DepartmentService{
  
    @Autowired
    private DepartmentRepository departmentRepository;
  
    // save operation
    @Override
    public Department saveDepartment(Department department) {
        return departmentRepository.save(department);
    }
  
    // read operation
    @Override
    public List<Department> fetchDepartmentList() {
        return (List<Department>) departmentRepository.findAll();
    }
  
    // update operation
    @Override
    public Department updateDepartment(Department department, Long departmentId) {
        Department depDB = departmentRepository.findById(departmentId).get();
  
        if (Objects.nonNull(department.getDepartmentName()) && !"".equalsIgnoreCase(department.getDepartmentName())) {
            depDB.setDepartmentName(department.getDepartmentName());
        }
  
        if (Objects.nonNull(department.getDepartmentAddress()) && !"".equalsIgnoreCase(department.getDepartmentAddress())) {
            depDB.setDepartmentAddress(department.getDepartmentAddress());
        }
  
        if (Objects.nonNull(department.getDepartmentCode()) && !"".equalsIgnoreCase(department.getDepartmentCode())) {
            depDB.setDepartmentCode(department.getDepartmentCode());
        }
  
        return departmentRepository.save(depDB);
    }
  
    // delete operation
    @Override
    public void deleteDepartmentById(Long departmentId) {
        departmentRepository.deleteById(departmentId);
    }
  
}

第 7 步：在控制器包内

在包中创建一个名为DepartmentController的类。

  • 爪哇

// Java Program to Illustrate DepartmentController File
  
// Importing package module
package com.amiya.springbootdemoproject.controller;
// Importing required classes
import com.amiya.springbootdemoproject.entity.Department;
import com.amiya.springbootdemoproject.service.DepartmentService;
import java.util.List;
import javax.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
  
// Annotation
@RestController
  
// Class
public class DepartmentController {
  
    // Annotation
    @Autowired private DepartmentService departmentService;
  
    // Save operation
    @PostMapping("/departments")
    public Department saveDepartment(
        @Valid @RequestBody Department department)
    {
  
        return departmentService.saveDepartment(department);
    }
  
    // Read operation
    @GetMapping("/departments")
    public List<Department> fetchDepartmentList()
    {
  
        return departmentService.fetchDepartmentList();
    }
  
    // Update operation
    @PutMapping("/departments/{id}")
    public Department
    updateDepartment(@RequestBody Department department,
                     @PathVariable("id") Long departmentId)
    {
  
        return departmentService.updateDepartment(
            department, departmentId);
    }
  
    // Delete operation
    @DeleteMapping("/departments/{id}")
    public String deleteDepartmentById(@PathVariable("id")
                                       Long departmentId)
    {
  
        departmentService.deleteDepartmentById(
            departmentId);
        return "Deleted Successfully";
    }
}

第 8 步：下面是 application.properties 文件的代码

server.port = 8082

# H2 Database
spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:dcbapp
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

现在运行您的应用程序，让我们在 Postman 中测试端点并参考我们的 H2 数据库。

在 Postman 中测试端点

端点 1： POST – http://localhost:8082/departments/

端点 2： GET - http://localhost:8082/departments/

端点 3： PUT - http://localhost:8082/departments/1

端点 4：删除 - http://localhost:8082/departments/1

H2 数据库如下图所示

 
allway2
关注
SpringData核心数据访问接口--CrudRepository示例代码
07-18
SpringData核心数据访问接口--CrudRepository,SpringData核心数据访问接口--CrudRepository示例代码
Spring Boot 整合Spring Data JPA 之 CrudRepository 接口
dh_sheep的博客
04-09 705
CrudRepository 接口 一、CrudRepository 接口介绍 1、主要是完成一些增删改查的操作。 2、CrudRepository继承了 Repository 接口（即原来 Repository 的方法都能用） 二、CrudRepository 接口使用 该接口提供的方法有：save(添加一个 或者 添加一个集合)、findOne(ID)、findAll(查询所有)、del...
Redis之十：Spring Data Redis --- CrudRepository方式
zp8126的专栏
03-02 1357
Spring Data Redis 的 CrudRepository 是 Spring Data 框架中用于提供基础 CRUD（创建、读取、更新和删除）操作的一个接口。在与 Redis 集成时，尽管 Redis 是一个键值存储系统，并没有像关系型数据库那样直接支持复杂的 SQL 查询语句，但 Spring Data Redis 通过自定义的 Repository 接口提供了对 Redis 数据进行 CRUD 操作的能力。CrudRepository 是一系列通用数据访问操作的基接口，它包含了一些如。
Spring Boot教程之五十一：Spring Boot – CrudRepository 示例
潜洋的专栏
01-06 1220
Spring Boot 是一个基于微服务的框架，在其中创建生产就绪的应用程序只需很少的时间。如果有人想在 Spring Boot 应用程序中使用 CrudRepository，他/她必须创建一个接口并扩展 CrudRepository 接口。Spring Boot 的 CrudRepository 是 Spring Data JPA 框架的一部分，它提供了对关系数据库中的实体执行。存储库管理的实体的 id 类型（通常是在实体/模型类中创建的 @Id 的包装类）中定义，它扩展了 Spring Data。
Gemini 2.5 Flash-Lite 与 GPT-5-mini 实战对比：从性能到成本的全方位选型指南
最新发布
weixin_38170853的博客
04-17 499
本文深入对比了Gemini 2.5 Flash-Lite和GPT-5-mini在性能、成本和上下文处理等方面的差异，为开发者提供全面的模型选型指南。通过实测数据展示两者在推理能力、代码生成和多轮对话等场景的优劣，并给出成本计算模型和选型决策树，帮助用户根据业务需求选择最适合的AI模型。
springboot之CrudRepository的简单使用
m0_63486787的博客
12-10 3331
上面的代码中，使用 @Autowired 注解将 UserRepository 接口注入到 UserService 中，然后通过 CrudRepository 的方法完成对数据库的操作。上面的代码中，使用 @Query 注解定义了 Native SQL 查询语句，其中 value 属性表示查询语句，nativeQuery 属性表示是否使用原生 SQL。上面的代码中，使用方法名 findByUsername 定义了根据用户名查询用户的方法，Spring Data JPA 会自动生成查询语句。
CrudRepository基础
arkitocy的博客
08-09 1万+
CrudRepository基础 一.基础 CrudRepository接口提供了最基本的对实体类的添删改查操作 –T save(Tentity);//保存单个实体 –Iterable save(Iterable<?extends T> entities);//保存集合 –T findOne(IDid);//根据id查找实体 –boolean exists(IDid);//根据id判断...
Spring Boot的数据访问:CrudRepository接口的使用
热门推荐
qiangcuo6087的博客
01-23 4万+
示例 使用CrudRepository接口访问数据 创建一个新的Maven项目，命名为crudrepositorytest。按照Maven项目的规范，在src/main/下新建一个名为resources的Folder。 （1） 修改pom.xml文件。 在pom.xml文件中增加web开发的启动器配置如下： org.springframework.boot s
Spring Boot教程之五十二：CrudRepository 和 JpaRepository 之间的区别
潜洋的专栏
01-07 1536
例如，它包含 flush()、saveAndFlush()、saveAllAndFlush()、deleteInBatch() 等以及 CrudRepository 中可用的方法。Spring Boot 中有一个名为 CrudRepository 的接口，其中包含用于 CRUD 操作的方法。它提供了对存储库的通用 Crud 操作。存储库管理的实体的 id 类型（通常是在实体/模型类中创建的 @Id 的包装类）存储库管理的实体的 id 类型（通常是在实体/模型类中创建的 @Id 的包装类）
【Spring Boot】Spring Boot CrudRepository 示例 | JPA 连接数据库
猫巳的博客
10-21 3960
文章目录1. 演示工具版本2. 项目中使用的 Maven 文件3. CrudRepository 接口4. 使用 CrudRepository 的步骤4.1 创建一个扩展 CrudRepository 的接口4.2 JPA 存储库的自动检测4.3 实例化并使用 CrudRepositorya. Create and Update:b. Read:c. Delete:5. 自定义存储库方法6. 在 CrudRepository 上使用 @Transactional 注解7. 在 application.pro
JPA CrudRepository方法详解
hello world
01-11 3121
CrudRepository方法详解 通过类关系图可以看到CrudRepository提供了公共的通用的CRUD方法。 CrudRepository interface内容 @NoRepositoryBean public interface CrudRepository<T, ID> extends Repository<T, ID> { <S extends T> S save(S var1); <S extends T> Iterabl
Spring Data Repository 使用详解
深圳市多克创新科技有限公司
07-31 1861
Spring Data Repository 使用详解
数据仓库层Repository（CrudRepository、PagingAndSortingRepository、JpaRepository）
记录和分享属于我的“IT”时光。
02-12 1480
数据仓库接口的作用：Repository原意指的是仓库，即数据仓库的意思。Repository居于业务层和数据层之间，将两者隔离开来，在它的内部封装了数据查询和存储的逻辑。
SpringDataJPA的接口
xinyihhh的博客
09-20 1391
JPA
SpringDataJPA多表联合查询
Mistra的博客
02-20 2732
相信大家都用过jpa，jpa继承CrudRepository和PagingAndSortingRepository接口之后，在简单的单表查询中，不管是使用自带的findAll()，saveAll等方法还是利用jpa的方法命名规范进行jpql查询，jpa使用起来快的一撇。然而在进行复杂查询时，需要继承JpaSpecificationExecutor接口 利用Specification 进行复杂查询，...
对于crudrepository怎么解决update的问题
黎鉴洪的博客
07-19 9866
直接使用她自己拥有的save方法，如果需要保存或更新的对象的id在数据库中已存在，此时save方法自动会执行update操作，如果id不存在则执行保存操作，但是切记，不要乱加注解，我之前就是多了个@Transactional注解造成JUnit Test不执行更新操作，害得我还要上网查crudrepository怎么更新的问题，既然解决了，就分享给大家。 crudrepository：
JPA的CrudRepository 没有update方法，那么该如何更新数据？
liu_rockefeller的博客
07-26 1万+
刚开始使用JPA 的小伙伴们，可能有些困惑： 如下源码所示，JPA的CrudRepository只有save 方法，没有update和create方法。我怎样告诉JPA我是要更新（update）而不是插入（create）？ @NoRepositoryBean public interface CrudRepository<T, ID> extends Repository<T, ...
Spring Data JPA实践与学习（二）
CodersCoder的博客
11-19 646
CrudRepository 接口 CrudRepository 为我们提供的方法有： count(): long 查询总数返回 long 类型； void delete(T entity) 根据 entity 进行删除； void deleteAll(Iterable<? extends T> entities) 批量删除； void deleteAll() 删除所有； void deleteById(ID id); 根据主键删除，查看源码会发现，其是先查询出来再进行删除； boolean
Spring Data Repositories使用详解( Spring Data CRUD)
深圳市多克创新科技有限公司
03-01 770
Spring Data Repositories使用详解
SpringDataJPA的CrudRepository接口详解
weixin_44664095的博客
01-11 7112
在用SpringData(JPA是操作关系型的数据库)是个非常不错的框架,开发人员省去了创建数据库表格的时间,与此同时还简化了持久层的代码量.在SpringData中目前为止最核心的是Repository接口,但是里面没有任何的方法: public interface Repository<T, ID extends Serializable> Repository还有许多的额子接口...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值