docs/basis/sringboot-restful-web-service.md · MilkCoder/springboot-guide

###  RESTful Web 服务介绍

本节我们将开发一个简单的 RESTful Web 服务。

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

为了节省时间，本篇内容的代码是在 **[Spring Boot 版 Hello World & Spring Boot 项目结构分析](https://snailclimb.gitee.io/springboot-guide/#/./start/springboot-hello-world)** 基础上进行开发的。

### 内容概览

通过下面的内容你将学习到下面这些东西：

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

### 下载 Lombok 优化代码利器

因为本次开发用到了 Lombok 这个简化 Java 代码的工具，所以我们需要在 pom.xml 中添加相关依赖。如果对 Lombok 不熟悉的话，我强烈建议你去了解一下，可以参考这篇文章：[《十分钟搞懂Java效率工具Lombok使用与原理》](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485385&idx=2&sn=a7c3fb4485ffd8c019e5541e9b1580cd&chksm=cea24802f9d5c1144eee0da52cfc0cc5e8ee3590990de3bb642df4d4b2a8cd07f12dd54947b9&token=1381785723&lang=zh_CN#rd)

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

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

![ IDEA 中下载支持 lombok 的插件](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/lombok-idea.png)

### RESTful Web 服务开发

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

`com.example.helloworld.entity`

```java
/**
 * @author shuang.kou
 */
@Data
public class Book {
    private String name;
    private String description;
}
```

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

```java
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`和`@RestController` 的对比，我会在下一篇文章中单独介绍到（`@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地址中的参数。`@RequestParam ` url的查询参数值。
5. `@RequestBody`:可以**将 *HttpRequest* body 中的 JSON 类型数据反序列化为合适的 Java 类型。**
6. `ResponseEntity`: **表示整个HTTP Response：状态码，标头和正文内容**。我们可以使用它来自定义HTTP Response 的内容。

### 运行项目并测试效果

这里我们又用到了开发 Web 服务必备的 **Postman** 来帮助我们发请求测试。

**1.使用 post 请求给书架增加书籍**

这里我模拟添加了 3 本书籍。

![使用 post 请求给书架增加书籍](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/post-add-book.png)

**2.使用 Delete 请求删除书籍**

这个就不截图了，可以参考上面发Post请求的方式来进行，请求的 url: [localhost:8333/api/book/1](localhost:8333/api/book/1)。

**3.使用 Get 请求根据书名获取特定的书籍**

请求的 url:[localhost:8333/api/book?name=book1](localhost:8333/api/book?name=book1)

### 总结

通过本文我们需到了使用 Lombok 来优化 Java 代码，以及一些开发 RestFul Web 服务常用的注解：`@RestController`  、`@RequestMapping`、`@PostMapping`、`@PathVariable`、`@RequestParam`、`@RequestBody`以及和HTTP Response 有关的 `Responsity`类。关于这些知识点的用法，我在上面都有介绍到，更多用法还需要自己去查阅相关文档。

代码地址：<https://github.com/Snailclimb/springboot-guide/tree/master/source-code/start/hello-world>（建议自己手敲一遍！！！）

MilkCoder/springboot-guide

简介

发行版

贡献者

语言

近期动态

MilkCoder/springboot-guide .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

语言

近期动态

搜索帮助

MilkCoder/springboot-guide