搭建一个 Spring Boot 应用
这不是一个玩具，用以下方法建的 Spring Boot 应用是可以直接在工业应用中的使用的。我们需要以下三个文件，在 Spring Boot getting started 找就可以了。
- pom.xml
- src/main/java/com/example/springboot/Application.java
- src/main/java/com/example/springboot/HelloController.java
获取 HTTP 请求
- 从HTTP请求中提取 query string
查询参数一般有如下格式： interface?param1=value1¶m2=value2。
使用@RequestParam进行接受。@RequestParam注解 require 参数默认为true，表示这个查询参数一定要存在，我们可以设置为 false，这个查询参数就可以不存在。
@RestController
public class HelloController {
@RequestMapping("/search")
public String search(@RequestParam("q") String param,
@RequestParam(value = "charset", required = false) String charset) {
return "you are searching" + param + charset;
}
}
- 获取路径信息
@RequestMapping可以放在METHOD或者TYPE上面，放在TYPE上，一般表示以此为根目录。
我们使用@PathVariable来匹配路径。
@DeleteMapping("...")可以替换成@RequestMapping(value = "...", method = RequestMethod.DELETE)。
此时我们用 postman 模拟 DELTE 操作，访问接口 localhost:8080/repos/golang/lazyben/123。
@RestController
@RequestMapping("repos")
public class IssueController {
@DeleteMapping("/{owner}/{repo}/{issueNumber}")
public void unlock(@PathVariable("owner") String owner,
@PathVariable("repo") String repo,
@PathVariable("issueNumber") String issueNumber) {
System.out.println(owner);
System.out.println(repo);
System.out.println(issueNumber);
}
}
- 从 POST 的负载中获取数据
使用@RequestBody获取负载的内容。我们接受的类只要符合 JavaBean 约定就可以了，Spring 会自动将拿到的 client 传来的数据并生成我们需要类的实例。
@RestController
@RequestMapping("repos")
public class IssueController {
@PostMapping("/{owner}/{repo}/issues")
public void create(@PathVariable("owner") String owner,
@PathVariable("repo") String repo,
@RequestBody User obj) {
System.out.println(obj);
}
}
public class User {
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
我们用 postman 模拟 POST 请求，发送了一段 JSON 信息。
{
"name": "lazyben",
"age": 23
}
得到了错误415，如下所示。这里犯了一个小错误，也是很容易出错的地方。这是由于 client 在向 server 发的 request 中的 header 没有指明 Media Type。解决办法很简单，只需要声明 Content-Type:application/json 即可。
{
"timestamp": "2021-01-05T10:31:29.406+00:00",
"status": 415,
"error": "Unsupported Media Type",
"message": "",
"path": "/repos/golang/lazyben/issues"
}
对于比较少的数据，我们可以直接用表单来传，此时 Content-Type:application/x-wwwform-urlencoded ，并使用 @RequestParam。Spring 只需要提取 body 中的参数即可，下面是一个例子：
@RestController
@RequestMapping("repos")
public class IssueController {
@PostMapping("/login")
public void login(@RequestParam("username") String username,
@RequestParam("password") String password) {
System.out.println(username);
System.out.println(password);
}
}
最后我们对从POST请求中获取参数做一个总结。
| 场景 | Content-Type | 使⽤注解 | 适⽤于 |
|---|---|---|---|
| 提取整个body中的对象 | application/json | @RequestBody | JSON |
| 提取body中的参数 | application/x-wwwform-urlencoded | @RequestParam | 表单 |
生成 HTTP 响应
- 直接操作 HttpServletRespnse 对象
一个 WebApp 监听80端口，从这个端口进来的 HTTP 请求，是怎么变成 Java 对象的呢？在 WebApp 更底层的地方，还存在着 Servlet 容器。Servlet 容器是 Java 世界处理 Web 应用的标准，它可以从机器的端口上面读取字节流，把它封装成 Java 对象方便上层进行处理。上层处理完之后，把结果丢给 Servlet 容器，Servlet 容器又可以将其变成字节流，返回给端口。因此 Servlet 容器扮演的是从字节流到 Java 对象转换的中间层。它的核心接口就是HttpServletRequest和HttpServletResponse。如下代码所示，为什么我们可以直接写在参数里呢？因为Servlet 容器已经帮我们封装好了 Java 对象。
@RestController
public class HelloController {
@RequestMapping("/")
public String index(HttpServletRequest request, HttpServletResponse response) {
response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
return "Greetings from Spring Boot!";
}
}
可以看见的是，我们成功显示了 Greetings from Spring Boot! ，但也拿到了 error 400。
我们来看一下
HttpServletRequest 和 HttpServletResponse这两个对象到底是什么。他们两个代表了当前正在进行的 HTTP 请求和 HTTP 响应。打上断点，来看一看里面有些什么。request 中有 header，cookies等。我们可以用 response.getWriter.write("...") 直接写一些东西回去。总的来说这个方式比较偏向底层、原始、简单、粗暴。
- 直接返回HTML字符串
@RestController
public class HelloController {
@RequestMapping("/")
public String index() {
return "hello word!
";
}
}
- 返回对象，并自动格式化成JSON
这是一个比较常用的方式。对应的我们要写上@ResponseBody
@RestController
public class HelloController {
@RequestMapping("/")
@ResponseBody
public Object index() {
Map result = new HashMap<>();
result.put("result", Arrays.asList("aaa", "bbb", "ccc"));
return result;
}
}
下面是我们得到的结果，可以发现它被自动格式化为了JSON格式。
{"result":["aaa","bbb","ccc"]}
- 模版引擎渲染
常用的模版引擎有JSP/Velocity/Freemaker。
RESTful API
- 使⽤HTTP动词来代表动作
- GET：获取资源
- POST：新建资源
- PUT：更新资源
- DELTE：删除资源
- 使⽤URL（名词）来代表资源
- 资源⾥⾯没有动词
- 使⽤复数来代表资源列表
github api 设计是业界的标杆