AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

使用Spring MVC 4构建Restful服务

2017-11-14 1167
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

    使用Spring MVC 4构建RESTful服务相对于其它框架来说，有很多优势。首先，Spring MVC 4作为Spring的框架之一，可以很好地与Spring进行集成。其次，Spring MVC 4的拦截器是在方法层级上的拦截，相对于其它MVC框架（如Struts2）的拦截器具有更高的效率。再者，Spring MVC 4采用基于注解的配置，入手容易，开发灵活。


    Spring MVC 4采用的是jacson解析JSON。jacson一款非常高效强大的JSON工具类，可以轻松地在JAVA对象与json对象和XML文档之间进行序列化和反序列化。本文中的例子采用的是Spring 4.1.1.RELEASE和jacson 2.4.0版本，经测试无任何异常。接下来，上干货：


    开发环境准备：

        Eclipse Luna

        Apache Tomcat 8.0

        JDK 1.7

        Spring 4.1.1.RELEASE

        jackson 2.4.0


    工程目录如下：

wKioL1RmtujyFDVPAAGhvKmuW54452.jpg



    1. 新建Maven Project，选择在“Archetype类型”中，选择“maven-archetype-webapp”。


    2. 在Pom.xml中添加 Maven 依赖，从而可以使用 Spring和jackson中的特性。如果读者使用的是Dynamic Web Project，可以从Maven仓库下载对的Spring Jar和 jacson jar。


    Spring的Maven仓库地址：http://repo1.maven.org/maven2/org/springframework/

    jackson的Maven仓库地址：http://repo1.maven.org/maven2/com/fasterxml/jackson/core/



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
< 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.favccxx.favsoft</ groupId >
   < artifactId >favspringmvcrestful</ artifactId >
   < packaging >war</ packaging >
   < version >0.0.1-SNAPSHOT</ version >
   < name >favspringmvcrestful Maven Webapp</ name >
   < url >http://maven.apache.org</ url >
   
   < properties >
       < spring.version >4.1.1.RELEASE</ spring.version >
       < jackson.version >2.4.0</ jackson.version >
   </ properties >
   
   < dependencies >
     < dependency >
       < groupId >junit</ groupId >
       < artifactId >junit</ artifactId >
       < version >3.8.1</ version >
       < scope >test</ scope >
     </ dependency >
     
     < dependency >
         < groupId >org.springframework</ groupId >
         < artifactId >spring-core</ artifactId >
         < version >${spring.version}</ version >
     </ dependency >
     < dependency >
         < groupId >org.springframework</ groupId >
         < artifactId >spring-webmvc</ artifactId >
         < version >${spring.version}</ version >
     </ dependency >
     < dependency >
         < groupId >org.springframework</ groupId >
         < artifactId >spring-beans</ artifactId >
         < version >${spring.version}</ version >
     </ dependency >
     < dependency >
         < groupId >org.springframework</ groupId >
         < artifactId >spring-context</ artifactId >
         < version >${spring.version}</ version >
     </ dependency >
     
     
     < dependency >
       < groupId >com.fasterxml.jackson.core</ groupId >
       < artifactId >jackson-core</ artifactId >
       < version >${jackson.version}</ version >
     </ dependency >
     < dependency >
       < groupId >com.fasterxml.jackson.core</ groupId >
       < artifactId >jackson-annotations</ artifactId >
       < version >${jackson.version}</ version >
     </ dependency >
     < dependency >
       < groupId >com.fasterxml.jackson.core</ groupId >
       < artifactId >jackson-databind</ artifactId >
       < version >${jackson.version}</ version >
     </ dependency >
     
     < dependency >
         < groupId >jstl</ groupId >
         < artifactId >jstl</ artifactId >
         < version >1.2</ version >
     </ dependency >
     < dependency >
         < groupId >taglibs</ groupId >
         < artifactId >standard</ artifactId >
         < version >1.1.2</ version >
     </ dependency >
     
   </ dependencies >
   < build >
     < finalName >favspringmvcrestful</ finalName >
   </ build >
</ project >


    3.在 web.xml中，配置Spring MVC 4 的DispatcherServlet转发和编码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<? xml  version = "1.0"  encoding = "UTF-8" ?>
< web-app  version = "2.4"  xmlns = "http://java.sun.com/xml/ns/j2ee"
     xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
     http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
     < display-name >favblog</ display-name >
 
     < context-param >
         < param-name >contextConfigLocation</ param-name >
         < param-value ></ 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 >
 
     < listener >
         < listener-class >org.springframework.web.context.ContextLoaderListener</ listener-class >
     </ listener >
 
     < servlet >
         < servlet-name >springMVC</ servlet-name >
         < servlet-class >org.springframework.web.servlet.DispatcherServlet</ servlet-class >
         < init-param >
             < param-name >contextConfigLocation</ param-name >
             < param-value >classpath*:spring-context.xml</ param-value >
         </ init-param >
         < load-on-startup >1</ load-on-startup >
     </ servlet >
     < servlet-mapping >
         < servlet-name >springMVC</ servlet-name >
         < url-pattern >/</ url-pattern >
     </ servlet-mapping >
</ web-app >
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<? xml  version = "1.0"  encoding = "UTF-8" ?>
< beans  xmlns = "http://www.springframework.org/schema/beans"
     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.xsd
         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd
         http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd">
         
     < context:component-scan  base-package = "com.favccxx.favsoft.favjson.controller" ></ context:component-scan >
     
     < mvc:annotation-driven ></ mvc:annotation-driven >
     
     < bean  id = "viewResolver"  class = "org.springframework.web.servlet.view.UrlBasedViewResolver" >
         < property  name = "viewClass"
             value = "org.springframework.web.servlet.view.JstlView"  />
         < property  name = "prefix"  value = "/WEB-INF/views"  />
         < property  name = "suffix"  value = ".jsp"  />
     </ bean >
</ beans >


    4.新建 FavUser.java 类，测试JSON与Object之间的映射。需要注意的是，如果想对日期进行格式化，在其Getter方法上，使用 @JsonFormat 即可，这样就能输出符合pattern类型的日期，但是这同时也要求输入的日期参数也必须是pattern类型的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package  com.favccxx.favsoft.favjson.pojo;
 
import  java.util.Date;
 
import  com.fasterxml.jackson.annotation.JsonFormat;
 
public  class  FavUser {
     
     private  String userId;
     private  String userName;
     private  int  userAge;
     private  Date createDate;
     
     public  String getUserId() {
         return  userId;
     }
     public  void  setUserId(String userId) {
         this .userId = userId;
     }
     public  String getUserName() {
         return  userName;
     }
     public  void  setUserName(String userName) {
         this .userName = userName;
     }
     public  int  getUserAge() {
         return  userAge;
     }
     public  void  setUserAge( int  userAge) {
         this .userAge = userAge;
     }
     @JsonFormat (pattern= "yyyy-MM-dd HH:mm:ss" )
     public  Date getCreateDate() {
         return  createDate;
     }
     public  void  setCreateDate(Date createDate) {
         this .createDate = createDate;
     }
     
     
 
}

   

    5. 新建FavRestfulController，通过不同的方法测试Spring MVC 4 返回String、Object类型的JSON。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package  com.favccxx.favsoft.favjson.controller;
 
import  java.io.IOException;
 
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.RequestParam;
import  org.springframework.web.bind.annotation.RestController;
 
import  com.fasterxml.jackson.core.JsonParseException;
import  com.fasterxml.jackson.databind.JsonMappingException;
import  com.fasterxml.jackson.databind.ObjectMapper;
import  com.favccxx.favsoft.favjson.pojo.FavUser;
 
@RestController
public  class  FavRestfulController {
     
     @RequestMapping (value= "/getUserName" ,method=RequestMethod.POST)
     public  String getUserName( @RequestParam (value= "name" ) String name){
         return  name;
     }
     
     @RequestMapping ( "getFavUser" )
     public  FavUser getFavUser( @RequestParam ( "userName" ) String userName,String userId, int  userAge){
         FavUser favUser =  new  FavUser();
         favUser.setUserId(userId);
         favUser.setUserName(userName);
         favUser.setUserAge(userAge);
         return  favUser;
     }
     
     @RequestMapping ( "getFavUserBody" )
     public  FavUser getFavUserBody( @RequestBody  String body){
         ObjectMapper mapper =  new  ObjectMapper();
         FavUser favUser =  null ;
         try  {
             favUser = mapper.readValue(body,  FavUser. class );
         }  catch  (JsonParseException e) {
             e.printStackTrace();
         }  catch  (JsonMappingException e) {
             e.printStackTrace();
         }  catch  (IOException e) {
             e.printStackTrace();
         }
         return  favUser;
     }
 
}


 6.运行结果如下：

wKioL1RmuWjhdcagAAEnFQ-0h9k100.jpg

wKiom1RmuPeR_IPQAAHCrDPrp7Y273.jpg





本文转自 genuinecx 51CTO博客，原文链接：http://blog.51cto.com/favccxx/1576730，如需转载请自行联系原作者
文章标签：
Java
Spring
前端开发
Web App开发
数据格式
关键词：
Spring构建
Restful服务
Restful spring
Spring restful
Spring构建restful
余二五
目录
相关文章
龙大吉
|
3月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目，定义`Book`实体类、`BookRepository`接口和`BookService`服务类，最后实现`BookController`控制器来处理HTTP请求，展示了从基础环境搭建到API测试的完整过程。
龙大吉
65 4
1603458909890196
|
5月前
|
缓存 弹性计算 API
用 Go 快速开发一个 RESTful API 服务
用 Go 快速开发一个 RESTful API 服务
1603458909890196
51 0
路边两盏灯
|
5月前
|
缓存 NoSQL Java
【Azure Redis 缓存】示例使用 redisson-spring-boot-starter 连接/使用 Azure Redis 服务
【Azure Redis 缓存】示例使用 redisson-spring-boot-starter 连接/使用 Azure Redis 服务
路边两盏灯
83 0
时光在流逝
|
2月前
|
JSON 关系型数据库 测试技术
使用Python和Flask构建RESTful API服务
使用Python和Flask构建RESTful API服务
时光在流逝
103 2
游客762btuqu5wybw666
|
4月前
|
Go API 开发者
深入探讨：使用Go语言构建高性能RESTful API服务
在本文中，我们将探索Go语言在构建高效、可靠的RESTful API服务中的独特优势。通过实际案例分析，我们将展示Go如何通过其并发模型、简洁的语法和内置的http包，成为现代后端服务开发的有力工具。
游客762btuqu5wybw666
112 14
土木林森
|
4月前
|
Java API 对象存储
微服务魔法启动！Spring Cloud与Netflix OSS联手，零基础也能创造服务奇迹！
这段内容介绍了如何使用Spring Cloud和Netflix OSS构建微服务架构。首先，基于Spring Boot创建项目并添加Spring Cloud依赖项。接着配置Eureka服务器实现服务发现，然后创建REST控制器作为API入口。为提高服务稳定性，利用Hystrix实现断路器模式。最后，在启动类中启用Eureka客户端功能。此外，还可集成其他Netflix OSS组件以增强系统功能。通过这些步骤，开发者可以更高效地构建稳定且可扩展的微服务系统。
土木林森
76 1
土木林森
|
4月前
|
前端开发 安全 Java
技术进阶：使用Spring MVC构建适应未来的响应式Web应用
【9月更文挑战第2天】随着移动设备的普及，响应式设计至关重要。Spring MVC作为强大的Java Web框架，助力开发者创建适应多屏的应用。本文推荐使用Thymeleaf整合视图，通过简洁的HTML代码提高前端灵活性；采用`@ResponseBody`与`Callable`实现异步处理，优化应用响应速度；运用`@ControllerAdvice`统一异常管理，保持代码整洁；借助Jackson简化JSON处理；利用Spring Security增强安全性；并强调测试的重要性。遵循这些实践，将大幅提升开发效率和应用质量。
土木林森
77 7
请看我回答~
|
5月前
|
JavaScript 安全 API
构建高效后端服务：RESTful API 设计与实现
【8月更文挑战第31天】在数字化时代，一个清晰、高效且安全的后端服务是应用程序成功的关键。本文将深入探讨如何设计并实现一个遵循REST原则的API，确保服务的可扩展性和维护性。我们将从基础概念出发，逐步引入真实代码示例，展示如何利用现代技术栈创建高性能的后端服务。无论你是初学者还是有经验的开发者，这篇文章都将为你提供新的视角和实用的技巧。
请看我回答~
78 2
土木林森
|
5月前
|
API Java Python
API的神秘面纱：从零开始构建你的RESTful服务
【8月更文挑战第31天】在现代网络应用开发中，RESTful API已成为数据交互的标准。本文通过比较流行的技术栈（如Node.js、Python的Django和Flask、Java的Spring Boot）及其框架，帮助你理解构建RESTful API的关键差异，涵盖性能、可扩展性、开发效率、社区支持、安全性和维护性等方面，并提供示例代码和最佳实践，指导你选择最适合项目需求的工具，构建高效、安全且易维护的API服务。
土木林森
66 0
土木林森
|
5月前
|
Java 缓存 数据库连接
揭秘！Struts 2性能翻倍的秘诀：不可思议的优化技巧大公开
【8月更文挑战第31天】《Struts 2性能优化技巧》介绍了提升Struts 2 Web应用响应速度的关键策略，包括减少配置开销、优化Action处理、合理使用拦截器、精简标签库使用、改进数据访问方式、利用缓存机制以及浏览器与网络层面的优化。通过实施这些技巧，如懒加载配置、异步请求处理、高效数据库连接管理和启用GZIP压缩等，可显著提高应用性能，为用户提供更快的体验。性能优化需根据实际场景持续调整。
土木林森
95 0

热门文章

最新文章

  • 1
    SpringMVC标签用法
  • 2
    02springmvc架构原理分析
  • 3
    SpringMVC多视图技术
  • 4
    Spring MVC 参数的绑定方法
  • 5
    JavaEE SpringMVC
  • 6
    深入理解 Spring MVC Controller —— 请求映射
  • 7
    springMVC初探--环境搭建和第一个HelloWorld简单项目
  • 8
    springMvc22-eclipse创建Maven项目没有src/main/java并不能新建的问题
  • 9
    SpringMVC控制器接收不了PUT提交的参数的解决方案
  • 10
    springmvc中@PathVariable和@RequestParam的区别
  • 1
    Spring高手之路18——从XML配置角度理解Spring AOP
    110
  • 2
    Spring Boot中一般如何使用线程池？
    806
  • 3
    Spring Boot 源码面试知识点
    106
  • 4
    【MongoDB 专栏】MongoDB 与 Spring Boot 的集成实践
    269
  • 5
    深入探索Spring Boot Web应用源码及实战应用
    119
  • 6
    ruoyi-nbcio从spring2.7.18升级springboot到3.1.7，java从java8升级到17（二）
    382
  • 7
    springboot全局自定义异常
    48
  • 8
    RabbitMQ的springboot项目集成使用-01
    153
  • 9
    什么是Spring Boot 自动配置？
    64
  • 10
    Spring cloud原理详解
    84

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第二阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • Spring Cloud 微服务核心组件集 mica 的设计思路
  • workshop专场-微服务专场-开发者动手实践营-微服务-Spring Cloud Alibaba 微服务全家桶体验
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧

    • 相关实验场景

    更多
  • 快速上手使用Dubbo进行远程调用
  • Spring-cloud-stream-binder-rocketmq入门与实践
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    DataWorks智能交互式数据开发与分析之旅