spring boot recipes第三章 spring MVC注解笔记-优快云博客

本文链接：https://blog.youkuaiyun.com/csdnnmbdybb/article/details/103324116

本文深入探讨SpringBoot中RESTful API的设计与实现，详细解释了@RestController、@Controller、@ResponseBody、@RequestMapping等注解的功能及用法，通过示例展示了如何使用这些注解创建有效的API接口。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@RestController

@RestController 相当于@Controller+@ResponseBody两个注解的结合，返回json数据不需要在方法前面@ResponseBody注解了，但使用这个注解，就不能返回jsp,html页面，视图解析器无法解析jsp,html页面。

简而言之：表明当前类是控制器且返回的是一组数据，不是页面

@Controller

@Controller 将当前修饰的类注入SpringBoot IOC容器，使得从该类所在的项目跑起来的过程中，这个类就被实例化。当然也有语义化的作用，即代表该类是充当Controller的作用

@ResponseBody

@ResponseBody 它的作用简短截说就是指该类中所有的API接口返回的数据，甭管你对应的方法返回Map或是其他Object，它会以Json字符串的形式返回给客户端，本人尝试了一下，如果返回的是String类型，则仍然是String。

@RequestMapping

@RequestMapping有8个属性。

value：指定请求的实际地址。

method：指定请求的method类型（GET,POST,PUT,DELETE）等。

consumes：指定处理请求的提交内容类型（Context-Type）。

produces：指定返回的内容类型，还可以设置返回值的字符编码。

params：指定request中必须包含某些参数值，才让该方法处理。

headers：指定request中必须包含某些指定的header值，才让该方法处理请求。

@GetMapping

类似的还有

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping

如果我们想使用传统的@RequestMapping注释实现URL处理程序，那么它应该是这样的：

@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)

新方法可以简化为：

@GetMapping(value="/get/{id}")

@PathVariable

@PathVariable ：接收请求路径中占位符的值

//@PathVariable可以用来映射URL中的占位符到目标方法的参数中
    @RequestMapping("/testPathVariable/{book}/{id}")
//占位符中有个id和一个book，下面的@PathVariable中的value必须一致
    public String testPathVariable(@PathVariable("id") Integer id,@PathVariable("book") String book)
    {
        System.out.println("testPathVariable:"+id);
        return "OK";
    }

ResponseEntity返回数据、状态、头部信息

@GetMapping("/{isbn}")
public ResponseEntity<Book> get(@PathVariable("isbn") String isbn) {
  return bookService.find(isbn)
      .map(body -> ResponseEntity.ok(body))
      .orElse(ResponseEntity.notFound().build());
}

@PostMapping
public ResponseEntity<Book> create(@RequestBody Book book,
                                   UriComponentsBuilder uriBuilder) {
  Book created = bookService.create(book);
  URI newBookUri = uriBuilder.path("/books/{isbn}").build(created.getIsbn());
  return ResponseEntity
          .created(newBookUri)
          .body(created);
}