SpringBoot 构建复杂的 REST ful 风格 API

本贴最后更新于 2719 天前,其中的信息可能已经时过境迁

首先,回顾并详细说明一下在快速入门中使用的 @Controller、@RestController、@RequestMapping 注解。如果您对 Spring MVC 不熟悉并且还没有尝试过快速入门案例,建议先看一下快速入门的内容。

@Controller:修饰 class,用来创建处理 http 请求的对象
@RestController:Spring4 之后加入的注解,原来在 @Controller 中返回 json 需要 @ResponseBody 来配合,如果直接用 @RestController 替代 @Controller 就不需要再配置 @ResponseBody,默认返回 json 格式。
@RequestMapping:配置 url 映射
下面我们尝试使用 Spring MVC 来实现一组对 User 对象操作的 RESTful API,配合注释详细说明在 Spring MVC 中如何映射 HTTP 请求、如何传参、如何编写单元测试。

RESTful API 具体设计如下:

User 实体定义:


	public class User { 
	 
	    private Long id; 
	    private String name; 
	    private Integer age; 
	 
	    // 省略setter和getter 
	     
	}

实现对 User 对象的操作接口


	@RestController 
	@RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下 
	public class UserController { 
	 
	    // 创建线程安全的Map 
	    static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); 
	 
	    @RequestMapping(value="/", method=RequestMethod.GET) 
	    public List<User> getUserList() { 
	        // 处理"/users/"的GET请求,用来获取用户列表 
	        // 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递 
	        List<User> r = new ArrayList<User>(users.values()); 
	        return r; 
	    } 
	 
	    @RequestMapping(value="/", method=RequestMethod.POST) 
	    public String postUser(@ModelAttribute User user) { 
	        // 处理"/users/"的POST请求,用来创建User 
	        // 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数 
	        users.put(user.getId(), user); 
	        return "success"; 
	    } 
	 
	    @RequestMapping(value="/{id}", method=RequestMethod.GET) 
	    public User getUser(@PathVariable Long id) { 
	        // 处理"/users/{id}"的GET请求,用来获取url中id值的User信息 
	        // url中的id可通过@PathVariable绑定到函数的参数中 
	        return users.get(id); 
	    } 
	 
	    @RequestMapping(value="/{id}", method=RequestMethod.PUT) 
	    public String putUser(@PathVariable Long id, @ModelAttribute User user) { 
	        // 处理"/users/{id}"的PUT请求,用来更新User信息 
	        User u = users.get(id); 
	        u.setName(user.getName()); 
	        u.setAge(user.getAge()); 
	        users.put(id, u); 
	        return "success"; 
	    } 
	 
	    @RequestMapping(value="/{id}", method=RequestMethod.DELETE) 
	    public String deleteUser(@PathVariable Long id) { 
	        // 处理"/users/{id}"的DELETE请求,用来删除User 
	        users.remove(id); 
	        return "success"; 
	    } 
	 
	}

下面针对该 Controller 编写测试用例验证正确性,具体如下。当然也可以通过浏览器插件等进行请求提交验证。


	@RunWith(SpringJUnit4ClassRunner.class) 
	@SpringApplicationConfiguration(classes = MockServletContext.class) 
	@WebAppConfiguration 
	public class ApplicationTests { 
	 
		private MockMvc mvc; 
	 
		@Before 
		public void setUp() throws Exception { 
			mvc = MockMvcBuilders.standaloneSetup(new UserController()).build(); 
		} 
	 
		@Test 
		public void testUserController() throws Exception { 
	        // 测试UserController 
			RequestBuilder request = null; 
	 
			// 1、get查一下user列表,应该为空 
			request = get("/users/"); 
			mvc.perform(request) 
					.andExpect(status().isOk()) 
					.andExpect(content().string(equalTo("[]"))); 
	 
			// 2、post提交一个user 
			request = post("/users/") 
					.param("id", "1") 
					.param("name", "测试大师") 
					.param("age", "20"); 
			mvc.perform(request) 
			        .andExpect(content().string(equalTo("success"))); 
	 
			// 3、get获取user列表,应该有刚才插入的数据 
			request = get("/users/"); 
			mvc.perform(request) 
					.andExpect(status().isOk()) 
					.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"测试大师\",\"age\":20}]"))); 
	 
			// 4、put修改id为1的user 
			request = put("/users/1") 
					.param("name", "测试终极大师") 
					.param("age", "30"); 
			mvc.perform(request) 
					.andExpect(content().string(equalTo("success"))); 
	 
			// 5、get一个id为1的user 
			request = get("/users/1"); 
			mvc.perform(request) 
					.andExpect(content().string(equalTo("{\"id\":1,\"name\":\"测试终极大师\",\"age\":30}"))); 
	 
			// 6、del删除id为1的user 
			request = delete("/users/1"); 
			mvc.perform(request) 
					.andExpect(content().string(equalTo("success"))); 
	 
			// 7、get查一下user列表,应该为空 
			request = get("/users/"); 
			mvc.perform(request) 
					.andExpect(status().isOk()) 
					.andExpect(content().string(equalTo("[]"))); 
	 
		} 
	 
	}

至此,我们通过引入 web 模块(没有做其他的任何配置),就可以轻松利用 Spring MVC 的功能,以非常简洁的代码完成了对 User 对象的 RESTful API 的创建以及单元测试的编写。其中同时介绍了 Spring MVC 中最为常用的几个核心注解:@Controller,@RestController,RequestMapping 以及一些参数绑定的注解:@PathVariable,@ModelAttribute,@RequestParam 等。

  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    944 引用 • 1459 回帖 • 17 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • 资讯

    资讯是用户因为及时地获得它并利用它而能够在相对短的时间内给自己带来价值的信息,资讯有时效性和地域性。

    55 引用 • 85 回帖
  • Solo

    Solo 是一款小而美的开源博客系统,专为程序员设计。Solo 有着非常活跃的社区,可将文章作为帖子推送到社区,来自社区的回帖将作为博客评论进行联动(具体细节请浏览 B3log 构思 - 分布式社区网络)。

    这是一种全新的网络社区体验,让热爱记录和分享的你不再感到孤单!

    1434 引用 • 10054 回帖 • 490 关注
  • Lute

    Lute 是一款结构化的 Markdown 引擎,支持 Go 和 JavaScript。

    25 引用 • 191 回帖 • 16 关注
  • 钉钉

    钉钉,专为中国企业打造的免费沟通协同多端平台, 阿里巴巴出品。

    15 引用 • 67 回帖 • 339 关注
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    75 引用 • 1737 回帖 • 5 关注
  • IBM

    IBM(国际商业机器公司)或万国商业机器公司,简称 IBM(International Business Machines Corporation),总公司在纽约州阿蒙克市。1911 年托马斯·沃森创立于美国,是全球最大的信息技术和业务解决方案公司,拥有全球雇员 30 多万人,业务遍及 160 多个国家和地区。

    17 引用 • 53 回帖 • 136 关注
  • 微服务

    微服务架构是一种架构模式,它提倡将单一应用划分成一组小的服务。服务之间互相协调,互相配合,为用户提供最终价值。每个服务运行在独立的进程中。服务于服务之间才用轻量级的通信机制互相沟通。每个服务都围绕着具体业务构建,能够被独立的部署。

    96 引用 • 155 回帖 • 1 关注
  • 招聘

    哪里都缺人,哪里都不缺人。

    190 引用 • 1057 回帖
  • iOS

    iOS 是由苹果公司开发的移动操作系统,最早于 2007 年 1 月 9 日的 Macworld 大会上公布这个系统,最初是设计给 iPhone 使用的,后来陆续套用到 iPod touch、iPad 以及 Apple TV 等产品上。iOS 与苹果的 Mac OS X 操作系统一样,属于类 Unix 的商业操作系统。

    85 引用 • 139 回帖 • 1 关注
  • 博客

    记录并分享人生的经历。

    273 引用 • 2388 回帖
  • 安装

    你若安好,便是晴天。

    132 引用 • 1184 回帖
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用 • 1 关注
  • Eclipse

    Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。

    75 引用 • 258 回帖 • 617 关注
  • 互联网

    互联网(Internet),又称网际网络,或音译因特网、英特网。互联网始于 1969 年美国的阿帕网,是网络与网络之间所串连成的庞大网络,这些网络以一组通用的协议相连,形成逻辑上的单一巨大国际网络。

    98 引用 • 344 回帖
  • 开源中国

    开源中国是目前中国最大的开源技术社区。传播开源的理念,推广开源项目,为 IT 开发者提供了一个发现、使用、并交流开源技术的平台。目前开源中国社区已收录超过两万款开源软件。

    7 引用 • 86 回帖
  • 创业

    你比 99% 的人都优秀么?

    84 引用 • 1399 回帖
  • SVN

    SVN 是 Subversion 的简称,是一个开放源代码的版本控制系统,相较于 RCS、CVS,它采用了分支管理系统,它的设计目标就是取代 CVS。

    29 引用 • 98 回帖 • 680 关注
  • Latke

    Latke 是一款以 JSON 为主的 Java Web 框架。

    71 引用 • 535 回帖 • 787 关注
  • 心情

    心是产生任何想法的源泉,心本体会陷入到对自己本体不能理解的状态中,因为心能产生任何想法,不能分出对错,不能分出自己。

    59 引用 • 369 回帖
  • 新人

    让我们欢迎这对新人。哦,不好意思说错了,让我们欢迎这位新人!
    新手上路,请谨慎驾驶!

    52 引用 • 228 回帖
  • IPFS

    IPFS(InterPlanetary File System,星际文件系统)是永久的、去中心化保存和共享文件的方法,这是一种内容可寻址、版本化、点对点超媒体的分布式协议。请浏览 IPFS 入门笔记了解更多细节。

    21 引用 • 245 回帖 • 241 关注
  • jQuery

    jQuery 是一套跨浏览器的 JavaScript 库,强化 HTML 与 JavaScript 之间的操作。由 John Resig 在 2006 年 1 月的 BarCamp NYC 上释出第一个版本。全球约有 28% 的网站使用 jQuery,是非常受欢迎的 JavaScript 库。

    63 引用 • 134 回帖 • 724 关注
  • wolai

    我来 wolai:不仅仅是未来的云端笔记!

    2 引用 • 14 回帖
  • TGIF

    Thank God It's Friday! 感谢老天,总算到星期五啦!

    287 引用 • 4484 回帖 • 669 关注
  • SEO

    发布对别人有帮助的原创内容是最好的 SEO 方式。

    35 引用 • 200 回帖 • 22 关注
  • 国际化

    i18n(其来源是英文单词 internationalization 的首末字符 i 和 n,18 为中间的字符数)是“国际化”的简称。对程序来说,国际化是指在不修改代码的情况下,能根据不同语言及地区显示相应的界面。

    8 引用 • 26 回帖
  • Dubbo

    Dubbo 是一个分布式服务框架,致力于提供高性能和透明化的 RPC 远程服务调用方案,是 [阿里巴巴] SOA 服务化治理方案的核心框架,每天为 2,000+ 个服务提供 3,000,000,000+ 次访问量支持,并被广泛应用于阿里巴巴集团的各成员站点。

    60 引用 • 82 回帖 • 595 关注