`
weigang.gao
  • 浏览: 491631 次
  • 性别: Icon_minigender_1
  • 来自: 上海
文章分类
社区版块
存档分类
最新评论

Spring MVC风格的restful接口开发

 
阅读更多

项目的目录结构如下:


1.流程图

略。。

 

2.服务端代码

①实体类

package com.bjsxt.model;

import java.io.Serializable;

public class Person implements Serializable{

	/**
	 * 
	 */
	private static final long serialVersionUID = -3727979363425652597L;

	private int id;
	
	private String name;
	
	private String sex;
	
	private int age;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getSex() {
		return sex;
	}

	public void setSex(String sex) {
		this.sex = sex;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}
}

 

②接口编码IPersonService

package com.bjsxt.server;

import javax.ws.rs.core.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import com.bjsxt.model.Person;


/**
 * spring MVC风格的restful接口
 * 
 * @author gaoweignag
 * @since JDK1.7
 */
@RequestMapping("/test")
@Controller
public interface IPersonService {


	@RequestMapping(value = "/hello", produces = "text/plain;charset=UTF-8")
	public @ResponseBody
	String hello();

	
	@RequestMapping(value = "/say/{msg}", produces = "application/json;charset=UTF-8")
	public @ResponseBody
	String say(@PathVariable(value = "msg") String msg);

	
	@RequestMapping(value = "/person/{id:\\d+}", method = RequestMethod.GET, produces = "application/json;charset=UTF-8")
	public @ResponseBody
	String getPerson(@PathVariable("id") int id);
	
	
	@RequestMapping(value = "/person/{id:\\d+}", method = RequestMethod.DELETE)
	public @ResponseBody Object deletePerson(@PathVariable("id") int id) ;
	
	/**
	 * 推荐使用,这种可以解决绝大多数问题
	 * @param person
	 * @return
	 */
	@RequestMapping(value = "/person", method = RequestMethod.POST, 
			produces = {MediaType.APPLICATION_JSON,"application/json;charset=UTF-8"},
			consumes = {MediaType.APPLICATION_JSON,MediaType.APPLICATION_XML})
	public String addPerson(Person person);
	
	
	@RequestMapping(value = "/person", method = RequestMethod.PUT)
	public @ResponseBody Object updatePerson(@RequestBody Person person);
	
	
}

 

③接口实现类PersonService

package com.bjsxt.server.impl;

import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.core.MediaType;
import net.sf.json.JSONObject;

import org.apache.log4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import com.bjsxt.model.Person;
import com.bjsxt.server.IPersonService;


/**
 * spring MVC风格的restful接口
 * 
 * @author gaoweignag
 * @since JDK1.7
 */
@Controller
public class PersonService implements IPersonService{

	/** 日志实例 */
	private static final Logger logger = Logger.getLogger(PersonService.class);

	public @ResponseBody
	String hello() {
		logger.info("hello........");
		return "你好!hello";
	}

	public @ResponseBody
	String say(@PathVariable(value = "msg") String msg) {
		return "{\"msg\":\"you say:'" + msg + "'\"}";
	}

	public @ResponseBody
	String getPerson(@PathVariable("id") int id) {
		logger.info("获取人员信息id=" + id);
		Person person = new Person();
		person.setName("张三");
		person.setSex("男");
		person.setAge(30);
		person.setId(id);
		
		JSONObject jsonObject = JSONObject.fromObject(person);
		logger.info(jsonObject);
		logger.info(jsonObject.toString());
		return jsonObject.toString();
	}
	
	public Object deletePerson(@PathVariable("id") int id) {
		logger.info("删除人员信息id=" + id);
		JSONObject jsonObject = new JSONObject();
			jsonObject.put("msg", "删除人员信息成功");
	return jsonObject;
	}


	public @ResponseBody String addPerson(@RequestBody Person person) {
		logger.info("注册人员信息成功id=" + person.getId());
		JSONObject jsonObject = new JSONObject();
		jsonObject.put("msg", "注册人员信息成功");
		return jsonObject.toString();
	}
	
	public @ResponseBody Object updatePerson(@RequestBody Person person) {
		logger.info("更新人员信息id=" + person.getId());
		JSONObject jsonObject = new JSONObject();
		jsonObject.put("msg", "更新人员信息成功");
		return jsonObject.toString();
	}

}

 

④配置web.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <display-name>springMVCRestful</display-name>
  <servlet>
    <servlet-name>springMVCRestful</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>    
  </servlet>
  <servlet-mapping>
    <servlet-name>springMVCRestful</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
  <!-- 如果有乱码我们则需要配置字符编码集的过滤器来防止乱码问题 -->
    <filter>
      <filter-name>encodingFilter</filter-name>
      <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
      <init-param>
        <param-name>encoding</param-name>
        <param-value>utf-8</param-value>
      </init-param>
      <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
      </init-param>
    </filter>
    
    <filter-mapping>
      <filter-name>encodingFilter</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>    
    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

 

⑤配置spring mvc文件springMVCRestful-servlete.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:context="http://www.springframework.org/schema/context"
             xmlns:aop="http://www.springframework.org/schema/aop"
             xmlns:tx="http://www.springframework.org/schema/tx"
             xmlns:mvc="http://www.springframework.org/schema/mvc"
             xsi:schemaLocation="http://www.springframework.org/schema/beans
                     http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
                     http://www.springframework.org/schema/context
                     http://www.springframework.org/schema/context/spring-context-3.0.xsd
                     http://www.springframework.org/schema/aop
                     http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
                     http://www.springframework.org/schema/tx
                     http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
                     http://www.springframework.org/schema/mvc 
                     http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"
                     default-autowire="byName"
                     >
   <!-- 初始化com.bjsxt目录下面的bean  -->
   <context:component-scan base-package="com.bjsxt"></context:component-scan>
   
   <!-- 消息适配器 -->
   <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="messageConverters">
          <list>
               <!-- json转换器 -->
                <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />
            </list>
        </property>
    </bean>
	
  
  <!--配置spring MVC的注解 驱动 -->
  <mvc:annotation-driven/>
</beans>

 

3.客户端代码PersonClientTest,使用junit进行单元测试

package com.bjsxt.client;

import org.apache.log4j.Logger;
import org.junit.BeforeClass;
import org.junit.Test;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;

import com.bjsxt.model.Person;

public class PersonClientTest {
	
	private static Logger LOG = Logger.getLogger(PersonClientTest.class); 
	
	private static RestTemplate template = null;
	
	@BeforeClass
	public static void beforeClass(){
		template = new RestTemplate(); 
		
	}
	
	@Test
	public void testHello(){
		LOG.info("进入hello Method start...");
		String url = "http://localhost:8080/springMVCRestful/test/hello";
		/**
		 * 第一个参数是restful接口请求路径
		 * 第二个参数是响应的类型 String.class
		 */
		String result = template.getForObject(url, String.class);
		LOG.info("输出结果:"+result);
		LOG.info("进入hello Method end...");
	}
	
	@Test
	public void testSay(){
		LOG.info("进入say Method start...");
		String url = "http://localhost:8080/springMVCRestful/test/say/gaoweigang";
		String result = template.getForObject(url, String.class);
		LOG.info("输出结果:"+result);
		LOG.info("进入say Method end...");
		
	}
	
	@Test
	public void testGetPerson(){
		LOG.info("进入getPerson Method start...");
		/**
		 * restful参数类型是int,不能传String类型的参数,否则调用不到接口
		 */
		String url = "http://localhost:8080/springMVCRestful/test/person/101";
		String result = template.getForObject(url, String.class);
		LOG.info("输出结果:"+result);
		LOG.info("进入getPerson Method end...");
		
	}
	
	
	@Test
	public void testDeletePerson(){
		LOG.info("进入deletePerson Method start...");
		/**
		 * restful参数类型是int,不能传String类型的参数,否则调用不到接口
		 */
		String url = "http://localhost:8080/springMVCRestful/test/person/1234";
		
		try {
			template.delete(url);
		} catch (RestClientException e) {
			e.printStackTrace();
		} 
		LOG.info("进入deletePerson Method end...");
		
	}
	
	
	@Test
	public void testUpdatePerson(){
		LOG.info("进入UpdatePerson Method start...");
		/**
		 * restful参数类型是int,不能传String类型的参数,否则调用不到接口
		 */
		String url = "http://localhost:8080/springMVCRestful/test/person";
		
		try {
			Person person =new Person();
			person.setId(1234);
			person.setName("gaoweigang");
			person.setAge(22);
			person.setSex("男");
			
			template.put(url, person);
		} catch (RestClientException e) {
			e.printStackTrace();
		} 
		LOG.info("进入UpdatePerson Method end...");
		
	}
	
	@Test
	public void testAddPerson(){
		LOG.info("进入addPerson Method start...");
		/**
		 * restful参数类型是int,不能传String类型的参数,否则调用不到接口
		 */
		String url = "http://localhost:8080/springMVCRestful/test/person";
		Person person =new Person();
		person.setId(1234);
		person.setName("gaoweigang");
		person.setAge(22);
		person.setSex("男");
		
		String result = template.postForObject(url, person, String.class);
		LOG.info("输出结果为:"+result);
		
		LOG.info("进入addPerson Method end...");
		
	}


}

 

4.启动tomcat服务后,就可以对PersonClientTest进行单元测试了

 

可能遇到的问题:

1.The prefix "mvc" for element "mvc:annotation-driven" is not bound 的解决方法

在spring mvc在配置文件中添加namespace

xmlns:mvc="http://www.springframework.org/schema/mvc"
http://www.springframework.org/schema/mvc 
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"
  • 大小: 32.1 KB
分享到:
评论
1 楼 wangyudong 2018-03-14  
非常详细的代码实例,试着写出了自己的API用Wisdom RESTClient一次就测通,生成精美的测试报告和API文档
Wisdom RESTClient
https://github.com/Wisdom-Projects/rest-client

谢谢作者的分享!赞一个!

相关推荐

    spring mvc restful service

    Spring MVC 是一个强大的Java框架,用于构建Web应用程序,特别是对于基于模型-视图-控制器(MVC...通过这种方式,你可以更好地理解如何结合Spring MVC、RESTful设计原则以及Maven构建工具来开发高效、可维护的Web服务。

    restful 接口开发规范(RESTfulAPIdesignguide)

    在开发RESTful接口时,我们需要遵循一定的设计规范来确保接口的一致性、可维护性和易用性。RESTful API(Representational State Transfer,也称为RESTful web服务)是一种提供互联网计算机系统间互操作性的方法。...

    Spring MVC RESTFUL接口实例和android测试客户端

    **Spring MVC RESTful接口实例详解** Spring MVC 是一个强大的Java Web框架,用于构建基于模型-视图-控制器(MVC)架构的Web应用程序。RESTful是Representational State Transfer的缩写,是一种网络应用程序的设计...

    RESTful_Spring3MVC

    Spring 3 MVC框架是Java开发者广泛使用的构建Web应用的工具,它为开发RESTful API提供了强大的支持。本教程将深入探讨如何利用Spring 3 MVC实现RESTful服务。 首先,理解REST的基本原则至关重要。RESTful架构有以下...

    最全最经典spring-mvc教程

    除此之外,教程可能还会涵盖Spring MVC的RESTful API设计,如何创建JSON响应,以及使用Spring Boot快速构建Spring MVC应用。Spring Boot简化了配置,提供了预配置的依赖,使得开发者能更快地启动项目。 错误处理和...

    Spring mvc RESTful demo

    **Spring MVC RESTful 示例** Spring MVC 是 Spring 框架的一部分,它主要用于构建 Web 应用程序,尤其是处理 HTTP 请求和响应。RESTful 风格的 Web 服务已经成为现代 Web 开发的标准,因为它强调简单、轻量级的...

    spring3 mvc restful freemarker jquery json

    综上所述,这个整合架构提供了一种高效的Web开发模式,Spring3 MVC处理后端逻辑,RESTful设计优化了接口,FreeMarker生成动态页面,jQuery简化了前端交互,而JSON则作为数据交换的桥梁。这样的组合能够帮助开发者...

    Mastering Spring MVC 4(2015.09)源码

    此外,Spring MVC 4还支持RESTful风格的Web服务,通过@RequestMapping注解的produces和consumes属性,可以处理不同格式的HTTP请求和响应,如JSON、XML等。 总的来说,"Mastering Spring MVC 4(2015.09)源码"提供了...

    Spring MVC 教程快速入门 深入分析

    Spring MVC是一种基于Java的实现了MVC设计模式的请求驱动类型的轻量级Web框架,使用了IoC容器,支持RESTful风格的应用程序开发。Spring MVC通过分离模型(Model)、视图(View)和控制器(Controller)来简化Web开发...

    spring mvc 4.0

    在Spring MVC 4.0版本中,它引入了许多改进和新特性,以提升开发效率和应用程序的性能。 1. **依赖注入**:Spring MVC 4.0继续支持Spring框架的核心功能,依赖注入(DI),允许开发者通过配置来管理对象及其依赖...

    自动配置和Spring MVC来创建一个RESTful Web服务.rar

    4. **RESTful Web服务**: REST(Representational State Transfer)是一种网络应用程序的设计风格和开发方式,基于HTTP协议,以资源为中心,通过统一的接口(如GET、POST、PUT、DELETE等HTTP方法)操作资源。RESTful...

    spring MVC .docx

    12. **RESTful**: Spring MVC支持RESTful Web服务,通过HTTP动词(GET、POST、PUT、DELETE等)和URI结构来创建无状态、客户端驱动的接口。 13. **Spring Data Access**: Spring MVC可以与Spring Data、Hibernate、...

    Spring mvc实现Restful返回xml格式数据实例详解

    在实现RESTful接口时,通常会定义好一系列的资源路径,并为这些路径编写对应的Controller方法。如"/api/coffees/{id}",其中{id}就是通过@PathVariable获取的路径变量,可以用来表示具体的操作哪个资源。 总结来说...

    Spring实现RESTful Web 服务Demo

    本教程将通过一个名为"spring-mvc-demo"的项目,详细介绍如何使用Spring框架来实现RESTful Web服务。 一、Spring MVC与RESTful Web服务 Spring MVC是Spring框架的一部分,专门用于处理Web请求和响应。RESTful Web...

    Spring MVC 基础实例源码01

    14. **RESTful API**:Spring MVC通过`@RestController`和`@RequestMapping`可以轻松创建RESTful风格的API,便于前后端分离的开发。 15. **Spring MVC的配置**:包括XML配置和Java配置两种方式,现在更推荐使用Java...

    使用Spring4 MVC 构建RESTful服务器,输出JSON格式的数据结构

    在现代Web开发中,构建RESTful服务已经成为标准实践,它以简洁、无状态的方式提供了HTTP接口,便于客户端和服务器之间的数据交互。Spring4 MVC作为Java领域最流行的MVC框架之一,提供了一流的支持来构建RESTful API...

    Spring MVC学习框架

    11. **RESTful 支持**:Spring MVC 通过 @RequestMapping 注解支持 RESTful 风格的 Web 服务,可以方便地创建资源操作接口。 12. **国际化与本地化**:Spring MVC 提供了支持多语言的功能,可以根据用户的 locale ...

    spring MVC文档

    此外,Spring MVC支持RESTful Web服务,通过@RequestMapping注解可以声明式地定义URL映射。HTTP方法如GET、POST、PUT、DELETE等可以被精确地映射到控制器方法。同时,Spring MVC还提供了异常处理机制,可以自定义...

    精通Spring MVC4

    《精通Spring MVC4》这本书是Java开发者们的重要参考资料,它深入浅出地讲解了Spring MVC这一强大框架的各个方面。...《精通Spring MVC4》这本书将帮助读者全面掌握这些知识,并提升实际开发能力。

Global site tag (gtag.js) - Google Analytics