使用 Kotlin、Spring Boot 和 PostgreSQL 的地理空间信使

工程 | Sébastien Deleuze | 2016年3月20日 | ...

继我上一篇 Kotlin 博客文章 之后,今天我想介绍我为即将在 Spring I/O 2016 大会 上发表的演讲“使用 Kotlin 和 Spring Boot 开发地理空间 Web 服务”而开发的新 Spring Boot + Kotlin 应用程序。

处理原生数据库功能

此应用程序的目标之一是了解如何像在 NoSQL 世界中一样利用原生数据库功能。在这里,我们想使用 PostGIS 提供的地理空间支持,它是 PostgreSQL 的空间数据库扩展。原生 JSON 支持 也可以是一个很好的用例。

这个地理空间信使示例应用程序 可在 GitHub 上找到,有两种版本:

一个 Spring Data JPA + Hibernate Spatial 变种 会很有趣,所以请随时通过 pull request 贡献它 ;-) Kotlin Query DSL 支持也会很好,但目前不支持(如果您有兴趣,请在此 issue 上评论)。在这篇博文中,我将重点介绍 Exposed 变种。

地理空间信使代码导览

领域模型

这两个 Kotlin 类 轻松描述了我们的领域模型:

class Message(
    var content  : String,
    var author   : String,
    var location : Point? = null,
    var id       : Int?   = null
)

class User(
    var userName  : String,
    var firstName : String,
    var lastName  : String,
    var location  : Point? = null
)

SQL Schema

Exposed 允许我们使用一种类型安全且非常方便使用的 SQL API 来描述表的结构(自动补全、重构和防错)。

object Messages : Table() {
    val id       = integer("id").autoIncrement().primaryKey()
    val content  = text("content")
    val author   = reference("author", Users.userName)
    val location = point("location").nullable()
}

object Users : Table() {
    val userName  = text("user_name").primaryKey()
    val firstName = text("first_name")
    val lastName  = text("last_name")
    val location  = point("location").nullable()
}

值得注意的是,Exposed 并不原生支持 PostGIS 功能,如 geometry 类型或地理空间查询。这时 Kotlin 扩展 就派上用场了,只需几行代码即可添加此类支持,而无需使用扩展类。

fun Table.point(name: String, srid: Int = 4326): Column<Point>
  = registerColumn(name, PointColumnType())

infix fun ExpressionWithColumnType<*>.within(box: PGbox2d) : Op<Boolean>
  = WithinOp(this, box)

仓库

更新:我们现在可以使用 Exposed 的 @Transactional 支持 了!事务管理通过 @EnableTransactionManagement 注解和 Application 类中的 PlatformTransactionManager bean 进行配置。

我们的仓库也非常简洁且灵活,因为它们允许您使用类型安全 SQL API 编写任何类型的 SQL 查询,即使是复杂的 WHERE 子句。

请注意,由于我们使用的是 Spring Framework 4.3,因此在这样的单构造函数类中,我们不再需要指定 @Autowired 注解

interface CrudRepository<T, K> {
    fun createTable()
    fun create(m: T): T
    fun findAll(): Iterable<T>
    fun deleteAll(): Int
    fun findByBoundingBox(box: PGbox2d): Iterable<T>
    fun updateLocation(userName:K, location: Point)
}

interface UserRepository: CrudRepository<User, String>

@Repository
@Transactional // Should be at @Service level in real applications
class DefaultUserRepository(val db: Database) : UserRepository {

    override fun createTable() = SchemaUtils.create(Users)

    override fun create(user: User): User {
        Users.insert(toRow(user))
        return user
    }

    override fun updateLocation(userName:String, location: Point) = {
        location.srid = 4326
        Users.update({Users.userName eq userName})
            { it[Users.location] = location }
    }

    override fun findAll() = Users.selectAll().map { fromRow(it) }

    override fun findByBoundingBox(box: PGbox2d) =
            Users.select { Users.location within box }
                 .map { fromRow(it) }

    override fun deleteAll() = Users.deleteAll()

    private fun toRow(u: User): Users.(UpdateBuilder<*>) -> Unit = {
        it[userName] = u.userName
        it[firstName] = u.firstName
        it[lastName] = u.lastName
        it[location] = u.location
    }

    private fun fromRow(r: ResultRow) =
        User(r[Users.userName],
             r[Users.firstName],
             r[Users.lastName],
             r[Users.location])
}

控制器

控制器也非常简洁,并使用了 Spring Framework 4.3 即将推出的 @GetMapping / @PostMapping 注解,它们只是 @RequestMapping 注解的方法特定快捷方式。

@RestController
@RequestMapping("/user")
class UserController(val repo: UserRepository) {

    @PostMapping
    @ResponseStatus(CREATED)
    fun create(@RequestBody u: User) { repo.create(u) }

    @GetMapping
    fun list() = repo.findAll()

    @GetMapping("/bbox/{xMin},{yMin},{xMax},{yMax}")
    fun findByBoundingBox(@PathVariable xMin:Double,
                          @PathVariable yMin:Double,
                          @PathVariable xMax:Double,
                          @PathVariable yMax:Double)
            = repo.findByBoundingBox(
                        PGbox2d(Point(xMin, yMin), Point(xMax, yMax)))

    @PutMapping("/{userName}/location/{x},{y}")
    @ResponseStatus(NO_CONTENT)
    fun updateLocation(@PathVariable userName:String,
                       @PathVariable x: Double,
                       @PathVariable y: Double)
            = repo.updateLocation(userName, Point(x, y))
}

客户端是一个纯 HTML + Javascript 应用程序,使用 OpenLayers 地图库开发(更多细节请参阅 index.htmlmap.js),它会定位您,并通过 Server-Sent Events 将地理定位消息发送/接收给/从其他用户。

Screenshot

最后但同样重要的是,REST API 得益于出色的 Spring REST docs 项目,得到了充分的测试和文档记录。更多细节请参阅 MessageControllerTestsindex.adoc

结论

开发此应用程序时,我的主要感受是它很有趣、高效,并且 SQL API 和 Kotlin 的类型系统以及空安全提供了高度的灵活性和安全性。生成的 Spring Boot 应用程序是一个 18 MB 的独立可执行 jar 包,内存占用低(该应用程序可以在 -Xmx32m 的情况下运行!!!)。使用 Spring REST docs 也非常愉快,再次证明了 Kotlin 良好的 Java 互操作性。

我遇到的一些小问题(数组注解属性Java 8 Stream 支持完整的函数引用支持),计划在 Kotlin 1.1 中修复。Exposed 库尚处于早期阶段,需要进一步成熟,但在我看来,它很有前景,并展示了 Kotlin 如何用于构建类型安全的 DSL API(这个 HTML 类型安全构建器也是一个很好的例子)。

请记住,官方支持的 Spring Data 项目 与 Kotlin 配合良好,正如我在上一篇博文中的 spring-boot-kotlin-demo 项目中所展示的那样。

如果您将在五月中旬来到巴塞罗那(无论如何,去巴塞罗那总是个好主意!),不要错过参加 Spring I/O 大会的机会。此外,SpringOne Platform(八月初,拉斯维加斯)的注册也已开放,如果您想享受早鸟票价,请抓紧。后者也仍然接受演讲提案。所以,如果您有兴趣就 Spring 或 Pivotal 相关技术进行演讲,请随时提交!

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,助您加速进步。

了解更多

获得支持

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件,只需一份简单的订阅。

了解更多

即将举行的活动

查看 Spring 社区所有即将举行的活动。

查看所有