Kotlin + SpringBoot + MySQL + Ngrok_根据mysql生成konlin代码

从一开始只有一个IDEA，到上线一个外网可访问的API。最后的效果是这样的：

开发环境：Win10 + IDEA + Gradle

主要技术：SpringBoot框架 + Kotlin语言 + MySQL数据库

内容提要：

1. 创建一个基于Gradle的项目
2. 初始化SpringBoot
3. 安装、配置、关联MySQL
4. 构建一个简单的API
5. 打包一个可执行文件
6. 使用ngrok做外网访问

---

创建一个新项目

先用IDEA创建一个Gradle项目

注意：

1. 基于Gradle
2. 使用Kotlin
3. IDEA对JDK做了一些改进，比如把原来的Logging换成了SLF4J，在使用时有时会导致重复导包。为了避免麻烦，我们使用原生的JDK。

接下来一路Next。

如果你网络没问题的话，最后会是这样一个项目结构：

---

初始化SpringBoot

修改自动生成的build.gradle如下：

代码如下：

buildscript {
    ext.kotlin_version = '1.1.51'
    ext.spring_boot_version = '1.5.8.RELEASE'
 
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.springframework.boot:spring-boot-gradle-plugin:$spring_boot_version"
    }
}
 
apply plugin: 'kotlin'
apply plugin: 'org.springframework.boot'
 
 
repositories {
    mavenCentral()
}
 
dependencies {
    compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version"
    compile 'org.springframework.boot:spring-boot-starter-web'
}
 
compileKotlin {
    kotlinOptions.jvmTarget = "1.8"
}
compileTestKotlin {
    kotlinOptions.jvmTarget = "1.8"
}

对上边四个标注解释：

• 上边三条，主要是添加了一个SpringBoot的gradle插件，作用如下：
  • 整合类路径上所有的jar，并建立一个单一的，可运行的"über-jar"。（不用管，就是一个名字。）
  • 它搜索public static void main()方法来标记为可运行的类。
  • 它提供了一个内建的依赖解析器，设置了版本号，以匹配SpringBoot的依赖。您可以覆盖任何你想要的版本，但它会默认引导的选择版本的集合。可以注意到下边对spring-boot-starter-web的依赖没有设置版本。SpringBoot有很多组件，之后依赖的组件多了，就很很方便的管理版本了。
• 最后一条，真正的引用。SpringBoot的Web基础包。

接下来，我们创建一个入口文件添加一些简单代码并运行。注意：一定要创建包！

@Controller              //表明这是一个Controller，控制路由的东西
@EnableAutoConfiguration //告诉SpringBoot开始依据依赖路径等添加Beans。
class SampleController {
 
    @RequestMapping("/") //映射最基础的URL
    @ResponseBody        //表明这是一个Resopnse，而不是一个视图名称
    internal fun home(): String {
        return "Hello World!" //为请求返回一个字符串。
    }
}
 
fun main(args: Array<String>) {
    SpringApplication.run(SampleController::class.java, *args)
}

不出错的话，这时候访问localhost:8080（默认的），会看到我们刚才设置的Hello World!：

表明SpringBoot运行正常。继续下一步。

---

接入MySQL

首先，修改依赖，添加下面的依赖：

compile 'org.springframework.boot:spring-boot-starter-data-jpa'
compile 'mysql:mysql-connector-java'

结果如图：

然后，需要连接到MySQL服务器。我们去下载一个MySQL。
我是Windows的系统，所以按照Windows大致说下流程，很简单的东西。推荐使用MySQL Installer，Windows下载地址，只有32位的包，但是安装的时候可选安装64位的组件。

选择要安装的组件，我选了Custom和下面5个。不想安装多的话，可以只安装Server组件就可以了。自己决定选什么。

这个之后的配置，我只设置了root的密码。（也可以不设置，一路next）。

接下来，配置一下数据库：

先进入MySQL Server的目录下面，我的是C:\Program Files\MySQL\MySQL Server 5.7\bin，用的频繁的话可以加到环境变量里去，输入命令mysql -u root -p并输入密码进入数据库，然后执行下边的数据库命令：

mysql> create database db_example; -- 创建一个数据库，名字自己设置。
mysql> create user 'springuser'@'localhost' identified by 'ThePassword'; -- 创建一个用户，专门管理这个数据库。也可以不创建用户，等下直接使用root用户。
mysql> grant all on db_example.* to 'springuser'@'localhost'; -- 把新建数据库的所有权限都给到新建用户

我的配置如下：

然后在项目里关联上数据库：

在resources目录下，创建一个文件application.properties，内容如下：

spring.jpa.hibernate.ddl-auto=create
spring.datasource.url=jdbc:mysql://localhost:3306/（数据库名字）
spring.datasource.username=（用户名,比如我的是springuser或者root）
spring.datasource.password=（密码，没有就空着）

另外关于spring.jpa.hibernate.ddl-auto：

1. 几个选项
   • none MySQL默认选项，不改变数据库结构。
   • update 根据给定的实体结构改变数据库。
   • create 每次都创建数据库，但关闭的时候不删除数据库。
   • create-drop 创建数据库，在SessionFactory关闭时删除数据库。
2. 在这里，我们使用create是因为我们现在还没有数据库结构。第一次运行之后，我们可以根据需求切换到update或none。要改变数据库结构时使用update。
3. H2和其他嵌入式数据库默认是create-drop，但对于其他类似MySQL的是none
4. 数据库处于生产状态时使用none是很好的安全做法，你设置none，并移除连接到Spring应用程序的MySQL用户的所有特权，然后只给增删查改的权限。

---

开始构建一个简单的服务

我们要做的：

1. 有一个User的表
2. 可以通过请求增加一个User，也可以查找所有的User信息

先创建一个User类

package hello
 
import javax.persistence.Entity
import javax.persistence.GeneratedValue
import javax.persistence.GenerationType
import javax.persistence.Id
 
 
@Entity // 告诉Hibernate依据这个类创建一个表
class User {
    @Id //主键
    @GeneratedValue(strategy = GenerationType.AUTO) //自增长
    var id: Int? = null
 
    var name: String? = null
 
    var email: String? = null
}

再创建一个操作数据的接口

// Spring会自动生成一个名为userRepository（注意是首字母小写）Bean用来操作增删改查
interface UserRepository : CrudRepository<User, Long>

再创建一个Controller处理请求

@Controller    // 申明这是一个Controller
@RequestMapping(path = arrayOf("/demo")) // 匹配路径以/demo开头的URL
class MainController(@Autowired private val userRepository: UserRepository) {//@Autowired 使用该注解可自动找到之前Spring自动创建的名为userRepository的Bean来填充数据
 
    val allUsers: Iterable<User>
        @GetMapping(path = arrayOf("/all"))
        @ResponseBody
        get() = userRepository.findAll()
 
    @GetMapping(path = arrayOf("/add")) 
    @ResponseBody
    fun addNewUser(@RequestParam name: String, @RequestParam email: String): String {
        // @RequestParam 请求参数
 
        val n = User()
        n.name = name
        n.email = email
        userRepository.save(n)
        return "Saved"
    }
}

注意:@GetMapping只匹配Get请求，是@RequestMapping(method=GET)的简写。同理还有@PostMapping等。如果只写@RequestMapping不指明请求方式表示匹配所有类型的请求。

最后，修改一下我们的入口类App.kt：

@SpringBootApplication
open class Application
 
fun main(args: Array<String>) {
    SpringApplication.run(Application::class.java, *args)
}

注意：

1. 不加open修饰符会报错。kotlin中不加open修饰符类默认为final类，而SpringBootApplication不能是final类。
2. 关于@SpringBootApplication，其实是以下几个注解的简便写法。
   • @Configuration 标记类为bean定义的应用程序上下文的来源
   • @EnableAutoConfiguration 之前已经提到过了告诉SpringBoot开始依据依赖路径等添加Beans。
   • 通常你会添加@EnableWebMvc一个Spring MVC的应用程序，但是当它看到春天开机自动将其添加弹簧webmvc在classpath。此标志的应用程序作为Web应用程序和激活密钥的行为，如设立DispatcherServlet。
   • @ComponentScan告诉Spring在hello包自动寻找其他组件，配置，控制器。

这时候我们再运行一下：

用Get方法传递一个User信息，它会执行保存操作，并返回结果：

获取所有User信息：

奇怪的是一个请求会执行两次，在隐身模式下就不会这样，我还在找原因。

好了，现在一个基本的Api已经搭建好了，在本地已经能访问了。接下来，我们看如何打包运行，以及连接外网。

打包运行

由于SpringBoot的特性，使用Gradle可以方便的生成jar文件。

生成的文件在这里：

把生成的文件复制到桌面上并运行，为了方便我给它改了一个简单点的名字：

和之前的效果一模一样的。

---

使用ngrok连接外网

我使用的ngrok.cc，因为可以免费绑定自己的域名。

流程如下：

1. 注册账户
2. 开通一个隧道，选第三个免费的。
   1. 选http
   2. 隧道名称随便起
   3. 前置域名[***.free.ngrok.cc]
   4. 本地端口，比如我们使用的127.0.0.1:8080
   5. http用户名密码，先不用管
   6. 添加
3. 照简单教程下载对应版本的软件，启动。
4. 开启你的SpringBoot服务，把之前的localhost:8080换成***.free.ngrok.cc即可访问。***换自己起的前置域名。

如果你有一个域名，可以来替换掉这个免费域名：

点击隧道管理 -> 选中隧道 -> 修改

按规定设置域名解析，比如我的是阿里云的域名：

设置好等一会即可。另外注意，ngrok.cc目前还不支持https访问，所以使用自己的域名时也要注意使用http进行访问。

---

除了上边提到的错误，我还遇到了另外一个错误，显示端口占用。解决方法如下。

先打开CMD命令行命令netstat ?ano，找到占用8080端口的进程的PID：

去进程详情里找到该进程，结束掉，重新启动SpringBoot服务。

---

相关文档

本文内容主要来自：

1. 实现简单的Web服务
2. 访问MySQL

推荐：一个比较完整的REST服务

---

最后，SpringBoot能做的东西还很多，本文只是和你一起搭了一个很基本的框架，你可以不断的去添加新的内容进去，去尝试构造你自己的优雅的API，做更多的事。