Spring4 MVC REST服务使用@RestController实例

最新推荐文章于 2024-10-12 00:46:48 发布
最新推荐文章于 2024-10-12 00:46:48 发布
阅读量208 收藏
点赞数
文章标签： 测试 json java
原文链接：http://www.cnblogs.com/borter/p/9519783.html
版权
在这篇文章中，我们将通过开发使用 Spring4 @RestController 注解来开发基于Spring MVC4的REST风格的JSON服务。我们将扩展这个例子通过简单的注释与JAXB标注域类支持XML输出和JSON输出。在这个示例中，我们需要URL的后缀为 .xml 或 .json 以获得所需的输出。
使用以下技术：
  • Spring 4.0.6.RELEASE
  • jackson-mapper-asl 1.9.13
  • Maven 3
  • JDK 1.6
  • Tomcat 7.0.54
  • Eclipse JUNO Service Release 2

让我们现在开始！

第1步：创建目录结构
之前的文章使用Eclipse创建Maven Web项目包含了一步一步的指导，使用 Eclipse 来创建一个Maven项目(Spring4MVCRestServiceDemo)。
下面是最终的项目目录结构：

我们将使用 Spring Java配置而不使用XML。现在，让我们来添加/更新上述项目结构中提到的内容。
第2步：使用 pom.xml 更新所需的依赖 
<?xml version="1.0"?>
<project
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
	xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

	<modelVersion>4.0.0</modelVersion>
	<groupId>com.yiibai.springmvc</groupId>
	<artifactId>Spring4MVCRestServiceDemo</artifactId>
	<packaging>war</packaging>
	<version>1.0.0</version>
	<name>Spring4MVCRestServiceDemo Maven Webapp</name>

	<properties>
		<springframework.version>4.0.6.RELEASE</springframework.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${springframework.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>${springframework.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>${springframework.version}</version>
		</dependency>

		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
		</dependency>
		<dependency>
			<groupId>javax.servlet.jsp.jstl</groupId>
			<artifactId>jstl-api</artifactId>
			<version>1.2</version>
		</dependency>
		<dependency>
			<groupId>javax.servlet.jsp</groupId>
			<artifactId>javax.servlet.jsp-api</artifactId>
			<version>2.3.1</version>
		</dependency>

		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-mapper-asl</artifactId>
			<version>1.9.13</version>
		</dependency>
	</dependencies>
	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-war-plugin</artifactId>
					<version>2.4</version>
					<configuration>
						<warSourceDirectory>src/main/webapp</warSourceDirectory>
						<warName>Spring4MVCRestServiceDemo</warName>
						<failOnMissingWebXml>false</failOnMissingWebXml>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
		<finalName>Spring4MVCRestServiceDemo</finalName>
	</build>
</project> 

上面的 pom.xml 与以前的教程中定义的相同。有一个显着的区别： 我们已经包括一个依赖于Jackson 库(jackson-mapper-asl)，其将用于所述响应数据转换成JSON字符串。

对于Spring 4.1.x 和以上， jackson-databind 2.3或以上是推荐使用的，以避免转换问题。

安全的选择，你可以包括 jackson-databind 最新版本。 
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.5.3</version>
    </dependency>
第3步：添加一个POJO/域对象 
package com.yiibai.springmvc.domain;

public class Message {

	String name;
	String text;

	public Message(String name, String text) {
		this.name = name;
		this.text = text;
	}

	public String getName() {
		return name;
	}

	public String getText() {
		return text;
	}

}
上述对象将从控制器返回 Jackson 转换成 JSON 的格式。
第4步：添加控制器
在 src/main/java 包下添加控制器类，如下图所示。 
package com.yiibai.springmvc.controller;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.yiibai.springmvc.domain.Message;

@RestController
public class HelloWorldRestController {

	@RequestMapping("/hello/{player}")
	public Message message(@PathVariable String player) {

		Message msg = new Message(player, "Hello " + player);
		return msg;
	}

} 

@PathVariable表示参数将被绑定到变量 URI 模板。更有趣的事情，这里要注意的是，这里我们使用的是 @RestController 注解，这标志着这个类作为控制器，每一个方法返回域对象/pojo代替一个视图。这意味着我们不再使用视图解析器，我们不再直接发送响应的HTML，我们只发送的域对象转换成格式。在我们的例子中，由于 jackson 包含在类路径中，消息对象将转换成JSON格式。

第5步：添加配置类 
package com.yiibai.springmvc.configuration;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = "com.yiibai.springmvc")
public class HelloWorldConfiguration {

} 

在这里，这个类是主要提供组件，扫描和注释支持。需要注意的是，我们没有任何视图解析器配置，因为我们在Rest案例并不需要。

第6步：添加初始化类

添加一个初始化类实现WebApplicationInitializer在src/main/java，使用如下图所示指定包(在这种情况下，替代在web.xml中定义的任何spring的配置)。在Servlet 3.0容器启动时，这个类会被加载并实例，它是在启动时方法将通过servlet容器调用。

package com.yiibai.springmvc.configuration;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;

public class HelloWorldInitializer implements WebApplicationInitializer {

	public void onStartup(ServletContext container) throws ServletException {

		AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
		ctx.register(HelloWorldConfiguration.class);
		ctx.setServletContext(container);

		ServletRegistration.Dynamic servlet = container.addServlet(
				"dispatcher", new DispatcherServlet(ctx));

		servlet.setLoadOnStartup(1);
		servlet.addMapping("/");
	}

} 

更新：请注意，上面的类可以写成更加简洁[和它的首选方式]，通过扩展 AbstractAnnotationConfigDispatcherServletInitializer 基类，如下所示：

package com.yiibai.springmvc.configuration;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class HelloWorldInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

	@Override
	protected Class<?>[] getRootConfigClasses() {
		return new Class[] { HelloWorldConfiguration.class };
	}
 
	@Override
	protected Class<?>[] getServletConfigClasses() {
		return null;
	}
 
	@Override
	protected String[] getServletMappings() {
		return new String[] { "/" };
	}

}
第7步：构建和部署应用程序

现在构建 war(在 Eclipse中)或通过 Maven 命令行( mvn clean install)。 部署 war 文件到Servlet3.0容器。

运行它。访问： http://localhost:8080/Spring4MVCRestServiceDemo/hello/Messi ，您将看到 JSON 输出，如下图所示：

就这样，所有输出如上所示。

适应XML输出

现在，如上面提到的，只是通过增加模型类(Message)JAXB注释，我们可以让XML输出支持以及JSON输出。下面是相同的演示：

package com.yiibai.springmvc.domain;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "pizza")
public class Message {

	String name;
	String text;

	public Message(){
		
	}
	
	public Message(String name, String text) {
		this.name = name;
		this.text = text;
	}

	@XmlElement
	public String getName() {
		return name;
	}
	
	@XmlElement
	public String getText() {
		return text;
	}

}
编译，部署并再次运行它，会看到下面的输出(注意URL后缀)，访问URL：http://localhost:8080/Spring4MVCRestServiceDemo/hello/Yiibai.xml

再次访问：http://localhost:8080/Spring4MVCRestServiceDemo/hello/Yiibai.json

如果没有任何后缀，默认格式是XML：

到这里，全部完成！

转载于:https://www.cnblogs.com/borter/p/9519783.html

dengjuanshou7445
关注
如何详细介绍@RestController注解的使用方法，并提供多个示例演示其在实际项目中的应用
专注于深入研究多种编程语言，以实战为导向，逐步拓展开发技能，提升工程化编码和思维能力，展现无敌技术实力。
07-21 1080
@RestController是Spring Framework中的一个注解，用于标识控制器类，使其成为RESTful风格的控制器。通过使用@RestController注解，我们可以将普通的Java类转换为处理HTTP请求的控制器，同时自动进行对象的序列化和反序列化，简化了RESTful API的开发。
Spring RestController
从零开始的教程世界
07-15 1084
Spring RestController annotation is a convenience annotation that is itself annotated with @Controller and @ResponseBody. This annotation is applied to a class to mark it as a request handler. Spring ...
Spring MVC使用@RestController生成JSON示例
angou6476的博客
09-13 153
继上一章的生成JSON示例http://www.cnblogs.com/EasonJim/p/7500405.html，现在还有另一种选择，就是使用@RestController，下面将参照上一节例子进行改造，展示核心代码。 UserController.java package com.jsoft.testspringmvc.controller; import org....
@controller注解和@RestController注解详解
最新发布
qq_45705626的博客
10-12 1161
MVC控制器 主要用于传统的Web应用开发，其中涉及到视图渲染，最终目的是生成HTML页面供浏览器显示。REST控制器 则主要用于提供API接口，支持前后端分离的架构，返回的数据通常是结构化的，如JSON或XML，由前端JavaScript框架或其他客户端消费。
REST服务使用@RestController实例，输出xml/json
weixin_30580943的博客
06-05 314
REST服务使用@RestController实例，输出xml/json 需要用到的服务注解 org.springframework.web.bind.annotation.RestController 　　 用到的包：java和json互转 jackson-mapper-asl #//java对象和json相互转化 jackson-databind #...
@RestController注解的作用和示例
weixin_53559285的博客
06-05 2083
接着，在方法sayHello()上使用@GetMapping注解，定义了一个GET请求的URL路径，该请求路径用于处理客户端发起的GET请求，并将响应的结果直接返回给客户端。@RestController是Spring MVC框架中的一个注解，它结合了@Controller和@ResponseBody两个注解的功能，用于标记一个类或者方法，表示该类或方法用于处理HTTP请求，并将响应的结果直接返回给客户端，而不需要进行视图渲染。
@RestController的使用
晚晴小筑
08-28 3572
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Controller @ResponseBody public @interface RestController { String value() default ""; }可以看到，该注解本身使用@Controller和@ResponseB
Spring3MVC-REST-HelloWorld 实例简单代码
06-17
这个实例是初学者理解Spring MVC与REST结合使用的理想起点。REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，以简洁和标准化的方式组织资源。 首先，我们需要了解...
Spring @MVC REST 实例以及 (同一资源,多种展现:xml,json,html)
12-24
该实例展示了 spring3 REST 的使用方法，以及同一种内容，多种不同方式展示的实现，例如同一 User 信息，可以展示为:xml,json,html三种不同的格式。可以参考这篇文章：http://badqiu.javaeye.com/blog/552806
spring4MVC+Hibernate4实例（增删改查）
06-18
以上就是"spring4MVC+Hibernate4实例（增删改查）"中的主要技术点，这个实例为初学者提供了学习Spring MVC和Hibernate整合的实践平台，并且通过REST风格实现了Web服务。通过理解和实践这些概念，开发者可以更好地...
spring-mvc-rest-post-unit-testing:Spring MVC REST JSON发布请求单元测试示例
05-02
在本文中，我们将深入探讨如何使用Java进行Spring MVC REST JSON发布请求的单元测试。Spring MVC是Spring框架的一个组件，主要用于构建Web应用程序，而REST（Representational State Transfer）是一种设计网络应用的...
spring3.0 mvc和rest入门例子
03-23
4. **创建RESTful API**：通过`@RestController`注解，我们可以创建处理HTTP请求的REST端点。比如，使用`@RequestMapping`定义GET请求，`@RequestBody`和`@ResponseBody`用于处理JSON或XML数据的输入和输出。 5. **...
@Controller和@RestController的区别？
热门推荐
刚刚
05-08 20万+
@Controller和@RestController的区别？ 官方文档： @RestController is a stereotype annotation that combines @ResponseBody and @Controller. 意思是： @RestController注解相当于@ResponseBody ＋ @Controller合在一起的作用。 1)
SpringMVC 4.1.6 @RestController实例入门
weixin_33908217的博客
07-13 113
2019独角兽企业重金招聘Python工程师标准>>> ...
@RestController常见用法
OriSu
04-15 8577
@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。 Request Mapping 基础用法 下面是一个同时在类和方法上应用了 @RequestMapping 注解的示例： @RestController @RequestMapping("/home") public cl...
springboot RestController传参 demo实战项目
01-20 1084
简介 前后端分离下,前后端通讯的各种方法 Git地址 https://gitee.com/wqrzsy/lp-demo/tree/master/lp-spring-web 更多demo请关注 springboot demo实战项目 java 脑洞 java 面试宝典 开源工具 项目分析 ####1. 测试Post提交实体请求，后端要用@RequestBody接收 前端 <form id='...
面试向：RestController代码示例
Tech in Pieces
01-20 313
@RestController @RequestMapping(value="/api") public class UserRestController { UserService userService; @Autowired public UserRestController(UserService userService) { this.userService = userService; } @RequestMappint(val.
RestController
as619649246的博客
02-08 1513
@RestController 注解是从 Spring 4.0 版本开始添加进来的，主要用于更加方便的构建 RESTful Web 服务。 @RestController注解相当于@ResponseBody ＋ @Controller合在一起的作用。 @Controller用于将类标记为 Spring MVC 控制器 若使用@Controller 注解，在对应的方法上，视图解析器可以解析return 的jsp,html页面，并且跳转到相应页面 若返回json等内容到页面，则需要加@ResponseB
spring @RestController注解的作用及代码示例
学亮编程手记
11-20 239
注解可以方便地创建RESTful风格的控制器，简化代码的编写，同时自动将方法返回值转换为HTTP响应的内容。注解将控制器类标记为RESTful风格的控制器，同时默认将所有方法的返回值直接转换为HTTP响应的内容。注解的组合，用于标记控制器类，并将其作为RESTful风格的控制器。可以简化控制器类的编写，无需在每个方法上单独使用。注解是Spring框架中常用的注解之一，它是。类，将其作为RESTful风格的控制器。直接作为HTTP响应的内容返回给客户端。方法映射到GET请求的路径。方法，并将方法的返回值。
@RestController注解的作用
08-15
@RestController注解是Spring MVC框架中的一种用于标识Controller类的注解，它主要用于将Controller类标识为可以处理REST请求的类，并且返回JSON或XML格式的响应结果。 ### 回答2： @RestController注解的作用是将...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值