cad项目接口

This commit is contained in:
lxp
2026-11-03 15:11:51 +08:00
parent 8f0214a64e
commit c5be9835bf
3 changed files with 331 additions and 0 deletions
+46
View File
@@ -0,0 +1,46 @@
# CAD 工作空间建表 SQL
在启用 CAD 接口前,由运维在现有 `vibemake` 数据库手工执行以下 SQL(MySQL 8.0.13+)。应用不自动建表,不修改现有项目表。所有业务时间按上海时间写入。
`id` 和归属外键仅供服务内部使用,对外使用 `cad_project_code` 和 `upload_code`。两张表与 Git 项目无关联。上线顺序:执行 SQL → 部署后端 → 配置并验证 CAD 私有 OSS → 开放前端入口。回滚代码时保留两张表和 OSS 对象。
```sql
CREATE TABLE cad_project (
id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部主键,不对外返回',
cad_project_code VARCHAR(32) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT 'CAD项目唯一业务编码',
owner_user_id BIGINT NOT NULL COMMENT '所属用户内部主键,关联sys_user.id',
name VARCHAR(100) NOT NULL COMMENT 'CAD项目名称',
description VARCHAR(2000) NOT NULL DEFAULT '' COMMENT 'CAD项目描述',
document_object_key VARCHAR(512) CHARACTER SET ascii COLLATE ascii_bin NOT NULL DEFAULT '' COMMENT '当前原生设计文件的私有OSS对象键',
file_name VARCHAR(255) NOT NULL DEFAULT '' COMMENT '当前原生设计文件名称',
size_bytes BIGINT NOT NULL DEFAULT 0 COMMENT '当前设计文件大小,单位字节',
version BIGINT NOT NULL DEFAULT 0 COMMENT '当前保存版本,空项目为0,每次成功保存递增',
saved_at DATETIME(3) NULL COMMENT '最近成功保存设计文件的上海时间',
deleted TINYINT NOT NULL DEFAULT 0 COMMENT '逻辑删除标记,0未删除,1已删除',
created_at DATETIME(3) NOT NULL COMMENT '项目创建上海时间',
updated_at DATETIME(3) NOT NULL COMMENT '项目信息最近更新上海时间',
PRIMARY KEY (id),
UNIQUE KEY uk_cad_project_code (cad_project_code),
KEY idx_cad_project_owner_list (owner_user_id, deleted, updated_at, id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='CAD个人工作空间项目';
CREATE TABLE cad_project_upload (
id BIGINT NOT NULL AUTO_INCREMENT COMMENT '内部主键,不对外返回',
upload_code VARCHAR(32) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT '上传批次唯一业务编码',
cad_project_id BIGINT NOT NULL COMMENT '所属CAD项目内部主键,关联cad_project.id',
expected_version BIGINT NOT NULL COMMENT '签发上传时的项目基础版本,用于并发保存校验',
object_key VARCHAR(512) CHARACTER SET ascii COLLATE ascii_bin NOT NULL COMMENT '本批次不可覆盖的私有OSS对象键',
file_name VARCHAR(255) NOT NULL COMMENT '本批次原生设计文件名称',
size_bytes BIGINT NOT NULL COMMENT '本批次声明的文件大小,单位字节',
expires_at DATETIME(3) NOT NULL COMMENT '未确认批次的截止上海时间,与上传签名一致',
saved_version BIGINT NULL COMMENT '确认成功的版本号,空值表示尚未确认',
saved_at DATETIME(3) NULL COMMENT '首次确认成功上海时间,重复确认返回原值',
created_at DATETIME(3) NOT NULL COMMENT '批次创建上海时间',
updated_at DATETIME(3) NOT NULL COMMENT '批次最近更新上海时间',
PRIMARY KEY (id),
UNIQUE KEY uk_cad_upload_code (upload_code),
KEY idx_cad_upload_project (cad_project_id, created_at)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='CAD设计文件上传与保存确认批次';
```
保存事务锁定当前用户的未删除项目和对应批次,按 `expected_version` 条件更新当前对象键和版本,同时写入批次回执。失败整体回滚。重放已确认批次只返回首次确认的版本和时间,不重新绑定旧对象;项目删除后仍拒绝重放。首期不清理上传批次或旧 OSS 对象,不提供历史恢复接口。
+120
View File
@@ -0,0 +1,120 @@
# CAD 个人工作空间前端对接
CAD 与 Vibemake 共用 `/api/auth/login`、`/api/auth/logout` 和 `/api/users/me`,使用同一个 `Authorization: Bearer <平台 token>`。CAD 工作空间独立于现有 `/api/workspace/projects`,不创建 Git 仓库、不自动发布社区。只支持当前用户的单个自包含原生 `.sc` 设计文件,不管理外部引用的多文件装配。
通用响应、上海时间格式、分页和跨域规则沿用 [Vibemake 接入约定](vibemake-api.md#接入约定)。CAD 所有接口返回 `Cache-Control: no-store`。业务编码为不透明字符串,不使用数据库 ID。
## 接口与数据
下表前缀为 `/api/cad/workspace/projects`。全部需要登录,成功均为 HTTP 200,JSON 为 `{code,message,data,requestId}`。
| 方法 | 相对路径 | 请求 | 成功 data |
| --- | --- | --- | --- |
| GET | 空 | `page=1&size=20&keyword=名称` | 项目分页 |
| POST | 空 | `{name,description?}` | 项目 |
| GET | `/{cadProjectCode}` | 无 | 项目 |
| PATCH | `/{cadProjectCode}` | `{name?,description?}` | 项目 |
| DELETE | `/{cadProjectCode}` | 无 | null |
| POST | `/{cadProjectCode}/uploads/signature` | `{fileName,sizeBytes,expectedVersion}` | 上传签名 |
| PUT | `/{cadProjectCode}/document` | `{uploadCode}` | 保存回执 |
| GET | `/{cadProjectCode}/document` | 无 | 文件读取信息 |
名称必填,去除首尾空白后 1~100 字符;描述最多 2000 字符,新建时默认空字符串。PATCH 省略或 null 表示保留,描述传 `""` 可清空,至少提供一个非 null 字段。
项目:
```ts
interface CadProject {
cadProjectCode: string;
name: string;
description: string;
hasDocument: boolean;
version: number;
fileName: string;
sizeBytes: number;
savedAt: string | null;
createdAt: string;
updatedAt: string;
}
interface CadUploadSignature {
uploadCode: string;
uploadUrl: string;
formFields: Record<string, string>;
expiresAt: string;
}
interface CadSaveResult {
cadProjectCode: string;
version: number;
savedAt: string;
}
interface CadDocument {
downloadUrl: string;
expiresAt: string;
version: number;
fileName: string;
sizeBytes: number;
}
```
新项目 `hasDocument=false、version=0、fileName=""、sizeBytes=0、savedAt=null`。列表只包含本人未删除项目,按最近更新时间倒序;支持名称包含搜索。`page` 为 1~100000,`size` 为 1~100,默认 20,返回 `{items,page,size,total}`。同名项目允许存在。改名不改变文件保存版本。
## 保存和重新打开
1. 新设计首次保存先创建项目,保留返回的 `cadProjectCode` 和 `version=0`。
2. 使用 SolidCraft 原生序列化生成完整 `.sc`,不能仅上传 STL、STEP、GLB 或显示网格;原生文件保留参数及可编辑设计。需要由前端接通原生文件导出和导入桥接,当前本机/浏览器保存不等于云端保存。
3. 文件名须为不含路径和控制字符的 `.sc` 名称,最多 255 字符。文件非空,默认上限 268435456 字节(256 MiB)。`sizeBytes` 和 `expectedVersion` 必须是 JSON 整数,不接受字符串或小数。
4. 申请签名,将 `formFields` 全部原样写入 FormData,最后追加 `file`,POST 到 `uploadUrl`。不携带平台 Authorization,不手写 multipart Content-Type。OSS 成功为 HTTP 200,无需解析 JSON。
5. 上传完成后提交原 `uploadCode` 确认。后端核验对象大小、批次归属、截止时间和基础版本,成功才更新当前设计引用,并返回新版本。
6. 只有确认成功才显示云端已保存;序列化期间及上传期间又产生的修改仍应标为未保存。每个项目前端串行执行云端保存。
7. 打开项目先读详情;空项目进入新设计,否则 GET `document`,fetch `downloadUrl` 得到原始文件字节并交给 SolidCraft 打开。**本次编辑基础版本使用 `document.version`**,文件与版本来自同一快照,不混用先前详情中的版本。
上传签名默认 15 分钟,未确认批次同一时刻过期;文件上传完成但确认已过期时,重新申请批次。下载地址默认 5 分钟,用完即丢弃,不存为永久地址;过期时重新调用 API 获取。业务时间为上海时间字符串,无时区后缀,解析时补 `+08:00`。
相同 `uploadCode` 重复确认返回首次保存回执,不重复增加版本。即使之后已有更新版本,重试旧批次也不会恢复旧文件;回执版本可能小于最新项目版本,需要时重新读取详情。网络超时先保留原批次并重试确认,不直接创建新项目或新批次。OSS 同一对象禁止覆盖,OSS 上传超时先尝试确认,缺文件再处理上传,不无条件重复上传。
两个标签页使用相同基础版本保存时,只有一个成功,另一个收到 `CAD_VERSION_CONFLICT`。保留本地修改并提供重新打开最新设计、下载本地副本或另存新项目的处理入口;不能只换成最新版本号后自动覆盖。
离开、切换项目、退出登录前提示未保存修改。401 后保留设计并引导重新登录,重新登录后核对当前账号和项目归属再继续保存。推荐部署同源的可编辑 SolidCraft 构建;iframe 跨源集成如使用 postMessage,须校验 source 和精确 origin,平台 Token 不放 URL。现有 `?embed` 会关闭浏览器持久化等能力,不能直接充当云端保存桥接。
## 错误处理
| HTTP / code | 处理 |
| --- | --- |
| 400 `BAD_REQUEST` / `CAD_INVALID_FILE` | 校验名称、描述、文件和整数参数 |
| 401 `UNAUTHORIZED` | 保留本地修改,恢复登录 |
| 404 `NOT_FOUND` | 非本人、不存在或已删除的项目/批次,停止对此项目保存 |
| 404 `CAD_DOCUMENT_NOT_FOUND` | 空项目尚未保存文件 |
| 409 `CAD_VERSION_CONFLICT` | 保留修改,处理并发冲突 |
| 409 `CAD_FILE_MISSING` | 尚未上传完整,检查 OSS 上传结果后重试确认 |
| 409 `CAD_FILE_SIZE_MISMATCH` | 当前文件不变,重新申请并上传正确文件 |
| 409 `CAD_UPLOAD_EXPIRED` | 重新申请上传批次 |
| 413 `CAD_FILE_TOO_LARGE` / `REQUEST_TOO_LARGE` | 文件超限或 JSON 超限,调整请求 |
| 429 `RATE_LIMITED` | 按 Retry-After 等待后重试 |
| 502 `CAD_OSS_ERROR` | 保留当前设计及批次,稍后重试 |
| 503 `CAD_STORAGE_UNAVAILABLE` / `CAD_STORAGE_UNSAFE` | 存储未开启或配置不符合要求,联系管理员 |
| 503 `CAD_CODE_BUSY` / `REDIS_UNAVAILABLE` | 暂时无法处理,保留输入后重试 |
删除为逻辑删除,之后列表、详情、读取、编辑及保存确认均不可访问,不提供恢复;已签发的 OSS 下载链接在到期前仍可能使用。上传失败、替换、删除均保留旧 OSS 对象,首期没有历史恢复和对象自动清理。
## 部署配置
先手工执行 [CAD 建表 SQL](cad-database.md),再部署后端。CAD 业务接口随应用部署可用,文件存储默认关闭;配置以下变量后开启。
| 变量 | 默认值 / 要求 |
| --- | --- |
| `CAD_OSS_ENABLED` | false,配置齐全后设为 true |
| `CAD_OSS_REGION` | cn-beijing |
| `CAD_OSS_ENDPOINT` | 可选,HTTPS OSS Endpoint;不填写时按地域生成 |
| `CAD_OSS_BUCKET` | 必填,必须独立于现有公开资源 Bucket |
| `CAD_OSS_ACCESS_KEY_ID` / `CAD_OSS_ACCESS_KEY_SECRET` | 专用 RAM 凭据,通过部署环境注入 |
| `CAD_OSS_ROOT_DIRECTORY` | 沿用本环境资源根目录(test 为 vibemake_dev,prod 为 vibemake) |
| `CAD_MAX_FILE_BYTES` | 268435456;配置范围为 1 字节至 OSS 表单上限 5 GiB,需同时兼容编辑器读取上限 |
| `CAD_UPLOAD_VALIDITY` / `CAD_DOWNLOAD_VALIDITY` | 15m / 5m;范围 1 秒至 7 天 |
| `RATE_CAD_CREATE_PER_MINUTE` / `RATE_CAD_SIGN_PER_MINUTE` | 5 / 20,按当前用户独立限流 |
| `RATE_CAD_SAVE_PER_MINUTE` / `RATE_CAD_READ_PER_MINUTE` | 30 / 60,保存确认和下载签名尝试次数 |
Bucket ACL 必须 private,不能存在公共读取策略,建议开启阻止公共访问;必须从未开启版本控制(Off,Suspended 也不允许)。RAM 需要根目录 `cad-projects/*` 的 `oss:PutObject`、`oss:PutObjectAcl`、`oss:GetObject`,以及 Bucket 的 `oss:GetBucketAcl`、`oss:GetBucketPolicyStatus`、`oss:GetBucketVersioning`。后端只读取这些配置,不修改 Bucket。不要给前端 RAM 密钥。
上传策略精确绑定对象键、大小、MIME、Content-Disposition、private ACL 和禁止覆盖;后端在签发上传/下载时检查 Bucket ACL、策略及版本控制。相关行为依据 [OSS PostObject 官方文档](https://www.alibabacloud.com/help/en/oss/developer-reference/postobject);版本控制开启或暂停时,OSS 会忽略禁止覆盖参数,因此部署要求 Off。
OSS CORS 允许真实编辑器来源的 POST、GET,允许 Content-Type;需要时暴露 Content-Length 和 Content-Disposition。直传和文件下载不携带平台 Token。生产联调须验证:匿名 GET 原对象被拒绝、有效签名能读取、过期签名不能读取、同对象二次上传被拒绝,以及完整原生设计保存后能恢复编辑。API 自动化使用存储替身,不能替代真实 Bucket 的这些验证。
@@ -0,0 +1,165 @@
package com.linkerbot.vibemake.service.cad;
import static org.assertj.core.api.Assertions.*;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.linkerbot.vibemake.common.BusinessException;
import com.linkerbot.vibemake.service.config.CadProperties;
import com.linkerbot.vibemake.service.config.OssProperties;
import com.linkerbot.vibemake.service.support.ProjectSupport;
import jakarta.validation.Validation;
import jakarta.validation.ValidatorFactory;
import java.net.URI;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Base64;
import org.junit.jupiter.api.*;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
class AliyunCadObjectStoreTest {
private final ObjectMapper json = new ObjectMapper();
private final CadProperties properties = new CadProperties();
private final OssProperties publicOss = new OssProperties();
private final OSS sdk = mock(OSS.class);
private AliyunCadObjectStore storage;
@BeforeEach
void setup() {
OssProperties oss = properties.getOss();
oss.setEnabled(true);
oss.setRegion("cn-beijing");
oss.setBucket("cad-private-test");
oss.setAccessKeyId("TestKey");
oss.setAccessKeySecret("test-secret");
oss.setRootDirectory("vibemake_dev");
publicOss.setBucket("public-resources");
AccessControlList acl = new AccessControlList();
acl.setCannedACL(CannedAccessControlList.Private);
when(sdk.getBucketAcl("cad-private-test")).thenReturn(acl);
when(sdk.getBucketPolicyStatus("cad-private-test")).thenReturn(new GetBucketPolicyStatusResult());
when(sdk.getBucketVersioning("cad-private-test")).thenReturn(new BucketVersioningConfiguration());
storage = new AliyunCadObjectStore(properties, publicOss, json, sdk);
}
@Test
void uploadPolicyBindsPrivateAclExactObjectSizeAndForbidsOverwrite() throws Exception {
CadObjectStore.SignedUpload result = storage.signUpload("vibemake_dev/cad-projects/code/batch/design.sc",
"支架.sc", 1234, Duration.ofMinutes(15));
assertThat(result.uploadUrl()).isEqualTo("https://cad-private-test.oss-cn-beijing.aliyuncs.com");
assertThat(result.formFields()).containsEntry("x-oss-object-acl", "private")
.containsEntry("x-oss-forbid-overwrite", "true")
.containsEntry("x-oss-content-type", "application/octet-stream");
JsonNode policy = json.readTree(Base64.getDecoder().decode(result.formFields().get("policy")));
assertThat(policy.path("conditions").toString()).contains(
"[\"eq\",\"$x-oss-object-acl\",\"private\"]",
"[\"eq\",\"$x-oss-forbid-overwrite\",\"true\"]",
"[\"content-length-range\",1234,1234]",
"[\"eq\",\"$key\",\"vibemake_dev/cad-projects/code/batch/design.sc\"]",
"[\"eq\",\"$Content-Disposition\"");
assertThat(result.expiresAt()).isBetween(ProjectSupport.now().plusMinutes(14), ProjectSupport.now().plusMinutes(16));
}
@Test
void downloadUsesRealSdkV4SignerWithPrivateCacheAndOriginalFileName() throws Exception {
ClientBuilderConfiguration configuration = new ClientBuilderConfiguration();
configuration.setSignatureVersion(SignVersion.V4);
OSS realSigner = OSSClientBuilder.create().endpoint(properties.getOss().resolvedEndpoint())
.region("cn-beijing").credentialsProvider(new DefaultCredentialProvider("TestKey", "test-secret"))
.clientConfiguration(configuration).build();
try {
// 实际执行 SDK 的本地签名算法,不发网络请求。
when(sdk.generatePresignedUrl(any(GeneratePresignedUrlRequest.class)))
.thenAnswer(invocation -> realSigner.generatePresignedUrl(invocation.getArgument(0, GeneratePresignedUrlRequest.class)));
CadObjectStore.SignedDownload result = storage.signDownload("vibemake_dev/cad-projects/code/batch/design.sc", "支架.sc", Duration.ofMinutes(5));
URI url = URI.create(result.downloadUrl());
assertThat(url.getScheme()).isEqualTo("https");
assertThat(url.getHost()).isEqualTo("cad-private-test.oss-cn-beijing.aliyuncs.com");
String query = URLDecoder.decode(url.getRawQuery(), StandardCharsets.UTF_8);
assertThat(query).contains("x-oss-signature-version=OSS4-HMAC-SHA256",
"response-cache-control=private, no-store", "response-content-disposition=attachment", "x-oss-signature=")
.containsPattern("x-oss-expires=(299|300)(?:&|$)");
assertThat(result.expiresAt()).isBetween(ProjectSupport.now().plusMinutes(4), ProjectSupport.now().plusMinutes(6));
} finally {
realSigner.shutdown();
}
}
@Test
void rejectsPublicAclAndPublicPolicyInsteadOfReturningCredentials() {
AccessControlList acl = new AccessControlList();
acl.setCannedACL(CannedAccessControlList.PublicRead);
when(sdk.getBucketAcl("cad-private-test")).thenReturn(acl);
assertUnsafe(() -> storage.signUpload("key", "x.sc", 1, Duration.ofMinutes(15)));
acl.setCannedACL(CannedAccessControlList.Private);
GetBucketPolicyStatusResult policy = new GetBucketPolicyStatusResult();
policy.setPublic(true);
when(sdk.getBucketPolicyStatus("cad-private-test")).thenReturn(policy);
assertUnsafe(() -> storage.signDownload("key", "x.sc", Duration.ofMinutes(5)));
verify(sdk, never()).generatePresignedUrl(any(GeneratePresignedUrlRequest.class));
}
@ParameterizedTest
@ValueSource(strings = {"Enabled", "Suspended"})
void rejectsVersioningThatWouldAllowOverwritingAlreadySavedObjects(String status) {
when(sdk.getBucketVersioning("cad-private-test")).thenReturn(new BucketVersioningConfiguration(status));
assertUnsafe(() -> storage.signUpload("key", "x.sc", 1, Duration.ofMinutes(15)));
assertUnsafe(() -> storage.signDownload("key", "x.sc", Duration.ofMinutes(5)));
}
@Test
void requiresDistinctBucketAndExplicitlyEnabledStorage() {
publicOss.setBucket("cad-private-test");
assertUnsafe(() -> storage.signUpload("key", "x.sc", 1, Duration.ofMinutes(15)));
properties.getOss().setEnabled(false);
assertThatThrownBy(() -> storage.signDownload("key", "x.sc", Duration.ofMinutes(5)))
.isInstanceOfSatisfying(BusinessException.class, error -> assertThat(error.code()).isEqualTo("CAD_STORAGE_UNAVAILABLE"));
verifyNoInteractions(sdk);
}
@Test
void missingObjectAndTransportErrorsHaveStableCodes() {
OSSException missing = new OSSException("not found", "NoSuchKey", "request-test", "host", null, null, null);
when(sdk.getObjectMetadata("cad-private-test", "key")).thenThrow(missing);
assertThatThrownBy(() -> storage.size("key")).isInstanceOfSatisfying(BusinessException.class,
error -> assertThat(error.code()).isEqualTo("CAD_FILE_MISSING"));
doThrow(new ClientException("network")).when(sdk).getObjectMetadata("cad-private-test", "key");
assertThatThrownBy(() -> storage.size("key")).isInstanceOfSatisfying(BusinessException.class,
error -> assertThat(error.code()).isEqualTo("CAD_OSS_ERROR"));
when(sdk.getBucketAcl("cad-private-test")).thenThrow(new OSSException("denied"));
assertThatThrownBy(() -> storage.signUpload("key", "x.sc", 1, Duration.ofMinutes(15)))
.isInstanceOfSatisfying(BusinessException.class, error -> assertThat(error.status()).isEqualTo(502));
}
@Test
void validatesNestedCredentialsSizeAndSignatureValidity() {
try (ValidatorFactory factory = Validation.buildDefaultValidatorFactory()) {
assertThat(factory.getValidator().validate(properties)).isEmpty();
properties.getOss().setAccessKeySecret("");
assertThat(factory.getValidator().validate(properties)).isNotEmpty();
properties.getOss().setEnabled(false);
assertThat(factory.getValidator().validate(properties)).isEmpty();
properties.setUploadValidity(Duration.ZERO);
assertThat(factory.getValidator().validate(properties)).isNotEmpty();
properties.setUploadValidity(Duration.ofMinutes(15));
properties.setDownloadValidity(Duration.ofDays(8));
assertThat(factory.getValidator().validate(properties)).isNotEmpty();
properties.setDownloadValidity(Duration.ofMinutes(5));
properties.setMaxFileBytes(5368709121L);
assertThat(factory.getValidator().validate(properties)).isNotEmpty();
}
}
private void assertUnsafe(org.assertj.core.api.ThrowableAssert.ThrowingCallable action) {
assertThatThrownBy(action).isInstanceOfSatisfying(BusinessException.class,
error -> assertThat(error.code()).isEqualTo("CAD_STORAGE_UNSAFE"));
}
}