简单介绍REST
REST%uA0表示状态传输。这是一个体系结构样式,可用于设计网络服务,可以被各种客户端消耗。核心思想是,不使用如CORBA,RPC或SOAP复杂的机制在机器之间进行连接,简单的 HTTP 用于使它们之间调用。
-
创建资源:应该使用%uA0HTTP%uA0POST
-
要获取资源:应该使用HTTP%uA0GET
-
更新资源:应使用HTTP%uA0PUT
-
要删除资源:应使用HTTPꃞLETE
通常Rest%uA0是基于Web服务返回JSON或XML数据格式作为响应,虽然它并不仅仅限于这些类型。客户端可以指定(使用 HTTPꂬcept 报头),他们所感兴趣的资源类型,并且服务器可以返回资源,指定它所服务的内容类型资源。%uA0
基于REST的控制器
下面是一个可能基于 REST 的控制器,实现REST%uA0API。这里所说的“可能”,这意味着可以以另一种方式实现它,还是(或者更纯粹的方式)符合REST风格。
- GET%uA0请求%uA0/api/user/%uA0返回用户的列表
- GET%uA0请求%uA0%uA0/api/user/1%uA0返回ID为1的用户
- POST%uA0请求%uA0/api/user/%uA0以用户对象的JSON格式创建新的用户
- PUT%uA0请求%uA0/api/user/3%uA0以用户对象作为JSON更新ID为3的用户
- DELETE%uA0请求%uA0/api/user/4%uA0删除ID为4的用户
- DELETE%uA0请求%uA0/api/user/ 删除所有的用户
package com.yiibai.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.yiibai.springmvc.model.User import com.yiibai.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) } }
@RestController%uA0:%uA0首先,我们使用 Spring4 的新 @RestController 注释。%uA0它的注解消除了注释每个以@ResponseBody的方法。@RestController本身注解为@ResponseBody,并且可以被视为@Controller和@ResponseBody的组合。
@RequestBody%uA0:%uA0如果一个方法的参数都注解有@RequestBody,Spring将绑定传入的%uA0HTTP%uA0请求体(在@RequestMapping提到该法的URL)到这个参数。这样做 Spring 将[在后台]使用HTTP消息转换为HTTP请求主体转换成域对象[反序列化要求主体域对象]的基础上,接受或Content-Type头请求。
@ResponseBody%uA0:如果一个方法被注解为@ResponseBody,Spring将绑定返回值传出的 HTTP 响应体。这样做Spring将[在后台]使用HTTP消息转换器的返回值转换为HTTP响应体[序列化对象响应正文],根据内容类型出现在请求的HTTP头。%uA0前面已经提到,在 Spring4 可能会停止使用此注释。
ResponseEntity是一个真正处理。%uA0它代表了整个HTTP响应。一件好事是你可以控制任何进入它东西。可以指定状态码,头和主体。它自带几个构造函数执行你想要的 HTTP 响应发送的信息。
@PathVariable%uA0这种表示法表示方法参数应绑定到一个 URI 模板变量[“{}”]。
基本上,@RestController,@RequestBody,ResponseEntity&@PathVariable 都是用 Spring%uA04%uA0实现%uA0REST%uA0API%uA0需要知道的。此外,Spring提供了一些支持类来帮助你实现一些定制。
MediaType :%uA0通过@RequestMapping注解,你还可以,指定要生产或消费的 MediaType(使用生产或消费属性),通过特定的控制器的方法,以进一步缩小映射。
部署并测试API,让我们深入研究这个东西是如何工作的
它只是一个普通的控制器类,可部署的应用程序的一部分。[完整下载的应用程序代码显示在本教程文章最后,你可以直接部署到容器。先部署它,才能有这些可用服务,这里先详细讨论了每一个操作。部署的应用程序并访问:http://localhost:8080/Spring4MVCCRUDRestService.
为了测试这个API,这里使用一个外部客户端POSTMAN(这是一个%uA0Chrome%uA0插件,下载安装:http://www.getpostman.com/)。后面我们也将编写我们自己的客户端,也就几分钟的时间。
1.%uA0检索所有用户
你可能想知道的响应是如何发送 JSON 字符串,并在响应中确认Content-Type头。这已在我们的项目Jackson库中实现。
<dependency> <groupId>com.fasterxml.jackson.core</groupId> %uA0%uA0%uA0%uA0<artifactId>jackson-databind</artifactId> <version>2.5.3</version> </dependency>
关于Spring内置转换器,大部分的时间他们只需要某些库在类路径中以便进行转换。当然,有时我们也需要去适应我们的 API/应用程序也是如此。举例来说,如果我们想为XML,我们应标注适当JAXB标注User类。
2.%uA0检索单用户
3. 创建一个用户
发送。您应该看到HTTP200响应,没有主体(如API不发送主体任何东西)。但是,你应该找一个Location头指定位置新创建的用户。
通过这种方式实现是常见的REST。但是,如果你想以 POST/%uA0PUT请求的响应主体发送内容,也没有人阻止你。

请注意,我们收到的响应体的这个时候。这是在控制器中的方法的实现发送。同样,可以决定不发送更新信息的响应体,并只发送位置标头(如创建)。
5.%uA0删除一个用户
6.%uA0删除所有用户
7.%uA0用户删除后,验证所有用户
使用REST模板编写REST客户端
我们上面使用 Postman 是一个很好的客户端测试 REST%uA0API%uA0工具。但是,如果想从应用程序消耗基于REST的Web服务,需要一个REST客户端的应用程序。其中最流行的 HTTP 客户端就是 Apache%uA0HttpComponents%uA0HttpClient。%uA0但在细节上使用这种访问 REST 服务太低级。
Spring RestTemplate 可以来补救。%uA0RestTemplate 提供对应于六个主要的 HTTP 方法,使许多调用RESTful服务只需要一行代码,就可执行 REST最佳实践的更高层次的方法。
- 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, Class%uA0responseType, String… uriVariables)
- HTTP HEAD : headForHeaders(String url, String… urlVariables)
- HTTP OPTIONS : optionsForAllow(String url, String… urlVariables)
- HTTP PATCH and others : exchange execute
package com.yiibai.springmvc import java.net.URI import java.util.LinkedHashMap import java.util.List import org.springframework.web.client.RestTemplate import com.yiibai.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() } }
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----------
完整的实例
工程结构
声明项目的依赖关系
<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.yiibai.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-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>
User Service
package com.yiibai.springmvc.service import java.util.List import com.yiibai.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.yiibai.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.yiibai.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() } }
Model class
package com.yiibai.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 + "]" } }
Configuration class
package com.yiibai.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.yiibai.springmvc") public class HelloWorldConfiguration { }
Initialization Class
package com.yiibai.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[] { "/" } } }
添加CORS支持REST%uA0API
” No ‘Access-Control-Allow-Origin’ 的头存在于所请求的资源。%uA0Origin ‘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.” are common in such case.
解决办法是跨域资源共享。基本上,在服务器端,我们可以返回更多的CORS系统的访问控制头在响应中,这将最终允许进一步域间的通信。
package com.yiibai.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() {} }
package com.yiibai.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 } }
到些整个示例教程讲解完成,包教不包会。有兴趣的朋友可以下载代码:http://pan.baidu.com/s/1dEjOnp3