Spring Boot + Kotlin,快速构建RESTful API

对相同的url进行GETPOSTPUTDELETE操作,并根据操作的不同返回JSON类型的对象或提示信息

文章结构如下:

  1. 创建Spring Boot项目
  2. 返回值(一个普通的Bean类,和一个提示信息类。
  3. 路由处理
  4. 全局异常处理
  5. 附录(git

环境:Win10+IDEA 2018.1

一、创建项目

选择Spring Initializr
配置名称、语言、项目类型等
依赖,只选一个Web即可
项目目录
选中auto-import,自动导包

二、返回值处理

正常的Bean类

data class Person(val name: String, val age: Int, val isMale: Boolean)

提示信息类

data class Result(val code: Int, val message: String) {
    constructor(status: ResultStatus) : this(status.code, status.message)
}

提示信息枚举,这里暂时只写了三种提示

enum class ResultStatus(val code: Int, val message: String) {
    DELETE_SUCCESS(204, "删除成功"),
    NOT_FOUND(404, "找不到对应的资源"),
    UNKNOWN_ERROR(500, "未知错误"),
}

三、路由处理

注解解释:

  1. @RestController,相当于@ResponseBody+@Controller
  2. @RequestMapping(),路由匹配,写在类上则表示整个类都以该路由为基础。
  3. @GetMapping等四个以请求方法开头的注解,相当于指定了请求方式的@RequestMapping
  4. @PathVariable,路径参数,匹配路径中{}包含的字段
  5. @RequestBody,将所有请求参数作为JSON解析,映射到匹配的实例中。前端可以直接提交一个JSON对象作为请求数据,请求的Content-Type需为application/json

参数解释:

  1. response: HttpServletResponse,响应对象,不需要可以不写。同理还有请求对象request:HttpServletRequest。(对象命名没有规定
@RestController
@RequestMapping("/persons")
class PersonController {

    //可以直接返回
    @GetMapping  //查找所有,GET访问 `http://localhost:8080/persons`
    fun getAll(): Any = persons

    //直接返回可省略返回类型,因为可以自动推断返回值;另外注意路径变量的写法
    @GetMapping("/{index}") 
    fun get(@PathVariable index: Int) = persons[index]

    //前端提交JSON对象,可以使用RequestBody解析。提交成功后,将响应码的状态码设置为201
    @PostMapping
    fun save(@RequestBody person: Person, response: HttpServletResponse): Any {
        persons.add(person)
        response.status = 201
        return person
    }

    //put修改。修改成功后,将响应码的状态码设置为201
    @PutMapping("/{index}")
    fun modify(@RequestBody person: Person, @PathVariable index: Int, response: HttpServletResponse): Any {
        //判断,返回错误码
        if (index >= persons.count()) {
            response.status = 404
            return Result(ResultStatus.NOT_FOUND)
        }
        persons[index] = person
        response.status = 201
        return persons[index]
    }

    //delete删除。删除成功后,将响应码的状态设置为204
    @DeleteMapping("/{index}")
    fun delete(@PathVariable index: Int, response: HttpServletResponse): Any {
        persons.removeAt(index)
        response.status = 204
        return Result(ResultStatus.DELETE_SUCCESS)
    }

    companion object {
        //数据源
        private val persons = MutableList(4, { index -> Person("Person$index", 20 + index, index % 2 == 0) })
    }
}

四、全局异常处理

捕获全局的异常进行处理。可以将其写入日志,或是对异常做类型判断,返回更详细的信息。

@ControllerAdvice
class ExceptionHandler {

    @ExceptionHandler(value = [Exception::class])
    @ResponseBody
    fun error(e: Exception, response: HttpServletResponse): Any {
        response.status = 500
        return Result(ResultStatus.UNKNOWN_ERROR)
    }
}

五、附录

访问路径及方法(基础域名:http://localhost:8080):

  1. 查找所有,GET访问 /persons
  2. 查找指定索引为2的(数字大可触发全局异常处理逻辑),GET访问 /persons/2
  3. 增加一个,POST访问 /persons
  4. 修改指定索引为2的实例,PUT访问 /persons/2
  5. 修改指定索引为2的实例,DELETE访问 /persons/2

需要项目代码请访问Git仓库地址

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

推荐阅读更多精彩内容