SpringMVC+RestFul詳細示例實戰(zhàn)教程(實現(xiàn)跨域訪問)

一、理解 REST

REST(Representational State Transfer),中文翻譯叫“表述性狀態(tài)轉(zhuǎn)移”。是 Roy Thomas Fielding 在他2000年的博士論文中提出的。它與傳統(tǒng)的 SOAP Web 服務(wù)區(qū)別在于,REST關(guān)注的是要處理的數(shù)據(jù),而 SOAP 主要關(guān)注行為和處理。要理解好 REST,根據(jù)其首字母拆分出的英文更容易理解。

表述性(Representational):對于 REST 來說,我們網(wǎng)絡(luò)上的一個個URI資源可以用各種形式來表述,例如:XML、JSON或者HTML等。

狀態(tài)(State): REST 更關(guān)注資源的狀態(tài)而不是對資源采取的行為。

轉(zhuǎn)移(Transfer):在網(wǎng)絡(luò)傳輸過程中,REST 使資源以某種表述性形式從一個應(yīng)用轉(zhuǎn)移到另一個應(yīng)用(如從服務(wù)端轉(zhuǎn)移到客戶端)。

具體來說,REST 中存在行為,它的行為是通過 HTTP 表示操作的方法來定義的即:GET、POST、PUT、DELETE、PATCH;GET用來獲取資源,POST用來新建資源(也可以用于更新資源),PUT用來更新資源,DELETE用來刪除資源,PATCH用來更新資源。 基于 REST 這樣的觀點,我們需要避免使用 REST服務(wù)、REST Web服務(wù) 這樣的稱呼,這些稱呼多少都帶有一些強調(diào)行為的味道。

二、使用 RESTful 架構(gòu)設(shè)計使用誤區(qū)

RESTful 架構(gòu):是基于 REST 思想的時下比較流行的一種互聯(lián)網(wǎng)軟件架構(gòu)。它結(jié)構(gòu)清晰、符合標(biāo)準(zhǔn)、易于理解、擴展方便,所以正得到越來越多網(wǎng)站的采用。

在沒有足夠了解 REST 的時候,我們很容易錯誤的將其視為 “基于 URL 的 Web 服務(wù)”,即將 REST 和 SOAP 一樣,是一種遠程過程調(diào)用(remote procedure call,RPC)的機制。但是 REST 和 RPC 幾乎沒有任何關(guān)系,RPC 是面向服務(wù)的,而 REST 是面向資源的,強調(diào)描述應(yīng)用程序的事物和名詞。這樣很容易導(dǎo)致的一個結(jié)果是我們在設(shè)計 RESTful API 時,在 URI 中使用動詞。例如:GET /user/getUser/123。正確寫法應(yīng)該是 GET /user/123。

三、 springMVC 支持 RESTful

在 spring 3.0 以后,spring 這對 springMVC 的一些增強功能對 RESTful 提供了良好的支持。在4.0后的版本中,spring 支持一下方式創(chuàng)建 REST 資源:

  1. 控制器可以處理所有的 HTTP 方法,包含幾個主要的 REST 方法:GET、POST、PUT、DELETE、PATCH

  2. 借助 spring 的視圖解析器,資源能夠以多種方式進行表述,包括將模型數(shù)據(jù)渲染為 XML、JSON、Atom、已經(jīng) RSS 的 View 實現(xiàn);

  3. 可以使用 ContentNegotiatingViewResolver 來選擇最適合客戶端的表述;

  4. 借助 @ResponseBody 注解和各種 HttpMethodConverter 實現(xiàn),能夠替換基于視圖的渲染方式;

  5. 類似地,@RequestBody 注解以及 HttpMethodConverter 實現(xiàn)可以將傳入的 HTTP 數(shù)據(jù)轉(zhuǎn)化為傳入控制器處理方法的 Java 對象;

  6. 借助 RestTemplate ,spring 應(yīng)用能夠方便地使用 REST 資源。

四、基于Rest的Controller(控制器)

我們的 REST API :

  • GET 方式請求 /api/user/ 返回用戶列表
  • GET 方式請求 /api/user/1返回id為1的用戶
  • POST 方式請求 /api/user/ 通過user對象的JSON 參數(shù)創(chuàng)建新的user對象
  • PUT 方式請求 /api/user/3 更新id為3的發(fā)送json格式的用戶對象
  • DELETE 方式請求/api/user/4刪除 ID為 4的user對象
  • DELETE 方式請求/api/user/刪除所有user
    package com.websystique.springmvc.controller;  
       
    import java.util.List;  
       
    import org.springframework.beans.factory.annotation.Autowired;  
    import org.springframework.http.HttpHeaders;  
    import org.springframework.http.HttpStatus;  
    import org.springframework.http.MediaType;  
    import org.springframework.http.ResponseEntity;  
    import org.springframework.web.bind.annotation.PathVariable;  
    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.RestController;  
    import org.springframework.web.util.UriComponentsBuilder;  
       
    import com.websystique.springmvc.model.User;  
    import com.websystique.springmvc.service.UserService;  
       
    @RestController  
    public class HelloWorldRestController {  
       
        @Autowired  
        UserService userService;  //Service which will do all data retrieval/manipulation work  
       
           
        //-------------------Retrieve All Users--------------------------------------------------------  
           
        @RequestMapping(value = "/user/", method = RequestMethod.GET)  
        public ResponseEntity<List<User>> listAllUsers() {  
            List<User> users = userService.findAllUsers();  
            if(users.isEmpty()){  
                return new ResponseEntity<List<User>>(HttpStatus.NO_CONTENT);//You many decide to return HttpStatus.NOT_FOUND  
            }  
            return new ResponseEntity<List<User>>(users, HttpStatus.OK);  
        }  
       
       
        //-------------------Retrieve Single User--------------------------------------------------------  
           
        @RequestMapping(value = "/user/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)  
        public ResponseEntity<User> getUser(@PathVariable("id") long id) {  
            System.out.println("Fetching User with id " + id);  
            User user = userService.findById(id);  
            if (user == null) {  
                System.out.println("User with id " + id + " not found");  
                return new ResponseEntity<User>(HttpStatus.NOT_FOUND);  
            }  
            return new ResponseEntity<User>(user, HttpStatus.OK);  
        }  
       
           
           
        //-------------------Create a User--------------------------------------------------------  
           
        @RequestMapping(value = "/user/", method = RequestMethod.POST)  
        public ResponseEntity<Void> createUser(@RequestBody User user,    UriComponentsBuilder ucBuilder) {  
            System.out.println("Creating User " + user.getName());  
       
            if (userService.isUserExist(user)) {  
                System.out.println("A User with name " + user.getName() + " already exist");  
                return new ResponseEntity<Void>(HttpStatus.CONFLICT);  
            }  
       
            userService.saveUser(user);  
       
            HttpHeaders headers = new HttpHeaders();  
            headers.setLocation(ucBuilder.path("/user/{id}").buildAndExpand(user.getId()).toUri());  
            return new ResponseEntity<Void>(headers, HttpStatus.CREATED);  
        }  
       
           
        //------------------- Update a User --------------------------------------------------------  
           
        @RequestMapping(value = "/user/{id}", method = RequestMethod.PUT)  
        public ResponseEntity<User> updateUser(@PathVariable("id") long id, @RequestBody User user) {  
            System.out.println("Updating User " + id);  
               
            User currentUser = userService.findById(id);  
               
            if (currentUser==null) {  
                System.out.println("User with id " + id + " not found");  
                return new ResponseEntity<User>(HttpStatus.NOT_FOUND);  
            }  
       
            currentUser.setName(user.getName());  
            currentUser.setAge(user.getAge());  
            currentUser.setSalary(user.getSalary());  
               
            userService.updateUser(currentUser);  
            return new ResponseEntity<User>(currentUser, HttpStatus.OK);  
        }  
       
        //------------------- Delete a User --------------------------------------------------------  
           
        @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)  
        public ResponseEntity<User> deleteUser(@PathVariable("id") long id) {  
            System.out.println("Fetching & Deleting User with id " + id);  
       
            User user = userService.findById(id);  
            if (user == null) {  
                System.out.println("Unable to delete. User with id " + id + " not found");  
                return new ResponseEntity<User>(HttpStatus.NOT_FOUND);  
            }  
       
            userService.deleteUserById(id);  
            return new ResponseEntity<User>(HttpStatus.NO_CONTENT);  
        }  
       
           
        //------------------- Delete All Users --------------------------------------------------------  
           
        @RequestMapping(value = "/user/", method = RequestMethod.DELETE)  
        public ResponseEntity<User> deleteAllUsers() {  
            System.out.println("Deleting All Users");  
       
            userService.deleteAllUsers();  
            return new ResponseEntity<User>(HttpStatus.NO_CONTENT);  
        }  
       
    }  

springmvc注解詳解

@RestController :首先我們使用的是Spring 4的新注解 @RestController注解.

此注解避免了每個方法都要加上@ResponseBody注解。也就是說@RestController 自己戴上了 @ResponseBody注解,看以看作是

@RequestBody : 如果方法參數(shù)被 @RequestBody注解,Spring將綁定HTTP請求體到那個參數(shù)上。如果那樣做,Spring將根據(jù)請求中的ACCEPT或者 Content-Type header(私下)使用 HTTP Message converters 來將http請求體轉(zhuǎn)化為domain對象。

@ResponseBody : 如果方法加上了@ResponseBody注解,Spring返回值到響應(yīng)體。如果這樣做的話,Spring將根據(jù)請求中的 Content-Type header(私下)使用 HTTP Message converters 來將domain對象轉(zhuǎn)換為響應(yīng)體。

ResponseEntity: 是一個真實數(shù)據(jù).它代表了整個 HTTP 響應(yīng)(response). 它的好處是你可以控制任何對象放到它內(nèi)部。

你可以指定狀態(tài)碼、頭信息和響應(yīng)體。它包含你想要構(gòu)建HTTP Response 的信息。

@PathVariable: 此注解意味著一個方法參數(shù)應(yīng)該綁定到一個url模板變量[在'{}'里的一個]中

一般來說你,要實現(xiàn)REST API in Spring 4 需要了解@RestController , @RequestBody, ResponseEntity 和 @PathVariable 這些注解 .另外, spring 也提供了一些支持類幫助你實現(xiàn)一些可定制化的東西。

MediaType : 帶著 @RequestMapping 注解,通過特殊的控制器方法你可以額外指定,MediaType來生產(chǎn)或者消耗。

五、發(fā)布和測試此API

想要測試此API,我將使用POSTMAN這個外部客戶端,接下來我們也將寫我們自己的客戶端。

1. 獲取所有用戶

打開 POSTMAN工具,選擇請求類型為GET,指明uri


這里寫圖片描述

注意:我們沒有指明任何HTTP頭。點擊 發(fā)送,將接收到所有用戶的列表


這里寫圖片描述

也要注意HTTP 200 響應(yīng)。


這里寫圖片描述

你也許好奇為什么此響應(yīng)通過JSON字符串發(fā)送的,在響應(yīng)里的Content-Type 頭說明了這個。
因為我們添加了JACKSON

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

因為Spring在類路徑發(fā)現(xiàn)了這個庫,它調(diào)用了內(nèi)置的MappingJackson2HttpMessageConverter 轉(zhuǎn)換器將響應(yīng)(對象集合)轉(zhuǎn)換為JSON格式。
Spring內(nèi)置轉(zhuǎn)換器的好處是,大部分情況下只要把庫放到類路徑,即可完成轉(zhuǎn)換。當(dāng)然了有時候我們也需要
采用我們的API。比如,如果我們像也提供XML格式的話,我們需要對User類加上JAXB注解。

2. 獲取單個用戶

GET方式 指定/user/1

這里寫圖片描述

現(xiàn)在試著發(fā)送一個帶有錯誤識別碼的GET請求,將收到一個HTTP 404


這里寫圖片描述

3.創(chuàng)建一個 User

選擇POST方法,指明uri /user/ 指明POSTMAN Body選項卡,選擇application/json類型

這里寫圖片描述

你要注意POSTMAN自動添加了Content-Type 頭信息
這里寫圖片描述

記?。?/strong> Accept header包含client能給識別的類型。 Content-Type header表示數(shù)據(jù)的實際類型。

點擊發(fā)送以后 將收到 HTTP 200 沒有響應(yīng)體(api里面沒有在響應(yīng)體發(fā)送任何東西)


這里寫圖片描述

你可以查詢新創(chuàng)建的用戶


這里寫圖片描述

這是實現(xiàn)REST的普通實現(xiàn)方式。但是也沒人阻止你為POST或者PUT方式響應(yīng)體里發(fā)送內(nèi)容。但是這還是REST 的API?值得懷疑。
不管怎樣,我們試著創(chuàng)建同一個用戶時,你將獲得HTTP沖突的響應(yīng)。


這里寫圖片描述

4.更新用戶

發(fā)送一個HTTP PUT 請求來更新用戶。

這里寫圖片描述

注意:這次我們接收到了響應(yīng)體。這是因為在控制器的方法實現(xiàn)里我們發(fā)送了數(shù)據(jù)。再次強調(diào),有的人也許不在響應(yīng)體里面發(fā)送更新的詳情,只發(fā)送位置頭(和創(chuàng)建用戶一樣)。

5.刪除用戶

這里寫圖片描述

6 刪除所有用戶

這里寫圖片描述

7.刪除用戶后驗證

這里寫圖片描述

六、根據(jù)RestTemplate 寫REST Client

Postman是測試Rest Api的超好用的工具,但是如果你想完整的消化REST,可以嘗試自己寫一個。
最出名的Htpp 客戶端是HttpClient( Apache HttpComponents )。
但是用它來訪問REST service則相對少見。
Spring的 RestTemplate隨之出現(xiàn)。RestTemplate 提供了高級方法,來響應(yīng)者6種主要的HTTP方法。

HTTP 方法和對應(yīng)的 RestTemplate方法:

  • HTTP GET : getForObject, getForEntity
  • HTTP PUT : put(String url, Object request, String…?urlVariables)
  • HTTP DELETE : delete
  • HTTP POST : postForLocation(String url, Object request, String…? urlVariables), postForObject(String url, Object request, ClassresponseType, String…? uriVariables)
  • HTTP HEAD : headForHeaders(String url, String…? urlVariables)
  • HTTP OPTIONS : optionsForAllow(String url, String…? urlVariables)
  • HTTP PATCH and others : exchange execute

定義 Rest client , 定義REST services

 package com.websystique.springmvc;  
       
    import java.net.URI;  
    import java.util.LinkedHashMap;  
    import java.util.List;  
       
    import org.springframework.web.client.RestTemplate;  
       
    import com.websystique.springmvc.model.User;  
       
    public class SpringRestTestClient {  
       
        public static final String REST_SERVICE_URI = "http://localhost:8080/Spring4MVCCRUDRestService";  
           
        /* GET */  
        @SuppressWarnings("unchecked")  
        private static void listAllUsers(){  
            System.out.println("Testing listAllUsers API-----------");  
               
            RestTemplate restTemplate = new RestTemplate();  
            List<LinkedHashMap<String, Object>> usersMap = restTemplate.getForObject(REST_SERVICE_URI+"/user/", List.class);  
               
            if(usersMap!=null){  
                for(LinkedHashMap<String, Object> map : usersMap){  
                    System.out.println("User : id="+map.get("id")+", Name="+map.get("name")+", Age="+map.get("age")+", Salary="+map.get("salary"));;  
                }  
            }else{  
                System.out.println("No user exist----------");  
            }  
        }  
           
        /* GET */  
        private static void getUser(){  
            System.out.println("Testing getUser API----------");  
            RestTemplate restTemplate = new RestTemplate();  
            User user = restTemplate.getForObject(REST_SERVICE_URI+"/user/1", User.class);  
            System.out.println(user);  
        }  
           
        /* POST */  
        private static void createUser() {  
            System.out.println("Testing create User API----------");  
            RestTemplate restTemplate = new RestTemplate();  
            User user = new User(0,"Sarah",51,134);  
            URI uri = restTemplate.postForLocation(REST_SERVICE_URI+"/user/", user, User.class);  
            System.out.println("Location : "+uri.toASCIIString());  
        }  
       
        /* PUT */  
        private static void updateUser() {  
            System.out.println("Testing update User API----------");  
            RestTemplate restTemplate = new RestTemplate();  
            User user  = new User(1,"Tomy",33, 70000);  
            restTemplate.put(REST_SERVICE_URI+"/user/1", user);  
            System.out.println(user);  
        }  
       
        /* DELETE */  
        private static void deleteUser() {  
            System.out.println("Testing delete User API----------");  
            RestTemplate restTemplate = new RestTemplate();  
            restTemplate.delete(REST_SERVICE_URI+"/user/3");  
        }  
       
       
        /* DELETE */  
        private static void deleteAllUsers() {  
            System.out.println("Testing all delete Users API----------");  
            RestTemplate restTemplate = new RestTemplate();  
            restTemplate.delete(REST_SERVICE_URI+"/user/");  
        }  
       
        public static void main(String args[]){  
            listAllUsers();  
            getUser();  
            createUser();  
            listAllUsers();  
            updateUser();  
            listAllUsers();  
            deleteUser();  
            listAllUsers();  
            deleteAllUsers();  
            listAllUsers();  
        }  
    }  

重啟服務(wù)器,運行上面的程序。

下面是輸出:

    Testing listAllUsers API-----------  
    User : id=1, Name=Sam, Age=30, Salary=70000.0  
    User : id=2, Name=Tom, Age=40, Salary=50000.0  
    User : id=3, Name=Jerome, Age=45, Salary=30000.0  
    User : id=4, Name=Silvia, Age=50, Salary=40000.0  
    Testing getUser API----------  
    User [id=1, name=Sam, age=30, salary=70000.0]  
    Testing create User API----------  
    Location : http://localhost:8080/Spring4MVCCRUDRestService/user/5  
    Testing listAllUsers API-----------  
    User : id=1, Name=Sam, Age=30, Salary=70000.0  
    User : id=2, Name=Tom, Age=40, Salary=50000.0  
    User : id=3, Name=Jerome, Age=45, Salary=30000.0  
    User : id=4, Name=Silvia, Age=50, Salary=40000.0  
    User : id=5, Name=Sarah, Age=51, Salary=134.0  
    Testing update User API----------  
    User [id=1, name=Tomy, age=33, salary=70000.0]  
    Testing listAllUsers API-----------  
    User : id=1, Name=Tomy, Age=33, Salary=70000.0  
    User : id=2, Name=Tom, Age=40, Salary=50000.0  
    User : id=3, Name=Jerome, Age=45, Salary=30000.0  
    User : id=4, Name=Silvia, Age=50, Salary=40000.0  
    User : id=5, Name=Sarah, Age=51, Salary=134.0  
    Testing delete User API----------  
    Testing listAllUsers API-----------  
    User : id=1, Name=Tomy, Age=33, Salary=70000.0  
    User : id=2, Name=Tom, Age=40, Salary=50000.0  
    User : id=4, Name=Silvia, Age=50, Salary=40000.0  
    User : id=5, Name=Sarah, Age=51, Salary=134.0  
    Testing all delete Users API----------  
    Testing listAllUsers API-----------  
    No user exist----------  

七、完整的例子

1、項目結(jié)構(gòu)

這里寫圖片描述

2、pom.xml添加項目依賴

  <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/maven-v4_0_0.xsd">  
      <modelVersion>4.0.0</modelVersion>  
      <groupId>com.websystique.springmvc</groupId>  
      <artifactId>Spring4MVCCRUDRestService</artifactId>  
      <packaging>war</packaging>  
      <version>1.0.0</version>  
      <name>Spring4MVCCRUDRestService Maven Webapp</name>  
       
        <properties>  
            <springframework.version>4.2.0.RELEASE</springframework.version>  
            <jackson.version>2.5.3</jackson.version>  
        </properties>  
       
        <dependencies>  
            <dependency>  
                <groupId>org.springframework</groupId>  
                <artifactId>spring-webmvc</artifactId>  
                <version>${springframework.version}</version>  
            </dependency>  
            <dependency>  
                <groupId>org.springframework</groupId>  
                <artifactId>spring-tx</artifactId>  
                <version>${springframework.version}</version>  
            </dependency>  
       
            <dependency>  
                <groupId>com.fasterxml.jackson.core</groupId>  
                <artifactId>jackson-databind</artifactId>  
                <version>${jackson.version}</version>  
            </dependency>  
            <dependency>  
                <groupId>javax.servlet</groupId>  
                <artifactId>javax.servlet-api</artifactId>  
                <version>3.1.0</version>  
            </dependency>  
                   
        </dependencies>  
       
       
        <build>  
            <pluginManagement>  
                <plugins>  
                    <plugin>  
                        <groupId>org.apache.maven.plugins</groupId>  
                        <artifactId>maven-compiler-plugin</artifactId>  
                        <version>3.2</version>  
                        <configuration>  
                            <source>1.7</source>  
                            <target>1.7</target>  
                        </configuration>  
                    </plugin>  
                    <plugin>  
                        <groupId>org.apache.maven.plugins</groupId>  
                        <artifactId>maven-war-plugin</artifactId>  
                        <version>2.4</version>  
                        <configuration>  
                            <warSourceDirectory>src/main/webapp</warSourceDirectory>  
                            <warName>Spring4MVCCRUDRestService</warName>  
                            <failOnMissingWebXml>false</failOnMissingWebXml>  
                        </configuration>  
                    </plugin>  
                </plugins>  
            </pluginManagement>  
       
            <finalName>Spring4MVCCRUDRestService</finalName>  
        </build>  
    </project>  

3、User Service

  package com.websystique.springmvc.service;  
       
    import java.util.List;  
       
    import com.websystique.springmvc.model.User;  
       
       
       
    public interface UserService {  
           
        User findById(long id);  
           
        User findByName(String name);  
           
        void saveUser(User user);  
           
        void updateUser(User user);  
           
        void deleteUserById(long id);  
       
        List<User> findAllUsers();   
           
        void deleteAllUsers();  
           
        public boolean isUserExist(User user);  
           
    }  
    package com.websystique.springmvc.service;  
       
    import java.util.ArrayList;  
    import java.util.Iterator;  
    import java.util.List;  
    import java.util.concurrent.atomic.AtomicLong;  
       
    import org.springframework.stereotype.Service;  
    import org.springframework.transaction.annotation.Transactional;  
       
    import com.websystique.springmvc.model.User;  
       
    @Service("userService")  
    @Transactional  
    public class UserServiceImpl implements UserService{  
           
        private static final AtomicLong counter = new AtomicLong();  
           
        private static List<User> users;  
           
        static{  
            users= populateDummyUsers();  
        }  
       
        public List<User> findAllUsers() {  
            return users;  
        }  
           
        public User findById(long id) {  
            for(User user : users){  
                if(user.getId() == id){  
                    return user;  
                }  
            }  
            return null;  
        }  
           
        public User findByName(String name) {  
            for(User user : users){  
                if(user.getName().equalsIgnoreCase(name)){  
                    return user;  
                }  
            }  
            return null;  
        }  
           
        public void saveUser(User user) {  
            user.setId(counter.incrementAndGet());  
            users.add(user);  
        }  
       
        public void updateUser(User user) {  
            int index = users.indexOf(user);  
            users.set(index, user);  
        }  
       
        public void deleteUserById(long id) {  
               
            for (Iterator<User> iterator = users.iterator(); iterator.hasNext(); ) {  
                User user = iterator.next();  
                if (user.getId() == id) {  
                    iterator.remove();  
                }  
            }  
        }  
       
        public boolean isUserExist(User user) {  
            return findByName(user.getName())!=null;  
        }  
       
        private static List<User> populateDummyUsers(){  
            List<User> users = new ArrayList<User>();  
            users.add(new User(counter.incrementAndGet(),"Sam",30, 70000));  
            users.add(new User(counter.incrementAndGet(),"Tom",40, 50000));  
            users.add(new User(counter.incrementAndGet(),"Jerome",45, 30000));  
            users.add(new User(counter.incrementAndGet(),"Silvia",50, 40000));  
            return users;  
        }  
       
        public void deleteAllUsers() {  
            users.clear();  
        }  
       
    }  

4、Model (模型)類

  package com.websystique.springmvc.model;  
       
    public class User {  
       
        private long id;  
           
        private String name;  
           
        private int age;  
           
        private double salary;  
       
        public User(){  
            id=0;  
        }  
           
        public User(long id, String name, int age, double salary){  
            this.id = id;  
            this.name = name;  
            this.age = age;  
            this.salary = salary;  
        }  
           
        public long getId() {  
            return id;  
        }  
       
        public void setId(long id) {  
            this.id = id;  
        }  
       
        public String getName() {  
            return name;  
        }  
       
        public void setName(String name) {  
            this.name = name;  
        }  
       
        public int getAge() {  
            return age;  
        }  
       
        public void setAge(int age) {  
            this.age = age;  
        }  
       
        public double getSalary() {  
            return salary;  
        }  
       
        public void setSalary(double salary) {  
            this.salary = salary;  
        }  
       
        @Override  
        public int hashCode() {  
            final int prime = 31;  
            int result = 1;  
            result = prime * result + (int) (id ^ (id >>> 32));  
            return result;  
        }  
       
        @Override  
        public boolean equals(Object obj) {  
            if (this == obj)  
                return true;  
            if (obj == null)  
                return false;  
            if (getClass() != obj.getClass())  
                return false;  
            User other = (User) obj;  
            if (id != other.id)  
                return false;  
            return true;  
        }  
       
        @Override  
        public String toString() {  
            return "User [id=" + id + ", name=" + name + ", age=" + age  
                    + ", salary=" + salary + "]";  
        }  
       
       
    }  

5、配置類

注意:下面的配置相當(dāng)于applicationContext-springmvc.xml的配置文件,這只是用java類的方式對springmvc配置,這是省配置的方法。

    package com.websystique.springmvc.configuration;  
       
    import org.springframework.context.annotation.ComponentScan;  
    import org.springframework.context.annotation.Configuration;  
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;  
       
    @Configuration  
    @EnableWebMvc  
    @ComponentScan(basePackages = "com.websystique.springmvc")  
    public class HelloWorldConfiguration {  
           
       
    }  

由于restful的方式不需要視圖的配置,所以不需要任何的實現(xiàn)。

6、初始化類(相當(dāng)于web.xml文件)

注意:這個初始化類相當(dāng)于web.xml文件,這樣就省去了web.xml的配置。

    package com.websystique.springmvc.configuration;  
       
    import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;  
       
    public class HelloWorldInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {  
        
        @Override  
        protected Class<?>[] getRootConfigClasses() {  
            return new Class[] { HelloWorldConfiguration.class };  
        }  
         
        @Override  
        protected Class<?>[] getServletConfigClasses() {  
            return null;  
        }  
         
        @Override  
        protected String[] getServletMappings() {  
            return new String[] { "/" };  
        }  
        
    }  

五、REST API添加CORS支持(實現(xiàn)跨域訪問)

當(dāng)訪問REST API時,你可能需要面對“同源策略”問題。

錯誤如下:

” No ‘Access-Control-Allow-Origin’ header is present on the requested resource. Origin ‘http://127.0.0.1:8080′ is therefore not allowed access.” OR
” XMLHttpRequest cannot load http://abc.com/bla. Origin http://localhost:12345 is not allowed by Access-Control-Allow-Origin.”

一般來說,在服務(wù)器端,我們在響應(yīng)中返回額外的CORS訪問控制頭,實現(xiàn)跨域鏈接。

用 Spring的話,我么可以寫一個簡單的過濾器為每個響應(yīng)添加CORS特征頭。

  package com.websystique.springmvc.configuration;  
       
    import java.io.IOException;  
       
    import javax.servlet.Filter;  
    import javax.servlet.FilterChain;  
    import javax.servlet.FilterConfig;  
    import javax.servlet.ServletException;  
    import javax.servlet.ServletRequest;  
    import javax.servlet.ServletResponse;  
    import javax.servlet.http.HttpServletResponse;  
       
       
    public class CORSFilter implements Filter {  
       
        public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {  
            System.out.println("Filtering on...........................................................");  
            HttpServletResponse response = (HttpServletResponse) res;  
            response.setHeader("Access-Control-Allow-Origin", "*");  
            response.setHeader("Access-Control-Allow-Methods", "POST, GET, PUT, OPTIONS, DELETE");  
            response.setHeader("Access-Control-Max-Age", "3600");  
            response.setHeader("Access-Control-Allow-Headers", "x-requested-with");  
            chain.doFilter(req, res);  
        }  
       
        public void init(FilterConfig filterConfig) {}  
       
        public void destroy() {}  
       
    }  

需要將其添加在Spring 配置中:

   package com.websystique.springmvc.configuration;  
       
    import javax.servlet.Filter;  
       
    import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;  
       
    public class HelloWorldInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {  
        
        @Override  
        protected Class<?>[] getRootConfigClasses() {  
            return new Class[] { HelloWorldConfiguration.class };  
        }  
         
        @Override  
        protected Class<?>[] getServletConfigClasses() {  
            return null;  
        }  
         
        @Override  
        protected String[] getServletMappings() {  
            return new String[] { "/" };  
        }  
           
        @Override  
        protected Filter[] getServletFilters() {  
            Filter [] singleton = { new CORSFilter()};  
            return singleton;  
        }  
        
    }  
參考資料

文章有不當(dāng)之處,歡迎指正,你也可以關(guān)注我的微信公眾號:好好學(xué)java,獲取優(yōu)質(zhì)學(xué)習(xí)資源。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,534評論 19 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong閱讀 22,933評論 1 92
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,261評論 6 342
  • 看到【簡書】首頁上,關(guān)于分享孩子的文字的活動,征求你的意見后,你自己選了一篇以前的習(xí)作,我?guī)椭凇竞啎可贤陡辶耍?..
    素面迎風(fēng)閱讀 178評論 1 0
  • 一、基本信息 本科哈爾濱,酒店管理。不喜歡本專業(yè),職業(yè)規(guī)劃是否轉(zhuǎn)型? 結(jié)合大領(lǐng)域分析,生物能源、金融、高科技互聯(lián)網(wǎng)...
    glacier2016閱讀 438評論 0 0

友情鏈接更多精彩內(nèi)容