SuperAPI AI 工具集

kotlin-backend-conventions

编程与开发

查看项目

更新于 10-16 08:51

技能介绍

用途

该技能面向 BK-CI 项目的 Kotlin 后端代码编写与重构,帮助开发者在修改 .kt 或 .kts 文件时遵循项目级 Kotlin 规范。它关注的是 Kotlin 语言层面的代码约定,而非后端分层、API 设计或 Spring Boot 架构。

主要能力

技能内容按三块组织:

  • 文件结构、格式与导入:reference/1-file-format-import.md
  • 命名、函数设计与对象调用:reference/2-naming-function-design.md
  • 空安全、集合与 BK-CI 项目约定:reference/3-null-safety-project-practice.md

其中项目特有的高价值约定被优先关注,例如行宽、命名参数、禁止 wildcard import、避免完整类路径直接调用。

使用方式

在编写或重构 BK-CI Kotlin 后端代码、处理文件结构/格式/命名规范、调整函数设计/对象创建/空安全/集合使用方式,或判断某段 Kotlin 写法是否符合项目约定时使用。规范建议按需加载,而非以长篇规则常驻每次会话。能交给格式化工具和静态检查的规则,不在主技能中重复展开。

适用场景

  • 编写或重构 BK-CI Kotlin 后端代码
  • 处理 Kotlin 文件结构、格式和命名规范
  • 调整函数设计、对象创建、空安全和集合使用方式
  • 判断某段 Kotlin 写法是否符合项目约定

限制

不适用于以下情况:

  • 只是一般后端分层或服务归属判断
  • 只是 Spring Boot 配置和框架用法
  • 只是单元测试写法,不涉及 Kotlin 语言约定

该技能不替代后端分层、API 设计或 Spring Boot 架构技能。如果问题转向后端服务分层,可联动查看 backend-microservice-development;如果转向 Spring Boot 框架用法,可查看对应框架规范;如果编写测试,可查看 unit-testing。

关键陷阱

  • 把通用 Kotlin 教程内容原样塞进规则层
  • 只记格式,不看 BK-CI 项目特有约束
  • 语言规范、后端架构规范、Spring Boot 用法混成一个大文档

延伸阅读

  • 文件结构、格式与导入:reference/1-file-format-import.md
  • 命名、函数设计与对象调用:reference/2-naming-function-design.md
  • 空安全、集合与 BK-CI 项目约定:reference/3-null-safety-project-practice.md