如何编写 Java HTTP 接口供别人调用

在实际开发中，我们经常需要编写 HTTP 接口供其他系统或者服务调用。本文将介绍如何使用 Java 编写一个简单的 HTTP 接口，并提供示例代码以及最佳实践。

实际问题

假设我们需要开发一个简单的用户管理系统，其中包括用户的增删改查功能。我们希望提供一个 HTTP 接口，供其他系统调用来实现用户的管理操作。

解决方案

我们将使用 Spring Boot 来快速搭建一个简单的用户管理系统，并提供 HTTP 接口供其他系统调用。首先，我们需要定义一个用户实体类 User，包括用户的 id、姓名和年龄。

public class User {
    private Long id;
    private String name;
    private int age;

    // 省略 getter 和 setter 方法
}

接下来，我们需要定义一个控制器类 UserController，其中包括用户的增删改查接口。

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

    private List<User> users = new ArrayList<>();

    @PostMapping
    public User addUser(@RequestBody User user) {
        users.add(user);
        return user;
    }

    @GetMapping
    public List<User> getUsers() {
        return users;
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return users.stream()
                .filter(user -> user.getId().equals(id))
                .findFirst()
                .orElse(null);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        users.removeIf(user -> user.getId().equals(id));
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        users.removeIf(u -> u.getId().equals(id));
        users.add(user);
        return user;
    }
}

以上代码中，我们定义了添加用户、查询所有用户、查询单个用户、删除用户以及更新用户的接口。通过 @PostMapping、@GetMapping、@DeleteMapping和@PutMapping注解来指定接口的请求方法。

接下来，我们需要在 Application 类中添加启动类，启动 Spring Boot 应用。

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

类图

下面是用户管理系统的类图，包括 User 实体类和 UserController 控制器类。

classDiagram
    class User {
        Long id
        String name
        int age
    }

    class UserController {
        List<User> users
        + addUser(user: User): User
        + getUsers(): List<User>
        + getUser(id: Long): User
        + deleteUser(id: Long): void
        + updateUser(id: Long, user: User): User
    }

    User "1" --> "0..*" UserController

示例

假设我们已经启动了用户管理系统，并且系统运行在 localhost:8080，我们可以使用 Curl 命令或者 Postman 工具来调用接口。

添加用户

curl -X POST -H "Content-Type: application/json" -d '{"id": 1, "name": "Alice", "age": 25}' http://localhost:8080/users

查询所有用户

curl http://localhost:8080/users

查询单个用户

curl http://localhost:8080/users/1

删除用户

curl -X DELETE http://localhost:8080/users/1

更新用户

curl -X PUT -H "Content-Type: application/json" -d '{"id": 1, "name": "Bob", "age": 30}' http://localhost:8080/users/1

结论

通过本文的介绍，我们学习了如何使用 Spring Boot 框架编写一个简单的 HTTP 接口供其他系统调用。我们定义了用户实体类和用户控制器类，并提供了增删改查的接口。通过示例代码和 Curl 命令，我们可以方便地调用接口来实现用户的管理操作。希望本文对您有所帮助，谢谢阅读！