Skip to content

小工具开发文档

hippo otter 三黍定制版本: otter

前言

genostack平台的小工具模块，是为了将用户积累的脚本快速改造成可部署于k8s集群的一种解决方案。 该方案简化了开发人员实现整套web应用的步骤，以统一的风格让第三方使用者与公司积累的脚本进行交互。 目前小工具开发套件包含hippo(sdk)、otter(前端组件代码)两部分。使用此开发套件封装脚本或工具逻辑代码， 使开发人员无需关注平台订单，任务调度，日志收集等方面的问题，并且无需开发web页面。为方便开发人员使用， 本文档将迭代更新。

小工具分类

目前小工具分为任务式APP和常规APP。

使用hippo开发小工具，首先需要明确是否需要使用调度任务的功能。如果脚本或业务逻辑运行时间长、 消耗资源多(内存等)，建议使用任务框架调度任务，此时需要参考任务APP开发流程，否则参考常规APP开发流程。

为了方便开发，可以将`任务式APP`和`常规APP`的代码整理成模板项目。使用时只需要运行相关命令即可初始化项目。 本教程为了使开发人员更清楚目录结构和相关文件，将会从头开始构建。

开发步骤

小工具开发大致可分为如下几步：

  1. 准备开发环境
  2. 根据需要初始化项目(常规APP、任务APP)
  3. 开发业务代码
  4. 本地验证
  5. 构建docker镜像
  6. 测试环境使用该镜像部署
  7. 上线

快速开始教程将重点关注前4步,打包部署教程重点关注后3步。除此之外还将介绍项目参数配置、hippo工具类和API、otter界面配置等

另外，本教程将全程使用以下变量指代一些参数值

export PROJECT_PATH=/path/to/project    # 项目所在目录
export OTTER_VERSION=ST_20250604.1      # otter版本
export HIPPO_VERSION=2.2.11             # hippo版本
export CONDA_ENV_NAME=smalltool         # conda环境名称

mkdir -p ${PROJECT_PATH} && cd ${PROJECT_PATH} # 后续的所有操作都在该目录下进行
# 准备必要的目录结构
mkdir -p app/views/ms_jk
mkdir -p instance/log