Spring Boot - 构建优雅的Restful API

SpringBoot是搭建微服务的利器,那么微服务于微服务之间如果交互调用?RPC是一种,但是Restful风格的Http请求也是其中一种。

什么是Restful

REST(英文:Representational State Transfer,简称REST)描述了一个架构样式的网络系统,比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中,他是 HTTP 规范的主要编写者之一。在目前主流的三种Web服务交互方案中,REST相比于SOAP(Simple Object Access protocol,简单对象访问协议)以及XML-RPC更加简单明了,无论是对URL的处理还是对Payload的编码,REST都倾向于用更加简单轻量的方法设计和实现。值得注意的是REST并没有一个明确的标准,而更像是一种设计的风格。-- 摘自百度百科

环境工具

  • JDK1.8
  • MySQL5.7
  • Postman
  • IDEA
  • Maven3

当前使用的Spring Boot的版本为1.5.8.RELEASE

创建项目

IDEA -> New -> Project -> Spring Initializr -> 填写Group和Artifact -> Next -> 选择Web,勾选Web;选择SQL,勾选MyBatis和MySQL -> Next -> Finish

创建相应包、类和文件

需要创建一些包、类和相应的文件

com.roachfu.tutorial
    controller
        DemoController.java
    entity
        Demo.java
    mapper
        DemoMapper.java
    service
        impl
            DemoServiceImpl.java
        DemoService.java
    SpringBootRestfulApplication.java

Restful 风格

我们知道Http是有很多种请求方式的:
GETHEADPOSTPUTPATCHDELETEOPTIONSTRACE

我们常用的有POSTDELETEPUTGET,分别对应我们的增删改查。

  • GET /users:获取用户列表
  • GET /users/{uid} 获取某个用户信息
  • POST /users 新增一个用户
  • PUT /users/{uid} 修改某个用户信息
  • DELETE /users/{uid} 删除某个用户

更多资料请看RESTful API 设计指南

application.properties配置

设置了上下文路径,MyBatis配置以及连接MySQL数据库

server.context-path=/tutorial

mybatis.type-aliases-package=com.roachfu.tutorial.entity
mybatis.configuration.map-underscore-to-camel-case=true

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.56.2:3306/spring_boot?useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=Fanshu_123456

DemoController

@RestController
@RequestMapping("/demos")
public class DemoController {

    @Resource
    private DemoService demoService;

    @PostMapping
    public int add(@RequestBody Demo demo){
        return demoService.save(demo);
    }

    @GetMapping
    public List<Demo> queryList(){
        return demoService.getList();
    }

    @GetMapping("/{id}")
    public Demo queryOne(@PathVariable("id")Integer id){
        return demoService.getOne(id);
    }

    @PutMapping("/{id}")
    public int update(@PathVariable("id")Integer id, @RequestBody Demo demo){
        demo.setId(id);
        demo.setUpdateTime(new Date());
        return demoService.update(demo);
    }

    @DeleteMapping("/{id}")
    public int delete(@PathVariable("id")Integer id){
        return demoService.delete(id);
    }
}
  • @GetMapping 等价于 @RequestMapping(method = RequestMethod.GET)
  • @GetMapping("/{id}") 等价于 @RequestMapping(value = "/{id}", method = RequestMethod.GET)
  • @PostMapping 等价于 @RequestMapping(method = RequestMethod.POST)

以此类推。

DemoServiceImpl

@Service
public class DemoServiceImpl implements DemoService {

    @Resource
    private DemoMapper demoMapper;

    @Override
    public List<Demo> getList() {
        return demoMapper.selectList();
    }

    @Override
    public Demo getOne(Integer id) {
        return demoMapper.selectOne(id);
    }

    @Override
    public int save(Demo demo) {
        return demoMapper.insert(demo);
    }

    @Override
    public int update(Demo demo) {
        return demoMapper.update(demo);
    }

    @Override
    public int delete(Integer id) {
        return demoMapper.delete(id);
    }
}

至于entity,mapper等在前面的教程中已经有展示过了,也可以查看项目源码

演示结果

由于直接在浏览器中输入URL,请求只支持GET请求,这样就无法看到其他请求方式的效果。
所以我们要借助Postman来进行测试。需要设置content-typeapplication/json

  • 运行SpringBootRestfulApplication.java中的main方法。
  • 打开Postman,并设置对应的方法,例如用POST请求新增一个Demo
新增一个Demo
  • 测试其他的方法并查看结果
GET http://localhost:8080/tutorial/demos
GET http://localhost:8080/tutorial/demos/1
PUT http://localhost:8080/tutorial/demos/1
DELETE http://localhost:8080/tutorial/demos/1

好吧,优雅的Restful API 我们就搞定了

项目源码

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • Spring的模型-视图-控制器(MVC)框架是围绕一个DispatcherServlet来设计的,这个Servl...
    alexpdh阅读 2,638评论 0 3
  • 1、Spring MVC请求流程 (1)初始化:(对DispatcherServlet和ContextLoderL...
    拾壹北阅读 1,945评论 0 12
  • 文/ZYRzyr原文链接:http://www.jianshu.com/p/e907595e9d1d 本文提纲一、...
    ZYRzyr阅读 1,784评论 0 49
  • 最近两天本来就感冒,然而还被蹬被子冻醒,每天被子在地上也是醉了,什么时候学的。 一开始没印象,是在老家,先去了小丽...
    沂尾鱼阅读 171评论 0 0