当前位置：首页 > article >正文

Spring Boot实战：构建一个简单的RESTful API

article 2025/1/3 0:33:44

Spring Boot是一个开源框架，旨在简化Spring应用的创建与开发过程。通过Spring Boot，你可以轻松地创建独立、生产级的Spring应用，而不需要复杂的配置。本教程将带领大家一步一步构建一个简单的RESTful API，演示Spring Boot的核心功能。

一、项目准备

1.1 创建Spring Boot项目

我们将通过Spring Initializr来创建Spring Boot项目。Spring Initializr是一个提供Web界面来生成Spring Boot项目的工具，您可以在https://start.spring.io访问它。

选择以下配置：

Project: Maven Project
Language: Java
Spring Boot: 选择最新的稳定版本
Project Metadata:
- Group: com.example
- Artifact: springboot-demo
- Name: springboot-demo
- Description: A demo project for Spring Boot
- Package name: com.example.springbootdemo
- Packaging: Jar
- Java: 11或更高版本

选择依赖项（Dependencies）：

Spring Web：构建RESTful Web应用所需的基本依赖
Spring Data JPA：用于数据库访问
H2 Database：一个轻量级的嵌入式数据库，用于存储数据
Spring Boot DevTools：提供热部署功能，便于开发过程中的实时更新

点击"Generate"按钮下载生成的项目文件并解压。

1.2 导入项目到IDE

将解压后的项目导入到你的IDE中（如IntelliJ IDEA、Eclipse等）。IDE会自动识别并加载Maven项目。

二、创建简单的RESTful API

2.1 编写实体类

首先，我们将创建一个简单的Book实体类，用于表示图书数据。

在src/main/java/com/example/springbootdemo/model目录下创建一个名为Book.java的文件：

package com.example.springbootdemo.model;

import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class Book {

    @Id
    private Long id;
    private String title;
    private String author;

    // 构造器
    public Book() {}

    public Book(Long id, String title, String author) {
        this.id = id;
        this.title = title;
        this.author = author;
    }

    // Getter和Setter方法
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
}

2.2 创建Repository接口

为了实现对Book实体的CRUD操作，我们将使用Spring Data JPA。接下来，我们创建一个BookRepository接口，它会继承JpaRepository接口，提供基本的数据库操作。

在src/main/java/com/example/springbootdemo/repository目录下创建BookRepository.java：

package com.example.springbootdemo.repository;

import com.example.springbootdemo.model.Book;
import org.springframework.data.jpa.repository.JpaRepository;

public interface BookRepository extends JpaRepository<Book, Long> {
}

JpaRepository提供了常用的数据库操作方法，如save()、findAll()、findById()等。

2.3 创建Controller类

接下来，我们创建一个BookController类，来实现RESTful API的接口。在src/main/java/com/example/springbootdemo/controller目录下创建BookController.java：

package com.example.springbootdemo.controller;

import com.example.springbootdemo.model.Book;
import com.example.springbootdemo.repository.BookRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.Optional;

@RestController
@RequestMapping("/api/books")
public class BookController {

    @Autowired
    private BookRepository bookRepository;

    // 获取所有图书
    @GetMapping
    public List<Book> getAllBooks() {
        return bookRepository.findAll();
    }

    // 根据ID获取单本图书
    @GetMapping("/{id}")
    public Optional<Book> getBookById(@PathVariable Long id) {
        return bookRepository.findById(id);
    }

    // 创建新图书
    @PostMapping
    public Book createBook(@RequestBody Book book) {
        return bookRepository.save(book);
    }

    // 更新图书信息
    @PutMapping("/{id}")
    public Book updateBook(@PathVariable Long id, @RequestBody Book book) {
        if (bookRepository.existsById(id)) {
            book.setId(id);
            return bookRepository.save(book);
        } else {
            return null; // 或者抛出异常
        }
    }

    // 删除图书
    @DeleteMapping("/{id}")
    public void deleteBook(@PathVariable Long id) {
        bookRepository.deleteById(id);
    }
}

2.4 配置应用程序

在src/main/resources/application.properties中配置数据库连接（在此案例中使用H2数据库）：

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.h2.console.enabled=true
spring.jpa.hibernate.ddl-auto=update

spring.datasource.url：配置数据库连接，这里使用内存中的H2数据库。
spring.jpa.hibernate.ddl-auto=update：自动根据实体类更新数据库表结构。

2.5 启动应用程序

在src/main/java/com/example/springbootdemo/SpringbootDemoApplication.java中，Spring Boot的主启动类会自动启动应用：

package com.example.springbootdemo;

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

@SpringBootApplication
public class SpringbootDemoApplication {

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

2.6 运行项目

点击IDE中的“运行”按钮，启动Spring Boot应用程序。应用会在默认端口8080上启动。

三、测试API接口

使用Postman或cURL测试RESTful API：

GET /api/books：获取所有图书
GET /api/books/{id}：根据ID获取单本图书
POST /api/books：创建新图书
- 请求体：{"id": 1, "title": "Spring Boot Guide", "author": "John Doe"}
PUT /api/books/{id}：更新图书信息
- 请求体：{"title": "Spring Boot Guide Updated", "author": "John Doe"}
DELETE /api/books/{id}：删除图书