1. 程式人生 > >基於Restful風格實現Spring MVC

基於Restful風格實現Spring MVC

如果說現在你要做一個系統,假設說有一個模組屬於公告管理,那麼我們可能安排路徑的時候會這樣安排NewsAction路徑:
· 增加新聞:/pages/back/admin/news/add.action;
· 新聞列表:/pages/back/admin/news/list.action
隨著技術的發展,有一種新型的架構設計思想:Restful風格,也就是說利用一個簡單的路徑,而後根據HTTP提交模式不同。那麼可以完成不同的功能,也就是說:
· 看一個新聞內容:/news/1,GET;
· 刪除新聞:/news/1,DELETE。

基礎整合配置
如果現在希望Spring MVC執行的時候可以以Restful的風格進行執行,那麼首先需要新增一些依賴程式庫,修改pom.xml檔案,追加如下的配置:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.8.3</version>
<version>2.8.3</version>

在pom.xml裡配置


        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId
>
<artifactId>jackson-core</artifactId> <version>2.8.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId
>
<version>2.8.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.8.3</version> </dependency>

隨後還需要修改web.xml檔案,因為如果要想實現Restful風格的開發,那麼對於所有的Action請求路徑就必須做出修改

<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

建立一個MemberAction程式類,定義有如下的一個程式操作:

public class MemberAction {
// 定義該方法的訪問路徑,而後表示該方法返回的資料型別為普通的文字型別(MIME)
    @RequestMapping(value="/info",produces="text/plain;charset=UTF-8")
    public @ResponseBody String info() { // 該方法的返回值即迴應的主題訊息
    return "www.mldnjava.cn" ;
    }
    }

在未使用restful操作的時候要想實現這樣的輸出則必須利用response物件完成處理,但是如果使用了restful之後整個的操作利用註解可以直接將方法的返回內容變為一個具體的文字資料出現。

    @RequestMapping(value = "/echo/{msgParam}", produces = "text/plain;charset=UTF-8")
    public @ResponseBody String echo(@PathVariable("msgParam") String msg) {
        return "ECHO : " + msg;
    }

也就是說整個在Restful處理過程之中,這些路徑的控制會更加的全面,可以表述的含義也更加的豐富。

Spring MVC本身支援restful風格操作,但是在整個的Restful風格里面大部分的情況都是與JSON的結合處理。所以首先需要配置JSON相關的程式開發包

<dependency>
    <groupId>net.sf.ezmorph</groupId>
    <artifactId>ezmorph</artifactId>
    <version>1.0.6</version>
</dependency>
<dependency>
    <groupId>commons-lang</groupId>
    <artifactId>commons-lang</artifactId>
    <version>2.6</version>
</dependency>
<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.9.2</version>
</dependency>
<dependency>
    <groupId>commons-collections</groupId>
    <artifactId>commons-collections</artifactId>
    <version>3.2.1</version>
</dependency>

這個時候還需要使用到JSON的開發包,但是對於這個開發包建議自己單獨配置。

實現資料的追加處理

Restful風格的主題操作都表示可以直接進行資訊的接收與處理,利用Spring MVC中提供的自動VO接收處理,以及返回JSON處理結果為方式進行一個增加的操作實現。 1、 建立一個Member.java的VO類,這個VO類需要考慮到後期針對於JSON轉換輸出操作。

package cn.mldn.vo;
import java.io.Serializable;
import java.util.Date;
import javax.xml.bind.annotation.XmlRootElement;
@SuppressWarnings("serial")
@XmlRootElement
public class Member implements Serializable {
    private Integer mid ;
    private String name ;
    private Double salary ;
    private Date hiredate ;
}

在MebmerAction程式裡面建立一個處理方法; · 增加日期的處理轉換器:

private Logger log = Logger.getLogger("MemberAction.class");

    @InitBinder
    public void initBinder(WebDataBinder wdb){
        wdb.registerCustomEditor(java.util.Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), true));
    }

    @RequestMapping(value="/member",method=RequestMethod.POST,produces="application/json;charset=UTF-8")
    public @ResponseBody Object add(Member vo){
        log.info("member的add方法");
        log.info("member:" + vo);
        JSONObject obj = new JSONObject();
        obj.put("flag", true);
        return obj;
    }

建立一個JSP以及JS操作通過jQuery盡心呼叫處理:

<script type="text/javascript" src="js/jquery.min.js"></script>
<script type="text/javascript" src="js/restful_demo.js"></script>
<div id="butDiv">
<button id="addMember"> </button>
</div>
<div id="showDiv"></div>

定義一個restful_dempo.js檔案,來進行資料驗證等操作:

$(function(){
    $(addMember).on("click",function(){
        $.ajax({
            url : "member",
            type : "post",
            dataType : "json",
            data : {
                mid : 1001,
                name : "史密斯",
                salary : 9888.2,
                hiredate : "1999-10-12"
            },
            success : function(data){
                $(showDiv).append("<p>增加處理結果"+data.flag+"</p>");
            },
            error : function(data){
                $(showDiv).append("<p>對不起出錯了     !!!!!!!!!!!!</p>");
            }
        });
    });
}

資料更新處理

資料的更新處理主要是值得是修改增加刪除,其中對於增加處理已經完成了,
實現修改操作:
在MemberAction裡面最佳一個新的方法:
    @RequestMapping(value="/member",method=RequestMethod.PUT,produces="application/json;charset=UTF-8")
    public @ResponseBody Object edit(Member vo){
        JSONObject obj = new JSONObject();
        log.info("edit" + vo);
        obj.put("flag", true);
        return  obj;
    }

隨後在restful_demo.js檔案裡面對editMember檔案裡面為按鈕繫結時間:

$(editMember).on("click",function(){
        $.ajax({
            url : "member?mid=1111&name=阿倫&salary=999.99&hiredate=1999-90-90",
            type : "put",
            dataType : "json",
            success : function(data){
                $(showDiv).append("<h1>修改處理操作 "+ data.flag +"</h1>");
            },
            error : function(data){
                $(showDiv).append("<h1>修改頁面出錯了</h1>");
            }
        });
    });

刪除使用者處理:
在MemberAction只中定義相關的刪除處理方法

    @RequestMapping(value="/member/{mid:\\d+}",method=RequestMethod.DELETE,produces="application/json;charset=UTF-8")
    public @ResponseBody Object delete(@PathVariable("mid") int mid){
        JSONObject obj = new JSONObject();
        obj.put("flag", true);
        log.info("delete" + mid);
        return obj;
    }

在js裡面需要傳送的是DELETE請求模式:

    $(removeMember).on("click",function(){
        $.ajax({
            url : "member/1001",
            type : "delete",
            dataType : "json",
            success : function(data){
                $(showDiv).append("<h1>刪除處理操作 "+ data.flag +"</h1>");
            },
            error : function(data){
                $(showDiv).append("<h1>刪除頁面出錯了</h1>");
            }
        });
    });

在Restful裡面增加使用POST模式,修改使用PUT模式,刪除使用DELETE模式:

之後進行資料的查詢操作:
對於資料的查詢操作最多的形式就是進行單的資訊查詢,以及資料的分頁查詢操作:
取得單個使用者資訊:
在MemberAction裡面定義一個根據id取得使用者資訊的處理操作:

@RequestMapping(value="/member/{mid:\\d+}",method=RequestMethod.GET,produces="application/json;charset=UTF-8")
    public @ResponseBody Object get(@PathVariable("mid") int mid){
        Member vo = new Member();
        vo.setMid(mid);
        vo.setName("史密斯");
        vo.setSalary(199.11);
        vo.setHiredate(new Date());
        return vo;
    }

在前臺頁面之中使用js進行呼叫,把返回的結果直接進行輸出:

$(listMember).on("click",function(){
        $.ajax({
            url : "member/mid",
            type : "patch",
            dataType : "json",
            success : function(data){
                $(showDiv).append("<h1> "+data.condition+" </h1>");
                $(showDiv).append("<h1> "+data.memberCount+" </h1>");
                console.log(data.allMembers.length);
                for(var x = 0 ; x < data.allMembers.length ; x ++){
                    $(showDiv).append("<h1> 修改處理操作"+ data.allMembers[x].mid +", "+data.allMembers[x].name+" "+data.allMembers[x].salary+" "+new Date(data.allMembers[x].hiredate).format("yyyy-MM-dd hh:mm:ss")+"</h1>");
                }
            },
            error : function(data){
                $(showDiv).append("<h1>分頁查詢頁面出錯了</h1>");
            }
        });
    });

在js頁面之中對時間日期函式進行處理:

Date.prototype.format = function(fmt) {
    var o = {
        "M+" : this.getMonth() + 1, //
        "d+" : this.getDate(), //
        "h+" : this.getHours(), //
        "m+" : this.getMinutes(), //
        "s+" : this.getSeconds(), //
        "q+" : Math.floor((this.getMonth() + 3) / 3), //
        "S" : this.getMilliseconds()
        //
    };
    if (/(y+)/.test(fmt))
        fmt = fmt.replace(RegExp.$1, (this.getFullYear() + "")
                .substr(4 - RegExp.$1.length));
    for ( var k in o)
        if (new RegExp("(" + k + ")").test(fmt))
            fmt = fmt.replace(RegExp.$1, (RegExp.$1.length == 1) ? (o[k])
                    : (("00" + o[k]).substr(("" + o[k]).length)));
    return fmt;
}

最後進行一個分頁列表操作:
如果要進行分頁列表的控制,那麼一定需要傳遞若干個分頁的控制引數:lineSize,currentPage,column,keyWord,如果現在要想進行這些引數的接收控制,最好的做法就是單獨編寫一個分頁的工具類:
定義SplitUtil工具類,該工具可以自動的接受傳遞的引數內容,因為會自動呼叫setter方法:

public class Member {
    private Integer mid;
    private String name;
    private Double salary;
    private Date hiredate;
    public Integer getMid() {
        return mid;
    }
    public void setMid(Integer mid) {
        this.mid = mid;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Double getSalary() {
        return salary;
    }
    public void setSalary(Double salary) {
        this.salary = salary;
    }
    public Date getHiredate() {
        return hiredate;
    }
    public void setHiredate(Date hiredate) {
        this.hiredate = hiredate;
    }
    @Override
    public String toString() {
        return "Member [mid=" + mid + ", name=" + name + ", salary=" + salary + ", hiredate=" + hiredate + "]";
    }

在MemberAction裡面最佳有一個分頁的控制顯示方法:

@RequestMapping(value="/member/{condition}",method=RequestMethod.PATCH,produces="application/json;charset=UTF-8")
    public @ResponseBody Object list(@PathVariable("condition") String condition,SplitPageUtil su){
        List<Member> all = new ArrayList<Member>();
        for(int x = (su.getCp()-1) * su.getLs() ; x < su.getCp() * su.getLs() ; x ++){
            Member vo = new Member();
            vo.setMid(x);
            vo.setName("性名 - " + x );
            vo.setSalary(1000.00 + x*35);
            vo.setHiredate(new Date());
            all.add(vo);
        }
        for (Member member : all) {
            System.out.println(member);
        }
        Map<String,Object> map = new HashMap<String,Object>();
        map.put("memberCount", 892349);
        map.put("allMembers", all);
        map.put("condition", condition);
        return map;
    }

在js之中編寫js檔案進行分頁的呼叫:

$(listMember).on("click",function(){
        $.ajax({
            url : "member/mid",
            type : "patch",
            dataType : "json",
            success : function(data){
                $(showDiv).append("<h1> "+data.condition+" </h1>");
                $(showDiv).append("<h1> "+data.memberCount+" </h1>");
                console.log(data.allMembers.length);
                for(var x = 0 ; x < data.allMembers.length ; x ++){
                    $(showDiv).append("<h1> 修改處理操作"+ data.allMembers[x].mid +", "+data.allMembers[x].name+" "+data.allMembers[x].salary+" "+new Date(data.allMembers[x].hiredate).format("yyyy-MM-dd hh:mm:ss")+"</h1>");
                }
            },
            error : function(data){
                $(showDiv).append("<h1>分頁查詢頁面出錯了</h1>");
            }
        });
    });