com.publiccms.common.tools

类 CmsFileUtils

java.lang.Object

com.publiccms.common.tools.CmsFileUtils

public class CmsFileUtils
extends java.lang.Object

CmsFileUtils 文件操作组件

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsFileUtils.FileInfo FileInfo 文件信息封装类
static class	CmsFileUtils.FileInfoComparator
static class	CmsFileUtils.FileReplaceResult FileSearchResult 文件查找结果
static class	CmsFileUtils.FileSearchResult FileSearchResult 文件查找结果

字段概要

字段

限定符和类型	字段和说明
static java.lang.String[]	ALLOW_FILES
static java.lang.String[]	AUDIO_FILE_SUFFIXS
private static CmsFileUtils.FileInfoComparator	CREATEDATE_COMPARATOR
static java.lang.String[]	DOCUMENT_FILE_SUFFIXS
static java.lang.String	FILE_TYPE_AUDIO
static java.lang.String	FILE_TYPE_DOCUMENT
static java.lang.String	FILE_TYPE_IMAGE
static java.lang.String	FILE_TYPE_OTHER
static java.lang.String	FILE_TYPE_PDF
static java.lang.String	FILE_TYPE_VIDEO
private static CmsFileUtils.FileInfoComparator	FILENAME_COMPARATOR
private static CmsFileUtils.FileInfoComparator	FILESIZE_COMPARATOR
static java.lang.String	HEADERS_SEND_APACHE
static java.lang.String	HEADERS_SEND_CTRL
static java.lang.String	HEADERS_SEND_NGINX
static java.lang.String[]	IMAGE_FILE_SUFFIXS
static java.util.List<java.lang.String>	IMAGE_FILE_SUFFIXS_LIST
static java.lang.String[]	IMAGE_FILETYPES
private static CmsFileUtils.FileInfoComparator	MODIFIEDDATE_COMPARATOR
static java.lang.String	NGINX_PRIVATEFILE_PREFIX
static java.lang.String	ORDERFIELD_CREATEDATE
static java.lang.String	ORDERFIELD_FILENAME
static java.lang.String	ORDERFIELD_FILESIZE
static java.lang.String	ORDERFIELD_MODIFIEDDATE
static java.lang.String[]	OTHER_FILE_SUFFIXS
static java.lang.String[]	OTHER_FILETYPES
static java.lang.String	UPLOAD_PATH
static java.lang.String	USER_PRIVATE_PATH
static java.lang.String[]	VIDEO_FILE_SUFFIXS
static java.lang.String[]	VIDEO_FILETYPES

构造器概要

构造器

限定符	构造器和说明
private	CmsFileUtils()

方法概要

限定符和类型	方法和说明
static void	copyFileToFile(java.lang.String source, java.lang.String destination)
static void	copyFileToOutputStream(java.lang.String filepath, java.io.OutputStream outputStream)
static void	copyInputStreamToFile(java.io.InputStream source, java.lang.String destination)
static boolean	createFile(java.lang.String filepath, java.lang.String content) 写入文件
static boolean	delete(java.lang.String filepath) 移动文件或目录
static boolean	exists(java.lang.String filepath)
static java.lang.String	getFileContent(java.lang.String filepath) 获取文件内容
static java.util.List<CmsFileUtils.FileInfo>	getFileList(java.lang.String dirPath, boolean useFilter, java.lang.String orderField) 获取目录下文件列表
static java.util.List<CmsFileUtils.FileInfo>	getFileList(java.lang.String dirPath, java.lang.String orderField) 获取目录下文件列表
static java.lang.String	getFileName(java.lang.String filePath) 获取文件名
private static FileUploadResult	getFileSize(java.io.File file, java.lang.String filename, java.lang.String suffix)
static FileUploadResult	getFileSize(java.lang.String filepath, java.lang.String filename, java.lang.String suffix)
static java.lang.String	getFileType(java.lang.String suffix)
static java.lang.String	getPrivateFileSignString(long expiry, java.lang.String filepath) 获取私有文件前面字符串
static java.lang.String	getSafeFileName(java.lang.String path)
static java.lang.String	getSuffix(java.lang.String originalFilename) 获取文件后缀
static java.lang.String	getUploadFileName(java.lang.String suffix) 获取文件名
static java.lang.String	getUserPrivateFileName(long userId, java.lang.String filepath) 获取用户私有文件名
static boolean	isDirectory(java.lang.String filepath)
static boolean	isFile(java.lang.String filepath)
private static boolean	isSafe(java.util.List<org.apache.pdfbox.cos.COSObject> pdfObjects)
static boolean	isSafe(java.lang.String filepath, java.lang.String suffix) 获取文件内容
static void	mkdirs(java.lang.String filepath)
static void	mkdirsParent(java.lang.String filepath)
static boolean	moveFile(java.lang.String filepath, java.lang.String backupFilePath) 移动文件或目录
static void	replaceFileList(java.lang.String dirPath, java.util.List<CmsFileUtils.FileReplaceResult> fileList, java.lang.String word, java.lang.String replace) 获取目录下文件列表
private static void	searchFileList(java.nio.file.Path dirPath, java.lang.String parentPath, java.lang.String word, java.util.List<CmsFileUtils.FileSearchResult> fileList) 获取目录下文件列表
static java.util.List<CmsFileUtils.FileSearchResult>	searchFileList(java.lang.String dirPath, java.lang.String parentPath, java.lang.String word) 获取目录下文件列表
static boolean	updateFile(java.lang.String filepath, java.lang.String historyFilePath, java.lang.String content) 修改文件内容
static java.lang.String	upload(byte[] data, java.lang.String fileName) 上传文件
static java.lang.String	upload(byte[] data, java.lang.String fileName, java.lang.String originalName, java.lang.String metadataPath) 上传文件
static java.nio.file.Path	upload(org.springframework.web.multipart.MultipartFile file, java.lang.String fileName) 上传文件
static void	writeByteArrayToFile(java.lang.String filepath, byte[] data)

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

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

字段详细资料

UPLOAD_PATH

public static final java.lang.String UPLOAD_PATH

另请参阅:

常量字段值

USER_PRIVATE_PATH

public static final java.lang.String USER_PRIVATE_PATH

另请参阅:

常量字段值

HEADERS_SEND_CTRL

public static final java.lang.String HEADERS_SEND_CTRL

另请参阅:

常量字段值

HEADERS_SEND_NGINX

public static final java.lang.String HEADERS_SEND_NGINX

另请参阅:

常量字段值

HEADERS_SEND_APACHE

public static final java.lang.String HEADERS_SEND_APACHE

另请参阅:

常量字段值

NGINX_PRIVATEFILE_PREFIX

public static final java.lang.String NGINX_PRIVATEFILE_PREFIX

另请参阅:

常量字段值

ORDERFIELD_FILENAME

public static final java.lang.String ORDERFIELD_FILENAME

另请参阅:

常量字段值

ORDERFIELD_FILESIZE

public static final java.lang.String ORDERFIELD_FILESIZE

另请参阅:

常量字段值

ORDERFIELD_CREATEDATE

public static final java.lang.String ORDERFIELD_CREATEDATE

另请参阅:

常量字段值

ORDERFIELD_MODIFIEDDATE

public static final java.lang.String ORDERFIELD_MODIFIEDDATE

另请参阅:

常量字段值

FILENAME_COMPARATOR

private static final CmsFileUtils.FileInfoComparator FILENAME_COMPARATOR

FILESIZE_COMPARATOR

private static final CmsFileUtils.FileInfoComparator FILESIZE_COMPARATOR

CREATEDATE_COMPARATOR

private static final CmsFileUtils.FileInfoComparator CREATEDATE_COMPARATOR

MODIFIEDDATE_COMPARATOR

private static final CmsFileUtils.FileInfoComparator MODIFIEDDATE_COMPARATOR

IMAGE_FILE_SUFFIXS_LIST

public static final java.util.List<java.lang.String> IMAGE_FILE_SUFFIXS_LIST

AUDIO_FILE_SUFFIXS

public static final java.lang.String[] AUDIO_FILE_SUFFIXS

IMAGE_FILE_SUFFIXS

public static final java.lang.String[] IMAGE_FILE_SUFFIXS

DOCUMENT_FILE_SUFFIXS

public static final java.lang.String[] DOCUMENT_FILE_SUFFIXS

VIDEO_FILE_SUFFIXS

public static final java.lang.String[] VIDEO_FILE_SUFFIXS

OTHER_FILE_SUFFIXS

public static final java.lang.String[] OTHER_FILE_SUFFIXS

ALLOW_FILES

public static final java.lang.String[] ALLOW_FILES

IMAGE_FILETYPES

public static final java.lang.String[] IMAGE_FILETYPES

OTHER_FILETYPES

public static final java.lang.String[] OTHER_FILETYPES

VIDEO_FILETYPES

public static final java.lang.String[] VIDEO_FILETYPES

FILE_TYPE_IMAGE

public static final java.lang.String FILE_TYPE_IMAGE

另请参阅:

常量字段值

FILE_TYPE_VIDEO

public static final java.lang.String FILE_TYPE_VIDEO

另请参阅:

常量字段值

FILE_TYPE_DOCUMENT

public static final java.lang.String FILE_TYPE_DOCUMENT

另请参阅:

常量字段值

FILE_TYPE_AUDIO

public static final java.lang.String FILE_TYPE_AUDIO

另请参阅:

常量字段值

FILE_TYPE_OTHER

public static final java.lang.String FILE_TYPE_OTHER

另请参阅:

常量字段值

FILE_TYPE_PDF

public static final java.lang.String FILE_TYPE_PDF

另请参阅:

常量字段值

构造器详细资料

CmsFileUtils

private CmsFileUtils()

方法详细资料

getFileList

public static java.util.List<CmsFileUtils.FileInfo> getFileList(java.lang.String dirPath,
                                                                java.lang.String orderField)

获取目录下文件列表

参数:

dirPath -

orderField -

返回:

file info list

searchFileList

public static java.util.List<CmsFileUtils.FileSearchResult> searchFileList(java.lang.String dirPath,
                                                                           java.lang.String parentPath,
                                                                           java.lang.String word)

获取目录下文件列表

参数:

dirPath -

parentPath -

word -

返回:

file result list

replaceFileList

public static void replaceFileList(java.lang.String dirPath,
                                   java.util.List<CmsFileUtils.FileReplaceResult> fileList,
                                   java.lang.String word,
                                   java.lang.String replace)

获取目录下文件列表

参数:

dirPath -

fileList -

word -

replace -

searchFileList

private static void searchFileList(java.nio.file.Path dirPath,
                                   java.lang.String parentPath,
                                   java.lang.String word,
                                   java.util.List<CmsFileUtils.FileSearchResult> fileList)

获取目录下文件列表

参数:

dirPath -

parentPath -

word -

fileList -

getFileList

public static java.util.List<CmsFileUtils.FileInfo> getFileList(java.lang.String dirPath,
                                                                boolean useFilter,
                                                                java.lang.String orderField)

获取目录下文件列表

参数:

dirPath -

useFilter -

orderField -

返回:

file info list

writeByteArrayToFile

public static void writeByteArrayToFile(java.lang.String filepath,
                                        byte[] data)
                                 throws java.io.IOException

参数:

filepath -

data -

抛出:

java.io.IOException

getFileSize

public static FileUploadResult getFileSize(java.lang.String filepath,
                                           java.lang.String filename,
                                           java.lang.String suffix)

参数:

filepath -

filename -

suffix -

返回:

uploadResult

getFileSize

private static FileUploadResult getFileSize(java.io.File file,
                                            java.lang.String filename,
                                            java.lang.String suffix)

参数:

file -

suffix -

返回:

uploadResult

copyInputStreamToFile

public static void copyInputStreamToFile(java.io.InputStream source,
                                         java.lang.String destination)
                                  throws java.io.IOException

参数:

source -

destination -

抛出:

java.io.IOException

copyFileToFile

public static void copyFileToFile(java.lang.String source,
                                  java.lang.String destination)
                           throws java.io.IOException

参数:

source -

destination -

抛出:

java.io.IOException

copyFileToOutputStream

public static void copyFileToOutputStream(java.lang.String filepath,
                                          java.io.OutputStream outputStream)
                                   throws java.io.IOException

参数:

filepath -

outputStream -

抛出:

java.io.IOException

mkdirs

public static void mkdirs(java.lang.String filepath)

参数:

filepath -

mkdirsParent

public static void mkdirsParent(java.lang.String filepath)

参数:

filepath -

isDirectory

public static boolean isDirectory(java.lang.String filepath)

参数:

filepath -

返回:

isFile

public static boolean isFile(java.lang.String filepath)

参数:

filepath -

返回:

exists

public static boolean exists(java.lang.String filepath)

参数:

filepath -

返回:

createFile

public static boolean createFile(java.lang.String filepath,
                                 java.lang.String content)
                          throws java.io.IOException

写入文件

参数:

filepath -

content -

返回:

whether to create successfully

抛出:

java.io.IOException

moveFile

public static boolean moveFile(java.lang.String filepath,
                               java.lang.String backupFilePath)

移动文件或目录

参数:

filepath -

backupFilePath -

返回:

whether to move successfully

getSafeFileName

public static java.lang.String getSafeFileName(java.lang.String path)

参数:

path -

返回:

safe file path

delete

public static boolean delete(java.lang.String filepath)

移动文件或目录

参数:

filepath -

返回:

whether to move successfully

updateFile

public static boolean updateFile(java.lang.String filepath,
                                 java.lang.String historyFilePath,
                                 java.lang.String content)
                          throws java.io.IOException

修改文件内容

参数:

filepath -

historyFilePath -

content -

返回:

whether to modify successfully

抛出:

java.io.IOException

isSafe

public static boolean isSafe(java.lang.String filepath,
                             java.lang.String suffix)

获取文件内容

参数:

filepath -

suffix -

返回:

is safe

isSafe

private static boolean isSafe(java.util.List<org.apache.pdfbox.cos.COSObject> pdfObjects)

getFileContent

public static java.lang.String getFileContent(java.lang.String filepath)

获取文件内容

参数:

filepath -

返回:

file content

getUploadFileName

public static java.lang.String getUploadFileName(java.lang.String suffix)

获取文件名

参数:

suffix -

返回:

upload file name

getPrivateFileSignString

public static java.lang.String getPrivateFileSignString(long expiry,
                                                        java.lang.String filepath)

获取私有文件前面字符串

参数:

expiry -

filepath -

返回:

avatar file name

getUserPrivateFileName

public static java.lang.String getUserPrivateFileName(long userId,
                                                      java.lang.String filepath)

获取用户私有文件名

参数:

userId -

filepath -

返回:

user private file name

getFileName

public static java.lang.String getFileName(java.lang.String filePath)

获取文件名

参数:

filePath -

返回:

suffix

getSuffix

public static java.lang.String getSuffix(java.lang.String originalFilename)

获取文件后缀

参数:

originalFilename -

返回:

suffix

getFileType

public static java.lang.String getFileType(java.lang.String suffix)

upload

public static java.lang.String upload(byte[] data,
                                      java.lang.String fileName)
                               throws java.lang.IllegalStateException,
                                      java.io.IOException

上传文件

参数:

data -

fileName -

返回:

file name

抛出:

java.lang.IllegalStateException

java.io.IOException

upload

public static java.lang.String upload(byte[] data,
                                      java.lang.String fileName,
                                      java.lang.String originalName,
                                      java.lang.String metadataPath)
                               throws java.lang.IllegalStateException,
                                      java.io.IOException

上传文件

参数:

data -

fileName -

originalName -

metadataPath -

返回:

file name

抛出:

java.lang.IllegalStateException

java.io.IOException

upload

public static java.nio.file.Path upload(org.springframework.web.multipart.MultipartFile file,
                                        java.lang.String fileName)
                                 throws java.io.IOException

上传文件

参数:

file -

fileName -

返回:

file name

抛出:

java.io.IOException