Loading...
Loading...
后端微服务开发规范,涵盖目录结构、分层架构(API/Service/DAO)、依赖注入、配置管理、Spring Boot 最佳实践。当用户进行后端开发、创建新微服务、编写 Kotlin/Java 代码或设计服务架构时使用。
npx skill4agent add tencentblueking/bk-ci backend-microservice-development核心服务:process(流水线) | project(项目) | repository(代码库) | auth(权限)
四层架构:api-{service}(接口) → biz-{service}(业务+DAO) → boot-{service}(启动) → model-{service}(数据模型)
包命名:com.tencent.devops.<module>
Resource 前缀:User*(Web) | Service*(内部) | Build*(Agent) | Open*(外部)// Resource 接口定义
@Tag(name = "USER_PIPELINE", description = "用户-流水线资源")
@Path("/user/pipelines")
@Produces(MediaType.APPLICATION_JSON)
interface UserPipelineResource {
@GET
@Operation(summary = "获取流水线列表")
fun list(@HeaderParam(AUTH_HEADER_USER_ID) userId: String): Result<List<PipelineInfo>>
}
// Resource 实现(构造器注入)
@RestResource
class UserPipelineResourceImpl @Autowired constructor(
private val pipelineService: PipelineService
) : UserPipelineResource04-frontend-vue-development05-go-agent-developmentdatabase-designcore/{service}/
├── api-{service}/ # API接口定义层 - 对外暴露服务契约
├── biz-{service}/ # 业务逻辑层 - 包含 Service、DAO
├── boot-{service}/ # Spring Boot启动层 - 独立部署单元
└── model-{service}/ # 数据模型层 - JOOQ 生成的数据库访问对象| 服务 | 职责 |
|---|---|
| project | 项目管理(所有模块基础依赖) |
| process | 流水线编排与调度(核心服务) |
| repository | 代码库管理 |
| artifactory | 制品库(对接 COS/S3) |
| store | 研发商店(插件、模板) |
| environment | 构建机/环境管理 |
| dispatch | 构建调度分发 |
| auth | 权限认证(RBAC) |
| ticket | 凭证管理 |
| log | 构建日志 |
| quality | 质量红线 |
| notify | 通知服务 |
| openapi | 对外 API |
| metrics | 度量服务 |
| websocket | WebSocket 服务 |
| misc | 杂项服务 |
| 前缀 | 用途 | 路径前缀 | 示例 |
|---|---|---|---|
| 用户 Web 交互 | | |
| 服务间内部调用 | | |
| 构建过程 Agent/Worker | | |
| 第三方 Agent 专用 | | |
| 对外开放(OpenAPI) | | |
| 运营管理接口 | | |
@RestResource // REST 资源实现类
@Path("/user/artifactories")
@GET / @POST / @PUT / @DELETE
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)@Tag(name = "USER_ARTIFACTORY", description = "版本仓库-仓库资源")
@Operation(summary = "根据元数据获取文件")
@Parameter(description = "用户ID", required = true)@BkField(minLength = 1, maxLength = 128)
@BkField(patternStyle = BkStyleEnum.CODE_STYLE)| 操作 | 命名前缀 |
|---|---|
| 查询 | |
| 创建 | |
| 修改 | |
| 删除 | |
build.gradle.ktsResult<T>