XiHan.Framework.ObjectStorage.FileSystem
5.0.0-preview.1
Prefix Reserved
This is a prerelease version of XiHan.Framework.ObjectStorage.FileSystem.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package XiHan.Framework.ObjectStorage.FileSystem --version 5.0.0-preview.1
NuGet\Install-Package XiHan.Framework.ObjectStorage.FileSystem -Version 5.0.0-preview.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XiHan.Framework.ObjectStorage.FileSystem" Version="5.0.0-preview.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XiHan.Framework.ObjectStorage.FileSystem" Version="5.0.0-preview.1" />
<PackageReference Include="XiHan.Framework.ObjectStorage.FileSystem" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XiHan.Framework.ObjectStorage.FileSystem --version 5.0.0-preview.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: XiHan.Framework.ObjectStorage.FileSystem, 5.0.0-preview.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XiHan.Framework.ObjectStorage.FileSystem@5.0.0-preview.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XiHan.Framework.ObjectStorage.FileSystem&version=5.0.0-preview.1&prerelease
#tool nuget:?package=XiHan.Framework.ObjectStorage.FileSystem&version=5.0.0-preview.1&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
XiHan.Framework.ObjectStorage.FileSystem
文件系统对象存储(Ring 3,默认实现,role: default)。提供 objectstorage.blob@1 与 objectstorage.multipart@1(RFC-0012);预签名地址装 Hosting.AspNetCore 的 HostedBlobUrlFeature 并 MapXiHanBlobs(),由宿主代收发。
builder.AddXiHan(xihan => xihan.UseFeature<FileSystemObjectStorageFeature>());
{ "XiHan": { "ObjectStorage": { "FileSystem": { "RootPath": "/var/lib/app/blobs", "MaxTotalBytes": 1073741824, "MaxBlobBytes": 268435456 } } } }
{ "XiHan": { "ObjectStorage": { "Stores": { "archive": { "Provider": "filesystem", "RootPath": "/var/lib/app/archive" } } } } }
规则
- 布局:
<RootPath>/<container>/data/<key>存内容,<RootPath>/<container>/meta/<key>.json存元数据;根目录默认<AppContext.BaseDirectory>/blobs;容器目录按需创建。 - 写入先落同目录的临时文件(名含
.xihan-tmp-),复制完成后原子替换,再写元数据;读取方要么看到旧对象要么看到完整的新对象。不覆盖的写入(含分片上传的完成)以不替换的移动原子占位:内容文件已存在即OBJECTSTORAGE_CONFLICT_001,并发的不覆盖写入(含共享目录的多个进程)只有一个成功,不会先查再写让后写的静默覆盖(ADR-0089)。ETag是内容的 SHA-256。 - 配额:
MaxTotalBytes(默认 1 GiB)与MaxBlobBytes(默认 256 MiB),复制过程中逐段检查,超限的项返回OBJECTSTORAGE_UNAVAILABLE_002且不留下内容。启动时扫描目录得到已用量并清理残留临时文件,之后在进程内计量;多进程共享同一目录时配额只是近似。 - 列举:遍历容器目录、序数排序、按前缀过滤,续页标记是上一页最后一个键;元数据缺失(外部直接放进目录的文件)按文件信息补一份;文件名还原出的键不符合键文法的(含保留前缀
.xihan下的,ADR-0090)跳过。 - 范围读取(ADR-0049):打开内容文件后定位到起点,只交出该段。
- 分片上传:每次上传一个目录
<container>/uploads/<上传标识>/,manifest.json记键与写入选项,分片文件名带编号与内容的 SHA-256(同一编号重传先落新文件再删旧的);完成时按清单拼接成对象同目录的临时文件再原子替换,计入配额后删掉上传目录。暂存的分片不计入配额,单片与拼接后的对象受MaxBlobBytes约束;MultipartExpiryHours(默认 168)之前发起、仍未完成的上传在启动扫描时清掉。上传标识只认本实现发出的 32 位小写十六进制。 - 健康项
objectstorage.filesystem.capacity(存储自己实现,同步计算):已用量达到MaxTotalBytes即 Degraded(OBJECTSTORAGE_UNAVAILABLE_002,消息键objectstorage.quota.reached),否则 Ready。 - 命名实例(ADR-0050):特性总是登记 Provider
FileSystemBlobStoreProvider(名filesystem)——能力全部被 S3 等存储顶替时经IShadowAwareFeature.ConfigureShadowed只登记它,不读本配置节、不建缺省实例、不启动(ADR-0075);设置的键同本配置节,RootPath必填(不给就会和缺省实例落到同一目录),未知键报错;建出时即建目录并扫描用量,探测同上面的健康项口径。预签名用宿主签名器的ForStore(name)。 - 缺省实例的一致性(ADR-0075、ADR-0082):缺省的
IBlobStore、IBlobMultipartStore、IBlobUrlSigner必须落在同一存储上,只约束被要求的契约(有特性依赖,或XiHan:Providers/UseProvider指定)。存储包被要求提供分片上传或预签名却没被选为对象存储时,装配抛出OBJECTSTORAGE_VALIDATION_004(BlobStoreSelection.ProvidesDefaultInstance),应用启动失败;只是兜底选出的不失败,那个存储包按被顶替处理。与 S3 混装、以文件系统为缺省实例时指定XiHan:Providers:objectstorage.blob=xihan.objectstorage.filesystem即可;要缺省的分片上传再把objectstorage.multipart指定给本包,要缺省的预签名装配HostedBlobUrlFeature并把objectstorage.presign设为xihan.hosting.blob-urls。
依赖方向
依赖 XiHan.Framework.ObjectStorage.Abstractions。
状态
P3:可用,通过 ObjectStorage.Conformance(BlobStoreConformance 与 BlobStoreProviderConformance)。
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.14)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.14)
- Microsoft.Extensions.Diagnostics.Abstractions (>= 10.0.14)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.14)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.14)
- Microsoft.Extensions.Options (>= 10.0.14)
- System.Threading.RateLimiting (>= 10.0.14)
- XiHan.Framework.ObjectStorage.Abstractions (>= 5.0.0-preview.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on XiHan.Framework.ObjectStorage.FileSystem:
| Package | Downloads |
|---|---|
|
XiHan.Framework.Profiles.Full
曦寒框架 Full 组合包 |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 5.0.0-preview.2 | 0 | 11/6/2026 |
| 5.0.0-preview.1 | 40 | 11/4/2026 |