Spring Boot 实战：构建 RESTful API 服务

embedded/2025/2/27 12:54:52/

一、引言

在当今的软件开发领域，快速构建高效、可维护的后端服务是至关重要的。Spring Boot 作为 Spring 框架的扩展，以其简化配置、快速开发的特性，成为了众多开发者的首选。本文将带领大家通过一个实战项目，详细介绍如何使用 Spring Boot 构建一个 RESTful API 服务，实现对用户信息的增删改查操作。

二、项目准备

2.1 开发环境

  • JDK：建议使用 JDK 8 及以上版本。
  • Maven：用于项目依赖管理。
  • IDE：可以选择 IntelliJ IDEA 或 Eclipse。

2.2 创建 Spring Boot 项目

我们可以使用 Spring Initializr（https://start.spring.io/）来快速创建项目。在该网站上，我们进行如下配置：

  • Project：选择 Maven Project。
  • Language：选择 Java。
  • Spring Boot：选择合适的版本，这里我们选择 2.7.10。
  • Group：填写项目的包名，例如 com.example。
  • Artifact：填写项目名称，例如 user-api。
  • Dependencies：添加以下依赖：
    • Spring Web：用于构建 RESTful API。
    • Spring Data JPA：用于数据库操作。
    • H2 Database：嵌入式数据库，方便开发测试。

点击 “Generate” 按钮下载项目压缩包，解压后导入到 IDE 中。

三、项目结构

项目创建完成后，其基本结构如下：

收起

plaintext

user-api/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── userapi/
│   │   │               ├── UserApiApplication.java
│   │   │               ├── controller/
│   │   │               ├── entity/
│   │   │               ├── repository/
│   │   │               └── service/
│   │   └── resources/
│   │       ├── application.properties
│   │       └── static/
│   │       └── templates/
├── pom.xml

  • UserApiApplication.java：项目的启动类。
  • controller 包：用于存放控制器类，处理 HTTP 请求。
  • entity 包：用于存放实体类，对应数据库表。
  • repository 包：用于存放数据访问接口，操作数据库。
  • service 包：用于存放业务逻辑类。
  • application.properties：项目配置文件。

四、实体类设计

在 entity 包下创建 User 实体类，使用 JPA 注解将其映射到数据库表。

收起

java

package com.example.userapi.entity;import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;@Entity
public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String name;private int age;// 无参构造函数public User() {}// 有参构造函数public User(String name, int age) {this.name = name;this.age = age;}// Getters 和 Setterspublic 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 int getAge() {return age;}public void setAge(int age) {this.age = age;}
}

在上述代码中，@Entity 注解表示这是一个实体类，@Id 注解指定主键，@GeneratedValue 注解指定主键的生成策略。

五、数据访问层

在 repository 包下创建 UserRepository 接口，继承 JpaRepository 接口，该接口提供了基本的 CRUD 操作。

收起

java

package com.example.userapi.repository;import com.example.userapi.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;public interface UserRepository extends JpaRepository<User, Long> {
}

JpaRepository 接口的第一个泛型参数是实体类类型，第二个泛型参数是主键类型。

六、业务逻辑层

在 service 包下创建 UserService 类，实现用户信息的增删改查业务逻辑。

收起

java

package com.example.userapi.service;import com.example.userapi.entity.User;
import com.example.userapi.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;import java.util.List;
import java.util.Optional;@Service
public class UserService {@Autowiredprivate UserRepository userRepository;// 获取所有用户信息public List<User> getAllUsers() {return userRepository.findAll();}// 根据 ID 获取用户信息public Optional<User> getUserById(Long id) {return userRepository.findById(id);}// 添加用户信息public User addUser(User user) {return userRepository.save(user);}// 更新用户信息public User updateUser(Long id, User updatedUser) {return userRepository.findById(id).map(user -> {user.setName(updatedUser.getName());user.setAge(updatedUser.getAge());return userRepository.save(user);}).orElseGet(() -> {updatedUser.setId(id);return userRepository.save(updatedUser);});}// 删除用户信息public void deleteUser(Long id) {userRepository.deleteById(id);}
}

在上述代码中，@Service 注解表示这是一个业务逻辑类，@Autowired 注解用于自动注入 UserRepository 实例。

七、控制器层

在 controller 包下创建 UserController 类，处理 HTTP 请求，调用业务逻辑层的方法。

收起

java

package com.example.userapi.controller;import com.example.userapi.entity.User;
import com.example.userapi.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;import java.util.List;
import java.util.Optional;@RestController
@RequestMapping("/api/users")
public class UserController {@Autowiredprivate UserService userService;// 获取所有用户信息@GetMappingpublic List<User> getAllUsers() {return userService.getAllUsers();}// 根据 ID 获取用户信息@GetMapping("/{id}")public ResponseEntity<User> getUserById(@PathVariable Long id) {Optional<User> user = userService.getUserById(id);return user.map(value -> new ResponseEntity<>(value, HttpStatus.OK)).orElseGet(() -> new ResponseEntity<>(HttpStatus.NOT_FOUND));}// 添加用户信息@PostMappingpublic ResponseEntity<User> addUser(@RequestBody User user) {User savedUser = userService.addUser(user);return new ResponseEntity<>(savedUser, HttpStatus.CREATED);}// 更新用户信息@PutMapping("/{id}")public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User updatedUser) {User user = userService.updateUser(id, updatedUser);return new ResponseEntity<>(user, HttpStatus.OK);}// 删除用户信息@DeleteMapping("/{id}")public ResponseEntity<Void> deleteUser(@PathVariable Long id) {userService.deleteUser(id);return new ResponseEntity<>(HttpStatus.NO_CONTENT);}
}

在上述代码中，@RestController 注解表示这是一个 RESTful 控制器，@RequestMapping 注解指定请求的基础路径。不同的 HTTP 请求方法（@GetMapping、@PostMapping、@PutMapping、@DeleteMapping）对应不同的操作。

八、配置文件

在 application.properties 文件中进行数据库配置：

收起

properties

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

上述配置使用 H2 嵌入式数据库，spring.h2.console.enabled=true 表示开启 H2 数据库控制台，方便我们查看数据库内容。

九、测试 API

启动项目后，我们可以使用 Postman 或其他 API 测试工具来测试我们的 RESTful API。

  • 获取所有用户信息：发送 GET 请求到 http://localhost:8080/api/users。
  • 根据 ID 获取用户信息：发送 GET 请求到 http://localhost:8080/api/users/{id}，例如 http://localhost:8080/api/users/1。
  • 添加用户信息：发送 POST 请求到 http://localhost:8080/api/users，请求体为 JSON 格式，例如：

收起

json

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

  • 更新用户信息：发送 PUT 请求到 http://localhost:8080/api/users/{id}，请求体为 JSON 格式，例如：

收起

json

{"name": "Jane Doe","age": 32
}

  • 删除用户信息：发送 DELETE 请求到 http://localhost:8080/api/users/{id}，例如 http://localhost:8080/api/users/1。

十、总结

通过本文的实战项目，我们学习了如何使用 Spring Boot 构建一个简单的 RESTful API 服务。从项目创建、实体类设计、数据访问层、业务逻辑层到控制器层的开发，以及数据库配置和 API 测试，我们对 Spring Boot 的开发流程有了更深入的了解。Spring Boot 的简化配置和强大的功能使得我们能够快速开发出高效、可维护的后端服务。在实际项目中，我们可以根据需求进一步扩展功能，例如添加数据验证、日志记录、安全认证等。


http://www.ppmy.cn/embedded/167533.html

相关文章

vscode如何使用鼠标滚轮调整字体大小

vscode如何使用鼠标滚轮调整字体大小

1.打开设置 2.搜索Font Ligatures 3.编辑配置文件 4.修改代码并保存 修改前 修改后 在最后一行添加&#xff1a;“editor.mouseWheelZoom”: true 记得在上一行最后&#xff0c;加上英文版的“,”逗号 5.配置成功&#xff0c;再次按Ctrl鼠标滚轮便可以缩放了。
阅读更多...
macpro m1 安装deepseek

macpro m1 安装deepseek

记录一下安装过程&#xff1a; 一、环境准备 硬件要求 内存 ≥16GB&#xff1a;DeepSeek R1-8B 模型需占用约 4.9GB 显存&#xff0c;建议预留足够内存以避免运行卡顿29。 存储空间 ≥10GB&#xff1a;模型文件及依赖库需占用较大空间212。 软件依赖 安装 Ollama&#xff1a…
阅读更多...
「云原生」「云原生应用的构建与部署」

「云原生」「云原生应用的构建与部署」

云原生 为什么需要云原生&#xff1f; 从技术发展趋势看&#xff0c;更多的企业将会广泛应用云原生技术。在国家政策和企业需求的双重驱动下&#xff0c;更多企业上云&#xff0c;以及中国云计算的强势增长都是必然趋势&#xff0c;这也注定了更多企业将会关注、应用、采纳能…
阅读更多...
【Java 优选算法】模拟

【Java 优选算法】模拟

欢迎关注个人主页&#xff1a;逸狼 创造不易&#xff0c;可以点点赞吗~ 如有错误&#xff0c;欢迎指出~ 模拟算法的思路比较简单,根据题目描述列出流程,找出规律,将流程转化为代码 替换所有的问号 题目链接 解法 直接根据题目给出条件模拟 示例,找出规律 1.先找出字符?,再…
阅读更多...
Docker数据卷操作实战

Docker数据卷操作实战

什么是数据卷 数据卷 是一个可供一个或多个容器使用的特殊目录&#xff0c;它绕过 UFS&#xff0c;可以提供很多有用的特性: 数据卷 可以在容器之间共享和享用对 数据卷 的修改立马生效对 数据卷 的更新&#xff0c;不会影响镜像数据卷 默认会一直存在&#xff0c;即时容器被…
阅读更多...
大白话JavaScript闭包在实际项目中有哪些应用场景？

大白话JavaScript闭包在实际项目中有哪些应用场景？

大白话JavaScript闭包在实际项目中有哪些应用场景&#xff1f; 闭包是指有权访问另一个函数作用域中的变量的函数。在实际项目中&#xff0c;闭包有很多应用场景&#xff0c;以下是一些常见的例子&#xff1a; 数据封装和隐私保护 场景&#xff1a;在开发中&#xff0c;有时…
阅读更多...
CSS 真的会阻塞文档解析吗？

CSS 真的会阻塞文档解析吗？

在网页开发领域&#xff0c;一个常见的疑问是 CSS 是否会阻塞文档解析。理解这一问题对于优化网页性能、提升用户体验至关重要。要深入解答这个问题&#xff0c;需要从浏览器渲染网页的原理说起。 浏览器渲染网页的基本流程 浏览器在接收到 HTML 文档后&#xff0c;会依次进行…
阅读更多...
单线服务器和双线服务器分别是指什么？

单线服务器和双线服务器分别是指什么？

服务器双线和单线通常是指服务器的网络连接方式&#xff0c;单线服务器是指只有一条物理线路连接到服务器的服务器&#xff0c;成本上较为低廉&#xff0c;更加便于用户和企业进行管理与维护&#xff0c;适合对网络延迟度要求不高的小型网站和低流量的应用&#xff0c;但是当服…
阅读更多...
最新文章

Copyright @ 2022~2023