Spring mvc 使用RestController 以及 Controller

 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 數據自己定義 。