1. 程式人生 > >REST API 開發

REST API 開發

count ext light service edi 實際類型 測試 creat @service

本文我們將使用Spring MVC 4實現 CRUD Restful WebService , 通過RestTemplate寫一個 REST 客戶端,定義這些服務. 我們也可以通過外部的一些客戶端來測試這些服務。

簡短 & 快速介紹REST

REST表示 Representational State Transfer(表示性狀態轉換).

它是可以用來設計web services的框架,可以被不同的客戶端調用。

核心思想是:使用簡單的HTTP協議來實現調用,而不是CORBA, RPC 或者 SOAP等負責的機制。

在Rest 基礎設計中,資源使用以下動詞進行操作。

  • 創建資源 : 使用 HTTP POST
  • 獲取資源 : 使用 HTTP GET
  • 更新資源 : 使用 HTTP PUT
  • 刪除資源 : 使用 HTTP DELETE

也意味著,你作為Rest 服務開發者或者客戶,應該遵循以上的標準。

盡管沒有限制必須返回的類型,但是一般基於Web services的Rest返回JSON或者XML作為響應。

客戶端可以指定(使用HTTP Accept header)他們想要的資源類型嗎,服務器返回需要的資源。

指明資源的Content-Type。如果想詳細的理解 restful可以參考這裏:StackOverflow link

基於Rest的Controller(控制器)

我們的 REST API :

  • GET 方式請求 /api/user/ 返回用戶列表
  • GET 方式請求 /api/user/1返回id為1的用戶
  • POST 方式請求 /api/user/ 通過user對象的JSON 參數創建新的user對象
  • PUT 方式請求 /api/user/3 更新id為3的發送json格式的用戶對象
  • DELETE 方式請求/api/user/4刪除 ID為 4的user對象
  • DELETE 方式請求/api/user/刪除所有user
[java] view plain copy
  1. package com.websystique.springmvc.controller;
  2. import java.util.List;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.http.HttpHeaders;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.http.MediaType;
  7. import org.springframework.http.ResponseEntity;
  8. import org.springframework.web.bind.annotation.PathVariable;
  9. import org.springframework.web.bind.annotation.RequestBody;
  10. import org.springframework.web.bind.annotation.RequestMapping;
  11. import org.springframework.web.bind.annotation.RequestMethod;
  12. import org.springframework.web.bind.annotation.RestController;
  13. import org.springframework.web.util.UriComponentsBuilder;
  14. import com.websystique.springmvc.model.User;
  15. import com.websystique.springmvc.service.UserService;
  16. @RestController
  17. public class HelloWorldRestController {
  18. @Autowired
  19. UserService userService; //Service which will do all data retrieval/manipulation work
  20. //-------------------Retrieve All Users--------------------------------------------------------
  21. @RequestMapping(value = "/user/", method = RequestMethod.GET)
  22. public ResponseEntity<List<User>> listAllUsers() {
  23. List<User> users = userService.findAllUsers();
  24. if(users.isEmpty()){
  25. return new ResponseEntity<List<User>>(HttpStatus.NO_CONTENT);//You many decide to return HttpStatus.NOT_FOUND
  26. }
  27. return new ResponseEntity<List<User>>(users, HttpStatus.OK);
  28. }
  29. //-------------------Retrieve Single User--------------------------------------------------------
  30. @RequestMapping(value = "/user/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
  31. public ResponseEntity<User> getUser(@PathVariable("id") long id) {
  32. System.out.println("Fetching User with id " + id);
  33. User user = userService.findById(id);
  34. if (user == null) {
  35. System.out.println("User with id " + id + " not found");
  36. return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
  37. }
  38. return new ResponseEntity<User>(user, HttpStatus.OK);
  39. }
  40. //-------------------Create a User--------------------------------------------------------
  41. @RequestMapping(value = "/user/", method = RequestMethod.POST)
  42. public ResponseEntity<Void> createUser(@RequestBody User user, UriComponentsBuilder ucBuilder) {
  43. System.out.println("Creating User " + user.getName());
  44. if (userService.isUserExist(user)) {
  45. System.out.println("A User with name " + user.getName() + " already exist");
  46. return new ResponseEntity<Void>(HttpStatus.CONFLICT);
  47. }
  48. userService.saveUser(user);
  49. HttpHeaders headers = new HttpHeaders();
  50. headers.setLocation(ucBuilder.path("/user/{id}").buildAndExpand(user.getId()).toUri());
  51. return new ResponseEntity<Void>(headers, HttpStatus.CREATED);
  52. }
  53. //------------------- Update a User --------------------------------------------------------
  54. @RequestMapping(value = "/user/{id}", method = RequestMethod.PUT)
  55. public ResponseEntity<User> updateUser(@PathVariable("id") long id, @RequestBody User user) {
  56. System.out.println("Updating User " + id);
  57. User currentUser = userService.findById(id);
  58. if (currentUser==null) {
  59. System.out.println("User with id " + id + " not found");
  60. return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
  61. }
  62. currentUser.setName(user.getName());
  63. currentUser.setAge(user.getAge());
  64. currentUser.setSalary(user.getSalary());
  65. userService.updateUser(currentUser);
  66. return new ResponseEntity<User>(currentUser, HttpStatus.OK);
  67. }
  68. //------------------- Delete a User --------------------------------------------------------
  69. @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
  70. public ResponseEntity<User> deleteUser(@PathVariable("id") long id) {
  71. System.out.println("Fetching & Deleting User with id " + id);
  72. User user = userService.findById(id);
  73. if (user == null) {
  74. System.out.println("Unable to delete. User with id " + id + " not found");
  75. return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
  76. }
  77. userService.deleteUserById(id);
  78. return new ResponseEntity<User>(HttpStatus.NO_CONTENT);
  79. }
  80. //------------------- Delete All Users --------------------------------------------------------
  81. @RequestMapping(value = "/user/", method = RequestMethod.DELETE)
  82. public ResponseEntity<User> deleteAllUsers() {
  83. System.out.println("Deleting All Users");
  84. userService.deleteAllUsers();
  85. return new ResponseEntity<User>(HttpStatus.NO_CONTENT);
  86. }
  87. }

詳解:

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

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

@Controller 和 @ResponseBody的結合體。

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

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

ResponseEntity 是一個真實數據.它代表了整個 HTTP 響應(response). 它的好處是你可以控制任何對象放到它內部。

你可以指定狀態碼、頭信息和響應體。它包含你想要構建HTTP Response 的信息。

@PathVariable 此註解意味著一個方法參數應該綁定到一個url模板變量[在‘{}‘裏的一個]中

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

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

發布和測試此API

http://localhost:8080/Spring4MVCCRUDRestService. 想要測試此API,我將使用POSTMAN這個外部客戶端,接下來我們也將寫我們自己的客戶端。 1. 獲取所有用戶 打開 POSTMAN工具,選擇請求類型為GET,指明uri 技術分享圖片 註意:我們沒有指明任何HTTP頭。點擊 發送,將接收到所有用戶的列表 技術分享圖片 也要註意HTTP 200 響應。 技術分享圖片 你也許好奇為什麽此響應通過JSON字符串發送的,在響應裏的Content-Type 頭說明了這個。 因為我們添加了JACKSON [html] view plain copy
  1. <dependency>
  2. <groupId>com.fasterxml.jackson.core</groupId>
  3. <artifactId>jackson-databind</artifactId>
  4. <version>2.5.3</version>
  5. </dependency

因為Spring在類路徑發現了這個庫,它調用了內置的MappingJackson2HttpMessageConverter 轉換器將響應(對象集合)轉換為JSON格式。 Spring內置轉換器的好處是,大部分情況下只要把庫放到類路徑,即可完成轉換。當然了有時候我們也需要 采用我們的API。比如,如果我們像也提供XML格式的話,我們需要對User類加上JAXB註解。 2. 獲取單個用戶 GET方式 指定/user/1 技術分享圖片 現在試著發送一個帶有錯誤識別碼的GET請求,將收到一個HTTP 404 技術分享圖片 3.創建一個 User 選擇POST方法,指明uri /user/ 指明POSTMAN Body選項卡,選擇application/json類型 技術分享圖片 你要註意POSTMAN自動添加了Content-Type 頭信息 技術分享圖片 記住: Accept header包含client能給識別的類型。 Content-Type header表示數據的實際類型。 點擊發送以後 將收到 HTTP 200 沒有響應體(api裏面沒有在響應體發送任何東西) 技術分享圖片 你可以查詢新創建的用戶 技術分享圖片 這是實現REST的普通實現方式。但是也沒人阻止你為POST或者PUT方式響應體裏發送內容。但是這還是REST 的API?值得懷疑。 不管怎樣,我們試著創建同一個用戶時,你將獲得HTTP沖突的響應。 技術分享圖片 4.更新用戶 發送一個HTTP PUT 請求來更新用戶。 技術分享圖片 註意:這次我們接收到了響應體。這是因為在控制器的方法實現裏我們發送了數據。再次強調,有的人也許不在響應體裏面發送更新的詳情,只發送位置頭(和創建用戶一樣)。 5.刪除用戶 技術分享圖片 6 刪除所有用戶 技術分享圖片 7.刪除用戶後驗證 技術分享圖片

根據RestTemplate 寫REST Client

Postman是測試Rest Api的超好用的工具,但是如果你想完整的消化REST,可以嘗試自己寫一個。 最出名的Htpp 客戶端是HttpClient( Apache HttpComponents )。 但是用它來訪問REST service則相對少見。 Spring的 RestTemplate隨之出現。RestTemplate 提供了高級方法,來響應者6種主要的HTTP方法。 HTTP 方法和對應的 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 [java] view plain copy
  1. package com.websystique.springmvc;
  2. import java.net.URI;
  3. import java.util.LinkedHashMap;
  4. import java.util.List;
  5. import org.springframework.web.client.RestTemplate;
  6. import com.websystique.springmvc.model.User;
  7. public class SpringRestTestClient {
  8. public static final String REST_SERVICE_URI = "http://localhost:8080/Spring4MVCCRUDRestService";
  9. /* GET */
  10. @SuppressWarnings("unchecked")
  11. private static void listAllUsers(){
  12. System.out.println("Testing listAllUsers API-----------");
  13. RestTemplate restTemplate = new RestTemplate();
  14. List<LinkedHashMap<String, Object>> usersMap = restTemplate.getForObject(REST_SERVICE_URI+"/user/", List.class);
  15. if(usersMap!=null){
  16. for(LinkedHashMap<String, Object> map : usersMap){
  17. System.out.println("User : id="+map.get("id")+", Name="+map.get("name")+", Age="+map.get("age")+", Salary="+map.get("salary"));;
  18. }
  19. }else{
  20. System.out.println("No user exist----------");
  21. }
  22. }
  23. /* GET */
  24. private static void getUser(){
  25. System.out.println("Testing getUser API----------");
  26. RestTemplate restTemplate = new RestTemplate();
  27. User user = restTemplate.getForObject(REST_SERVICE_URI+"/user/1", User.class);
  28. System.out.println(user);
  29. }
  30. /* POST */
  31. private static void createUser() {
  32. System.out.println("Testing create User API----------");
  33. RestTemplate restTemplate = new RestTemplate();
  34. User user = new User(0,"Sarah",51,134);
  35. URI uri = restTemplate.postForLocation(REST_SERVICE_URI+"/user/", user, User.class);
  36. System.out.println("Location : "+uri.toASCIIString());
  37. }
  38. /* PUT */
  39. private static void updateUser() {
  40. System.out.println("Testing update User API----------");
  41. RestTemplate restTemplate = new RestTemplate();
  42. User user = new User(1,"Tomy",33, 70000);
  43. restTemplate.put(REST_SERVICE_URI+"/user/1", user);
  44. System.out.println(user);
  45. }
  46. /* DELETE */
  47. private static void deleteUser() {
  48. System.out.println("Testing delete User API----------");
  49. RestTemplate restTemplate = new RestTemplate();
  50. restTemplate.delete(REST_SERVICE_URI+"/user/3");
  51. }
  52. /* DELETE */
  53. private static void deleteAllUsers() {
  54. System.out.println("Testing all delete Users API----------");
  55. RestTemplate restTemplate = new RestTemplate();
  56. restTemplate.delete(REST_SERVICE_URI+"/user/");
  57. }
  58. public static void main(String args[]){
  59. listAllUsers();
  60. getUser();
  61. createUser();
  62. listAllUsers();
  63. updateUser();
  64. listAllUsers();
  65. deleteUser();
  66. listAllUsers();
  67. deleteAllUsers();
  68. listAllUsers();
  69. }
  70. }

重啟服務器,運行上面的程序。 下面是輸出: [plain] view plain copy
  1. Testing listAllUsers API-----------
  2. User : id=1, Name=Sam, Age=30, Salary=70000.0
  3. User : id=2, Name=Tom, Age=40, Salary=50000.0
  4. User : id=3, Name=Jerome, Age=45, Salary=30000.0
  5. User : id=4, Name=Silvia, Age=50, Salary=40000.0
  6. Testing getUser API----------
  7. User [id=1, name=Sam, age=30, salary=70000.0]
  8. Testing create User API----------
  9. Location : http://localhost:8080/Spring4MVCCRUDRestService/user/5
  10. Testing listAllUsers API-----------
  11. User : id=1, Name=Sam, Age=30, Salary=70000.0
  12. User : id=2, Name=Tom, Age=40, Salary=50000.0
  13. User : id=3, Name=Jerome, Age=45, Salary=30000.0
  14. User : id=4, Name=Silvia, Age=50, Salary=40000.0
  15. User : id=5, Name=Sarah, Age=51, Salary=134.0
  16. Testing update User API----------
  17. User [id=1, name=Tomy, age=33, salary=70000.0]
  18. Testing listAllUsers API-----------
  19. User : id=1, Name=Tomy, Age=33, Salary=70000.0
  20. User : id=2, Name=Tom, Age=40, Salary=50000.0
  21. User : id=3, Name=Jerome, Age=45, Salary=30000.0
  22. User : id=4, Name=Silvia, Age=50, Salary=40000.0
  23. User : id=5, Name=Sarah, Age=51, Salary=134.0
  24. Testing delete User API----------
  25. Testing listAllUsers API-----------
  26. User : id=1, Name=Tomy, Age=33, Salary=70000.0
  27. User : id=2, Name=Tom, Age=40, Salary=50000.0
  28. User : id=4, Name=Silvia, Age=50, Salary=40000.0
  29. User : id=5, Name=Sarah, Age=51, Salary=134.0
  30. Testing all delete Users API----------
  31. Testing listAllUsers API-----------
  32. No user exist----------

完整的例子 技術分享圖片

更新pom.xml添加項目依賴

[html] view plain copy
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3. <modelVersion>4.0.0</modelVersion>
  4. <groupId>com.websystique.springmvc</groupId>
  5. <artifactId>Spring4MVCCRUDRestService</artifactId>
  6. <packaging>war</packaging>
  7. <version>1.0.0</version>
  8. <name>Spring4MVCCRUDRestService Maven Webapp</name>
  9. <properties>
  10. <springframework.version>4.2.0.RELEASE</springframework.version>
  11. <jackson.version>2.5.3</jackson.version>
  12. </properties>
  13. <dependencies>
  14. <dependency>
  15. <groupId>org.springframework</groupId>
  16. <artifactId>spring-webmvc</artifactId>
  17. <version>${springframework.version}</version>
  18. </dependency>
  19. <dependency>
  20. <groupId>org.springframework</groupId>
  21. <artifactId>spring-tx</artifactId>
  22. <version>${springframework.version}</version>
  23. </dependency>
  24. <dependency>
  25. <groupId>com.fasterxml.jackson.core</groupId>
  26. <artifactId>jackson-databind</artifactId>
  27. <version>${jackson.version}</version>
  28. </dependency>
  29. <dependency>
  30. <groupId>javax.servlet</groupId>
  31. <artifactId>javax.servlet-api</artifactId>
  32. <version>3.1.0</version>
  33. </dependency>
  34. </dependencies>
  35. <build>
  36. <pluginManagement>
  37. <plugins>
  38. <plugin>
  39. <groupId>org.apache.maven.plugins</groupId>
  40. <artifactId>maven-compiler-plugin</artifactId>
  41. <version>3.2</version>
  42. <configuration>
  43. <source>1.7</source>
  44. <target>1.7</target>
  45. </configuration>
  46. </plugin>
  47. <plugin>
  48. <groupId>org.apache.maven.plugins</groupId>
  49. <artifactId>maven-war-plugin</artifactId>
  50. <version>2.4</version>
  51. <configuration>
  52. <warSourceDirectory>src/main/webapp</warSourceDirectory>
  53. <warName>Spring4MVCCRUDRestService</warName>
  54. <failOnMissingWebXml>false</failOnMissingWebXml>
  55. </configuration>
  56. </plugin>
  57. </plugins>
  58. </pluginManagement>
  59. <finalName>Spring4MVCCRUDRestService</finalName>
  60. </build>
  61. </project>

User Service

[java] view plain copy
  1. package com.websystique.springmvc.service;
  2. import java.util.List;
  3. import com.websystique.springmvc.model.User;
  4. public interface UserService {
  5. User findById(long id);
  6. User findByName(String name);
  7. void saveUser(User user);
  8. void updateUser(User user);
  9. void deleteUserById(long id);
  10. List<User> findAllUsers();
  11. void deleteAllUsers();
  12. public boolean isUserExist(User user);
  13. }


[java] view plain copy
  1. package com.websystique.springmvc.service;
  2. import java.util.ArrayList;
  3. import java.util.Iterator;
  4. import java.util.List;
  5. import java.util.concurrent.atomic.AtomicLong;
  6. import org.springframework.stereotype.Service;
  7. import org.springframework.transaction.annotation.Transactional;
  8. import com.websystique.springmvc.model.User;
  9. @Service("userService")
  10. @Transactional
  11. public class UserServiceImpl implements UserService{
  12. private static final AtomicLong counter = new AtomicLong();
  13. private static List<User> users;
  14. static{
  15. users= populateDummyUsers();
  16. }
  17. public List<User> findAllUsers() {
  18. return users;
  19. }
  20. public User findById(long id) {
  21. for(User user : users){
  22. if(user.getId() == id){
  23. return user;
  24. }
  25. }
  26. return null;
  27. }
  28. public User findByName(String name) {
  29. for(User user : users){
  30. if(user.getName().equalsIgnoreCase(name)){
  31. return user;
  32. }
  33. }
  34. return null;
  35. }
  36. public void saveUser(User user) {
  37. user.setId(counter.incrementAndGet());
  38. users.add(user);
  39. }
  40. public void updateUser(User user) {
  41. int index = users.indexOf(user);
  42. users.set(index, user);
  43. }
  44. public void deleteUserById(long id) {
  45. for (Iterator<User> iterator = users.iterator(); iterator.hasNext(); ) {
  46. User user = iterator.next();
  47. if (user.getId() == id) {
  48. iterator.remove();
  49. }
  50. }
  51. }
  52. public boolean isUserExist(User user) {
  53. return findByName(user.getName())!=null;
  54. }
  55. private static List<User> populateDummyUsers(){
  56. List<User> users = new ArrayList<User>();
  57. users.add(new User(counter.incrementAndGet(),"Sam",30, 70000));
  58. users.add(new User(counter.incrementAndGet(),"Tom",40, 50000));
  59. users.add(new User(counter.incrementAndGet(),"Jerome",45, 30000));
  60. users.add(new User(counter.incrementAndGet(),"Silvia",50, 40000));
  61. return users;
  62. }
  63. public void deleteAllUsers() {
  64. users.clear();
  65. }
  66. }

Model (模型)類

[java] view plain copy
  1. package com.websystique.springmvc.model;
  2. public class User {
  3. private long id;
  4. private String name;
  5. private int age;
  6. private double salary;
  7. public User(){
  8. id=0;
  9. }
  10. public User(long id, String name, int age, double salary){
  11. this.id = id;
  12. this.name = name;
  13. this.age = age;
  14. this.salary = salary;
  15. }
  16. public long getId() {
  17. return id;
  18. }
  19. public void setId(long id) {
  20. this.id = id;
  21. }
  22. public String getName() {
  23. return name;
  24. }
  25. public void setName(String name) {
  26. this.name = name;
  27. }
  28. public int getAge() {
  29. return age;
  30. }
  31. public void setAge(int age) {
  32. this.age = age;
  33. }
  34. public double getSalary() {
  35. return salary;
  36. }
  37. public void setSalary(double salary) {
  38. this.salary = salary;
  39. }
  40. @Override
  41. public int hashCode() {
  42. final int prime = 31;
  43. int result = 1;
  44. result = prime * result + (int) (id ^ (id >>> 32));
  45. return result;
  46. }
  47. @Override
  48. public boolean equals(Object obj) {
  49. if (this == obj)
  50. return true;
  51. if (obj == null)
  52. return false;
  53. if (getClass() != obj.getClass())
  54. return false;
  55. User other = (User) obj;
  56. if (id != other.id)
  57. return false;
  58. return true;
  59. }
  60. @Override
  61. public String toString() {
  62. return "User [id=" + id + ", name=" + name + ", age=" + age
  63. + ", salary=" + salary + "]";
  64. }
  65. }


配置類 [java] view plain copy
  1. package com.websystique.springmvc.configuration;
  2. import org.springframework.context.annotation.ComponentScan;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  5. @Configuration
  6. @EnableWebMvc
  7. @ComponentScan(basePackages = "com.websystique.springmvc")
  8. public class HelloWorldConfiguration {
  9. }
初始化類 [java] view plain copy
  1. package com.websystique.springmvc.configuration;
  2. import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  3. public class HelloWorldInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
  4. @Override
  5. protected Class<?>[] getRootConfigClasses() {
  6. return new Class[] { HelloWorldConfiguration.class };
  7. }
  8. @Override
  9. protected Class<?>[] getServletConfigClasses() {
  10. return null;
  11. }
  12. @Override
  13. protected String[] getServletMappings() {
  14. return new String[] { "/" };
  15. }
  16. }


為你的REST API添加CORS支持

當訪問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.” 一般來說,在服務器端,我們在響應中返回額外的CORS訪問控制頭,實現跨域鏈接。 用 Spring的話,我麽可以寫一個簡單的過濾器為每個響應添加CORS特征頭。 [java] view plain copy
  1. package com.websystique.springmvc.configuration;
  2. import java.io.IOException;
  3. import javax.servlet.Filter;
  4. import javax.servlet.FilterChain;
  5. import javax.servlet.FilterConfig;
  6. import javax.servlet.ServletException;
  7. import javax.servlet.ServletRequest;
  8. import javax.servlet.ServletResponse;
  9. import javax.servlet.http.HttpServletResponse;
  10. public class CORSFilter implements Filter {
  11. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
  12. System.out.println("Filtering on...........................................................");
  13. HttpServletResponse response = (HttpServletResponse) res;
  14. response.setHeader("Access-Control-Allow-Origin", "*");
  15. response.setHeader("Access-Control-Allow-Methods", "POST, GET, PUT, OPTIONS, DELETE");
  16. response.setHeader("Access-Control-Max-Age", "3600");
  17. response.setHeader("Access-Control-Allow-Headers", "x-requested-with");
  18. chain.doFilter(req, res);
  19. }
  20. public void init(FilterConfig filterConfig) {}
  21. public void destroy() {}
  22. }
需要將其添加在Spring 配置中: [java] view plain copy
  1. package com.websystique.springmvc.configuration;
  2. import javax.servlet.Filter;
  3. import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  4. public class HelloWorldInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
  5. @Override
  6. protected Class<?>[] getRootConfigClasses() {
  7. return new Class[] { HelloWorldConfiguration.class };
  8. }
  9. @Override
  10. protected Class<?>[] getServletConfigClasses() {
  11. return null;
  12. }
  13. @Override
  14. protected String[] getServletMappings() {
  15. return new String[] { "/" };
  16. }
  17. @Override
  18. protected Filter[] getServletFilters() {
  19. Filter [] singleton = { new CORSFilter()};
  20. return singleton;
  21. }
  22. }

REST API 開發