file-service

基于mu-ruby-template的微服务，用于上传和下载文件并存储其特定元数据。

教程

将file-service添加到栈中

在docker-compose.yml中添加以下片段以将文件服务包含到项目中：

yaml
file:
  image: semtech/mu-file-service:3.2.0
  links:
    - database:database
  volumes:
    - ./data/files:/share

接下来，在./config/dispatcher/dispatcher.ex中添加规则，将所有以/files/开头的请求分发到文件服务。例如：

elixir
  match "/files/*path" do
    forward conn, path, "[***]"
  end

转发URL中的主机file对应docker-compose.yml中文件服务的名称。

使用docker-compose up -d启动栈。文件服务将被创建。

有关如何设置mu.semte.ch项目的更多信息，请参见mu-project。

操作指南

如何在mu-cl-resources中配置文件资源

如果要在mu-cl-resources服务的领域中建模文件服务的文件，请在domain.lisp中添加以下内容：

lisp
(define-resource file ()
  :class (s-prefix "nfo:FileDataObject")
  :properties `((:name :string ,(s-prefix "nfo:fileName"))
                (:format :string ,(s-prefix "dct:format"))
                (:size :number ,(s-prefix "nfo:fileSize")))
  :has-one `((file :via ,(s-prefix "nie:dataSource")
                   :inverse t
                   :as "download"))
  :resource-base (s-url "[***]")
  :features `(include-uri)
  :on-path "files")

如何使用curl命令上传文件

假设mu-dispatcher在localhost:80上运行，可以使用以下命令执行文件上传：

bash
curl -i -X POST -H "Content-Type: multipart/form-data" -F "file=@/a/file.somewhere" http://localhost/files

如何从2.x升级到3.x版本的文件服务

要将文件服务从2.x升级到3.x，必须以SPARQL查询的形式执行迁移。

如果使用mu-migrations-service，请在迁移文件夹中添加以下SPARQL查询到*.sparql文件中。否则，直接对数据存储执行SPARQL查询。注意：这将不再支持2.x版本的文件服务！

PREFIX mu: <[***]>
PREFIX nfo: <[***]>
PREFIX nie: <[***]>
PREFIX dct: <[***]>
PREFIX dbpedia: <[***]>

WITH <[***]>
DELETE {
  ?uploadUri nfo:fileUrl ?fileUrl .
} INSERT {
  ?uploadUri dbpedia:fileExtension ?extension .
  ?fileUri a nfo:FileDataObject ;
    mu:uuid ?fileUuid ;
    nfo:fileName ?fileName ;
    dct:format ?format ;
    nfo:fileSize ?fileSize ;
    dbpedia:fileExtension ?extension ;
    dct:created ?created ;
    dct:modified ?modified ;
    nie:dataSource ?uploadUri .
} WHERE {
  ?uploadUri a nfo:FileDataObject ;
    nfo:fileName ?fileName ;
    dct:format ?format ;
    nfo:fileSize ?fileSize ;
    nfo:fileUrl ?fileUrl ;
    dct:created ?created ;
    dct:modified ?modified .

  OPTIONAL { ?fileUrl mu:uuid ?id }
  BIND(IF(BOUND(?id), ?id, STRUUID()) as ?fileUuid)

  BIND(IRI(REPLACE(STR(?fileUrl), "file:///data/", "share://")) as ?fileUri)

  BIND(STRAFTER(?fileName, ".") as ?extension)
}

参考

模型

!数据模型

本体和前缀

文件服务主要围绕Nepomuk文件本体构建。

文件

描述

文件服务在三元组存储中将上传的文件表示为两个资源：一个反映（虚拟）上传文件的资源，另一个反映存储在磁盘上的（物理）结果文件的资源。

存储文件的URI使用share://协议，并反映文件作为共享文件夹相对路径的位置。例如，share://uploads/my-file.pdf表示文件存储在/share/uploads/my-file.pdf。

类

nfo:FileDataObject

属性

配置

环境变量

以下设置可通过环境变量配置：

文件存储位置

默认情况下，文件服务将文件存储在挂载卷/share/的根目录中。可以通过MU_APPLICATION_FILE_STORAGE_PATH环境变量配置服务将文件存储在挂载的子文件夹中，该变量必须是Docker容器中/share/的相对路径。

例如：

yaml
file:
  image: semtech/mu-file-service:3.2.0
  links:
    - database:database
  environment:
    MU_APPLICATION_FILE_STORAGE_PATH: "my-project/uploads/"
  volumes:
    - ./data/my-project/uploads:/share/my-project/uploads

生成文件URI时将考虑子文件夹。使用上述配置的文件服务存储的文件URI将类似于share://my-project/uploads/example.pdf。

数据库连接

后端使用的三元组存储通过database链接到文件服务容器。如果通过MU_SPARQL_ENDPOINT配置了其他SPARQL端点URL，请相应更新链接名称。确保文件服务能够对该存储执行更新查询。

REST API

POST /files

上传文件。接受包含file参数的multipart/form-data，其中file参数包含要上传的文件。

响应

201 Created

上传成功，响应体中包含新创建的文件信息：

javascript
{
  "links": {
    "self": "files/b178ba66-206e-4551-b41e-4a46983912c0"
  },
  "data": {
    "type": "files",
    "id": "b178ba66-206e-4551-b41e-4a46983912c0",
    "attributes": {
        "name": "upload-name.pdf",
        "format": "application/pdf",
        "size": 1930,
        "extension": "pdf"
    }
  }
}

400 Bad Request

• 缺少file参数时。

GET /files/:id

获取指定ID文件的元数据。

响应

200 OK

返回指定ID文件的元数据：

javascript
{
  "links": {
    "self": "files/b178ba66-206e-4551-b41e-4a46983912c0"
  },
  "data": {
    "type": "files",
    "id": "b178ba66-206e-4551-b41e-4a46983912c0",
    "attributes": {
        "name": "upload-name.pdf",
        "format": "application/pdf",
        "size": 1930,
        "extension": "pdf"
    }
  }
}

404 Not Found

未找到指定ID的文件时。

GET /files/:id/download

下载指定ID文件的内容。

查询参数

• name（可选）：下载文件的名称（例如/files/1/download?name=report.pdf）

响应

200 OK

预期响应，返回文件。

404 Not Found

未找到指定ID的文件时。

500 Server Error

数据库中找到指定ID的文件，但磁盘上不存在。这很可能是服务器配置问题导致的。

DELETE /files/:id

删除指定ID的文件（元数据和内容）。

响应

204 No Content

删除成功时。