如何使用 Java 的 Spring Boot 创建一个 RESTful API？

各人好，我是 V 哥，使用 Java 的 Spring Boot 创建 RESTful API 可以满足多种开发场景，它提供了快速开发、易于设置、可扩展、可维护的优点，尤其适合现代软件开发的需求，资助你快速构建出高性能的后端服务。例如，在企业级应用中，通常需要开发大量的业务功能，并且要求体系具有可扩展性、可维护性和高可用性。Spring Boot 联合 Spring 生态体系的其他组件（如 Spring Security 用于安全，Spring Data 用于数据访问）可以快速构建出强大的企业级应用，通过 RESTful API 对外提供服务，满足企业内部或外部的业务需求。
  以下是使用 Java 的 Spring Boot 创建一个 RESTful API 的步调：
一、创建 Spring Boot 项目

• 打开 IDE（如 IntelliJ IDEA 或 Eclipse）。
  
• 选择创建一个新的 Spring Boot 项目。
  
• 在项目创建领导中，选择 Spring Web 依赖。这将包含创建 RESTful API 所需的根本依赖，如 Spring MVC 等。
  

二、创建控制器类（Controller Class）

在 src/main/java 目录下创建一个新的 Java 类，例如 UserController.java。

1. import org.springframework.web.bind.annotation.GetMapping;
2. import org.springframework.web.bind.annotation.RequestMapping;
3. import org.springframework.web.bind.annotation.RestController;
5. @RestController
6. @RequestMapping("/api/users")
7. public class UserController {
9.     @GetMapping("/")
10.     public String getUsers() {
11.         return "Hello, Users!";
12.     }
13. }

复制代码

代码表明：

• @RestController 注解将这个类标志为一个控制器，并且该类中的方法返回的数据将直接作为 HTTP 响应的内容，而不是视图名称。
  
• @RequestMapping("/api/users") 为这个控制器中的所有哀求映射了一个基础路径 /api/users。
  
• @GetMapping("/") 表现该方法将处理 GET 哀求，并且该哀求的路径是 /api/users/（因为 @RequestMapping 中已经设置了基础路径）。
  

三、运行项目

运行 Spring Boot 应用程序的主类，通常是带有 @SpringBootApplication 注解的类，例如：

1. import org.springframework.boot.SpringApplication;
2. import org.springframework.boot.autoconfigure.SpringBootApplication;
4. @SpringBootApplication
5. public class Application {
7.     public static void main(String[] args) {
8.         SpringApplication.run(Application.class, args);
9.     }
10. }

复制代码

代码表明：

• @SpringBootApplication 是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan。它启用了 Spring 的自动设置功能，并扫描当前包及其子包下的组件。
  
• SpringApplication.run(Application.class, args); 启动 Spring Boot 应用程序，Application.class 是启动类的类名，args 是命令行参数。
  

四、测试 API

打开浏览器大概使用工具（如 Postman），访问 http://localhost:8080/api/users/，你将看到 Hello, Users! 的消息。
五、添加更多的 API 端点

你可以在 UserController 中添加更多的方法，例如：

1. import org.springframework.web.bind.annotation.DeleteMapping;
2. import org.springframework.web.bind.annotation.GetMapping;
3. import org.springframework.web.bind.annotation.PathVariable;
4. import org.springframework.web.bind.annotation.PostMapping;
5. import org.springframework.web.bind.annotation.PutMapping;
6. import org.springframework.web.bind.annotation.RequestBody;
7. import org.springframework.web.bind.annotation.RequestMapping;
8. import org.springframework.web.bind.annotation.RestController;
10. @RestController
11. @RequestMapping("/api/users")
12. public class UserController {
14.     @GetMapping("/")
15.     public String getUsers() {
16.         return "Hello, Users!";
17.     }
19.     @GetMapping("/{id}")
20.     public String getUserById(@PathVariable Long id) {
21.         return "User with id: " + id;
22.     }
24.     @PostMapping("/")
25.     public String createUser(@RequestBody String user) {
26.         return "Creating user: " + user;
27.     }
29.     @PutMapping("/{id}")
30.     public String updateUser(@PathVariable Long id, @RequestBody String user) {
31.         return "Updating user with id: " + id + " with " + user;
32.     }
34.     @DeleteMapping("/{id}")
35.     public String deleteUser(@PathVariable Long id) {
36.         return "Deleting user with id: " + id;
37.     }
38. }

复制代码

代码表明：

• @GetMapping("/{id}")：处理 GET 哀求，路径中的 {id} 是一个路径变量，使用 @PathVariable 注解将其绑定到方法参数 id 上。
  
• @PostMapping("/")：处理 POST 哀求，@RequestBody 注解将哀求体中的数据绑定到方法参数 user 上。
  
• @PutMapping("/{id}")：处理 PUT 哀求，可用于更新资源。
  
• @DeleteMapping("/{id}")：处理 DELETE 哀求，可用于删除资源。
  

六、设置应用程序属性（可选）

你可以在 src/main/resources/application.properties 或 application.yml 文件中设置应用程序的属性，例如设置服务器端口：
application.properties：

1. server.port=8081

复制代码

application.yml：

1. server:
2.   port: 8081

复制代码

七、添加服务层和数据访问层（可选）

为了使应用程序更加完善，可以添加服务层（Service）和数据访问层（Repository）。以下是一个简单的示例：
UserService.java：

1. import org.springframework.stereotype.Service;
3. @Service
4. public class UserService {
5.     public String getUserById(Long id) {
6.         return "User with id: " + id;
7.     }
8. }

复制代码

UserController.java：

1. import org.springframework.beans.factory.annotation.Autowired;
2. import org.springframework.web.bind.annotation.GetMapping;
3. import org.springframework.web.bind.annotation.PathVariable;
4. import org.springframework.web.bind.annotation.RequestMapping;
5. import org.springframework.web.bind.annotation.RestController;
7. @RestController
8. @RequestMapping("/api/users")
9. public class UserController {
11.     @Autowired
12.     private UserService userService;
14.     @GetMapping("/{id}")
15.     public String getUserById(@PathVariable Long id) {
16.         return userService.getUserById(id);
17.     }
18. }

复制代码

代码表明：

• @Service 注解将 UserService 标志为一个服务组件。
  
• @Autowired 注解将 UserService 注入到 UserController 中，使得控制器可以调用服务层的方法。
  

通过上述步调，你可以熟悉 Java 的 Spring Boot 创建一个根本的 RESTful API，你学肥了吗，关注威哥爱编程，全栈开发你就行。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。