RESTful API(Representational State Transfer)是一种通过 HTTP 协议进行通信的架构风格，通常用于 Web 服务的开发。RESTful API 通过暴露 HTTP 方法(如 GET、POST、PUT、DELETE)与客户端进行数据交互，是现代 Web 应用中非常常见的一种 API 开发方式。小编将介绍如何使用 Java 开发一个简单的 RESTful API。
1. 什么是 RESTful API?
REST(Representational State Transfer)是一种面向资源的架构风格，它通过标准的 HTTP 协议来操作资源。RESTful API 的特点包括：
无状态：每个请求都必须包含处理该请求所需要的所有信息，服务器不存储客户端的任何状态。
客户端-服务器架构：客户端和服务器之间相互独立，通信通过 HTTP 协议进行。
资源标识：每个资源都有一个 URI(Uniform Resource Identifier)，通过 URI 进行标识和访问。
支持多种格式：响应数据通常使用 JSON 或 XML 格式传输，JSON 是最常见的格式。
HTTP 方法的使用：RESTful API 利用 HTTP 的四个基本方法来操作资源：GET(查询)、POST(创建)、PUT(更新)、DELETE(删除)。
2. 开发 RESTful API 的技术栈
在 Java 中开发 RESTful API，通常使用以下几种技术：
JAX-RS(Java API for RESTful Web Services)：Java 官方提供的用于构建 RESTful 服务的 API。
Spring Boot：一个快速开发框架，提供了内嵌 Web 服务器、自动配置等功能，非常适合开发 RESTful API。
Spring MVC：Spring 框架的一部分，支持开发 RESTful API，可以结合 Spring Boot 使用。
本文将以 Spring Boot 为例，介绍如何使用 Java 开发 RESTful API，因为 Spring Boot 简化了开发配置，适合快速构建 RESTful 服务。
3. 环境搭建
3.1 使用 Spring Boot 创建项目
访问 Spring Initializr 网站，选择以下配置：
Project: Maven Project
Language: Java
Spring Boot: 选择最新版本
Project Metadata: 输入项目名称、描述等信息
Dependencies: 选择 Spring Web(包括 Spring MVC 和嵌入式 Tomcat)，如果需要数据库支持，还可以选择 Spring Data JPA。
生成并下载项目后，解压并使用 IDE(如 IntelliJ IDEA 或 Eclipse)打开该项目。
3.2 项目结构
Spring Boot 创建的默认项目结构大致如下：
Copy Codesrc
└── main
├── java
│ └── com
│ └── example
│ └── restapi
│ ├── RestApiApplication.java
│ ├── controller
│ │ └── ProductController.java
│ ├── model
│ │ └── Product.java
│ └── service
│ └── ProductService.java
└── resources
├── application.properties
4. 创建 RESTful API
4.1 定义数据模型
我们将开发一个简单的产品管理 API，每个产品有 id、name 和 price 属性。首先，在 model 包中创建一个 Product 类：
javaCopy Codepackage com.example.restapi.model;
public class Product {
private long id;
private String name;
private double price;
public Product(long id, String name, double price) {
this.id = id;
this.name = name;
this.price = price;
}
// Getters and Setters
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 double getPrice() {
return price;
}
public void setPrice(double price) {
this.price = price;
}
}
4.2 创建服务层
接下来，创建 ProductService 类，模拟数据的获取、添加、更新和删除操作。为了简单起见，这里使用一个内存中的 List 来存储数据。
javaCopy Codepackage com.example.restapi.service;
import com.example.restapi.model.Product;
import org.springframework.stereotype.Service;
import java.util.ArrayList;
import java.util.List;
@Service
public class ProductService {
private List<Product> products = new ArrayList<>();
public ProductService() {
products.add(new Product(1, "Laptop", 799.99));
products.add(new Product(2, "Smartphone", 499.99));
products.add(new Product(3, "Tablet", 299.99));
}
public List<Product> getAllProducts() {
return products;
}
public Product getProductById(long id) {
return products.stream().filter(p -> p.getId() == id).findFirst().orElse(null);
}
public void addProduct(Product product) {
products.add(product);
}
public void updateProduct(long id, Product product) {
Product existingProduct = getProductById(id);
if (existingProduct != null) {
existingProduct.setName(product.getName());
existingProduct.setPrice(product.getPrice());
}
}
public void deleteProduct(long id) {
products.removeIf(p -> p.getId() == id);
}
}
4.3 创建控制器
然后，创建 ProductController 类，使用 @RestController 注解来定义 RESTful API。该类将处理 HTTP 请求，并调用 ProductService 来执行相应的操作。
javaCopy Codepackage com.example.restapi.controller;
import com.example.restapi.model.Product;
import com.example.restapi.service.ProductService;
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/products")
public class ProductController {
@Autowired
private ProductService productService;
// 获取所有产品
@GetMapping
public List<Product> getAllProducts() {
return productService.getAllProducts();
}
// 根据 ID 获取单个产品
@GetMapping("/{id}")
public Product getProductById(@PathVariable long id) {
return productService.getProductById(id);
}
// 添加新产品
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public void addProduct(@RequestBody Product product) {
productService.addProduct(product);
}
// 更新产品
@PutMapping("/{id}")
public void updateProduct(@PathVariable long id, @RequestBody Product product) {
productService.updateProduct(id, product);
}
// 删除产品
@DeleteMapping("/{id}")
public void deleteProduct(@PathVariable long id) {
productService.deleteProduct(id);
}
}
4.4 启动 Spring Boot 应用
在 RestApiApplication 类中添加 @SpringBootApplication 注解，并在 main 方法中调用 SpringApplication.run() 来启动 Spring Boot 应用。
javaCopy Codepackage com.example.restapi;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class RestApiApplication {
public static void main(String[] args) {
SpringApplication.run(RestApiApplication.class, args);
}
}
4.5 配置文件
Spring Boot 的默认配置已经足够启动一个基本的 Web 应用程序。如果需要自定义配置，可以修改 src/main/resources/application.properties 文件。
例如，修改端口号为 8081：
propertiesCopy Codeserver.port=8081
5. 测试 RESTful API
获取所有产品：
请求：GET http://localhost:8080/api/products
响应：返回所有产品的 JSON 数组。
获取单个产品：
请求：GET http://localhost:8080/api/products/1
响应：返回 ID 为 1 的产品的 JSON 数据。
添加新产品：
请求：POST http://localhost:8080/api/products
请求体：{"id":4,"name":"Monitor","price":199.99}
响应：返回状态码 201(Created)。
更新产品：
请求：PUT http://localhost:8080/api/products/4
请求体：{"name":"Curved Monitor","price":249.99}
响应：无响应体，状态码 200。
删除产品：
请求：DELETE http://localhost:8080/api/products/4
响应：无响应体，状态码 204。
通过 Spring Boot，我们可以快速开发一个 RESTful API。Spring Boot 提供的自动配置和嵌入式 Web 服务器使得开发过程更加简便。
