当前位置: 移动技术网 > IT编程>开发语言>Java > SpringMVC Restful api接口实现的代码

SpringMVC Restful api接口实现的代码

2019年07月19日  | 移动技术网IT编程  | 我要评论

【前言】

面向资源的 restful 风格的 api 接口本着简洁,资源,便于扩展,便于理解等等各项优势,在如今的系统服务中越来越受欢迎。

.net平台有webapi项目是专门用来实现restful api的,其良好的系统封装,简洁优雅的代码实现,深受.net平台开发人员所青睐,在后台服务api接口中,已经逐步取代了辉煌一时mvc controller,更准确地说,合适的项目使用更加合适的工具,开发效率将会更加高效。

python平台有tornado框架,也是原生支持了restful api,在使用上有了很大的便利。

java平台的springmvc主键在web开发中取代了struts2而占据了更加有力的地位,我们今天着重讲解如何在java springmvc项目中实现restful api。

【实现思路】

restful api的实现脱离不了路由,这里我们的restful api路由由spring mvc 的 controller来实现。

【开发及部署环境】

开发环境:windows 7 ×64 英文版

     intellij idea 2017.2

部署环境:jdk 1.8.0

     tomcat 8.5.5

测试环境:chrome

        fiddler

【实现过程】

1、搭建spring mvc maven项目

这里的搭建步骤不再赘述,如有需要参考:

2、新建控制器 studentcontroller

为了体现restful api 我们采用注解,requestmapping("/api/student")

具体的代码如下:

package controllers;

import org.springframework.web.bind.annotation.*;

@restcontroller
@requestmapping("/api/student")
public class studentcontroller {

 @requestmapping(method = requestmethod.get)
 public string get() {
  return "{\"id\":\"1\",\"name\":\"1111111111\"}";
 }

 @requestmapping(method = requestmethod.post)
 public string post() {
  return "{\"id\":\"2\",\"name\":\"2222222222\"}";
 }

 @requestmapping(method = requestmethod.put)
 public string put() {
  return "{\"id\":\"3\",\"name\":\"3333333333\"}";
 }

 @requestmapping(method = requestmethod.delete)
 public string delete() {
  return "{\"id\":\"4\",\"name\":\"4444444444\"}";
 }

 @requestmapping(value = "/{id}",method = requestmethod.get)
 public string get(@pathvariable("id") integer id) {
  return "{\"id\":\""+id+"\",\"name\":\"get path variable id\"}";
 }
}

这里有get,post,put,delete分别对应 查询,添加,修改,删除四种对资源的操作,即通常所说的crud。

spring mvc可实现restful的方式有@controller和@restcontroller两种方式,两种方式的区别如下:

@controller的方式实现如果要返回json,xml等文本,需要额外添加@responsebody注解,例如: 

   @responsebody //用于返回json数据或者text格式文本
  @requestmapping(value = "/testjson", method = requestmethod.get)
  public string testjson() {
   return "{\"id\":\"1001\",\"name\":\"zhangsan\"}";
  }

@restcontroller方式不需要写@responsebody,但是不能返回模型绑定数据和jsp视图,只能返回json,xml文本,仅仅是为了更加方便返回json资源而已。

上述的rest方法中多写了个get方法: 

 @requestmapping(value = "/{id}",method = requestmethod.get)
  public string get(@pathvariable("id") integer id) {
   return "{\"id\":\""+id+"\",\"name\":\"get path variable id\"}";
  }

该方法可以直接在url拼接一个参数,更加方便对资源的定向访问,例如查一个student list 可以默认空参数,而查询对应的某一个student详情信息,可以id=studentid 定向查询单条,使得我们对资源的访问更加快捷方便。

【系统测试】

运行系统,使用fiddler调用restful api接口:

1.get方式

  

2.post方式

   

3.put方式

  

4.delete方式

   

5.get/id方式

   

至此,可见我们的spring mvc restful api接口已经全部通过测试!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持移动技术网。

如对本文有疑问, 点击进行留言回复!!

相关文章:

验证码:
移动技术网