【Java从0到架构师】SpringMVC - RESTful

太过爱你忘了你带给我的痛 2022-09-04 03:51 172阅读 0赞

### RESTful ###

*  RESTful 风格的实践建议
 *  关于 put、delete
 *  @RestController

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/03\_SpringMVC][https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]

REST 的全称是：REpresentational State Transfer，译为"表现层状态转移"

REST 是一种互联网软件架构设计风格

*  定义了一组用于创建 Web 服务的约束
 *  符合 REST 架构的 web 服务，称为 RESTful Web 服务

# RESTful 风格的实践建议 #

1、**URL 中使用名词（建议用复数形式），不使用动词**

*  推荐：/users、/users/6
 *  不推荐：/listUsers、/getUser?id=6、/user/list、/user/get?id=6

2、**使用 HTTP 的方法表达动作**  
![在这里插入图片描述][954e279e2b4643d6909e7d384d5ab6ec.png]  
3、**一个资源连接到其他资源，使用子资源的形式**

*  GET /user/6/cars/88
 *  POST /user/8/cars

4、**API 版本化**

*  mj.com/v1/users
 *  mj.com/v2/users/66

5、**返回 JSON 格式的数据**

6、**发生错误时，不要返回 200 状态码**

# 关于 put、delete #

浏览器的 form 不支持 put，delete，可以使用 **HiddenHttpMethodFilter** 进行转化

*  post + \_method = put
 *  post + \_method = delete

web.xml 中配置 HiddenHttpMethodFilter：

<filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

前端通过隐藏域发送 put、delete 请求：

注意：为了安全起见，很多公司严格禁用 PUT、DELETE 请求

*  Tomcat 现在默认已经不支持 PUT、DELETE 请求

> 可以在 Tomcat 的 conf/web.xml 进行配置，即可支持 PUT、DELETE 请求

# @RestController #

`@RestController` = `@Controller` \+ `@ResponseBody`

*  相当于默认给所有方法都增加了 `@ResponseBody`

@RestController
    @RequestMapping("/users")
    public class RestfulController { 
    	@GetMapping
    	public String list() { 
    		return "list";
    	}
    	@GetMapping("/{id}")
    	public String get(@PathVariable String id) { 
    		return "get - " + id;
    	}
    	@PostMapping
    	public String save() { 
    		return "save";
    	}
    }

如果还是希望跳转页面，就返回 ModelAndView 对象

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]: https://gitee.com/szluyu99/mj_java_frame/tree/master/03_SpringMVC
[954e279e2b4643d6909e7d384d5ab6ec.png]: /images/20220829/108f226124a842ba9775b40cdab5b2f5.png