RESTFul 风格API

思考：想要实现下面表格所示的请求该如何做？

URL	RequestMethod	remark
/user	POST	新增用户
/user/1	DELETE	删除用户
/user/1	PUT	修改用户
/user	GET	查询用户

1. 非 Spring Boot 项目需要加入一些配置

想要支持 PUT & DELETE 请求首先得配置 HiddenHttpMethodFilter(可以将 POST 请求转化为 PUT & DELETE请求)：

<!-- 配置 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>

新增用户：

@RequestMapping(value="/user", method=RequestMethod.POST)
public String save(User user){
    userDao.save(user);
    return "redirect:/users";
}

删除用户：

拓展：如何将超链接<a href="/user/${id}">Delete</a>转为 DELETE请求?(超链接默认请求方式是 GET )页面中可以这么做：

<!--第一步：借助于JQuery将超链接请求的方式从get改为post方式，引入jquery-->
<script type="text/javascript" src="scripts/jquery-1.7.1.min.js"></script>
<script type="text/javascript">
    $(function () {
        //为所有的class为delete的按钮点击动作添加行为函数
        $(".delete").click(function () {
            //获取class为delete的超链接的地址
            var href = $(this).attr("href");
            //为隐藏域的action赋值并提交
            $("form").attr("action", href).submit();
            return false;
        })
    })
</script>
<!--第二步：创建含有隐藏域的表单请求-->
<form action="" method="POST">
    <!--这里的name必须是_method(可以从源码中得知)，value的值就是要转成的新的请求方式，如果
    没有SpringMVC的delete方式，可以忽略这一行，直接写一个空表单即可-->
    <input type="hidden" name="_method" value="DELETE">
</form>
<!--第三步：为超链接添加class属性，根据class改变其请求方式-->
<td><a class="delete" href="${pageContext.request.contextPath}/user/${user.id}">Delete</a>

可能会遇到的问题: 上述代码可能会涉及到spring mvc 静态资源访问的问题，在springmvc.xml中做如下配置即可：

<!--  
        default-servlet-handler 将在 SpringMVC 上下文中定义一个 DefaultServletHttpRequestHandler,
        它会对进入 DispatcherServlet 的请求进行筛查, 如果发现是没有经过映射的请求, 就将该请求交由 WEB 应用服务器默认的 
        Servlet 处理. 如果不是静态资源的请求，才由 DispatcherServlet 继续处理
        一般 WEB 应用服务器默认的 Servlet 的名称都是 default.
        若所使用的 WEB 服务器的默认 Servlet 名称不是 default，则需要通过 default-servlet-name 属性显式指定
    -->
<mvc:default-servlet-handler/>

<mvc:annotation-driven conversion-service="conversionService"></mvc:annotation-driven>

修改用户：

修改的请求方式是 PUT，所以也要使用隐藏域来转换请求方式：

<form action="${pageContext.request.contextPath}/user" method="POST">
    <input type="hidden" name="_method" value="PUT">
    // TODO
</form>

下面是完整示例的修改操作：

@RequestMapping(value="/user", method=RequestMethod.PUT)
public String update(User user){
    userDao.save(user);
    return "redirect:/users";
}

查询用户：

@RequestMapping(value="/user/{id}", method=RequestMethod.GET)
public String input(@PathVariable("id") Integer id, Map<String, Object> map){
    map.put("user", userDao.get(id));
    return "input";
}

上面展示的就是 CRUD 的基本请求以及注意事项，整合起来就是下面这样：

/**
 * spring 4.3 版本之前都是使用 @Controller + @ResponseBody 注解
 */
@Controller
@ResponseBody
// @RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("/users")
    public List<User> list(){
        return userService.getAll();
    }

    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public List<User> save(User user){
        userService.save(user);
        return userService.getAll();
    }

    @RequestMapping(value = "/user/{id}",method = RequestMethod.DELETE)
    public List<User> delete(@PathVariable("id") Integer id){
        userService.delete(id);
        return userService.getAll();
    }

    @RequestMapping("/user/{id}")
    public User get(@PathVariable("id") Integer id){
        return userService.getById(id);
    }

    @RequestMapping(value = "/user",method = RequestMethod.PUT)
    public List<User> update(User user){
        userService.update(user);
        return userService.getAll();
    }
}

但是在 Spring 4.3 之后又新增了几个注解，我们可以使用这些注解来简化我们的代码，示例如下：

/**
 * @RestController 注解相当于 @Controller + @ResponseBody 注解
 */
@RestController
public class RestUserController {

    private final static Log LOGGER = LogFactory.getLog(UserController.class);

    @Resource
    private UserService userService;

    @GetMapping("/users") // 相当于@RequestMapping("/users")
    public List<User> getAll(){
        LOGGER.info("GetMapping ... ");
        return userService.getAll();
    }

    @GetMapping("/user/{id}") // @RequestMapping("/user/{id}")
    public User get(@PathVariable("id") Integer id){
        LOGGER.info("get user ...");
        return userService.getById(id);
    }

    @PostMapping("user") // 相当于@RequestMapping(value = "/user",method = RequestMethod.POST)
    public List<User> save(User user){
        LOGGER.info("save user ...");
        userService.save(user);
        return userService.getAll();
    }

    @DeleteMapping("/user/{id}") // 相当于@RequestMapping(value = "/user/{id}",method = RequestMethod.DELETE)
    public List<User> delete(@PathVariable("id") Integer id){
        LOGGER.info("delete user ...");
        userService.delete(id);
        return userService.getAll();
    }

    @PutMapping("/user") // 相当于@RequestMapping(value = "/user",method = RequestMethod.PUT)
    public List<User> update(User user){
        LOGGER.info("update user ...");
        userService.update(user);
        return userService.getAll();
    }
}

2. 那么在 Spring Boot 项目中该怎么做呢？也要配置那些玩意儿？？？

答案是不需要！
时下流行的 Spring Boot 是不需要我们自己再去添加其他配置来完成 PUT & DELETE 请求的转换的，因为它都帮我们配置好了。
以上就是本次分享的知识点，可以实战操作一波先。。。

我是bearPotMan，一个经验不足的十八线演(码)员(农)。
Konw everything,control everything!