@ResponseBody
作用:
该注解用于将 Controller 的方法返回的对象,
通过 HttpMessageConverter 接口转换为指定格式的 数据如:
json,xml 等,通过 Response 响应给客户端
需求:
使用@ResponseBody 注解实现将 controller 方法返回对象转换为 json 响应给客户端。
前置知识点: Springmvc 默认用 MappingJacksonHttpMessageConverter 对 json 数据进行转换,
需要加入 jackson 的包。
前面是一些配置 正文在中间位置
User:
public class User implements Serializable {
private String username;
private String password;
private Integer age;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "User{" +
"username='" + username + '\'' +
", password='" + password + '\'' +
", age=" + age +
'}';
}
}
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>
<display-name>Archetype Created Web Application</display-name>
<!--配置解决中文乱码的过滤器,需要放在servlet前-->
<filter>
<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>
<!--配置前端控制器-->
<servlet>
<!--servlet-name:用来定义servlet的名称,该名称在整个应用中必须是惟一的。-->
<servlet-name>dispatcherServlet</servlet-name>
<!--servlet-class:用来指定servlet的完全限定的名称。 -->
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--
init-param: 与<context-param>元素具有相同的元素描述符,可以使用<init-param>子元素将初始化参数名和参数值传递给Servlet,
-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<!--启动容器时,初始化Servlet。-->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
springmvc.xml:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!--开启注解扫描-->
<context:component-scan base-package="cn.benti"/>
<!--视图解析器:帮助我们跳转到/WEB-INF/pages/xxx.jsp -->
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!--表示文件所在目录-->
<property name="prefix" value="/WEB-INF/pages/"/>
<!--表示文件后缀名是什么-->
<property name="suffix" value=".jsp"/>
</bean>
<!-- 前端控制器,哪些静态资源不拦截
location:指定的目录不要拦截,直接请求,
mapping:指在js目录下的所有文件(**代表所有文件)
这里是放出了js目录下的jQuery文件
-->
<mvc:resources mapping="/js/**" location="/js/" />
<!--开启springMVC框架注解支持-->
<mvc:annotation-driven />
</beans>
success.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<%-- 是否忽略EL表达式 --%>
<html>
<head>
<title>Title</title>
</head>
<body>
<h3>执行成功跳转页面</h3>
${user.username}
${user.password}
${user.age}
</body>
</html>
index.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h3>重定向过来的</h3>
</body>
</html>
正文开始
UserController:
@Controller
@RequestMapping("/user")
public class UserController {
/**
* 返回值为字符串
* @param model
* @return
*/
@RequestMapping("/testString")
public String testString(Model model) {
System.out.println("testString方法执行了");
//模拟从数据库中查询出User对象
User user = new User();
user.setUsername("清欢");
user.setPassword("123");
user.setAge(25);
//model存对象
model.addAttribute("user",user);
return "success";
}
}
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
</head>
<body>
<a href="user/testString">返回String</a>
</body>
</html>
结果:页面显示
执行成功跳转页面
清欢 123 25
UserController:
@Controller
@RequestMapping("/user")
public class UserController {
/**
* 返回值是void
*请求转发一次请求,不用编写项目名称
*
*/
@RequestMapping("/testVoid")
//没有返回值得时候 默认请求值为:/WEB-INF/pages/user/testVoid.jsp
public void testVoid(HttpServletRequest request, HttpServletResponse response) throws Exception{
System.out.println("testVoid方法执行了");
//1.编写请求转发的程序
//request.getRequestDispatcher("/WEB-INF/pages/success.jsp").forward(request,response);
//2.重定向
//response.sendRedirect(request.getContextPath()+"/index.jsp");
//3.直接会进行响应
//先设置中文乱码
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html;charset=UTF-8");
response.getWriter().print("你好");
return;
}
}
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
</head>
<body>
<a href="user/testVoid">返回Void</a>
</body>
</html>
结果:跳转到http://localhost:8080/user/testVoid 页面显示
你好
UserController:
@Controller
@RequestMapping("/user")
public class UserController {
/**
* 返回ModelAndView
* @return
*/
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView() {
//创建ModelAndView对象
ModelAndView mv = new ModelAndView();
System.out.println("testModelAndView方法执行了");
//模拟从数据库中查询出User对象
User user = new User();
user.setUsername("本体y");
user.setPassword("456");
user.setAge(23);
//把user对象存储到mv对象中,也会把user对象存储到request对象中
mv.addObject("user",user);
//跳转到哪个页面(使用了视图解析器)
mv.setViewName("success");
return mv;
}
}
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
</head>
<body>
<a href="user/testModelAndView">返回ModelAndView</a>
</body>
</html>
结果:页面显示
执行成功跳转页面
本体y 456 23
UserController:
@Controller
@RequestMapping("/user")
public class UserController {
/**
* 使用关键字的方式进行转发(forward)或者重定向(redirect)
* @return
*/
@RequestMapping("/testForwardOrRedirect")
public String testForwardOrRedirect() {
System.out.println("testForwardOrRedirect方法执行了");
//请求转发
//return "forward:/WEB-INF/pages/success.jsp";
//重定向
return "redirect:/index.jsp";
}
}
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
</head>
<body>
<a href="user/testForwardOrRedirect">转发或重定向的方式</a>
</body>
</html>
结果:跳转到 http://localhost:8080/index.jsp 页面显示
重定向过来的
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
</head>
<body>
<a href="user/testModelAndView">返回ModelAndView</a>
</body>
</html>
结果:页面显示
执行成功跳转页面
本体y 456 23
UserController:
@Controller
@RequestMapping("/user")
public class UserController {
/**
* 模拟异步请求响应
*/
@RequestMapping("/testAjax")
//@RequestBody:获取请求体内容,转成对象
//@ResponseBody:将java对象转为json格式的数据。
@ResponseBody
public User testAjax(@RequestBody User user /*String body*/) {
System.out.println("testAjax方法执行了");
// System.out.println(body);
//客户端发送的ajax的请求,传的是json字符串,后端把json字符串封装到user对象中
System.out.println(user);
//做响应,模拟查询数据
user.setUsername("陈潇");
user.setAge(20);
//做响应
return user;
}
}
response.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="js/jquery-3.4.1.min.js"></script>
<script>
//页面加载,绑定单击事件
$(function () {
$("#btn").click(function () {
//alert("hello btn");
//发送ajax请求
$.ajax({
//编写json格式,设置属性和值
url:"user/testAjax",
contentType:"application/json;charset=UTF-8",
data:'{"username":"彦","password":"789","age":"30"}',
dataType:"json",
type:"post",
success:function (data) {
//data:服务器端响应的json的数据,进行解析
alert(data);
alert(data.username);
alert(data.password);
alert(data.age);
}
});
});
});
</script>
</head>
<body>
<button id="btn">发送ajax的请求</button>
</body>
</html>
结果:页面弹窗依次:
[object Object]
陈潇
789
20
控制台输出
testAjax方法执行了
User{username='彦', password='789', age=30}
pom.xml:
<?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>cn.benti</groupId>
<artifactId>springmvc_day02_01response</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>springmvc_day02_01response Maven Webapp</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<!-- 版本锁定 -->
<spring.version>5.0.2.RELEASE</spring.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.9.0</version>
</dependency>
</dependencies>
<build>
<finalName>springmvc_day02_01response</finalName>
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
<plugins>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
</plugin>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<version>3.2.2</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>