Skip to content

用户指南 ​

版本对应声明

本文档对应 Neton 1.0.0(Kotlin 2.4.0 / KSP 2.3.10),目前处于公开 Beta 阶段,正式发布日期未定。 若文档与代码不一致,一律以 neton/examples/ 下的可编译示例和框架源码为准。

欢迎阅读 Neton Framework 用户指南。

Neton 是一个现代化的 Kotlin/Native Web 框架,基于 Kotlin Multiplatform 构建,编译为原生二进制文件,具备零反射、毫秒级启动、极低内存占用等特性。本指南将帮助你从零开始掌握 Neton 的核心功能,并构建高性能的 Web 应用。

目录导航 ​

入门 ​

  • 快速开始 -- 从零搭建第一个 Neton 应用,5 分钟运行 Hello World
  • 能力总览 -- 内建能力有哪些、什么交给平台、为什么这样更快更好维护
  • 项目结构 -- 了解 Neton 的模块划分、目录约定与配置文件

核心功能 ​

  • 路由与控制器 -- Controller 注解、HTTP 方法、路由组、DSL 路由
  • 参数绑定 -- 约定优于配置的参数推断,Path / Query / Body / Header / Cookie 绑定
  • 配置管理 -- TOML 配置文件、环境覆盖、@NetonConfig SPI 扩展
  • 日志系统 -- 结构化日志、Sink 路由、异步写入、Trace 上下文

安全与认证 ​

  • 安全指南 -- Authenticator + Guard 架构、JWT 认证、@RequireAuth / @AllowAnonymous 授权

数据与缓存 ​

  • 数据库操作 -- Entity + Table 模式、类型安全 Query DSL、Repository 层
  • 缓存 -- L1 + L2 两级缓存、@Cacheable / @CachePut / @CacheEvict 注解
  • Redis 与分布式锁 -- Redis 客户端、@Lock 分布式锁
  • 领域事件 -- 用事件总线解耦模块,SYNC / BEST_EFFORT / RETRYABLE 三种投递模式

进阶 ​

Neton Framework 文档