SpringMVC+Json建構基于Restful風格的應用

摘要

一個Spring使用Restful風格的案例

主要代碼：

web.xml

<?xml version="1.0" encoding="UTF-8"?>  
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"  
    version="2.5">  

    <context-param>  
        <param-name>log4jConfigLocation</param-name>  
        <param-value>classpath:log4j.properties</param-value>  
    </context-param>  
    <context-param>  
        <param-name>log4jRefreshInterval</param-name>  
        <param-value>60000</param-value>  
    </context-param>  
    <context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>classpath:applicationContext.xml</param-value>  
    </context-param>  

    <!-- 編碼過慮 -->  
    <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>  
    <filter-mapping>  
        <filter-name>encodingFilter</filter-name>  
        <url-pattern>/*</url-pattern>  
    </filter-mapping>  

    <!-- Spring監聽 -->  
    <listener>  
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>  

    <!-- Spring MVC DispatcherServlet -->  
    <servlet>  
        <servlet-name>springMVC3</servlet-name>  
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
        <init-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath:springMVC-servlet.xml</param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup>  
    </servlet>  
    <servlet-mapping>  
        <servlet-name>springMVC3</servlet-name>  
        <url-pattern>/</url-pattern>  
    </servlet-mapping>  

    <!-- 解決HTTP PUT請求Spring無法擷取請求參數的問題 -->  
    <filter>  
        <filter-name>HiddenHttpMethodFilter</filter-name>  
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>  
    </filter>  
    <filter-mapping>  
        <filter-name>HiddenHttpMethodFilter</filter-name>  
        <servlet-name>springMVC3</servlet-name>  
    </filter-mapping>  

    <display-name>UikitTest</display-name>  
    <welcome-file-list>  
        <welcome-file>/WEB-INF/jsp/index.jsp</welcome-file>  
    </welcome-file-list>  
</web-app>

springMVC-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>  
<beans default-lazy-init="true"  
    xmlns="http://www.springframework.org/schema/beans" xmlns:p="http://www.springframework.org/schema/p"  
    xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"  
    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-3.1.xsd    
       http://www.springframework.org/schema/mvc   
       http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd     
       http://www.springframework.org/schema/context   
       http://www.springframework.org/schema/context/spring-context-3.1.xsd">  

    <!-- 注解驅動 -->  
    <mvc:annotation-driven />  

    <!-- 掃描包 -->  
    <context:component-scan base-package="com.citic.test.action" />  

    <!-- 用于頁面跳轉,根據請求的不同跳轉到不同頁面，如請求index.do則跳轉到/WEB-INF/jsp/index.jsp -->  
    <bean id="findJsp"  
        class="org.springframework.web.servlet.mvc.UrlFilenameViewController" />  

    <bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">  
        <property name="mappings">  
            <props>  
                <prop key="index.do">findJsp</prop><!-- 表示index.do轉向index.jsp頁面 -->  
                <prop key="first.do">findJsp</prop><!-- 表示first.do轉向first.jsp頁面 -->  
            </props>  
        </property>  
    </bean>  

    <!-- 視圖解析 -->  
    <bean class="org.springframework.web.servlet.view.UrlBasedViewResolver">  
        <!-- 傳回的視圖模型資料需要經過jstl來處理 -->  
        <property name="viewClass"  
            value="org.springframework.web.servlet.view.JstlView" />  
        <property name="prefix" value="/WEB-INF/jsp/" />  
        <property name="suffix" value=".jsp" />  
    </bean>  

    <!-- 對靜态資源檔案的通路 不支援通路WEB-INF目錄 -->  
    <mvc:default-servlet-handler />  

    <!-- 對靜态資源檔案的通路 支援通路WEB-INF目錄 -->  
    <!-- <mvc:resources location="/uikit-2.3.1/" mapping="/uikit-2.3.1/**" /> -->  


    <bean id="stringConverter" class="org.springframework.http.converter.StringHttpMessageConverter">  
        <property name="supportedMediaTypes">  
            <list>  
                <value>text/plain;charset=UTF-8</value>  
            </list>  
        </property>  
    </bean>  

    <!-- 輸出對象轉JSON支援 -->  
    <bean id="jsonConverter"  
        class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"></bean>  
    <bean  
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
        <property name="messageConverters">  
            <list>  
                <ref bean="stringConverter"/>  
                <ref bean="jsonConverter" />  
            </list>  
        </property>  
    </bean>  
</beans>

Controller：

package com.citic.test.action;  

import java.util.ArrayList;  
import java.util.List;  

import net.sf.json.JSONObject;  

import org.apache.log4j.Logger;  
import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.PathVariable;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RequestMethod;  
import org.springframework.web.bind.annotation.RequestParam;  
import org.springframework.web.bind.annotation.ResponseBody;  

import com.citic.test.entity.Person;  

/** 
 * 基于Restful風格架構測試 
 */  
@Controller  
public class DekotaAction {  

    /** 日志執行個體 */  
    private static final Logger logger = Logger.getLogger(DekotaAction.class);  

    @RequestMapping(value = "/hello", produces = "text/plain;charset=UTF-8")  
    public @ResponseBody  
    String hello() {  
        return "你好！hello";  
    }  

    @RequestMapping(value = "/say/{msg}", produces = "application/json;charset=UTF-8")  
    public @ResponseBody  
    String say(@PathVariable(value = "msg") String msg) {  
        return "{\"msg\":\"you say:'" + msg + "'\"}";  
    }  

    @RequestMapping(value = "/person/{id:\\d+}", method = RequestMethod.GET)  
    public @ResponseBody  
    Person getPerson(@PathVariable("id") int id) {  
        logger.info("擷取人員資訊id=" + id);  
        Person person = new Person();  
        person.setName("張三");  
        person.setSex("男");  
        person.setAge(30);  
        person.setId(id);  
        return person;  
    }  

    @RequestMapping(value = "/person/{id:\\d+}", method = RequestMethod.DELETE)  
    public @ResponseBody  
    Object deletePerson(@PathVariable("id") int id) {  
        logger.info("删除人員資訊id=" + id);  
        JSONObject jsonObject = new JSONObject();  
        jsonObject.put("msg", "删除人員資訊成功");  
        return jsonObject;  
    }  

    @RequestMapping(value = "/person", method = RequestMethod.POST)  
    public @ResponseBody  
    Object addPerson(Person person) {  
        logger.info("注冊人員資訊成功id=" + person.getId());  
        JSONObject jsonObject = new JSONObject();  
        jsonObject.put("msg", "注冊人員資訊成功");  
        return jsonObject;  
    }  

    @RequestMapping(value = "/person", method = RequestMethod.PUT)  
    public @ResponseBody  
    Object updatePerson(Person person) {  
        logger.info("更新人員資訊id=" + person.getId());  
        JSONObject jsonObject = new JSONObject();  
        jsonObject.put("msg", "更新人員資訊成功");  
        return jsonObject;  
    }  

    @RequestMapping(value = "/person", method = RequestMethod.PATCH)  
    public @ResponseBody  
    List<Person> listPerson(@RequestParam(value = "name", required = false, defaultValue = "") String name) {  

        logger.info("查詢人員name like " + name);  
        List<Person> lstPersons = new ArrayList<Person>();  

        Person person = new Person();  
        person.setName("張三");  
        person.setSex("男");  
        person.setAge(25);  
        person.setId(101);  
        lstPersons.add(person);  

        Person person2 = new Person();  
        person2.setName("李四");  
        person2.setSex("女");  
        person2.setAge(23);  
        person2.setId(102);  
        lstPersons.add(person2);  

        Person person3 = new Person();  
        person3.setName("王五");  
        person3.setSex("男");  
        person3.setAge(27);  
        person3.setId(103);  
        lstPersons.add(person3);  

        return lstPersons;  
    }  
}

index.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>  
<%  
    String path = request.getContextPath();  
    String basePath = request.getScheme() + "://"  
            + request.getServerName() + ":" + request.getServerPort()  
            + path + "/";  
%>  

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
<html>  
<head>  
<base href="<%=basePath%>">  

<title>Uikit Test</title>  
    <meta http-equiv="pragma" content="no-cache">  
    <meta http-equiv="cache-control" content="no-cache">  
    <meta http-equiv="expires" content="0">  
    <meta http-equiv="keywords" content="keyword1,keyword2,keyword3">  
    <meta http-equiv="description" content="This is my page">  
    <link rel="stylesheet" type="text/css"   href="uikit-2.3.1/css/uikit.gradient.min.css">  
    <link rel="stylesheet" type="text/css" href="uikit-2.3.1/addons/css/notify.gradient.min.css">  
</head>  
<body>  
<div  
    style="width:800px;margin-top:10px;margin-left: auto;margin-right: auto;text-align: center;">  
    <h2>Uikit Test</h2>  
</div>  
<div style="width:800px;margin-left: auto;margin-right: auto;">  
    <fieldset class="uk-form">  
        <legend>Uikit表單渲染測試</legend>  
        <div class="uk-form-row">  
            <input type="text" class="uk-width-1-1">  
        </div>  
        <div class="uk-form-row">  
            <input type="text" class="uk-width-1-1 uk-form-success">  
        </div>  
        <div class="uk-form-row">  
            <input type="text" class="uk-width-1-1 uk-form-danger">  
        </div>  
        <div class="uk-form-row">  
            <input type="text" class="uk-width-1-1">  
        </div>  
        <div class="uk-form-row">  
            <select id="form-s-s">  
                <option>---請選擇---</option>  
                <option>是</option>  
                <option>否</option>  
            </select>  
        </div>  
        <div class="uk-form-row">  
            <input type="date" id="form-h-id" />  
        </div>  
    </fieldset>  
    <fieldset class="uk-form">  
        <legend>基于Restful架構風格的資源請求測試</legend>  
        <button class="uk-button uk-button-primary uk-button-large" id="btnGet">擷取人員GET</button>  
        <button class="uk-button uk-button-primary uk-button-large" id="btnAdd">添加人員POST</button>  
        <button class="uk-button uk-button-primary uk-button-large" id="btnUpdate">更新人員PUT</button>  
        <button class="uk-button uk-button-danger uk-button-large" id="btnDel">删除人員DELETE</button>  
        <button class="uk-button uk-button-primary uk-button-large" id="btnList">查詢清單PATCH</button>  
    </fieldset>  
</div>  

<script type="text/javascript" src="js/jquery-1.11.0.min.js"></script>  
<script type="text/javascript" src="uikit-2.3.1/js/uikit.min.js"></script>  
<script type="text/javascript" src="uikit-2.3.1/addons/js/notify.min.js"></script>  
<script type="text/javascript">  
    (function(window,$){  

        var dekota={  

            url:'',  

            init:function(){  
                dekota.url='<%=basePath%>';  
                $.UIkit.notify("頁面初始化完成", {status:'info',timeout:500});  
                $("#btnGet").click(dekota.getPerson);  
                $("#btnAdd").click(dekota.addPerson);  
                $("#btnDel").click(dekota.delPerson);  
                $("#btnUpdate").click(dekota.updatePerson);  
                $("#btnList").click(dekota.listPerson);  
            },  
            getPerson:function(){  
                $.ajax({  
                    url: dekota.url + 'person/101/',  
                    type: 'GET',  
                    dataType: 'json'  
                }).done(function(data, status, xhr) {  
                    $.UIkit.notify("擷取人員資訊成功", {status:'success',timeout:1000});  
                }).fail(function(xhr, status, error) {  
                    $.UIkit.notify("請求失敗！", {status:'danger',timeout:2000});  
                });  
            },  
            addPerson:function(){  
                $.ajax({  
                    url: dekota.url + 'person',  
                    type: 'POST',  
                    dataType: 'json',  
                    data: {id: 1,name:'張三',sex:'男',age:23}  
                    }).done(function(data, status, xhr) {  
                        $.UIkit.notify(data.msg, {status:'success',timeout:1000});  
                    }).fail(function(xhr, status, error) {  
                        $.UIkit.notify("請求失敗！", {status:'danger',timeout:2000});  
                    });  
                },  
                delPerson:function(){  
                    $.ajax({  
                        url: dekota.url + 'person/109',  
                        type: 'DELETE',  
                        dataType: 'json'  
                    }).done(function(data, status, xhr) {  
                        $.UIkit.notify(data.msg, {status:'success',timeout:1000});  
                    }).fail(function(xhr, status, error) {  
                        $.UIkit.notify("請求失敗！", {status:'danger',timeout:2000});  
                    });  
                },  
                updatePerson:function(){  
                    $.ajax({  
                        url: dekota.url + 'person',  
                        type: 'POST',//注意在傳參數時，加：_method:'PUT'　将對應背景的PUT請求方法  
                        dataType: 'json',  
                        data: {_method:'PUT',id: 221,name:'王五',sex:'男',age:23}  
                    }).done(function(data, status, xhr) {  
                        $.UIkit.notify(data.msg, {status:'success',timeout:1000});  
                    }).fail(function(xhr, status, error) {  
                        $.UIkit.notify("請求失敗！", {status:'danger',timeout:2000});  
                    });  
                },  
                listPerson:function(){  
                    $.ajax({  
                        url: dekota.url + 'person',  
                        type: 'POST',//注意在傳參數時，加：_method:'PATCH'　将對應背景的PATCH請求方法  
                        dataType: 'json',  
                        data: {_method:'PATCH',name: '張三'}  
                    }).done(function(data, status, xhr) {  
                        $.UIkit.notify("查詢人員資訊成功", {status:'success',timeout:1000});  
                    }).fail(function(xhr, status, error) {  
                        $.UIkit.notify("請求失敗！", {status:'danger',timeout:2000});  
                    });  
                }  
            };  
            window.dekota=(window.dekota)?window.dekota:dekota;  
            $(function(){  
                dekota.init();  
            });  
        })(window,jQuery);  

    </script>  
    </body>  
</html>

SpringMVC+Json建構基于Restful風格的應用

主要代碼：

web.xml

springMVC-servlet.xml

index.jsp

繼續閱讀

适用于JavaScript的ECMAScript 2020規範向前發展

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

JS生成uuid的四種方法

vue-cli簡介（中文翻譯）

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

layui多任務上傳添加進度條

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method

JSONObject包導入異常 java.lang.NoClassDefFoundErrorweb項目的導入包的問題