SpringBoot | RESTful Web

RESTful Web 服务介绍

RESTful Web 服务与传统的 MVC 开发一个关键区别是返回给客户端的内容的创建方式：传统的 MVC 模式开发会直接返回给客户端一个视图，但是 RESTful Web 服务一般会将返回的数据以 JSON 的形式返回，这也就是现在所推崇的前后端分离开发。

内容概览

1. Lombok 优化代码利器
2. @RestController
3. @RequestParam以及@Pathvairable
4. @RequestMapping、@GetMapping…
5. Responsity

下载 Lombok 优化代码利器

因为本次开发用到了 Lombok 这个简化 Java 代码的工具，所以我们需要在 pom.xml 中添加相关依赖。如果对 Lombok 不熟悉的话，我强烈建议你去了解一下，可以参考这篇文章：《十分钟搞懂Java效率工具Lombok使用与原理》

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>

并且你需要下载 IDEA 中支持 lombok 的插件

RESTful Web 服务开发

假如我们有一个书架，上面放了很多书。为此，我们需要新建一个 Book 实体类。

com.example.helloworld.entity
/**
 * @author shuang.kou
 */
@Data
public class Book {
    private String name;
    private String description;
}

我们还需要一个控制器对书架上进行添加、查找以及查看。为此，我们需要新建一个 BookController 。

import com.example.helloworld.entity.Book;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

@RestController
@RequestMapping("/api")
public class BookController {

    private List<Book> books = new ArrayList<>();

    @PostMapping("/book")
    public ResponseEntity<List<Book>> addBook(@RequestBody Book book) {
        books.add(book);
        return ResponseEntity.ok(books);
    }

    @DeleteMapping("/book/{id}")
    public ResponseEntity deleteBookById(@PathVariable("id") int id) {
        books.remove(id);
        return ResponseEntity.ok(books);
    }

    @GetMapping("/book")
    public ResponseEntity getBookByName(@RequestParam("name") String name) {
        List<Book> results = books.stream().filter(book -> book.getName().equals(name)).collect(Collectors.toList());
        return ResponseEntity.ok(results);
    }
}

1. @RestController **将返回的对象数据直接以 JSON 或 XML 形式写入 HTTP 响应(Response)中。**绝大部分情况下都是直接以 JSON 形式返回给客户端，很少的情况下才会以 XML 形式返回。转换成 XML 形式还需要额为的工作，上面代码中演示的直接就是将对象数据直接以 JSON 形式写入 HTTP 响应(Response)中。（@Controller +@ResponseBody= @RestController）。

2. @RequestMapping :上面的示例中没有指定 GET 与 PUT、POST 等，因为**@RequestMapping默认映射所有HTTP Action**，你可以使用@RequestMapping(method=ActionType)来缩小这个映射。

3. @PostMapping实际上就等价于 @RequestMapping(method = RequestMethod.POST)，同样的 @DeleteMapping ,@GetMapping也都一样，常用的 HTTP Action 都有一个这种形式的注解所对应。

4. @PathVariable :取url地址中的参数。@RequestParamurl的查询参数值。

   //@PathVariable是取的 /seckill/201801 中的201801
   @RequestMapping(value = "seckill/{courseNo}",method = RequestMethod.GET)
   public Result<Orders> seckill(User user, @PathVariable String courseNo){
       if (user == null){
           return Result.failure();
       }
       return seckillService.seckFlow(user,courseNo);
   }
   //@RequestParam 取的url的查询参数值。 ？后面的值
   //http://localhost:8999/hello?name=team-c 
   @GetMapping("/hello")
   public String greeting(@RequestParam(name = "name", required = false, defaultValue = "World") String name, Model model) {
       model.addAttribute("name", name);
       return "hello";
   }
   

5. @RequestBody:可以将 HttpRequest body 请求体中的 JSON 类型数据反序列化为合适的 Java 类型。

6. ResponseEntity: 表示整个HTTP Response：状态码，标头和正文内容。我们可以使用它来自定义HTTP Response 的内容。