很早就有人想让我写一个 kotlin x nodejs 的开发教程，利用 kotlin 可以编译为 js 的特性，理论上是可以很好的与 nodejs 配合的，而事实上也是如此。本篇即是讲述如何在 kotlin 的体系下玩转 nodejs，并最终实现一个简单的服务端应用。
首先我们要准备好 nodejs 的环境，采用以下命令来安装，如果已经装好了，可以跳过这一步:
for Mac
$ brew install nodejs
for Ubuntu
$ apt install nodejs
接着建立一个 Kotlin(Javascript) 项目，需要注意的是，如果选择使用本地 gradle 来编译，那么 gradle 的版本要大于 4.4，我自己的环境采用的版本是 4.6。
然后对 build.gradle 文件进行一定的修改，加入 compileKotlin2Js 的配置项:
compileKotlin2Js {
kotlinOptions.outputFile = "${projectDir}/web/ktnode.js"
kotlinOptions.moduleKind = "commonjs"
kotlinOptions.sourceMap = true
}
需要特别注意的是，对于纯前端的 KotlinJs 项目，moduleKind 应当被配置为 umd，而对于后端（可以带前端）的项目，应当配置为 commonjs，我们此处开发的是后端项目。
另外，还需要再对 gradle 进行一些改造，以正常的 web 项目部署的目录结构来输出编译结果，这样我们可以直接用热更新的方式来部署项目，方便调试。
build.doLast() {
configurations.compile.each { File file ->
copy {
includeEmptyDirs = false
from zipTree(file.absolutePath)
into "${projectDir}/web"
include { fileTreeElement ->
def path = fileTreeElement.path
path.endsWith(".js") && (path.startsWith("META-INF/resources/") || !path.startsWith("META-INF/"))
}
}
}
copy {
includeEmptyDirs = false
from new File("src/main/resources")
into "web"
}
}
准备好之后，我们可以把这个项目转为使用 npm 管理，也就是可以直接拿来运行了，在项目的根目录下执行命令:
$ npm init
这个命令将生成 package.json 文件，同样的，我们需要修改这个文件，以完成运行和依赖的配置：
{
"name": "ktnode",
"version": "1.0.0",
"description": "",
"scripts": {
"start": "node ./web/ktnode.js"
},
"author": "rarnu",
"license": "GPLv3",
"dependencies": {
"kotlin": "^1.3.20",
"express": "^4.15.4",
"mongoose": "^4.11.7"
}
}
这里需要注意的是，在 scripts 内的 start 选项，将指出从何开始运行 node 项目，此处指向我们的编译目标，即 ktnode.js，你也可以把这个名称修改为你自己项目的。
接着是依赖，要使用 Kotlin 来开发，那么也就必须在 nodejs 环境内安装 Kotlin 的包，除此之外，其他都是 nodejs 的常规操作了，运行 install 命令来完成依赖的安装:
$ npm install
现在可以尝试写一个文件，来跑起第一个 Kotlin x Nodejs 服务器了:
package com.rarnu.ktnode
import kotlin.js.json
external fun require(module: String): dynamic
external val process: dynamic
val express = require("express")
app = express()
fun main(args: Array<String>) {
app.get("/") { _, resp ->
resp.type("text/plain")
resp.send("Hello Kotlin x Nodejs")
}
app.listen(port) {
println("Listening on port $port")
}
}
然后编译，运行之:
$ gradle build
$ npm start
然后就可以在浏览器打开 http://localhost:8888 并看到这个页面啦。
第一个页面
好了，有了这个基础，我们可以走得更远，下面来说一下如果要返回静态页面以及带入静态的 js 等文件要怎么操作。
假设我们已经在 Kotlin 项目的 resources 目录下放置了 index.html 和 jquery.js，html 的代码如下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript">
function callapi() {
$.ajax({
url :"/api",
dataType: "text",
data: { name: "rarnu" },
success: function (data) { $("#result")[0].innerHTML = data; }
});
}
</script>
</head>
<body>
<p><input type="button" onclick="callapi();" value="CallAPI"></p>
<div id="result"></div>
</body>
</html>
然后我们需要设置静态页面路径，只有设置了静态页面路径，这个页面以及它加载的 js 才会正常展示：
var path = require("path")
app.use(express.static(path.join(__dirname, "")))
同样的，你可以尝试不设置静态页面路径，然后看看会发生什么。
好了，暂时不去管那个内置的 js 函数，现在我们再来看看如何动态的返回页面，这种技巧通常用于代码模板，从模板来生成一个页面并返回给用户。此时就需要从 resources 内加载页面的模板文件，然后将其返回给用户:
app.get("/sample") { _, resp ->
val fs = require("fs")
fs.readFile("index.html", "utf8") { _, data ->
resp.type("text/html")
resp.send(data)
}
}
接着，要讲一下如何来接受请求参数，在 nodejs 里，有三种接参数的方式，如下表所示:
| 代码 | 描述 | 示例 |
|---|---|---|
| req.params | 获取路由参数 | 从 /index 请求中获取 index |
| req.query | 获取查询字符串中的参数 | 从 /index?id=1 中获取 id |
| req.body | 获取经过 URLEncoded 的 body 参数 | 从 /index 中获取 post 上来的 id |
在 Kotlin 代码中，可以轻易的完成对于参数的获取:
app.get("/sample") { req, resp ->
val id = req.query.id
resp.type("text/plain")
resp.send(id)
}
要获取 post 方法传来的参数，需要额外的进行配置:
val bodyParser = require("body-parser")
app.use(bodyParser.urlencoded(extended = false))
app.post("/sample") {
val id = req.body.id
... ...
}
在 Kotlin 中，包含了许多方便开发的库，如果要返回的内容是一个 json 串，可以用一些简单的方法来进行拼装:
import kotlin.js.json
... ...
app.get("/sample") { _, resp ->
resp.type("text/json")
resp.send(json("result" to 0, "message" to "success"))
}
这段代码将返回以下 json 串:
{"result":0,"message":"success"}
还记得上面埋了个伏笔不，html 里的那个 callapi 函数，现在可以利用上面的内容，把这个函数写出来了:
app.get("/api") { req, resp ->
val name = req.query?.name ?: ""
resp.type("text/json")
resp.send(json("result" to 0, "message" to "Hello World: $name"))
}
再回过头来看一些能够方便开发的东西，比如说热部署，你一定会发现，在使用 npm start 后，不论怎么编辑页面或代码，都不能立即在浏览器上看到效果。如果想立即看到效果要怎么办呢？
$ sudo npm install -g supervisor
$ supervisor ktnode.js
这样就可以搞定了，supervisor 会监控 ktnode.js 所在的目录，在目录内容有变化时，可以即时刷新，这样就可以浏览器内实时预览了。
最后，在这个 Demo 程序的基础上，其实还是可以做很多抽象的，比如一个好的基础库可以让你事半功倍，比如这样:
package com.rarnu.ktnode
import kotlin.js.json
fun main(args: Array<String>) {
initServer()
routing("/index") { req, resp ->
resp.type("text/html")
loadRes("index.html") { resp.send(it) }
}
routing("/api") { req, resp ->
val name = req.query?.name ?: ""
resp.type("text/json")
resp.send(json("result" to 0, "message" to "Hello World: $name"))
}
startListen()
}
写成这样就会比较舒服，专心的处理请求响应的逻辑而无需关心其他内容，这需要在实际开发中多加积累。
我在 Github 上放了一个简单的 Demo，希望能起到抛砖引玉的作用。点此去玩 Demo
网友评论