Kotlin Misk Web框架

Kotlin Misk Web框架

• [1 Misk 框架介绍](#1 Misk 框架介绍)
• [2 Misk/SpringBoot 框架对比](#2 Misk/SpringBoot 框架对比)
• [3 Misk 添加依赖/配置](#3 Misk 添加依赖/配置)
• • [3.1 build.gradle.kts](#3.1 build.gradle.kts)
  • [3.2 settings.gradle.kts](#3.2 settings.gradle.kts)
  • [3.3 gradle.properties](#3.3 gradle.properties)
• [4 Misk 请求接口](#4 Misk 请求接口)
• [5 Misk 程序模块](#5 Misk 程序模块)
• [6 Misk 主服务类](#6 Misk 主服务类)
• [7 Misk 测试结果](#7 Misk 测试结果)

1 Misk 框架介绍

Misk 是由 Square 公司开发的一个开源的多语言服务器框架，主要用于构建微服务。它主要使用 Kotlin 语言，但也支持 Java。Misk 的设计目标是提供一个现代化、高效、易于使用的框架，用于快速开发和部署微服务。

主要特点和组件	解释
依赖注入	Misk 使用 Google 的 Guice 库进行依赖注入。这使得代码更加模块化，易于测试和维护。
Web 服务支持	Misk 提供了强大的 Web 服务支持，包括路由、请求处理、响应生成等。它使用注解来定义 API 端点，使得创建 RESTful 服务变得简单，Misk 内置了对 HTTP 和 gRPC 的支持。通过简单的注解，可以快速定义 RESTful API 和 gRPC 服务。
数据库支持	Misk 集成了 JDBC 和各种 ORM 框架，支持多种数据库操作。它还提供了事务管理和连接池管理。
配置管理	Misk 提供了灵活的配置管理系统，支持不同环境（如开发、测试、生产）的配置。
健康检查和指标	Misk 内置了健康检查和指标收集功能，有助于监控和管理服务的运行状态。
安全性	Misk 提供了认证和授权支持，包括 JWT 认证、CORS 配置等。
测试支持	Misk 提供了丰富的测试工具和框架，使得单元测试和集成测试变得容易。
异步编程	Misk 支持 Kotlin 协程，使得异步编程变得更加简单和高效。
服务发现和负载均衡	Misk 提供了服务发现和负载均衡的功能，有助于构建分布式系统。
插件系统	Misk 有一个灵活的插件系统，允许开发者轻松扩展和定制框架的功能。

核心组件	解释
MiskWeb	用于构建 Web 服务和管理控制台的组件。
MiskHibernate	提供与 Hibernate 集成的数据库访问功能。
MiskService	用于定义和管理服务生命周期的组件。
MiskSecurity	提供安全相关的功能，包括认证和授权

2 Misk/SpringBoot 框架对比

Misk	SpringBoot
设计理念： Misk 是由 Square 开发的，专门用于构建微服务。它注重开发者体验、可维护性和扩展性。 依赖注入： 基于 Google 的 Guice 依赖注入框架。 模块化： 使用模块化设计，鼓励将应用分成多个模块，易于管理和测试。 核心功能： 内置了很多 Square 的最佳实践和工具，如服务发现、数据库访问、配置管理等。	设计理念： Spring Boot 是基于 Spring 框架的，旨在简化 Spring 应用的开发过程，提供了开箱即用的配置。 依赖注入： 使用 Spring 的核心功能------依赖注入（Dependency Injection）。 自动配置： xSpring Boot 提供了自动配置功能，减少了开发者的配置工作量。 **广泛使用：**由于 Spring 的历史和广泛的社区支持，Spring Boot 提供了大量的集成和插件支持。
配置管理： Misk 使用 YAML 文件进行配置，支持多环境配置和动态配置管理。 **扩展性：**通过模块化设计，可以很容易地添加或移除功能模块。	配置管理 ：Spring Boot 使用 application.properties 或 application.yml 文件进行配置，支持多种配置源（文件、环境变量、命令行参数等）。 **扩展性：**Spring Boot 提供了强大的自动配置机制和大量的 Starter 项目，可以轻松集成第三方库和服务。
易用性： Square 提供了详细的文档和示例，开发者可以快速上手。 **工具支持：**提供了很多内部工具，如数据迁移、监控、日志等，简化了开发和运维过程。	易用性： Spring Boot 提供了丰富的文档和社区支持，开发者可以通过 Spring Initializr 快速创建项目。 **工具支持：**Spring Boot 有丰富的 IDE 支持（如 IntelliJ IDEA 和 Eclipse），并且有大量的第三方插件和扩展。
社区： 由于是 Square 开发并使用，社区相对较小，但有一定的活跃度和支持。 **生态系统：**主要由 Square 及其相关项目组成，生态系统相对封闭，但具有很高的内聚力和一致性。	社区： Spring 社区非常庞大和活跃，有大量的开发者、教程、论坛和开源项目支持。 **生态系统：**Spring Boot 拥有非常丰富的生态系统，几乎可以找到与任何技术栈的集成和支持。
性能： 由于是为微服务设计的，Misk 在性能方面有很多优化，尤其是在高并发场景下表现良好。 **稳定性：**Square 内部广泛使用，经过了实际生产环境的验证。	性能： Spring Boot 性能优异，特别是在大型企业应用和复杂的微服务架构中表现出色。**稳定性：**经过多年发展和大量企业应用验证，Spring Boot 非常稳定可靠。
Misk 更适合那些想要快速构建和部署微服务，并且愿意采用 Square 的最佳实践和工具的团队。它的模块化设计和高性能优化使其在特定场景下非常有优势。	Spring Boot 则更适合需要广泛集成和社区支持的项目。它的自动配置和强大的生态系统使其在各种规模和复杂度的项目中都能得心应手。

3 Misk 添加依赖/配置

3.1 build.gradle.kts

import org.jetbrains.kotlin.cli.jvm.compiler.findMainClass

plugins {
    kotlin("jvm") version "2.0.0"
}

group = "com.xu"
version = "1.0.0"

repositories {
    mavenCentral()
}

dependencies {
    testImplementation(kotlin("test"))
    implementation("com.squareup.misk:misk:2024.06.19.153119-a4bdcea")
    implementation("com.squareup.misk:misk-actions:2024.06.19.153119-a4bdcea")
    implementation("com.squareup.misk:misk-core:2024.06.19.153119-a4bdcea")
    implementation("com.squareup.misk:misk-inject:2024.06.19.153119-a4bdcea")
    implementation("com.squareup.misk:misk-service:2024.06.19.153119-a4bdcea")
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain(21)
}

3.2 settings.gradle.kts

plugins {
    id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
}

rootProject.name = "misk-test"

3.3 gradle.properties

kotlin.code.style=official

4 Misk 请求接口

package com.xu.action

import com.google.inject.Inject
import com.google.inject.Singleton
import misk.web.Get
import misk.web.PathParam
import misk.web.Post
import misk.web.QueryParam
import misk.web.RequestBody
import misk.web.ResponseContentType
import misk.web.actions.WebAction
import misk.web.mediatype.MediaTypes

@Singleton
class HelloWebAction @Inject constructor() : WebAction {

    @Get("/hello1/{name}")
    @ResponseContentType(MediaTypes.APPLICATION_JSON)
    fun hello1(@PathParam name: String, @QueryParam addr: String): List<String> {
        return listOf("你好", name, addr)
    }

    @Post("/hello2")
    @ResponseContentType(MediaTypes.APPLICATION_JSON)
    fun hello2(@RequestBody body: Student): Map<String, Any> {
        return mapOf("student" to body)
    }

    data class Student(val name: String, val addr: String);

}

5 Misk 程序模块

package com.xu

import com.xu.action.HelloWebAction
import misk.inject.KAbstractModule
import misk.web.WebActionModule

class HelloWorldModule : KAbstractModule() {

    override fun configure() {
        install(WebActionModule.create<HelloWebAction>())
    }

}

6 Misk 主服务类

package com.xu

import misk.MiskApplication
import misk.MiskRealServiceModule
import misk.environment.DeploymentModule
import misk.web.MiskWebModule
import misk.web.WebConfig
import wisp.deployment.Deployment

fun main(args: Array<String>) {

    val webConfig = WebConfig(port = 8080)
    val deployment = Deployment(
        name = "HelloWorldService",
        isProduction = true
    )

    MiskApplication(
        modules = listOf(
            MiskWebModule(webConfig),
            HelloWorldModule(),
            MiskRealServiceModule(),
            DeploymentModule(deployment)
        )
    ).run(args)
}

7 Misk 测试结果