使用kotlin开发最新版的spring boot应用 | SpringBoot实践

kotlin是由IntelliJ IDEA的开发商Jetbrain推出的一种基于JVM的开发语言,目标是简化Java中很多繁琐的设计,可以和Java无缝的集成,之前一直在单元测试的时候试着使用,最近正好由契机,试着用来写一下Spring Boot脚手架。

官方定义: Statically typed programming language for the JVM, Android and the browser

项目介绍

长期目标是使用kotlin开发一个完整的spring boot应用,目前搭建了最小量的脚手架。

在本次实践中增加了gradle docker插件的使用,使用gradle一站式的完成从开发、测试、打包到发布docker镜像的整个过程。

项目结构

structure
SpringBootKotlon
│
├─── build.gradle
└─── src
     ├───main
     │   ├─── docker
     │   ├─── java
     │   ├─── kotlin
     │   └─── resources
     │        └─── config/application.properties
     └───test
          ├─── java
          ├─── kotlin
          └─── resources

在main目录的java、kotlin、resources下面,包名是一样的。也就是说在kotlin/com/app和java/com/app下的类,在classpath引用的时候是同一个包。

创建Spring Boot项目

Spring Boot项目的创建,可以参考《用Gradle和SpringBoot实现简单的RESTful框架应用》。

为了支持kotlin本项目的build.gradle中需要增加kotlin的支持,并且配置docker插件。

buildscript {
    ext.kotlin_version = '1.1.0'
    ext.spting_boot_version = '1.5.2.RELEASE'

    ... ...

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath("org.springframework.boot:spring-boot-gradle-plugin:$spting_boot_version")
    }
}

... ...
apply plugin: "kotlin"
apply plugin: 'org.springframework.boot'

dependencies {
    ... ...

    compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"

    testCompile "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
    testCompile "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
}

sourceSets{
    main{
        ... ...
        kotlin {srcDir "src/main/kotlin"}
    }
    test{
        ... ...
        kotlin {srcDir "src/test/kotlin"}
    }
}

配置完之后,运行gradle idea,下载相应的gradle依赖包。在repositories中使用国内镜像和自建的本地nexus,可以加快依赖包的下载速度maven{ url 'http://maven.aliyun.com/nexus/content/groups/public/'}

配置sourceSets增加kotlin的包之后,可以自己创建一个gradle task,自动创建sourceSets对应的目录;gradle createJavaProject会根据sourceSets中配置的路径,创建指定set对应的目录。

task createJavaProject << {
    sourceSets*.java.srcDirs*.each { it.mkdirs() }
    sourceSets*.kotlin.srcDirs*.each { it.mkdirs() }
    sourceSets*.resources.srcDirs*.each { it.mkdirs()}
}

运行spring boot程序

项目的application入口类,使用kotlin语言实现,在kotlin中是没有静态方法的,所以如果要实现main函数,有两种方法,一种是将main函数写在class的外面;或者使用companion object {},将需要静态调用的方法写在{}中。

@SpringBootApplication
open class SpringBootKotlinApplication

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

相比spring mvc,spring boot给人最大的感触就是,用简单的注解和application.properties配置的方式,避免了spring mvc中繁琐而且容易出错的xml配置文件,极大的简化了spring boot的配置。值得一提的是,application配置文件,也可以使用yaml文件。

application配置文件说明

端口

通过在配置文件中设置server.port属性,可以指定spring boot运行时绑定的端口。

freemarker

spring.freemarker.*是spring boot提供的freemarker相关配置,可以配置的属性,和注解或者xml文件是一样的,要使用spring.freemarker配置,需要在gradle中,引入org.springframework.boot:spring-boot-starter-freemarker这个包。

此外,spring boot的application配置文件,还可以配置包括数据库在内的各种常见第三方工具或者库,应该是将提供了一系列starter包,将注解和配置过程包装起来了。

配置完成之后,就可以在Application类的子目录中编写Spring MVC的控制器代码。

编写restful controller

一个最基本的RestController代码如下:

@RestController
@RequestMapping(value = "/api/data")
class DataController {

    @RequestMapping(value = "",method = arrayOf(RequestMethod.GET,RequestMethod.PUT))
    fun index():Map<String,Any>{
        val resultMap = HashMap<String,Any>()

        resultMap["status"] = true
        resultMap["msg"] = "success"
        return resultMap
    }

    @RequestMapping(value = "show",method = arrayOf(RequestMethod.PUT),consumes = arrayOf(MediaType.APPLICATION_JSON_UTF8_VALUE))
    fun test(@RequestBody reqMap:Map<Any,Any>):Map<Any,Any>{
        return reqMap
    }
}

代码解读:

  • kotlin中使用arrayof来初始化数组;
  • 对于不指定类型或者Obejct型的变量,kotlin使用Any类型
  • method方法中可以指定对种请求头,很灵活
  • 在consumes中,可以指定接受的contentType为JSON格式
  • 如果请求是json格式,用ResponseBody就可以接收JSON对象

完成所有代码之后,运行gradle bootRun就可以启动服务。

curl 'http://localhost:8080/api/data/show'  \
    -X 'PUT'  \
    -H 'content-type: application/json'  \
    -H 'accept: application/json'  \
    --data-binary '{"data":"hello","who":"echo"}' --compressed

测试spring boot程序

spring boot和kotlin都提供了强大的测试套件,能够很好的和JUnit集成,进行集成测试和单元测试。编写一些基本的集成测试,检查接口是否正常。

spring boot starter test集成了JUnit 、Mockito、AssertJ 、Hamcrest 、Spring Test & Spring Boot Test可以方便的开始测试

@RunWith(SpringJUnit4ClassRunner::class)
@WebMvcTest(HomeController::class)
class HomeControllerStandaloneTest {

    @Autowired
    private var mvc: MockMvc? = null

    @Test
    @Throws(Exception::class)
    fun indexTest() {
        mvc!!.perform(MockMvcRequestBuilders.get("/").accept(MediaType.TEXT_HTML))
                .andExpect(status().isOk)
                .andExpect(model().attributeExists("data"))
                .andExpect { content().string(containsString("<title>Spring Boot Kotlin</title>")) }
    }
}

MockMvc可以依赖注入绑定通过WebMvcTest注解的HomeController控制器,然后针对指定的controller模拟请求。andExpect方法,检查response的header,body是否符合测试的期望。

源代码:https://github.com/liuwill-projects/SpringBootKotlin

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

推荐阅读更多精彩内容