Spring+SpringMVC+MyBatis+easyUI整合进阶篇(二)RESTful API实战笔记(接口设计及Java后端实现)

写在前面的话

原计划这部分代码的更新也是上传到ssm-demo仓库中,因为如下原因并没有这么做:

  • 有些使用了该项目的朋友建议重新创建一个仓库,因为原来仓库中的项目太多,结构多少有些乱糟糟的。
  • 而且这次的代码改动较大,与原来的目录结构及代码风格相比都有很大的差别。
  • 同时也考虑到不同的人所处的学习阶段不同,担心有人不习惯也不适应这种风格及后面的更新,有的朋友甚至可能是初学者,更适合学习ssm-demo这个基础项目。

基于以上几点,最终并没有选择把几个项目都放在一个代码仓库中,而是另外花了些时间改动并且重新创建了一个仓库,perfect-ssm另起炉灶,项目也在新的服务器和域名下部署。

接口设计

项目共有三个模块:

  • 文章管理模块
  • 图片管理模块
  • 用户管理模块

针对以上三个模块,并结合前文《设计一套好的RESTful API》中所总结的RESTful API设计原则,对api进行改造,目标接口如下:

图片上传:
原接口 []      http://ssm-demo.hanshuai.xin/loadimage/upload.do
现接口 [POST]  http://perfect-ssm.hanshuai.xin/images

文章添加:
原接口 []      http://ssm-demo.hanshuai.xin/article/save.do
现接口 [POST]  http://perfect-ssm.hanshuai.xin/articles 

文章修改:
原接口 []      http://ssm-demo.hanshuai.xin/article/save.do
现接口 [PUT]  http://perfect-ssm.hanshuai.xin/articles 

文章列表:
原接口 []      http://ssm-demo.hanshuai.xin/article/list.do
现接口 [GET]   http://perfect-ssm.hanshuai.xin/articles

文章删除:
原接口 []      http://ssm-demo.hanshuai.xin/article/delete.do
现接口 [DELETE]http://perfect-ssm.hanshuai.xin/articles

图片添加:
原接口 []      http://ssm-demo.hanshuai.xin/picture/save.do
现接口 [POST]  http://perfect-ssm.hanshuai.xin/pictures

图片修改:
原接口 []      http://ssm-demo.hanshuai.xin/picture/save.do
现接口 [PUT]  http://perfect-ssm.hanshuai.xin/pictures

图片列表:
原接口 []      http://ssm-demo.hanshuai.xin/picture/list.do
现接口 [GET]   http://perfect-ssm.hanshuai.xin/pictures

图片删除:
原接口 []      http://ssm-demo.hanshuai.xin/picture/delete.do
现接口 [DELETE]http://perfect-ssm.hanshuai.xin/pictures

用户登录:
原接口 []      http://ssm-demo.hanshuai.xin/user/login.do
现接口 [POST]  http://perfect-ssm.hanshuai.xin/users/cookie 

用户列表:
原接口 []      http://ssm-demo.hanshuai.xin/user/list.do
现接口 [GET]   http://perfect-ssm.hanshuai.xin/users 

用户删除:
原接口 []      http://ssm-demo.hanshuai.xin/user/delete.do
现接口 [DELETE]http://perfect-ssm.hanshuai.xin/users

用户添加:
原接口 []      http://ssm-demo.hanshuai.xin/user/save.do
现接口 [POST]  http://perfect-ssm.hanshuai.xin/users

修改密码:
原接口 []      http://ssm-demo.hanshuai.xin/user/modifyPassword.do
现接口 [PUT]   http://perfect-ssm.hanshuai.xin/users

根据不同资源映射成不同的uri,对于资源的具体操作类型,由HTTP动词来表示。

java后端实现

前文中提到了一些设计原则,这一篇就是将这些原则运用到项目中,但是理论性的知识看看就忘了,我写博客的目的不是为了写理论概念,没有实际项目配合我是不会写的,我觉得通过代码实现出来,配合实战才能让理论知识吸收的更好。

由于是ssm项目,因此主要是通过SpringMVC实现,更多的是使用了SpringMVC的注解来进行简化开发。

整合过程:

  • 首先是修改web.xml配置文件,使得URI可以符合RESTful风格。
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-context-mvc.xml</param-value>
        </init-param>
        <!--加载顺序为1 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
  • 修改spring-context-mvc.xml配置文件,配置json消息转换器及动态资源过滤。
    <!-- Start: 配置json消息转换器 & 参数解析-->
    <bean id="objectMapper" class="com.fasterxml.jackson.databind.ObjectMapper">
        <property name="dateFormat">
            <bean class="java.text.SimpleDateFormat">
                <constructor-arg index="0" type="java.lang.String" value="yyyy-MM-dd HH:mm:ss"/>
            </bean>
        </property>
    </bean>
    <mvc:annotation-driven>
        <mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="supportedMediaTypes">
                    <list>
                        <value>application/json; charset=UTF-8</value>
                    </list>
                </property>
                <property name="prettyPrint" value="true"/>
                <property name="objectMapper" ref="objectMapper"/>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <!-- End: 配置json消息转换器 & 参数解析 -->

    <!-- 使用了<url-pattern>/</url-pattern>,所以要对静态资源进行处理 -->
    <mvc:default-servlet-handler/>

    <!-- 默认的视图解析器 在上边的解析错误时使用 (默认使用html)- -->
    <bean id="defaultViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          p:order="1">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="contentType" value="text/html"/>
        <property name="prefix" value="/WEB-INF/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
  • @RequestMapping注解,规范和限制Http请求的请求方法。
@RequestMapping(value = "", method = RequestMethod.PUT)

@RequestMapping(value = "/{ids}", method = RequestMethod.DELETE)
  • @ResponseBody注解,将返回结果转换为JSON格式。
  • 增加common包,其中的工具类规定了返回状态码及返回数据的基本格式。
public class Constants {

    public static final int RESULT_CODE_SUCCESS = 200;  // 成功处理请求
    public static final int RESULT_CODE_BAD_REQUEST = 412;  // bad request
    public static final int RESULT_CODE_SERVER_ERROR = 500;  // 没有对应结果

}

public class Result<T> implements Serializable {
    private static final long serialVersionUID = 1L;
    private int resultCode;
    private String message;
    private T data;

    public Result() {
    }
}

注意事项

几个需要注意的注解:

  • @RequestMapping
  • @PathVariable
  • @ResponseBody
  • @RequestParam

代码中大量的出现,本文中也一再强调,因此,给正在看本篇文章的你一个建议就是如果你不熟悉这几个注解,花点时间去认真学习和实践一下,知道这几个注解的用法和注意事项,网上针对这些注解的文章有很多,可以针对性的学习一下,这篇文章就不再占用篇幅去赘述了,需要代码的话,直接去我的GitHub仓库中去下载就好。

结语

首发于我的个人博客,新的项目演示地址:perfect-ssm,用户名:admin,密码:123456。

如果有问题或者有一些好的创意,欢迎给我留言,也感谢向我指出项目中存在问题的朋友,本篇主要讲述了后端的实现,关于前端的修改会在下一篇文章中讲述。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Android相关

Gradle For Android(3)--管理依赖关系

依赖关系管理是Gradle的闪光点。在这个脚本中最好的一点,就是你所需要的只是添加一行到你的build.gradle中,然后Gradle就会从一个远程仓库中下载...

11730
来自专栏散尽浮华

Linux下monit进程管理操作梳理

Monit对运维人员来说可谓神器,它是一款功能非常丰富的进程、文件、目录和设备的监测工具,用于Unix平台。它可以自动修复那些已经停止运作的程序,特使适合处理那...

1.5K110

在Debian 8上安装Java

Java是一种功能强大的编程语言。用Java编写的软件可以在任何系统上编译和运行。与Python或C不同,Java不会预先安装在Linode分发映像上。本指南在...

22030
来自专栏跟着阿笨一起玩NET

WebSerivce测试工具 Storm

19900
来自专栏编程

Spring Boot+Mybatis+Redis二级缓存开发指南

背景 Spring-Boot因其提供了各种开箱即用的插件,使得它成为了当今最为主流的Java Web开发框架之一。Mybatis是一个十分轻量好用的ORM框架。...

599100
来自专栏向治洪

Ant打包

Ant打包 使用步骤: 对于已经存在的工程需要利用Ant命令更新一下: android update project -n Test -p D:/wo...

25380
来自专栏遊俠扎彪

Linux pstack 源码里的基础知识

Pstack 是 Linux 下一款堆栈跟踪工具,可以打印一个在跑程序的实时堆栈信息,其用法非常简单,只需要给定进程号即可,本文主要介绍Linux pstack...

73920
来自专栏java闲聊

AvtiveMQ与SpringBoot结合

23870
来自专栏程序猿DD

Spring Boot中增强对MongoDB的配置(连接池等)

之前在博客上转载了一篇关于《如何在Spring Boot中是配置MongoDB的连接数》的文章,相信关注我博客的朋友们肯定也看过了。这篇文章的作者主要重写了 M...

52380
来自专栏SpringBoot 核心技术

SpringCloud组件:你的Eureka服务注册中心安全吗?

在之前的章节我们讲到了SpringCloud组件:搭建Eureka服务注册中心,已经可以让我们自定义的微服务节点进行注册到该Eureka Server上,不过在...

48840

扫码关注云+社区

领取腾讯云代金券