Spring MVC入門3——返回JSON或XML等多種檢視
阿新 • • 發佈：2019-02-10
上一篇的例子返回的都是HTML的頁面，是為人進行服務的頁面，供人進行閱讀的。如果我們希望將Web作為一種服務，返回資料為機器服務，例如返回JSON，XML等，我們應該如何實現呢？很顯然，根據MVC的思想，以及Spirng MVC的架構設計，我們很容易就能想到，只需要修改對應的ViewResolver，讓其不選擇jsp或者html以及別的模版，而是選擇渲染成JSON,XML就可以了。
Spring MVC中ContentNegotiatingViewResolver這麼一個Resolver提供了這麼一種實現方法。
ContentNegotiatingViewResolver有什麼作用呢？
1.支援在Spring MVC下輸出不同的格式
2.該類不是自己處理view, 而是代理給不同的ViewResolver來處理不同的view;
我們要實現怎麼樣的效果呢？
1.訪問url的json會返回json物件。
例如：localhost:8080/user/123.json會返回以123為唯一標識的user的json物件。
2.訪問url的xml會返回xml物件。
例如：localhost:8080/user/123.xml會返回以123為唯一標識的user的xml物件。
3.直接訪問url會訪問url對應的頁面。
例如：localhost:8080/user/123會訪問原本的頁面。
那我們需要怎麼進行配置呢？
我們首先要修改viewResovler。
配置如下：
可是仔細一看，發現這個resolver只有json和xml的對映，那我們的jsp頁面的對映怎麼辦呢？<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver"> <!-- order表明執行順序，value為1最早執行 --> <property name="order" value="1" /> <property name="contentNegotiationManager"> <bean class="org.springframework.web.accept.ContentNegotiationManager"> <constructor-arg> <bean class="org.springframework.web.accept.PathExtensionContentNegotiationStrategy"> <constructor-arg> <map> <!-- 增加key到mineType的對映，還可以是別的格式pdf等 --> <entry key="json" value="application/json" /> <entry key="xml" value="application/xml" /> </map> </constructor-arg> </bean> </constructor-arg> </bean> </property> <property name="defaultViews"> <list> <!-- JSON View，JSON使用的真正的resolver，需要增加相應的依賴 --> <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView" /> <!-- XML View XML使用的真正的resolver，需要增加相應的依賴，並且需要返回的XML物件需要在下面的掃描中新增--> <bean class="org.springframework.web.servlet.view.xml.MarshallingView"> <constructor-arg> <bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller"> <property name="packagesToScan"> <list> <value>springmvc.web.model</value> </list> </property> </bean> </constructor-arg> </bean> </list> </property> </bean>
就需要增加另外一個resolver了，不過優先順序比它低。
<!-- 如果前面的都沒匹配到，則會採用這個resolver -->
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="order" value="2" />
<property name="viewClass"
value="org.springframework.web.servlet.view.JstlView" />
<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jsp" />
</bean>對於JSON和XML兩種檢視的resolver，需要什麼依賴呢？
JSON:
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.5.4</version>
</dependency><dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-oxm</artifactId>
<version>${spring.version}</version>
</dependency>這樣我們的配置就基本完成了。最後的配置如下：
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>
<!-- 中文亂碼問題 -->
<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>
<!-- encoding filter for jsp page -->
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 載入DispatcherServlet應用上下文 -->
<servlet>
<servlet-name>webDispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 可選的初始化，指定你載入的上下文檔案的位置，如果不寫，則預設使用/WEB-INF/[servlet-name]-servlet.xml的檔案
<init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:webDispatcherServlet-servlet.xml</param-value>
</init-param> -->
<!-- 設定servlet的優先順序，正數數時越小優先順序越高 -->
<load-on-startup>1</load-on-startup>
</servlet>
<!-- url攔截到對應的前端控制器 -->
<servlet-mapping>
<servlet-name>webDispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
webDIspatcherServlet-servlet.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:p="http://www.springframework.org/schema/p"
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-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/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<mvc:annotation-driven />
<!-- 掃描包下的註解,自動註冊bean -->
<context:component-scan base-package="springmvc.web" />
<import resource="viewResolver.xml" />
</beans>接下來就是業務邏輯部分：
我們需要一個用來傳遞的類：
@XmlRootElement
public class User {
private String id;
private String userName;
private String password;
public User() {
id = "000";
userName = "張三";
password = "張三的password";
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
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;
}
}Controller部分：
@Controller
@RequestMapping("/hello")
public class HelloWorldController {
@RequestMapping(value = "/user/{id}", method=RequestMethod.GET)
public String getUserPage(@PathVariable("id") String id, Model model) {
User user = new User();
user.setId(id);
model.addAttribute(user);
return "user";
}
}
網上看了很多篇部落格，很多都是在Spring 3.1之前支援的，而Spring3.2之後的版本對於其中很多屬性的set方法都棄用了，還是spring官網論壇好T T
這樣一來，返回什麼檢視都非常的方便了。