关于spring mvc 接口 Restful 化的问题

[zhanyeye]

@DirectorJerrian

dingtalk-app-server/src/main/java/com/softeng/dingtalk/controller/PrizeController.java

Lines 49 to 61 in e931b95

	@PostMapping("/prize/update")
	public void updatePrize(@RequestBody PrizeVO prizeVO){
	prizeService.updatePrize(prizeVO);
	}
	/**
	* 删除奖项
	* @param prizeId
	*/
	@GetMapping("/prize/delete")
	public void deletePrize(@RequestBody int prizeId){
	prizeService.deletePrize(prizeId);
	}

请看超人：RESTful API 设计指南

这里的@PostMapping("/prize/update") ，@GetMapping("/prize/delete") 好像不符合Restful 风格，（当然因为历史原因，项目的有些代码也没遵循 Restful 风格），可以用：

• @PutMapping("/prize")
• @DeleteMapping("/prize/{id}")
  其他注解：

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping

HTTP请求方法一览

方法	说明
GET	GET请求会显示请求指定的资源。一般来说GET方法应该只用于数据的读取，而不应当用于会产生副作用的非幂等的操作中。它期望的应该是而且应该是安全的和幂等的。这里的安全指的是，请求不会影响到资源的状态。
HEAD	HEAD方法与GET方法一样，都是向服务器发出指定资源的请求。但是，服务器在响应HEAD请求时不会回传资源的内容部分，即：响应主体。这样，我们可以不传输全部内容的情况下，就可以获取服务器的响应头信息。HEAD方法常被用于客户端查看服务器的性能。
POST	POST请求会 向指定资源提交数据，请求服务器进行处理，如：表单数据提交、文件上传等，请求数据会被包含在请求体中。POST方法是非幂等的方法，因为这个请求可能会创建新的资源或/和修改现有资源。
PUT	PUT请求会身向指定资源位置上传其最新内容，PUT方法是幂等的方法。通过该方法客户端可以将指定资源的最新数据传送给服务器取代指定的资源的内容。
DELETE	DELETE请求用于请求服务器删除所请求URI（统一资源标识符，Uniform Resource Identifier）所标识的资源。DELETE请求后指定资源会被删除，DELETE方法也是幂等的。
CONNECT	CONNECT方法是HTTP/1.1协议预留的，能够将连接改为管道方式的代理服务器。通常用于SSL加密服务器的链接与非加密的HTTP代理服务器的通信。
OPTIONS	OPTIONS请求与HEAD类似，一般也是用于客户端查看服务器的性能。 这个方法会请求服务器返回该资源所支持的所有HTTP请求方法，该方法会用'*'来代替资源名称，向服务器发送OPTIONS请求，可以测试服务器功能是否正常。JavaScript的XMLHttpRequest对象进行CORS跨域资源共享时，就是使用OPTIONS方法发送嗅探请求，以判断是否有对指定资源的访问权限。
TRACE	TRACE请求服务器回显其收到的请求信息，该方法主要用于HTTP请求的测试或诊断。
PATCH	PATCH方法出现的较晚，它在2010年的RFC 5789标准中被定义。PATCH请求与PUT请求类似，同样用于资源的更新。二者有以下两点不同：1.PATCH一般用于资源的部分更新，而PUT一般用于资源的整体更新。2.当资源不存在时，PATCH会创建一个新的资源，而PUT只会对已在资源进行更新。

[zhanyeye]

补充一下哈~
Restful 风格 DELETE 的使用的例子~

    @DeleteMapping("users/{uid}")
    public void rmUser(@PathVariable int uid) {
        userService.rmUser(uid);
    }

[zhanyeye]

修改前：

dingtalk-app-server/src/main/java/com/softeng/dingtalk/controller/PrizeController.java

Lines 20 to 63 in 1aa968d

	@RequestMapping("/api")
	public class PrizeController {
	@Autowired
	PrizeService prizeService;
	/**
	* 获取用户的获奖情况
	*
	* @param uid
	* @return
	*/
	@GetMapping("/prizeList")
	public List<Prize> findByUserId(@RequestAttribute int uid) {
	return prizeService.findByUser(uid);
	}
	/**
	* 新增奖项
	* @param uid
	* @param prizeVO
	*/
	@PutMapping("/prize")
	public void addNewPrize(@RequestAttribute int uid, @RequestBody PrizeVO prizeVO){
	prizeService.addNewPrize(uid,prizeVO);
	}
	/**
	* 更新奖项信息
	* @param prizeVO
	*/
	@PostMapping("/prize/update")
	public void updatePrize(@RequestBody PrizeVO prizeVO){
	prizeService.updatePrize(prizeVO);
	}
	/**
	* 删除奖项
	* @param prizeId
	*/
	@DeleteMapping("/prize")
	public void deletePrize(@RequestBody int prizeId){
	prizeService.deletePrize(prizeId);
	}
	}

修改后：

+ @RequestMapping("/api/users")    // 因为奖品属于某个用户
- @RequestMapping("/api")
public class PrizeController {
    @Autowired
    PrizeService prizeService;

    /**
     * 获取用户的获奖情况
     *
     * @param uid
     * @return
     */
+    @GetMapping("/{uid}/prizes")    // 列出某个用户的所有prize, 路径里传了uid, 但参数表中用 @RequestAttribute int uid，防止伪造请求
-    @GetMapping("/prizeList")
    public List<Prize> findByUserId(@RequestAttribute int uid) {
        return prizeService.findByUser(uid);
    }

    /**
     * 新增奖项
     * @param uid
     * @param prizeVO
     */
+    @PostMapping("/{uid}/prizes")    // 新建某个用户的一个 prize
-    @PutMapping("/prize")
    public void addNewPrize(@RequestAttribute int uid, @RequestBody PrizeVO prizeVO){
        prizeService.addNewPrize(uid,prizeVO);
    }

    /**
     * 更新奖项信息
     * @param prizeVO
     */
+    @PutMapping("/{uid}/prizes/{prizeId}")    // 更新某个用户的某个指定prize的信息（提供该prize的全部信息），prizeId 其实没有用到，没关系~
-    @PostMapping("/prize/update")
    public void updatePrize(@RequestBody PrizeVO prizeVO){
        prizeService.updatePrize(prizeVO);
    }

    /**
     * 删除奖项
     * @param prizeId
     */
+    @DeleteMapping("/{uid}/prizes/{prizeId}")    // 删除某个用户的某个 prize
+    public void deletePrize(@PathVariable int prizeId){
-    @DeleteMapping("/prize")
-    public void deletePrize(@RequestBody int prizeId){
        prizeService.deletePrize(prizeId);
    }
}

@DirectorJerrian @RickyWu9 @lilingj

[zhanyeye]

可以仔细看一下嘿🍄： https://www.ruanyifeng.com/blog/2014/05/restful_api.html