Spring Boot与Kotlin使用Spring Data Rest创建HAL风格Restful接口

REST web服务已成为在web上应用程序集成的首选方式。在其核心中,REST定义了系统由客户端交互的资源组成。这些资源以超媒体驱动的方式实现。Spring MVC为构建这些服务提供了坚实的基础。但是,对于多域对象系统,即使实施REST web服务的最简单原则也可能相当乏味,并且导致大量样板代码。

Spring Data REST构建在Spring Data repositories之上,并自动将其导出为REST资源。它利用超媒体来允许客户端查找存储库暴露的功能,并将这些资源自动集成到相关的超媒体功能中。

  • 根据model,生成HAL风格的restful API
  • 根据model,维护实体之间的关系
  • 支持分页
  • 允许动态地过滤集合资源
  • 允许通过处理Spring ApplicationEvents处理REST请求。
  • 目前支持JPA,MongoDB,Neo4j,Solr,Cassandra,Gemfire。
  • 支持自定义

将Spring Data REST添加到Spring Boot项目

dependencies {
    ...
    compile "org.springframework.boot:spring-boot-starter-data-rest:$spring_boot_version"
    ...
}

完整的 build.gradle文件

group 'name.quanke.kotlin'
version '1.0-SNAPSHOT'

buildscript {
    ext.kotlin_version = '1.2.10'
    ext.spring_boot_version = '1.5.4.RELEASE'
    ext.springfox_swagger2_version = '2.7.0'
    ext.mysql_version = '5.1.21'
    ext.mybatis_version = '1.1.1'
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath("org.springframework.boot:spring-boot-gradle-plugin:$spring_boot_version")

//        Kotlin整合SpringBoot的默认无参构造函数,默认把所有的类设置open类插件
        classpath("org.jetbrains.kotlin:kotlin-noarg:$kotlin_version")
        classpath("org.jetbrains.kotlin:kotlin-allopen:$kotlin_version")
    }
}

apply plugin: 'kotlin'
apply plugin: "kotlin-spring" // See https://kotlinlang.org/docs/reference/compiler-plugins.html#kotlin-spring-compiler-plugin
apply plugin: 'org.springframework.boot'
apply plugin: "kotlin-jpa"  //https://stackoverflow.com/questions/32038177/kotlin-with-jpa-default-constructor-hell
jar {
    baseName = 'chapter11-6-7-service'
    version = '0.1.0'
}
repositories {
    mavenCentral()
}


dependencies {
    compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version"
    compile("org.jetbrains.kotlin:kotlin-reflect:${kotlin_version}")

    compile "org.springframework.boot:spring-boot-starter-data-jpa:$spring_boot_version"
    compile "org.springframework.boot:spring-boot-starter-data-rest:$spring_boot_version"
    compile "mysql:mysql-connector-java:$mysql_version"


    testCompile "org.springframework.boot:spring-boot-starter-test:$spring_boot_version"
    testCompile "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"

}

compileKotlin {
    kotlinOptions.jvmTarget = "1.8"
}
compileTestKotlin {
    kotlinOptions.jvmTarget = "1.8"
}

创建对象User

import javax.persistence.*

/**
 * Created by http://quanke.name on 2018/1/10.
 */

@Entity
data class User(
        @Id
        @GeneratedValue(strategy = GenerationType.AUTO)
        var id: Long = -1,
        @Column(nullable = false)
        var username: String = "",

        var password: String = ""


)

创建UserRepository

  • 增加 @RepositoryRestResource注解 关于 @RepositoryRestResource详细的使用介绍,请参考: https://springcloud.cc/spring-data-rest-zhcn.html
import name.quanke.kotlin.chaper11_6_7.entity.User
import org.springframework.data.jpa.repository.JpaRepository
import org.springframework.data.jpa.repository.Query
import org.springframework.data.repository.query.Param
import org.springframework.data.rest.core.annotation.RepositoryRestResource

@RepositoryRestResource(path="user")
interface UserRepository : JpaRepository<User, Long> {

    fun findByUsername(username: String): List<User>

    fun findByUsernameAndPassword(username: String, password: String?): User

    @Query("from User u where u.username=:username")
    fun findUser(@Param("username") username: String): User

}

配置

application.yml文件中增加

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

启动

import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication


/**
 * Created by http://quanke.name on 2018/1/9.
 */

//参考:http://blog.csdn.net/soul_code/article/details/54108105

@SpringBootApplication
class Application

fun main(args: Array<String>) {
    SpringApplication.run(Application::class.java, *args)
}

测试

访问 127.0.0.1:8080/user

返回:

{
    "_embedded": {
        "users": [
            {
                "username": "http://gof.quanke.name",
                "password": "1111",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/73"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/73"
                    }
                }
            },
            {
                "username": "java.quanke.name",
                "password": "12",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/74"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/74"
                    }
                }
            },
            {
                "username": "test.quanke.name",
                "password": "aa",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/75"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/75"
                    }
                }
            },
            {
                "username": "es.quanke.name",
                "password": "12",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/76"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/76"
                    }
                }
            },
            {
                "username": "as.quanke.name",
                "password": "12",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/77"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/77"
                    }
                }
            },
            {
                "username": "vertx.quanke.name",
                "password": "12",
                "_links": {
                    "self": {
                        "href": "http://127.0.0.1:8083/user/78"
                    },
                    "user": {
                        "href": "http://127.0.0.1:8083/user/78"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "http://127.0.0.1:8083/user{?page,size,sort}",
            "templated": true
        },
        "profile": {
            "href": "http://127.0.0.1:8083/profile/user"
        },
        "search": {
            "href": "http://127.0.0.1:8083/user/search"
        }
    },
    "page": {
        "size": 20,
        "totalElements": 6,
        "totalPages": 1,
        "number": 0
    }
}

访问 127.0.0.1:8083/user/73

注意: 73 是user id 根据自己的实际情况测试

返回:

{
    "username": "http://gof.quanke.name",
    "password": "1111",
    "_links": {
        "self": {
            "href": "http://127.0.0.1:8083/user/73"
        },
        "user": {
            "href": "http://127.0.0.1:8083/user/73"
        }
    }
}

Spring Data REST 能做的事情很多,这篇文章先介绍到这里,先在这里埋个坑,之后会出更加详细的文章说Spring Data REST。

更多Spring Boot 和 kotlin相关内容

欢迎关注《Spring Boot 与 kotlin 实战》

参考

  • https://springcloud.cc/spring-data-rest-zhcn.html
  • https://www.jianshu.com/p/84f2bbffb885
  • https://www.cnblogs.com/aguncn/p/6762392.html
  • http://blog.csdn.net/soul_code/article/details/54108105
  • https://github.com/spring-projects/spring-data-examples/tree/master/rest

原文发布于微信公众号 - 全栈架构(keatingr)

原文发表时间:2018-01-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏java思维导图

Spring MVC 到 Spring BOOT的简化之路

从Servlet技术到Spring和Spring MVC,开发Web应用变得越来越简捷。但是Spring和Spring MVC的众多配置有时却让人望而却步,相信...

20420
来自专栏Ken的杂谈

Spring Cloud 入门教程1、服务注册与发现(Eureka)

Eureka是Netflix开源的服务注册与发现框架,Eureka由两个组件组成:Eureka服务器和Eureka客户端。

13520
来自专栏JAVA技术站

SpringCloud之熔断监控

四、加入监控地址/hystrix.stream配入,点Monitor Stream

14020
来自专栏nnngu

Spring MVC的配置和使用

笔记仓库:https://github.com/nnngu/LearningNotes

21990
来自专栏JAVA高级架构

Spring MVC工作原理

14020
来自专栏大数据-Hadoop、Spark

Flume + Kafka整合

Flume的安装与综合使用 https://www.jianshu.com/p/90e17b80f366 实时日志采集框架图 ? Flume + Ka...

37270
来自专栏Ken的杂谈

Spring Boot入门教程1、使用Spring Boot构建第一个Web应用程序

项目模板:maven-archetype-webapp GroupId:io.ken.springboot-course ArtifactId:springbo...

10910
来自专栏微信公众号:Java团长

Spring Boot入门

Spring Boot是Spring社区较新的一个项目。该项目的目的是帮助开发者更容易的创建基于Spring的应用程序和服务,让更多人的人更快的对Spring进...

12110
来自专栏Hongten

Maven的第一个小程序

关于maven的安装 : Install Maven in your computer

19820
来自专栏about云

让你快速认识flume及安装和使用flume1.5传输数据(日志)到hadoop2.2

问题导读: 1.什么是flume? 2.如何安装flume? 3.flume的配置文件与其它软件有什么不同? 一、认识flume 1.flume是什么? ...

397130

扫码关注云+社区

领取腾讯云代金券