使用Spring创建RestAPI模式的CRUD

痛定思痛。 2023-10-13 10:56 77阅读 0赞

> 在 Java Spring 中构建一个 CRUD REST API

微信搜索关注《Java学研大本营》，加入读者群，分享更多精彩

Representational State Transfer (REST) 是一种用于构建 Web API 的流行架构风格，而 Java Spring 是用于在 Java 中构建 REST API 的强大框架。

![cd49b7793a1f5e2fe9e4ccd29f329e40.png][]

在本教程中，我们将介绍在 Java Spring 中构建完整的 CRUD（创建、读取、更新、删除）REST API 的过程，使用 Spring Data JPA（Java Persistence API）库进行数据访问，使用 H2 数据库进行数据访问。贮存。

我们将从设置项目和定义实体模型开始，然后我们将为 API 创建存储库接口和控制器类。最后，我们将使用 Postman 或类似工具测试 API。

本教程将涵盖以下主题：

*  设置 Spring Boot 项目
 *  定义模型和存储库
 *  设置 Spring Data JPA 存储库
 *  创建服务层
 *  创建一个 REST 控制器
 *  使用 Postman 测试 API

在我们开始之前，请确保您的系统上安装了以下内容：

*  JDK 8 或更高版本
 *  Maven
 *  IDE（例如 IntelliJ 或 Eclipse）

### 搭建Spring Boot项目 ###

首先，让我们创建一个新的 Spring Boot 项目。您可以使用 IDE 的内置 Spring Initializr 功能或使用Spring Initializr 网站来生成新项目。

在 Spring Initializr 中，选择以下选项：

*  生成 Maven 项目
 *  Java版本：8或更高
 *  Spring Boot 版本：2.4.0 或更高
 *  Group：com.example（你可以使用任何你喜欢的包名）
 *  Artifact：crud-api（你可以使用任何你喜欢的名字）
 *  依赖项：Web、JPA 和 MySQL（或您喜欢的任何其他数据库）

生成项目后，将其导入到您的 IDE 中。

### 定义模型和存储库 ###

接下来，我们需要定义我们的模型类和存储库接口。

模型类表示我们要存储在数据库中的数据。在此示例中，我们将创建一个Person具有以下字段的模型类：

*  `id`: 长（主键）
 *  `name`：细绳
 *  `age`：整数 在 下创建一个新包`src/main/java`并将其命名为`com.example.crudapi.model`。在这个包中，创建一个名为的新类Person并添加以下代码：

package com.example.crudapi.model;
    
    import javax.persistence.*;
    
    @Entity
    @Table(name = "person")
    public class Person {
    
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
    
        @Column(name = "name")
        private String name;
    
        @Column(name = "age")
        private Integer age;
    
        public Person() {
        }
    
        public Person(String name, Integer age) {
            this.name = name;
            this.age = age;
        }
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public Integer getAge() {
            return age;
        }
    
        public void setAge(Integer age) {
            this.age = age;
        }
    }

注释`@Entity`指示此类是 JPA 实体。注释`@Table`指定了该实体将映射到的数据库表的名称。注解`@Id`指定实体的主键，注解`@GeneratedValue`指定主键自动生成。`@Column`注解指定字段将映射到数据库表中的列的名称。

接下来，我们将创建一个存储库接口来管理表中的数据`Person`。在`src/main/java`下创建一个新包并将其命名为`com.example.crudapi.repository`。在这个包中，创建一个名为的新接口`PersonRepository`并添加以下代码：

package com.example.crudapi.repository;
    
    import com.example.crudapi.model.Person;
    import org.springframework.data.jpa.repository.JpaRepository;
    
    public interface PersonRepository extends JpaRepository<Person, Long> {
    }

该`PersonRepository`接口扩展了`JpaRepository`接口，它为`Person`实体提供了基本的 CRUD 操作。

### 设置 Spring Data JPA 存储库 ###

接下来，我们将配置数据库并设置 Spring Data JPA 存储库。

将以下依赖项添加到您的pom.xml文件以包含 MySQL 连接器：

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.22</version>
    </dependency>

接下来，在`src/main/resources`目录中创建一个名为的新文件`src/main/resources`并添加以下属性：

spring.jpa.hibernate.ddl-auto=update
    spring.datasource.url=jdbc:mysql://localhost:3306/crud_api
    spring.datasource.username=<your_username>
    spring.datasource.password=<your_password>

这些属性配置以下内容：

*  `spring.jpa.hibernate.ddl-auto`：此属性告诉 Hibernate 根据实体类自动更新数据库模式。
 *  `spring.datasource.url`：此属性指定 MySQL 数据库的 URL。
 *  `spring.datasource.username`：此属性指定 MySQL 数据库的用户名。
 *  `spring.datasource.password`：此属性指定 MySQL 数据库的密码。

### 创建服务层 ###

接下来，我们将创建一个服务层来管理 CRUD 操作的业务逻辑。

在`src/main/java`下创建一个新包并将其命名为`com.example.crudapi.service`。在这个包中，创建一个名为`PersonService`的新接口并添加以下代码：

package com.example.crudapi.service;
    
    import com.example.crudapi.model.Person;
    
    import java.util.List;
    
    public interface PersonService {
    
        List<Person> findAll();
    
        Person findById(Long id);
    
        Person save(Person person);
    
        void deleteById(Long id);
    }

该接口定义了 CRUD 操作的方法：`findAll`、`findById`、`save`和`deleteById`。

接下来，创建一个名为`PersonServiceImpl`实现`PersonService`接口的新类并添加以下代码：

package com.example.crudapi.service;
    
    import com.example.crudapi.model.Person;
    import com.example.crudapi.repository.PersonRepository;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import java.util.List;
    
    @Service
    public class PersonServiceImpl implements PersonService {
    
        private final PersonRepository personRepository;
    
        @Autowired
        public PersonServiceImpl(PersonRepository personRepository) {
            this.personRepository = personRepository;
        }
    
        @Override
        public List<Person> findAll() {
            return personRepository.findAll();
        }
    
        @Override
        public Person findById(Long id) {
            return personRepository.findById(id).orElse(null);
        }
    
        @Override
        public Person save(Person person) {
            return personRepository.save(person);
        }
    
        @Override
        public void deleteById(Long id) {
            personRepository.deleteById(id);
        }
    }

此类使用`PersonRepository`对实体执行 CRUD 操作`Person`。注释`@Service`表明这是一个服务 bean 并且符合依赖注入的条件。

### 创建 REST 控制器 ###

接下来，我们将创建一个 REST 控制器以将 CRUD 操作公开为 HTTP 端点。

在`src/main/java`下创建一个新包并将其命名为`com.example.crudapi.controller`。在这个包中，创建一个名为`PersonController`的新类并添加以下代码：

package com.example.crudapi.controller;
    
    import com.example.crudapi.model.Person;
    import com.example.crudapi.service.PersonService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpStatus;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.List;
    
    @RestController
    @RequestMapping("/api")
    public class PersonController {
    
        private final PersonService personService;
    
        @Autowired
        public PersonController(PersonService personService) {
            this.personService = personService;
        }
    
        @GetMapping("/persons")
        public List<Person> findAll() {
            return personService.findAll();
        }
    
        @GetMapping("/persons/{id}")
        public Person findById(@PathVariable Long id) {
            return personService.findById(id);
        }
    
        @PostMapping("/persons")
        @ResponseStatus(HttpStatus.CREATED)
        public Person save(@RequestBody Person person) {
            return personService.save(person);
        }
    
        @DeleteMapping("/persons/{id}")
        @ResponseStatus(HttpStatus.NO_CONTENT)
    
        public void deleteById(@PathVariable Long id) {
        personService.deleteById(id);
      }

该`@RestController`注解表明该类是一个 REST 控制器，负责处理 HTTP 请求。注释`@RequestMapping`指定 REST 端点的基本 URL。

`@GetMapping`、`@PostMapping`和`@DeleteMapping`注释指定每个端点的HTTP 方法和 URL。`@PathVariable`注解将路径变量绑定到方法参数，`@RequestBody`注解将请求主体绑定到方法参数。

### 使用 Postman 测试 API ###

现在我们已经完成了 CRUD API 的实现，我们可以使用 Postman 或任何其他 REST 客户端对其进行测试。

启动应用程序并发送 GET 请求到`http://localhost:8080/api/persons`检索所有人的列表。

使用如下请求正文发送 POST请求到`http://localhost:8080/api/persons`：

{
      "name": "John",
      "age": 30
    }

这将在数据库中创建一个新人。

发送 GET 请求到`http://localhost:8080/api/persons/{id}`通过 ID 检索特定人员。

发送 DELETE 请求到`http://localhost:8080/api/persons/{id}`通过 ID 删除一个人。

就是这样！您已经在 Java Spring 中成功构建了一个 CRUD REST API。您现在可以通过添加更多 CRUD 操作或添加验证和错误处理来自定义 API。

### 推荐书单 ###

#### 《项目驱动零起点学Java》 ####

《项目驱动零起点学Java》共分 13 章，围绕 6 个项目和 258 个代码示例，分别介绍了走进Java 的世界、变量与数据类型、运算符、流程控制、方法、数组、面向对象、异常、常用类、集合、I/O流、多线程、网络编程相关内容。《项目驱动零起点学Java》总结了马士兵老师从事Java培训十余年来经受了市场检验的教研成果，通过6 个项目以及每章的示例和习题，可以帮助读者快速掌握Java 编程的语法以及算法实现。扫描每章提供的二维码可观看相应章节内容的视频讲解。

《项目驱动零起点学Java》贯穿6个完整项目，经过作者多年教学经验提炼而得，项目从小到大、从短到长，可以让读者在练习项目的过程中，快速掌握一系列知识点。

马士兵，马士兵教育创始人，毕业于清华大学，著名IT讲师，所讲课程广受欢迎，学生遍布全球大厂，擅长用简单的语言讲授复杂的问题，擅长项目驱动知识的综合学习。马士兵教育获得在线教育“名课堂”奖、“最受欢迎机构”奖。

赵珊珊，从事多年一线开发，曾为国税、地税税务系统工作。拥有7年一线教学经验，多年线上、线下教育的积累沉淀，培养学员数万名，讲解细致，脉络清晰。

[《项目驱动零起点学Java》(马士兵，赵珊珊)【摘要 书评 试读】- 京东图书京东JD.COM图书频道为您提供《项目驱动零起点学Java》在线选购，本书作者：，出版社：清华大学出版社。买图书，到京东。网购图书，享受最低优惠折扣!![icon-default.png?t=N5K3][icon-default.png_t_N5K3]https://item.jd.com/13607758.html][Java_ _ _- _JD.COM_Java_icon-default.png_t_N5K3_icon-default.png_t_N5K3_https_item.jd.com_13607758.html]

![19e5edb76e6b225b372df7f45f20c729.png][]

> > > > ### 精彩回顾 ###
> > 
> > [部署Spring Boot应用程序][Spring Boot]
> > 
> > [Java Spring Boot 3.0.0 RC1 震撼登场!][Java Spring Boot 3.0.0 RC1]

> > 微信搜索关注《Java学研大本营》
> > 
> > 访问【IT今日热榜】，发现每日技术热点

[cd49b7793a1f5e2fe9e4ccd29f329e40.png]: https://img-blog.csdnimg.cn/img_convert/cd49b7793a1f5e2fe9e4ccd29f329e40.png
[icon-default.png_t_N5K3]: https://csdnimg.cn/release/blog_editor_html/release2.3.2/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=N5K3
[Java_ _ _- _JD.COM_Java_icon-default.png_t_N5K3_icon-default.png_t_N5K3_https_item.jd.com_13607758.html]: https://item.jd.com/13607758.html
[19e5edb76e6b225b372df7f45f20c729.png]: https://img-blog.csdnimg.cn/img_convert/19e5edb76e6b225b372df7f45f20c729.png
[Spring Boot]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247485902&idx=1&sn=f8a8b41aa78df26fbb4171bf8b14c938&chksm=c27a0614f50d8f02690b33e16513185067ad3fad6638a7f6eaf1a2b03bf01ed3fad164339cb8&scene=21#wechat_redirect
[Java Spring Boot 3.0.0 RC1]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247485911&idx=1&sn=33ccbc9f8c9f98de24e05cdae26767f7&chksm=c27a060df50d8f1bb9d16fc293b5bd94faabacf4763d20f60a4962e709f1bd60efae4dd5a4ec&scene=21#wechat_redirect