0

0

java怎么实现RESTful API 手把手教你搭建RESTful风格的接口服务

星降

星降

发布时间:2025-11-06 23:47:02

|

1282人浏览过

|

来源于php中文网

原创

使用Spring Boot创建RESTful API,通过定义User实体和UserController实现增删改查,以内存数据模拟服务,结合HTTP动词完成接口设计,快速构建可测试的Web服务。

java怎么实现restful api 手把手教你搭建restful风格的接口服务

实现一个RESTful API服务,Java中最常见的方式是使用Spring Boot框架。它简化了配置和开发流程,能快速搭建出符合REST规范的接口服务。下面手把手带你从零开始创建一个基础但完整的RESTful接口。

1. 准备开发环境

确保你具备以下工具

  • JDK 8 或更高版本
  • Maven(用于依赖管理)
  • IDE(如 IntelliJ IDEA 或 Eclipse)
  • 浏览器或 Postman(用于测试接口)

2. 创建Spring Boot项目

访问 https://www.php.cn/link/5ecc613150de01b7e6824594426f24f4,填写以下信息:

  • Project: Maven
  • Language: Java
  • Spring Boot 版本:选择最新稳定版(如 3.x)
  • Group: com.example
  • Artifact: demo-api

在“Dependencies”中添加:

立即学习Java免费学习笔记(深入)”;

  • Spring Web

点击“Generate”下载压缩包,解压后导入到你的IDE中。

3. 理解RESTful设计原则

RESTful风格的核心是用HTTP动词表达操作,资源用URL表示。例如:

  • GET /users → 获取用户列表
  • POST /users → 创建新用户
  • GET /users/1 → 获取ID为1的用户
  • PUT /users/1 → 更新ID为1的用户
  • DELETE /users/1 → 删除ID为1的用户

4. 创建实体类(User)

src/main/java/com/example/demoapi/entity 目录下创建 User 类:

package com.example.demoapi.entity;

public class User { private Long id; private String name; private String email;

// 构造函数
public User() {}

public User(Long id, String name, String email) {
    this.id = id;
    this.name = name;
    this.email = email;
}

// Getter 和 Setter 方法
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 String getEmail() { return email; }
public void setEmail(String email) { this.email = email; }

}

AskAI
AskAI

无代码AI模型构建器,可以快速微调GPT-3模型,创建聊天机器人

下载

5. 创建Controller处理HTTP请求

src/main/java/com/example/demoapi/controller 下创建 UserController:

package com.example.demoapi.controller;

import com.example.demoapi.entity.User; import org.springframework.web.bind.annotation.*;

import java.util.ArrayList; import java.util.List; import java.util.concurrent.atomic.AtomicLong;

@RestController @RequestMapping("/users") public class UserController {

private List users = new ArrayList<>();
private AtomicLong counter = new AtomicLong();

// 初始化一些测试数据
public UserController() {
    users.add(new User(counter.incrementAndGet(), "张三", "zhangsan@example.com"));
    users.add(new User(counter.incrementAndGet(), "李四", "lisi@example.com"));
}

// GET /users - 获取所有用户
@GetMapping
public ListzuojiankuohaophpcnUseryoujiankuohaophpcn getAllUsers() {
    return users;
}

// GET /users/{id} - 获取指定用户
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    return users.stream()
            .filter(user -youjiankuohaophpcn user.getId().equals(id))
            .findFirst()
            .orElse(null);
}

// POST /users - 创建新用户
@PostMapping
public User createUser(@RequestBody User user) {
    user.setId(counter.incrementAndGet());
    users.add(user);
    return user;
}

// PUT /users/{id} - 更新用户
@PutMapping("/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
    for (User user : users) {
        if (user.getId().equals(id)) {
            user.setName(updatedUser.getName());
            user.setEmail(updatedUser.getEmail());
            return user;
        }
    }
    return null;
}

// DELETE /users/{id} - 删除用户
@DeleteMapping("/{id}")
public String deleteUser(@PathVariable Long id) {
    boolean removed = users.removeIf(user -youjiankuohaophpcn user.getId().equals(id));
    return removed ? "删除成功" : "用户不存在";
}

}

6. 启动并测试API

运行主类(通常叫 DemoApiApplication),启动成功后访问:

  • GET http://localhost:8080/users → 查看所有用户
  • GET http://localhost:8080/users/1 → 查看ID为1的用户
  • POST http://localhost:8080/users → Body 中提交 JSON 数据创建用户
  • PUT http://localhost:8080/users/1 → 更新用户信息
  • DELETE http://localhost:8080/users/1 → 删除用户

你可以用Postman或curl测试,例如创建用户的POST请求Body:

{
    "name": "王五",
    "email": "wangwu@example.com"
}

7. 小结与扩展建议

你现在已成功搭建了一个基本的RESTful API服务。虽然当前数据存在内存中,但结构清晰,适合学习理解REST原理。

下一步可以考虑:

  • 集成数据库(如 MySQL + JPA/Hibernate)
  • 添加数据校验(@Valid)
  • 统一返回格式(如封装 Result 对象)
  • 加入异常处理(@ControllerAdvice)
  • 使用Swagger生成API文档

基本上就这些,不复杂但容易忽略细节。照着做一遍,你就掌握了Java构建RESTful接口的基本能力。

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

834

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

738

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

2

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.8万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 793人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号