Spring Boot - 如何在 HTTP Post api 中传递自定义值？

Question

我是 Spring Boot 新手，我很难理解如何传递数据。例如：

我想将这些数据传递给我的服务器：

{
    "code", 1,
    "name": "C01"
}

所以我创建了 always 一个自定义对象，其中包含代码和名称作为属性来拥有这个 http post api？

@RequestMapping(value = "/new/", method = RequestMethod.POST)
public ResponseEntity<?> createOrder(@RequestBody CustomObject customObject){
    ...
}

我看到的另一个解决方案可能是这样，但我不能传递数字（int 代码），对吧？

@RequestMapping(value = "/new/{code}/{name}", method = RequestMethod.POST)
    public ResponseEntity<?> createOrder(@PathVariable("code") int code, @PathVariable("name") String name) {
        ...
}

亲切的问候:)

Answer 1

您可以将code 和name 传递为PathVariables，就像在您的示例中一样：

@RequestMapping(value = "/new/{code}/{name}")
public ResponseEntity<?> createOrder(@PathVariable("code") int code, @PathVariable("name") String name) {
    ...
}

根据文档，PathVariable 可以是 int 或 String 或 long 或 Date：

@PathVariable 参数可以是任何简单类型，例如 int、long、Date 等。Spring 会自动转换为适当的类型，如果转换失败则抛出 TypeMismatchException。

您还可以像这样定义Map<String, Object> 类型的PathVariable：

@RequestMapping(value = "/new/{code}/{name}")
public ResponseEntity<?> createOrder(@PathVariable("map") Map<String, Object> map) {
    Integer code = (Integer) map.get("code");
    String name = (String) map.get("name");
    ...
}

您甚至可以使用@RequestParam 并以 URL 查询参数的形式提供数据。

因此，可以通过多种方式将数据传递给 Spring MVC 控制器（更多详细信息in the docs），但我认为发布复杂数据的约定（我的意思是“复杂”不止一个状态）是定义一个请求正文，其中包含该复杂状态的序列化形式，即您在问题的第一个示例中显示的内容：

@RequestMapping(value = "/new/", method = RequestMethod.POST)
public ResponseEntity<?> createOrder(@RequestBody CustomObject customObject){
    ...
}

Answer 2

如果这个问题是关于 RESTful 最佳实践的，因为您正在开发用于创建 Order 对象的 web 服务，这就是我的设计方式

Order.java

public class Order {

  private Integer code;
  private String name;

  public Integer getCode() {
    return code;
  }

  public void setCode(final Integer code) {
    this.code = code;
  }

  public String getName() {
    return name;
  }

  public void setName(final String name) {
    this.name = name;
  }
}

控制器

@RequestMapping(value = "/orders", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Order> createOrder(@Valid @RequestBody Order order){
    ...
}

从技术上讲，你可以做很多事情来实现同样的事情，但这不会是一个 RESTful 服务，它充其量只是一个 RPC。