如何用Java构建基础REST接口服务_JavaWeb接口项目实战解析

Java构建REST接口首选Spring Boot,通过Initializr初始化项目并添加Spring Web等依赖,定义User实体与Result响应体,用@RestController编写增删改查接口,运行主类即可在8080端口测试。

用Java构建基础REST接口服务,核心是选对技术栈、理清请求响应流程、写好控制器逻辑,再配合简单配置即可跑通。Spring Boot 是当前最主流的选择,它省去了大量XML配置和容器部署工作,让开发者聚焦在业务接口本身。

选型与项目初始化

推荐使用 Spring Boot 2.7+ 或 3.x(注意 JDK 版本匹配:3.x 需 JDK 17+)。通过 Spring Initializr(https://start.spring.io)快速生成项目,勾选以下依赖:

  • Spring Web:提供 @RestController、@RequestMapping 等核心注解和内嵌Tomcat
  • Lombok(可选但强烈推荐):减少 Getter/Setter/构造器等模板代码
  • Spring Boot DevTools(开发期):热更新、调试更高效
  • Validation(如需参数校验):配合 @Valid 快速验证入参

定义数据模型与响应结构

先写一个简单的实体类,比如用户 User:

public class User {
  private Long id;
  private String name;
  private Integer age;
  // Lombok 自动生成 getter/setter/toString
}

统一响应体建议封装为 Result,包含 code、message、data 字段,便于前端处理成功/失败状态。

编写REST控制器

使用 @RestController 注解标记类,每个方法对应一个HTTP端点:

  • @GetMapping("/users") → 查询用户列表
  • @GetMapping("/users/{id}") → 根据ID查单个用户
  • @PostMapping("/users") → 创建新用户(@RequestBody 接收JSON)
  • @PutMapping("/users/{id}") → 更新用户(路径参数 + 请求体)
  • @DeleteMapping("/users/{id}") → 删除用户

方法内可直接返回对象(Spring Boot 自动序列化为 JSON),无需手动写 response.getWriter()。若需自定义状态码,用 @ResponseStatus 或 ResponseEntity。

启动与测试

运行主类(含 @SpringBootApplication 注解)即可启动内嵌Web服务器,默认端口 8080。用 curl、Postman 或浏览器直接访问:

  • GET http://localhost:8080/users → 返回 JSON 列表
  • POST http://localhost:8080/users,Body 选 JSON,传 {"name":"张三","age":25} → 创建成功后返回新用户对象

控制台会打印映射路径(Mapped "{[/users],methods=[GET]}"),这是验证接口是否注册成功的最直接依据。