tinystruct 开发模式指南

tinystruct 开发模式指南 是做什么的？

使用 tinystruct Java 框架构建模块的架构与实现模式。tinystruct 是一个轻量、高性能的框架，将 CLI 和 HTTP 视为平等的公民，无需编写 main() 方法，也无需大量配置。

核心理念

CLI 和 HTTP 是平等的公民。 每个使用 @Action 注解的方法，理想情况下都应该能够无需修改地在终端和 Web 浏览器中运行。这种“双模式”能力是 tinystruct 的核心设计哲学。

何时激活

适用场景

• 通过扩展 AbstractApplication 创建新的 Application 模块。
• 使用 @Action 定义路由和命令行操作。
• 通过 Context 处理每次请求的状态。
• 使用原生 Builder 和 Builders 组件执行 JSON 序列化。
• 通过 AbstractData POJO 进行数据库持久化操作。
• 使用 generate 命令从数据库表生成 POJO。
• 实现服务器推送事件 (SSE) 以进行实时推送。
• 通过 multipart 数据处理文件上传。
• 使用 URLRequest 和 HTTPHandler 发起出站 HTTP 请求。
• 在 application.properties 中配置数据库连接或系统设置。
• 调试路由冲突（Actions）或 CLI 参数解析。

工作原理

tinystruct 框架将任何带有 @Action 注解的方法视为终端和 Web 环境下的可路由端点。通过扩展 AbstractApplication 创建应用程序，它提供核心生命周期钩子（如 init()）以及对请求 Context 的访问。

路由由 ActionRegistry 处理，它会自动将路径段映射到方法参数并注入依赖。对于纯数据服务，应使用原生 Builder 和 Builders 组件进行 JSON 序列化，以保持零依赖的足迹。数据库层使用 AbstractData POJO 配合 XML 映射文件，无需外部 ORM 库即可完成 CRUD 操作。

示例

基本应用 (MyService)

public class MyService extends AbstractApplication {
    @Override
    public void init() {
        this.setTemplateRequired(false); // 为数据/API 应用禁用 .view 查找
    }

    @Override public String version() { return "1.0.0"; }

    @Action("greet")
    public String greet() {
        return "Hello from tinystruct!";
    }

    // 路径参数: GET /?q=greet/James  或者  bin/dispatcher greet/James
    @Action("greet")
    public String greet(String name) {
        return "Hello, " + name + "!";
    }
}

HTTP 模式消歧 (login)

@Action(value = "login", mode = Mode.HTTP_POST)
public String doLogin(Request<?, ?> request) throws ApplicationException {
    request.getSession().setAttribute("userId", "42");
    return "Logged in";
}

原生 JSON 数据处理 (Builder + Builders)

import org.tinystruct.data.component.Builder;
import org.tinystruct.data.component.Builders;

@Action("api/data")
public String getData() throws ApplicationException {
    Builders dataList = new Builders();
    Builder item = new Builder();
    item.put("id", 1);
    item.put("name", "James");
    dataList.add(item);

    Builder response = new Builder();
    response.put("status", "success");
    response.put("data", dataList);
    return response.toString(); // {"status":"success","data":[{"id":1,"name":"James"}]}
}

SSE (服务器推送事件)

import org.tinystruct.http.SSEPushManager;

@Action("sse/connect")
public String connect() {
    return "{\"type\":\"connect\",\"message\":\"Connected to SSE\"}";
}

// 推送给特定客户端
String sessionId = getContext().getId();
Builder msg = new Builder();
msg.put("text", "Hello, user!");
SSEPushManager.getInstance().push(sessionId, msg);

// 广播给所有
SSEPushManager.getInstance().broadcast(msg);

文件上传

import org.tinystruct.data.FileEntity;

@Action(value = "upload", mode = Mode.HTTP_POST)
public String upload(Request<?, ?> request) throws ApplicationException {
    List<FileEntity> files = request.getAttachments();
    if (files != null) {
        for (FileEntity file : files) {
            System.out.println("Uploaded: " + file.getFilename());
        }
    }
    return "Upload OK";
}

MCP 服务器与工具集成

tinystruct 从 SDK 版本 1.7.26 开始原生支持模型上下文协议 (MCP)。 MCP API（例如 org.tinystruct.mcp.MCPTool、org.tinystruct.mcp.MCPServer、org.tinystruct.mcp.MCPException）直接包含在核心依赖中：

<dependency>
    <groupId>org.tinystruct</groupId>
    <artifactId>tinystruct</artifactId>
    <version>1.7.26</version>
</dependency>

安全警告（提示注入）： 工具返回值会直接反馈到 AI 模型的上下文窗口中。在将调用者提供的参数包含到工具返回字符串之前，必须进行验证和清理。未能清理输入可能允许攻击者注入对抗性指令（提示注入），从而覆盖模型的行为。始终验证长度、字符集和空值。

创建 MCP 工具：

1. 扩展 org.tinystruct.mcp.MCPTool。
2. 使用 @Action 注解操作，并通过 arguments 数组中的 @Argument 声明参数。
3. 接受与 @Argument 中键匹配的显式方法参数作为参数。（不要使用 getContext().getAttribute(...) 来获取工具参数）。

import org.tinystruct.mcp.MCPTool;
import org.tinystruct.mcp.MCPException;
import org.tinystruct.system.annotation.Action;
import org.tinystruct.system.annotation.Argument;

public class MyCustomTool extends MCPTool {
    public MyCustomTool() {
        super("custom", "A custom tool for demonstrating MCP");
    }

    @Action(
        value = "custom/hello",
        description = "Say hello to someone",
        arguments = {
            @Argument(key = "name", description = "The name to greet", type = "string", optional = false)
        }
    )
    public String hello(String name) throws MCPException {
        // 安全：在返回给模型之前验证/清理工具输入
        // 以防止提示注入漏洞。
        if (name == null || name.length() > 50 || !name.matches("^[a-zA-Z0-9 ]+$")) {
            throw new MCPException("提供的名称无效");
        }
        return "Hello, " + name + "!";
    }
}

部署 MCP 服务器：

1. 扩展 org.tinystruct.mcp.MCPServer。
2. 重写 init() 并使用 this.registerTool() 注册你的工具。框架会自动扫描并映射 @Action 方法。

import org.tinystruct.mcp.MCPServer;

public class MyMCPServer extends MCPServer {
    @Override
    public void init() {
        super.init();
        this.registerTool(new MyCustomTool());
    }

    @Override
    public String version() {
        return "1.0.0";
    }
}

通过调度器运行服务器：

bin/dispatcher start --import org.tinystruct.system.HttpServer --import com.example.MyMCPServer

配置

设置项在 src/main/resources/application.properties 中管理。

# 数据库
driver=org.h2.Driver
database.url=jdbc:h2:~/mydb
database.user=sa
database.password=

# 服务器
default.home.page=hello
server.port=8080

# 区域设置
default.language=en_US

# 会话（集群环境使用 Redis）
# default.session.repository=org.tinystruct.http.RedisSessionRepository
# redis.host=127.0.0.1
# redis.port=6379

在应用中访问配置值：

String port = this.getConfiguration("server.port");

红旗与反模式

症状	正确模式
导入 com.google.gson 或 com.fasterxml.jackson	使用 org.tinystruct.data.component.Builder / Builders。
使用 List<Builder> 表示 JSON 数组	使用 Builders 以避免泛型类型擦除问题。
ApplicationRuntimeException: template not found	在仅 API 的应用的 init() 中调用 setTemplateRequired(false)。
使用 @Action 注解 private 方法	操作必须是 public 才能被框架注册。
在应用中硬编码 main(String[] args)	对所有模块使用 bin/dispatcher 作为入口点。
手动注册 ActionRegistry	更倾向于使用 @Action 注解进行自动发现。
运行时找不到操作	确保类通过 --import 导入或在 application.properties 中列出。
CLI 参数不可见	使用 --key value 传递；通过 getContext().getAttribute("--key") 访问。
两个方法相同路径，错误的方法被触发	设置明确的 mode（例如 HTTP_GET 与 HTTP_POST）以消除歧义。

最佳实践

1. 粒度化应用：将逻辑拆分成更小、更专注的应用，而不是一个庞大的类。
2. 在 init() 中设置：利用 init() 进行设置（配置、数据库），而不是在构造函数中。不要调用 setAction() — 使用 @Action 注解。
3. 模式感知：使用 @Action 中的 Mode 参数将敏感操作限制为仅 CLI 或特定 HTTP 方法。
4. 优先使用 Context 而非参数：对于可选的 CLI 标志，使用 getContext().getAttribute("--flag")，而不是向方法签名添加参数。
5. 异步事件：对于由事件触发的繁重任务，在事件处理程序内部使用 CompletableFuture.runAsync()。

技术参考

详细指南位于 references/ 目录：

• 架构与配置 — 抽象、包映射、属性
• 路由与 @Action — 注解详情、模式、参数
• 数据处理 — Builder、Builders、JSON 序列化与解析
• 数据库持久化 — AbstractData POJO、CRUD、映射 XML、POJO 生成
• 系统与使用 — Context、会话、SSE、文件上传、事件、网络
• 测试模式 — JUnit 5 单元测试和 HTTP 集成测试

参考源文件（内部）

• src/main/java/org/tinystruct/AbstractApplication.java — 带有生命周期钩子的核心基类
• src/main/java/org/tinystruct/system/annotation/Action.java — 注解与模式
• src/main/java/org/tinystruct/application/ActionRegistry.java — 路由引擎
• src/main/java/org/tinystruct/data/component/Builder.java — JSON 对象序列化器
• src/main/java/org/tinystruct/data/component/Builders.java — JSON 数组序列化器
• src/main/java/org/tinystruct/data/component/AbstractData.java — 带有 CRUD 的基础 POJO 类
• src/main/java/org/tinystruct/data/Mapping.java — 映射 XML 解析器
• src/main/java/org/tinystruct/data/tools/MySQLGenerator.java — POJO 生成器参考
• src/main/java/org/tinystruct/data/component/FieldType.java — SQL 到 Java 的类型映射
• src/main/java/org/tinystruct/data/component/Condition.java — 流式 SQL 查询构建器
• src/main/java/org/tinystruct/http/SSEPushManager.java — SSE 连接管理
• src/test/java/org/tinystruct/application/ActionRegistryTest.java — 注册表测试示例
• src/test/java/org/tinystruct/system/HttpServerHttpModeTest.java — HTTP 集成测试模式