大家好,又见面了,我是你们的朋友全栈君。
知识点:@RestController注解相当于@ResponseBody + @Controller合在一起的作用。
1) 如果只是使用@RestController注解Controller,则Controller中的方法无法返回jsp页面,或者html,配置的视图解析器 InternalResourceViewResolver不起作用,返回的内容就是Return 里的内容。
2) 如果需要返回到指定页面,则需要用 @Controller配合视图解析器InternalResourceViewResolver才行。
如果需要返回JSON,XML或自定义mediaType内容到页面,则需要在对应的方法上加上@ResponseBody注解。
3)如果需要返回JSON,XML或自定义mediaType内容到页面,则需要在对应的方法上加上@ResponseBody注解。
例如:
1.使用@Controller 注解,在对应的方法上,视图解析器可以解析return 的jsp,html页面,并且跳转到相应页面
若返回json等内容到页面,则需要加@ResponseBody注解
@CrossOrigin
@Controller
public class FileUploadController {
//跳转到上传文件的页面
@RequestMapping(value=”/gouploadimg”, method = RequestMethod.GET)
public String goUploadImg() {
//跳转到 templates 目录下的 uploadimg.html
return “uploadimg”;
}
//处理文件上传
@RequestMapping(value=”/testuploadimg”, method = RequestMethod.POST)
public @ResponseBody String uploadImg(@RequestParam(“file”) MultipartFile file,
HttpServletRequest request) {
System.out.println(“调用文件上传方法”);
String contentType = file.getContentType();
String fileName = file.getOriginalFilename();
2.@RestController注解,相当于@Controller+@ResponseBody两个注解的结合,返回json数据不需要在方法前面加@ResponseBody注解了,但使用@RestController这个注解,就不能返回jsp,html页面,视图解析器无法解析jsp,html页面
@CrossOrigin
@RestController /* @Controller + @ResponseBody*/
public class HospitalController {
//注入Service服务对象
@Autowired
private HospitalService hospitalService;
/**
* 查询所有医院信息(未分页)
*/
@RequestMapping(value = "findAllHospital",method = RequestMethod.GET)
public List<Hospital> findAllHospital(){
List<Hospital> hospitalList= hospitalService.findAllHospital();
return hospitalList;
}
参考:http://blog.csdn.net/gg12365gg/article/details/51345601
Spring mvc 使用RestController 和 Controller
一个完整的spring mvc helloWord 实例
环境 : InteillJ idea 编译工具 ,maven 工程
1、引入jar包 : spring mvc 的基本包以及 json 的相关jar包 。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.crystal.api</groupId>
<artifactId>spring-web</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>CoreApi</module>
<module>common</module>
<module>simple-business</module>
</modules>
<!-- spring mvc project-->
<!-- set jar version-->
<properties>
<org.springframework.version>4.3.4.RELEASE</org.springframework.version>
<junit.version>4.12</junit.version>
<slf4j.version>1.7.9</slf4j.version>
</properties>
<!-- dependency-->
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-expression</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-tx -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<!-- quartz-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${org.springframework.version}</version>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<!-- json-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.7.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.7.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.7.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
<version>2.4.2</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>1.9.13</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-core-asl</artifactId>
<version>1.9.13</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-lang/commons-lang -->
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.5</version>
</dependency>
</dependencies>
</project>
</dependencies> </project>

2、创建一个自己的helloWorldController ,这个controller采用 @Controller 注解

package com.crystal.api.controller;
import com.crystal.api.entity.User;
import org.springframework.stereotype.Controller;
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;
/**
* Created by Administrator on 2017/4/28.
* controller 的注解必须要使用 viewResolver : 前提是没有加 ResponseBody 注解
* controller注解中加上了 ResponseBody 注解,代表返回json格式
*/
@Controller
@RequestMapping(value = "/v2/hello")
public class HelloWordController {
/**
* 返回json 格式的数据
*
* @param name
* @return
*/
@RequestMapping(value = "/world", method = RequestMethod.GET)
@ResponseBody
public String returnJson(String name) {
System.out.println("name : " + name);
return "hello";
}
/**
* 返回页面 ,视图
*
* @param name
* @return
*/
@RequestMapping(value = "crystal")
public String returnView(String name) {
System.out.println("name : " + name);
return "hello";
}
/**
* ResponseBody 注解,代表返回json格式
* RequestBody 注解 ,代表 json格式提交数据
*
* @param user
* @return
*/
@RequestMapping(value = "/test/json", method = RequestMethod.POST)
@ResponseBody
public User testJson(@RequestBody User user) {
System.out.println(user.getId());
System.out.println(user.getName());
return user;
}
/**
* ResponseBody 注解,代表返回json格式
* form 形式的提交数据
*
* @param user
* @return
*/
@RequestMapping(value = "/test/post", method = RequestMethod.POST)
@ResponseBody
public User testPost(User user) {
System.out.println(user.getId());
System.out.println(user.getName());
return user;
}
}

代码解释 : 使用的是 @Controller 注解
1、returnView 方法 : 返回的结果是 视图,一个页面 。 这个要自己写相关的 hello.jsp 页面 , 并且配置 ViewResolver 视图解析器 。详细配置见 applicationContext.xml 中 。
2、returnJson 方法 :GET方法 , 在方法前加了 @ResponeBody 注解 ,返回json 格式的数据 。不需要配置视图解析器。
3、testPost方法 : POST方法 ,在方法前加了了 @ResponeBody 注解,返回json 格式的数据 。POST的传入参数类型为 :form形式的 。{“Content-Type”:”application/x-www-form-urlencoded”}
4、testJson方法 :POST方法 ,在方法前加了了 @ResponeBody 注解,返回json 格式的数据 。在实体参数User 上加入 @RequestBody 注解 ,表示psot接收参数类型为 :json形式的 。 {“Content-Type”:”application/json”}
3、创建一个自己的Restful 接口的HelloWorldController , 使用 @RestController 注解

package com.crystal.api.controller;
import com.crystal.api.entity.User;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
/**
* Created by Administrator on 2016/11/7.
*/
@RestController
@RequestMapping(value = "/rest", produces = {MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE})
public class RestHelloController {
/**
* get method
*
* @param name
* @return
*/
@RequestMapping(value = "/hello", method = RequestMethod.GET)
public String hello(@RequestParam("name") String name) {
System.out.println("name:" + name);
return name;
}
@RequestMapping(value = "/save", method = RequestMethod.POST)
public User save(HttpServletRequest request, @RequestBody User user) {
System.out.println(user.getId());
System.out.println(user.getName());
return user;
}
}

代码解释 : @RestController = @Controller + @ResponseBody
1、使用 @RestController 注解就包含了@ResponseBody注解 。返回 json 格式。 @RequestBody 注解的作用同上一样 。
4、配置servlet 的 web.xml :

<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
version="2.5">
<display-name>Archetype Created Web Application</display-name>
<!-- spring mvc dispatcher filter-->
<servlet>
<display-name>Spring Dispatcher Servlet</display-name>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:/WEB-INF/spring/applicationContext.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!--encoding filter-->
<filter>
<display-name>CharacterEncodingFilter</display-name>
<filter-name>CharacterEncodingFilter</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>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>

5、spring的基本配置 applicationContext.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:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 自动扫描配置路径下的包-->
<context:component-scan
base-package="com.crystal.api"/>
<!-- Enable task support -->
<!--<task:annotation-driven/>-->
<!-- 增加新的返回格式 :xml ,json-->
<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager"
enable-matrix-variables="true">
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper" ref="jacksonObjectMapper"/>
</bean>
<bean class="org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter">
<property name="objectMapper" ref="xmlObjectMapper"/>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<bean id="contentNegotiationManager"
class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
<property name="favorPathExtension" value="true"/>
<property name="favorParameter" value="false"/>
<property name="parameterName" value="mediaType"/>
<property name="ignoreAcceptHeader" value="false"/>
<property name="useJaf" value="false"/>
<property name="defaultContentType" value="application/json"/>
<property name="mediaTypes">
<map>
<entry key="html" value="text/html;charset=utf-8"/>
<entry key="json" value="application/json;charset=utf-8"/>
<entry key="xml" value="application/xml;charset=utf-8"/>
</map>
</property>
</bean>
<!-- 视图解析器-->
<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
<property name="contentNegotiationManager" ref="contentNegotiationManager"/>
<property name="viewResolvers">
<list>
<ref bean="viewResolver"></ref>
</list>
</property>
</bean>
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"></property>
<property name="suffix" value=".jsp"></property>
</bean>
</beans>

代码解释 : 基本的 扫描配置,以及注解启动配置。
<context:component-scan/> 标签 :告诉spring 来扫面指定包下的类 ,并注册被@Component,@Controller,@Service,@Repository等注解标记的组件。
<mvc:annotation-driven/>标签: 告诉Spring,我们启用注解驱动。然后Spring会自动为我们注册上面说到的几个Bean到工厂中,来处理我们的请求
为什么在 使用了@ResponseBody 注解之后, Controller返回的对象 自动被转换成对应的json数据??? 因为<mvc:annotation-driven/> 标签 。

在spring 3.2 之后的版本 ,<mvc:annotation-driven/> 实例换了两个重要的 类 。 RequestMappingHandlerMapping 和 RequestMappingHandlerAdapter ,实例化的其他类这里不多说 。
RequestMappingHandlerMapping :处理请求映射的,处理@RequestMapping跟请求地址之间的关系。
RequestMappingHandlerAdapter :是请求处理的适配器,也就是请求之后处理具体逻辑的执行,关系到哪个类的哪个方法以及转换器等工作,这个类是我们讲的重点,其中它的属性messageConverters是本文要讲的重点。

在 RequestMappingHandlerAdapter 类中 ,默认有4个转换器 。

如果<mvc:annotation-driven>节点有子节点message-converters,那么它的转换器属性messageConverters也由这些子节点组成。
配置转换器的两种方法 :
1、增加子节点 <message-converters> ,在默认的转换器基础上在加上 自己配置的装换器 。(json 转换器 , xml转换器)

<mvc:annotation-driven >
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper" ref="jacksonObjectMapper"/> <!-- 可以不配置-->
</bean>
<bean class="org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter">
<property name="objectMapper" ref="xmlObjectMapper"/>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>

2、 重新定义 RequestMappingHandlerAdapter 这个bean ,spring 会覆盖掉默认的 RequestMappingHandlerAdapter 。

实现 xml 格式的返回数据格式 : (在已经加入了xml 转换器的前提下 )
1、

使用 RequestMapping的 produces 属性,告知客户端 ,服务器可以支持 xml 格式的返回 。
2、访问 接口 : http://localhost:8080/rest/save ,body 数据自己定义 。


发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/140170.html原文链接:https://javaforall.net
