用Kotlin写一个Spring Boot微服务
Spring太复杂了,配置这个东西简直就是浪费生命。尤其在没有什么并发压力,随便搞一个RESTful服务让整个业务跑起来先的情况下,更是么有必要纠结在一堆的XML配置上。显然这么想的人是很多的,于是就有了Spring Boot。又由于Java 8太墨迹于是有了Kotlin。
数据源使用MySql, ORM使用MyBatis
。通过Spring Boot这个基本不怎么配置的不怎么微的微服务来开发一个Web App。
处理依赖
这里使用Maven来处理依赖。打开spring boot initializer来创建一个初始的项目。你可以选择Maven、Gradle,编程语言为Kotlin(其他还可以选择Java和Groovy)。最后选择Spring boot的版本,这里选择1.5.6.
选择完成后,点击Generate Project就会生成一个项目。
打开项目,我用的是Intellij Idea。为了可以使用MySql数据库,和MyBatic我们需要在项目中添加相关的依赖:
<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
来安装相关的依赖。这会花一点时间。你可以去和妹子聊一会儿了。。
例子的目录是这样的:
└── 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
下编辑配置文件。默认是没有这个文件和相应的目录的,自行创建。
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配置文件。
创建一个简单地实体类
这里定义一个简单地实体类,并声明为JPA实体。这个类的文件存放在目录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最大的优点就是省去了定义getter和setter,以及toString()
的时间。这些都已经默认实现。所以,在使用data class的对象的时候直接可以使用username
、password
当然还有userId
这样的属性直接访问。
创建简单地查询,或者说Dao类
这个就更加的简单了。
根据UserInfo
类,我们来实现一个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 }
泛型的类型参数分别是user和user的id的类型:User
, Long
。我们可以定义增删改查之外的Query。比如在上面的代码里我们定义了一个queryUserList()
方法。
我们这里是用了简单的注解方式在代码中加入SQL语句。你也可以使用mybatis的mapper资源文件来实现一样的功能。对于比较复杂的数据库操作,xml的mapper资源文件更加适合。
创建Service和对应的实现
我们尽量保证我们的代码贴近实际。在生产环境下写代码,为了保证代码有足够的可以应对需求的扩展的能力,那么一定会有一个接口和对应的实现。
Service接口
package com.example.demo interface IUserService{ fun queryUserList(userInfo: UserInfo): List<UserInfo> fun insertUser(userInfo: UserInfo): Int }
Service接口以“I"字母开头:IUserService
。里面包含两个方法,一个用来查询一个用来插入用户数据。
Service接口的实现
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的实现UserServiceImpl
里,我们使用Spring boot的依赖注入注解@Autowired
来注入mapper方法。然后使用mapper的方法来实际操作数据库。
这里尤其需要注意的是,在类的上面加入的@Service
注解。如果没有这个注解的话controller里是找不到这个bean的。
对应于Kotlin语言的特性中类和方法默认都是final的,如果要让Kotlin写的SpringBoot正常工作,就不得不在每一个相关的类上加入open
关键字。这样太麻烦了不是吗?于是就有了各种对应的插件。也就是上面贴出来的pom.xml文件里显示的。
用Controller测试一下
数据库,Rest服务和书库的连接都已经搞定。那么,我们就来测试一下。
我们在目录src\main\kotlin\com\example\demo\Controllers
创建一个UserController
类来测试和数据库的数据存取。
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
得到的用户列表,当然这里列表里就有一个UserInfo
对象。
代码在这里
参考文章:
http://blog.netgloo.com/2014/...
https://spring.io/guides/gs/a...