xyz.xuminghai.template

类 ReactiveClientTemplate

java.lang.Object

xyz.xuminghai.template.ReactiveClientTemplate

所有已实现的接口:

Executor

public class ReactiveClientTemplate
extends Object

2021/10/26 14:56 星期二
反应式的客户端模板，适用于直接返回http实体，这个模板下的方法是异步的，并不会直接得到结果

作者:

xuMingHai

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_TOP_DIRECTORY 阿里云盘默认的顶级目录

构造器概要

构造器

构造器和说明
ReactiveClientTemplate(Cache cache, ReactiveFileDao reactiveFileDao, ReactiveRecycleDao reactiveRecycleDao)

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>>	createFolder(CreateFolderRequest createFolderRequest) 创建文件夹
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>>	createFolder(String name) 创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录 详细的请求参数请参考：CreateFolderRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>>	createFolder(String name, CheckNameEnum checkNameEnum) 创建文件夹，在默认的顶级目录 详细的请求参数请参考：CreateFolderRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>>	createFolder(String parentFileId, String name) 创建文件夹，使用默认的同名策略，自动重命名 详细的请求参数请参考：CreateFolderRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>>	createFolder(String parentFileId, String name, CheckNameEnum checkNameEnum) 创建文件夹 详细的请求参数请参考：CreateFolderRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>>	downloadFile(String fileId, org.springframework.http.HttpHeaders httpHeaders) 下载文件，支持分段下载，断点续传
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>>	get(String fileId) 获取单个文件或文件夹的信息
Cache	getCache() 获取缓存实例
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<DownloadUrlResponse>>	getDownloadUrl(String fileId) 获取这个文件的下载参数
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>>	getImage(String fileId, boolean thumbnail) 获取图片资源
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<VideoPreviewPlayInfoResponse>>	getVideoPreviewPlayInfo(String fileId) 获取视频播放的预览信息
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<VideoPreviewPlayInfoResponse>>	getVideoPreviewPlayInfo(VideoPreviewPlayInfoRequest videoPreviewPlayInfoRequest) 获取视频播放的预览信息
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list() 获取顶级目录的文件列表 顶级目录：AbstractTemplate.DEFAULT_TOP_DIRECTORY
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list(ListRequest listRequest) 自定义请求参数的文件列表获取
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list(String folderId) 根据文件夹ID查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list(String folderId, OrderByEnum orderByEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list(String folderId, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>>	list(String folderId, OrderDirectionEnum orderDirectionEnum) 根据文件夹ID，查询这个文件夹下的文件信息 详细请求配置请参考：ListRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>>	palyVideo(URL url) 将原始的m3u8文件的ts文件相对地址改为绝对地址 480p 576p 被称为度SD(Standard Definition)（标清） 720p 被称为HD(High Definition)（高清） 1080p 被称为FHD(Full High Definition)（全高清） 4k 被称为UHD(Ultra High Definition)(超高答清)(或 4k UHD) 8k 被称为FUHD(Full Ultra High Definition)(8k超高清)(或 8k UHD)
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>>	search(SearchRequest searchRequest) 使用自定义的请求参数搜索文件
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>>	search(String fileName) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>>	search(String fileName, CategoryEnum categoryEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>>	search(String fileName, CategoryEnum categoryEnum, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>>	search(String fileName, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum) 根据文件名搜索文件 详细的请求配置请参考：SearchRequest
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<Void>>	trash(String fileId) 将文件或文件夹移入回收站
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>>	update(String fileId, String newFileName) 修改文件名或文件夹名
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>>	update(UpdateRequest updateRequest) 修改文件名或文件夹名
reactor.core.publisher.Mono<CreateFileResponse>	uploadFile(Path path) 上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）
reactor.core.publisher.Mono<CreateFileResponse>	uploadFile(Path path, CheckNameEnum checkNameEnum) 上传文件，使用默认的顶级目录（支持快传和分片上传）
reactor.core.publisher.Mono<CreateFileResponse>	uploadFile(String parentFileId, Path path) 上传文件，使用默认的同名策略（支持快传和分片上传）
reactor.core.publisher.Mono<CreateFileResponse>	uploadFile(String parentFileId, Path path, CheckNameEnum checkNameEnum) 上传文件（支持快传和分片上传）

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_TOP_DIRECTORY

public static final String DEFAULT_TOP_DIRECTORY

阿里云盘默认的顶级目录

另请参阅:

常量字段值

构造器详细资料

ReactiveClientTemplate

public ReactiveClientTemplate(Cache cache,
                              ReactiveFileDao reactiveFileDao,
                              ReactiveRecycleDao reactiveRecycleDao)

方法详细资料

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list()

获取顶级目录的文件列表
顶级目录：AbstractTemplate.DEFAULT_TOP_DIRECTORY

返回:

顶级目录下的文件列表

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list(String folderId)

根据文件夹ID查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

返回:

文件列表响应

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list(String folderId,
                                                                                               OrderByEnum orderByEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderByEnum - 根据什么排序，如名称、创建时间。。。

返回:

文件列表响应

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list(String folderId,
                                                                                               OrderDirectionEnum orderDirectionEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderDirectionEnum - 排序方向，升序排列或降序

返回:

文件列表响应

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list(String folderId,
                                                                                               OrderByEnum orderByEnum,
                                                                                               OrderDirectionEnum orderDirectionEnum)

根据文件夹ID，查询这个文件夹下的文件信息
详细请求配置请参考：ListRequest

参数:

folderId - 文件夹ID

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

文件列表响应

list

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ListResponse>> list(ListRequest listRequest)

自定义请求参数的文件列表获取

参数:

listRequest - 文件请求参数

返回:

文件列表响应

search

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>> search(String fileName)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

返回:

搜索响应结果。

search

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>> search(String fileName,
                                                                                                   CategoryEnum categoryEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

categoryEnum - 搜索的文件类型，如，图片、视频。。。

返回:

搜索响应结果。

search

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>> search(String fileName,
                                                                                                   OrderByEnum orderByEnum,
                                                                                                   OrderDirectionEnum orderDirectionEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

搜索响应结果。

search

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>> search(String fileName,
                                                                                                   CategoryEnum categoryEnum,
                                                                                                   OrderByEnum orderByEnum,
                                                                                                   OrderDirectionEnum orderDirectionEnum)

根据文件名搜索文件
详细的请求配置请参考：SearchRequest

参数:

fileName - 文件名

categoryEnum - 搜索的文件类型，如，图片、视频。。。

orderByEnum - 根据什么排序，如名称、创建时间。。。

orderDirectionEnum - 排序方向，升序排列或降序

返回:

搜索响应结果

search

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SearchResponse>> search(SearchRequest searchRequest)

使用自定义的请求参数搜索文件

参数:

searchRequest - 自定义搜索请求参数

返回:

搜索响应结果

get

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>> get(String fileId)

获取单个文件或文件夹的信息

参数:

fileId - 文件ID

返回:

文件信息（可以根据类型转为对应的子类）

getDownloadUrl

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<DownloadUrlResponse>> getDownloadUrl(String fileId)

获取这个文件的下载参数

参数:

fileId - 文件ID

返回:

这个文件的下载参数

downloadFile

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>> downloadFile(String fileId,
                                                                                                                               org.springframework.http.HttpHeaders httpHeaders)

下载文件，支持分段下载，断点续传

参数:

fileId - 文件ID

httpHeaders - 表示 HTTP 请求头

返回:

Http异步响应体

createFolder

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>> createFolder(String name)

创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录
详细的请求参数请参考：CreateFolderRequest

参数:

name - 文件夹名

返回:

响应信息

createFolder

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>> createFolder(String parentFileId,
                                                                                                               String name)

创建文件夹，使用默认的同名策略，自动重命名
详细的请求参数请参考：CreateFolderRequest

参数:

parentFileId - 父目录ID

name - 文件夹名

返回:

响应信息

createFolder

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>> createFolder(String name,
                                                                                                               CheckNameEnum checkNameEnum)

创建文件夹，在默认的顶级目录
详细的请求参数请参考：CreateFolderRequest

参数:

name - 文件夹名

checkNameEnum - 同名策略

返回:

响应信息

createFolder

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>> createFolder(String parentFileId,
                                                                                                               String name,
                                                                                                               CheckNameEnum checkNameEnum)

创建文件夹
详细的请求参数请参考：CreateFolderRequest

参数:

parentFileId - 父目录ID

name - 文件夹名

checkNameEnum - 同名策略

返回:

响应信息

createFolder

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreateFolderResponse>> createFolder(CreateFolderRequest createFolderRequest)

创建文件夹

参数:

createFolderRequest - 创建文件夹请求

返回:

响应信息

uploadFile

public reactor.core.publisher.Mono<CreateFileResponse> uploadFile(Path path)

上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）

参数:

path - 文件路径

返回:

响应信息

uploadFile

public reactor.core.publisher.Mono<CreateFileResponse> uploadFile(String parentFileId,
                                                                  Path path)

上传文件，使用默认的同名策略（支持快传和分片上传）

参数:

path - 文件路径

parentFileId - 父目录ID

返回:

响应信息

uploadFile

public reactor.core.publisher.Mono<CreateFileResponse> uploadFile(Path path,
                                                                  CheckNameEnum checkNameEnum)

上传文件，使用默认的顶级目录（支持快传和分片上传）

参数:

path - 文件路径

checkNameEnum - 同名策略

返回:

响应信息

uploadFile

public reactor.core.publisher.Mono<CreateFileResponse> uploadFile(String parentFileId,
                                                                  Path path,
                                                                  CheckNameEnum checkNameEnum)

上传文件（支持快传和分片上传）

参数:

path - 文件路径

parentFileId - 父目录ID

checkNameEnum - 同名策略

返回:

响应信息

update

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>> update(String fileId,
                                                                                             String newFileName)

修改文件名或文件夹名

参数:

fileId - 文件ID

newFileName - 新的文件名

返回:

响应信息

update

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<BaseItem>> update(UpdateRequest updateRequest)

修改文件名或文件夹名

参数:

updateRequest - 修改文件名请求参数

返回:

响应信息

trash

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<Void>> trash(String fileId)

将文件或文件夹移入回收站

参数:

fileId - 文件ID

返回:

响应信息

getVideoPreviewPlayInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<VideoPreviewPlayInfoResponse>> getVideoPreviewPlayInfo(VideoPreviewPlayInfoRequest videoPreviewPlayInfoRequest)

获取视频播放的预览信息

参数:

videoPreviewPlayInfoRequest - 请求体

返回:

返回的响应

getVideoPreviewPlayInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<VideoPreviewPlayInfoResponse>> getVideoPreviewPlayInfo(String fileId)

获取视频播放的预览信息

参数:

fileId - 文件ID

返回:

响应信息

palyVideo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>> palyVideo(URL url)

将原始的m3u8文件的ts文件相对地址改为绝对地址

  480p 576p 被称为度SD(Standard Definition)（标清）

  720p 被称为HD(High Definition)（高清）

  1080p 被称为FHD(Full High Definition)（全高清）

  4k 被称为UHD(Ultra High Definition)(超高答清)(或 4k UHD)

  8k 被称为FUHD(Full Ultra High Definition)(8k超高清)(或 8k UHD)
  

参数:

url - LiveTranscodingTask#getUrl()

返回:

处理后的m3u8文件

getImage

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>> getImage(String fileId,
                                                                                                                           boolean thumbnail)

获取图片资源

参数:

fileId - 文件ID

thumbnail - true使用缩略图的url，false使用原始图（ImageItem中的thumbnail缩略图）

返回:

图片资源

getCache

public Cache getCache()

获取缓存实例

返回:

缓存实例，如果没有开启缓存会返回空对象缓存