用Kotlin寫一個基于Spring Boot的RESTful服務(wù)

Spring太復(fù)雜了鲫懒,配置這個東西簡直就是浪費(fèi)生命嫩实。尤其在沒有什么并發(fā)壓力,隨便搞一個RESTful服務(wù)讓整個業(yè)務(wù)跑起來先的情況下窥岩,更是么有必要糾結(jié)在一堆的XML配置上甲献。顯然這么想的人是很多的,于是就有了Spring Boot颂翼。又由于Java 8太墨跡于是有了Kotlin竟纳。

數(shù)據(jù)源使用MySql, ORM使用MyBatis。通過Spring Boot這個基本不怎么配置的不怎么微的微服務(wù)來開發(fā)一個Web App疚鲤。

處理依賴

這里使用Maven來處理依賴锥累。打開spring boot initializer來創(chuàng)建一個初始的項目。你可以選擇Maven集歇、Gradle桶略,編程語言為Kotlin(其他還可以選擇Java和Groovy)。最后選擇Spring boot的版本诲宇,這里選擇1.5.6.
選擇完成后际歼,點(diǎn)擊Generate Project就會生成一個項目蒲列。

打開項目雄妥,我用的是Intellij Idea撵割。為了可以使用MySql數(shù)據(jù)庫柳沙,和MyBatic我們需要在項目中添加相關(guān)的依賴:

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>1.3.1</version>
    </dependency>

其中包括mysq connector和mybatis spring boot starter兩個庫。
使用命令:mvn clean install -DskipTests來安裝相關(guān)的依賴晴埂。這會花一點(diǎn)時間辽狈。你可以去和妹子聊一會兒了置逻。宙暇。

例子的目錄是這樣的:

└── src
    └── main
        └── kotlin
            └── com.example.demo

但是無論是用上面的哪種方式输枯,最后都需要在Maven文件中添加依賴項。添加完依賴項之后是這樣的:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>demo</name>
  <description>Demo project for Spring Boot</description>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.6.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <properties>
    <kotlin.compiler.incremental>true</kotlin.compiler.incremental>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <kotlin.version>1.1.4-3</kotlin.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.jetbrains.kotlin</groupId>
      <artifactId>kotlin-stdlib-jre8</artifactId>
      <version>${kotlin.version}</version>
    </dependency>
    <dependency>
      <groupId>org.jetbrains.kotlin</groupId>
      <artifactId>kotlin-reflect</artifactId>
      <version>${kotlin.version}</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>1.3.1</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
    <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
      <plugin>
        <artifactId>kotlin-maven-plugin</artifactId>
        <groupId>org.jetbrains.kotlin</groupId>
        <version>${kotlin.version}</version>
        <configuration>
          <compilerPlugins>
            <plugin>spring</plugin>
          </compilerPlugins>
          <jvmTarget>1.8</jvmTarget>
        </configuration>
        <executions>
          <execution>
            <id>compile</id>
            <phase>compile</phase>
            <goals>
              <goal>compile</goal>
            </goals>
          </execution>
          <execution>
            <id>test-compile</id>
            <phase>test-compile</phase>
            <goals>
              <goal>test-compile</goal>
            </goals>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-allopen</artifactId>
            <version>${kotlin.version}</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

配置文件

在目錄src/main/resources/application.yml下編輯配置文件占贫。默認(rèn)是沒有這個文件和相應(yīng)的目錄的桃熄,自行創(chuàng)建。

server:
  context-path: /api
  port: 9091

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/petshop
    username: root
    password: 123456
    driverClassName: com.mysql.jdbc.Driver

無需java的配置類型奥,或者什么XML配置文件瞳收。

創(chuàng)建一個簡單地實(shí)體類

這里定義一個簡單地實(shí)體類碉京,并聲明為JPA實(shí)體。這個類的文件存放在目錄src\main\java\hello\Entities\下螟深。

package com.example.demo

data class UserInfo(val userId: Long, var username: String?, var password: String?
                    , var deleted: Int = 0)

這里使用了Kotlin里的data class谐宙。data class最大的優(yōu)點(diǎn)就是省去了定義getter和setter,以及toString()的時間血崭。這些都已經(jīng)默認(rèn)實(shí)現(xiàn)。所以厘灼,在使用data class的對象的時候直接可以使用username夹纫、password當(dāng)然還有userId這樣的屬性直接訪問。

創(chuàng)建簡單地查詢设凹,或者說Dao類

這個就更加的簡單了舰讹。

根據(jù)UserInfo類,我們來實(shí)現(xiàn)一個UserMapper(Dao):

package com.example.demo

import org.apache.ibatis.annotations.Insert
import org.apache.ibatis.annotations.Mapper
import org.apache.ibatis.annotations.Select
import com.example.demo.UserInfo

@Mapper
interface UserMapper {

    @Select("""<script>
        select USER_ID, USER_NAME, PASSWORD, DELETED from user where 1=1
        <if test='username != null'>AND USER_NAME like #{username}%</if>
        <if test='userId != null'> AND USER_ID = #{userId}</if>
        <if test='deleted != null'> AND DELETED = #{deleted}</if>
        </script>""")
    fun queryUserList(userInfo: UserInfo): List<UserInfo>

    @Insert("""
        insert into user (USER_NAME, PASSWORD, DELETED)
            values (#{username}, #{password}, #{deleted})
        """)
    fun insertUser(userInfo: UserInfo): Int
}

泛型的類型參數(shù)分別是user和user的id的類型:User, Long闪朱。我們可以定義增刪改查之外的Query月匣。比如在上面的代碼里我們定義了一個queryUserList()方法。

我們這里是用了簡單的注解方式在代碼中加入SQL語句奋姿。你也可以使用mybatis的mapper資源文件來實(shí)現(xiàn)一樣的功能锄开。對于比較復(fù)雜的數(shù)據(jù)庫操作,xml的mapper資源文件更加適合称诗。

創(chuàng)建Service和對應(yīng)的實(shí)現(xiàn)

我們盡量保證我們的代碼貼近實(shí)際萍悴。在生產(chǎn)環(huán)境下寫代碼,為了保證代碼有足夠的可以應(yīng)對需求的擴(kuò)展的能力寓免,那么一定會有一個接口和對應(yīng)的實(shí)現(xiàn)癣诱。

Service接口

package com.example.demo

interface IUserService{
    fun queryUserList(userInfo: UserInfo): List<UserInfo>
    fun insertUser(userInfo: UserInfo): Int
}

Service接口以“I"字母開頭:IUserService。里面包含兩個方法袜香,一個用來查詢一個用來插入用戶數(shù)據(jù)撕予。

Service接口的實(shí)現(xiàn)

package com.example.demo

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.stereotype.Service

@Service
class UserServiceImpl : IUserService {
    @Autowired
    lateinit var userMapper: UserMapper

    override fun queryUserList(userInfo: UserInfo): List<UserInfo> {
        return userMapper.queryUserList(userInfo);
    }

    override fun insertUser(userInfo: UserInfo): Int {
        return userMapper.insertUser(userInfo);
    }
}

在Service的實(shí)現(xiàn)UserServiceImpl里,我們使用Spring boot的依賴注入注解@Autowired來注入mapper方法蜈首。然后使用mapper的方法來實(shí)際操作數(shù)據(jù)庫实抡。

這里尤其需要注意的是,在類的上面加入的@Service注解欢策。如果沒有這個注解的話controller里是找不到這個bean的澜术。

對應(yīng)于Kotlin語言的特性中類和方法默認(rèn)都是final的,如果要讓Kotlin寫的SpringBoot正常工作猬腰,就不得不在每一個相關(guān)的類上加入open關(guān)鍵字鸟废。這樣太麻煩了不是嗎?于是就有了各種對應(yīng)的插件姑荷。也就是上面貼出來的pom.xml文件里顯示的盒延。

用Controller測試一下

數(shù)據(jù)庫缩擂,Rest服務(wù)和書庫的連接都已經(jīng)搞定。那么添寺,我們就來測試一下胯盯。

我們在目錄src\main\kotlin\com\example\demo\Controllers創(chuàng)建一個UserController類來測試和數(shù)據(jù)庫的數(shù)據(jù)存取。

package com.example.demo

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RestController

@RestController
class UserController {
    @Autowired
    lateinit var userService: IUserService

    @GetMapping("/user/{userId}/id")
    fun queryUserById(@PathVariable userId: String): List<UserInfo> {
        var userInfo = UserInfo(userId = userId.toLong(), username = null,
                password = null)
        var userList = userService.queryUserList(userInfo)
        return userList
    }
}

測試URL可以是這樣的:
http://localhost:9091/api/user/1/id计露,這時會返回一個用userId得到的用戶列表博脑,當(dāng)然這里列表里就有一個UserInfo對象。

代碼在這里

參考文章:
http://blog.netgloo.com/2014/10/27/using-mysql-in-spring-boot-via-spring-data-jpa-and-hibernate/
https://spring.io/guides/gs/accessing-data-jpa/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末票罐,一起剝皮案震驚了整個濱河市叉趣,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌该押,老刑警劉巖疗杉,帶你破解...
    沈念sama閱讀 211,265評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異蚕礼,居然都是意外死亡烟具,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,078評論 2 385
  • 文/潘曉璐 我一進(jìn)店門奠蹬,熙熙樓的掌柜王于貴愁眉苦臉地迎上來朝聋,“玉大人,你說我怎么就攤上這事囤躁【脸幔” “怎么了?”我有些...
    開封第一講書人閱讀 156,852評論 0 347
  • 文/不壞的土叔 我叫張陵割以,是天一觀的道長金度。 經(jīng)常有香客問我,道長严沥,這世上最難降的妖魔是什么猜极? 我笑而不...
    開封第一講書人閱讀 56,408評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮消玄,結(jié)果婚禮上跟伏,老公的妹妹穿的比我還像新娘。我一直安慰自己翩瓜,他們只是感情好受扳,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,445評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著兔跌,像睡著了一般勘高。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,772評論 1 290
  • 那天华望,我揣著相機(jī)與錄音蕊蝗,去河邊找鬼。 笑死赖舟,一個胖子當(dāng)著我的面吹牛蓬戚,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播宾抓,決...
    沈念sama閱讀 38,921評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼子漩,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了石洗?” 一聲冷哼從身側(cè)響起幢泼,我...
    開封第一講書人閱讀 37,688評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎劲腿,沒想到半個月后旭绒,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體鸟妙,經(jīng)...
    沈念sama閱讀 44,130評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡焦人,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,467評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了重父。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片花椭。...
    茶點(diǎn)故事閱讀 38,617評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖房午,靈堂內(nèi)的尸體忽然破棺而出矿辽,到底是詐尸還是另有隱情,我是刑警寧澤郭厌,帶...
    沈念sama閱讀 34,276評論 4 329
  • 正文 年R本政府宣布袋倔,位于F島的核電站,受9級特大地震影響折柠,放射性物質(zhì)發(fā)生泄漏宾娜。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,882評論 3 312
  • 文/蒙蒙 一扇售、第九天 我趴在偏房一處隱蔽的房頂上張望前塔。 院中可真熱鬧,春花似錦承冰、人聲如沸华弓。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,740評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽寂屏。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間凑保,已是汗流浹背冈爹。 一陣腳步聲響...
    開封第一講書人閱讀 31,967評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留欧引,地道東北人频伤。 一個月前我還...
    沈念sama閱讀 46,315評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像芝此,于是被迫代替她去往敵國和親憋肖。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,486評論 2 348

推薦閱讀更多精彩內(nèi)容