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,一个经验不足的十八线演(码)员(农)。
Know everything,control everything!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容