文件存储 - 上传文件 - 《CUBA 框架开发者手册 Version 7.2》

3.9.8.1. 上传文件

3.9.8.1. 上传文件

通过使用FileUpload和FileMultiUpload组件可以将用户计算机上的文件上传到存储中。本手册中的相应组件说明以及加载和展示图片章节都提供了用法示例。

FileUpload 组件也可在即用型 FileUploadDialog 窗口中使用，这个窗口设计用来加载文件至临时存储。

临时客户端级存储（ FileUploadingAPI ）将临时文件存储在由cuba.tempDir应用程序属性定义的文件夹中。如果出现任何故障，临时文件还是保留在文件夹中。cuba_FileUploading bean 的 clearTempDirectory() 方法由cuba-web-spring.xml文件中定义的定时任务周期性调用来清理临时存储。

FileUploadDialog 对话框提供将文件上传到临时存储的基本功能。窗口包含了上传按钮和投放区域，可以支持从浏览器外拖拽文件至投放区进行上传。

此对话框是使用旧版的界面 API 实现，可以按照下面的方式使用：

@Inject
private Screens screens;
@Inject
private FileUploadingAPI fileUploadingAPI;
@Inject
private DataManager dataManager;
@Subscribe("showUploadDialogBtn")
protected void onShowUploadDialogBtnClick(Button.ClickEvent event) {
    FileUploadDialog dialog = (FileUploadDialog) screens.create("fileUploadDialog", OpenMode.DIALOG);
    dialog.addCloseWithCommitListener(() -> {
        UUID fileId = dialog.getFileId();
        String fileName = dialog.getFileName();
        File file = fileUploadingAPI.getFile(fileId); (1)
        FileDescriptor fileDescriptor = fileUploadingAPI.getFileDescriptor(fileId, fileName); (2)
        try {
            fileUploadingAPI.putFileIntoStorage(fileId, fileDescriptor); (3)
            dataManager.commit(fileDescriptor); (4)
        } catch (FileStorageException e) {
            throw new RuntimeException(e);
        }
    });
    screens.show(dialog);
}

1	- 获取 `java.io.File` 对象，此对象指向文件在 Web 客户端文件系统的位置。一般情况下，文件上传后回放到文件存储中，如果需要处理该文件，则需要获取 File 对象。
2	- 创建一个 `FileDescriptor` 实体。
3	- 上传文件至中间层的文件存储。
4	- 保存 `FileDescriptor` 实体。

在上传成功后，对话框使用 COMMIT_ACTION_ID 关闭。在 CloseWithCommitListener 监听器中，可以用 getFileId() 和 getFileName() 方法获取上传文件的 UUID 和名称。然后可以获取文件本身或者创建 FileDescriptor 对象并上传文件到文件存储，也可以实现其它的逻辑。