EOS8

# com.eos.foundation.common.utils.FileUtil

# 构件包说明

本工具类实现了对文件的操作处理。

# 运算逻辑构件使用说明

该构件包包含以下构件：

序号 方法 功能描述
1 copyDir(String srcDirPath, String destDirPath) 复制目录下的内容到指定目录路径
2 copyDirToDir(String srcDirPath, String destDirPath) 复制整个目录到指定目录
3 copyFile(String srcFilePath, String destFilePath) 复制文件到指定文件路径
4 copyFilesByFilter(String srcDirPath, String destDirPath, String ignoreFileSuffixes) 复制满足条件的文件到指定目录路径
5 copyFileToDir(String srcFilePath, String destDirPath) 复制文件到指定文件目录
6 copyLargeFile(String srcFilePath, String destFilePath) 复制大文件（超过2G）至指定文件路径
7 copyLargeFileToDir(String srcFilePath, String destDirPath) 复制大文件（超过2G）至指定目录路径
8 delete(String path) 删除指定路径的内容，指定路径可以是文件或目录
9 deleteDir(String dirPath) 删除指定文件夹
10 deleteFile(String filePath) 删除指定文件
11 deleteFilesByFilter(String dirPath, String ignoreFileSuffixes) 删除满足条件的文件
12 listFilesByFilter(String dirPath, String ignoreFileSuffixes) 列出目录中满足条件的文件名称
13 moveDir(String srcDirPath, String destDirPath) 移动目录下的内容到指定目录路径
14 moveDirToDir(String srcDirPath, String destDirPath) 移动整个目录到指定目录
15 moveFilesByFilter(String srcDirPath, String destDirPath, String ignoreFileSuffixes) 移动满足条件的文件到指定目录
16 moveFileToDir(String srcFilePath, String destDirPath) 移动文件到指定目录
17 readFile(String filePath, String encoding) 把文件读成字符串
18 renameFile(String filePath, String newFileName) 重命名文件
19 smartCopyFile(String srcFilePath, String destPath) 复制文件到指定路径，指定路径可以是文件或目录
20 writeFile(String filePath, String data, String encoding) 把字符串写成文件

# copyDir：复制目录下的内容到指定目录路径

# 【功能说明】

复制目录下的内容到指定目录路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径
  1. 抛出异常说明
    • 如果srcDirPath不是目录或者不存在会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录会抛出EOSRuntimeException异常，不存在则会自动创建。
  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的所有文件复制到另一个目录下。

  • 场景描述 需要复制文件夹时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String src_DirPath 变量 传引用
参数 destDirPath String dest_DirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/to</dest_DirPath>
        <src_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/from</src_DirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# copyDirToDir：复制整个目录到指定目录

# 【功能说明】

复制整个目录到指定目录，被复制的目录将作为目标目录的子目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyDirToDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径

  1. 抛出异常说明

    • 如果srcDirPath不是目录或者不存在会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 与copyDir (opens new window)不同的是，copyDirToDir会将源文件夹作为目标文件夹的子文件夹。

# 【参考案例】

示例：将一个目录复制到另外一个目录下，作为子目录。

  • 场景描述 需要复制文件夹时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String src_DirPath 变量 传引用
参数 destDirPath String dest_DirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/to</dest_DirPath>
        <src_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/from</src_DirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# copyFile：复制文件到指定文件路径

# 【功能说明】

复制文件到指定文件路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destFilePath String 目标文件路径

  1. 抛出异常说明

    • 如果srcFilePath没有指定文件或者指定文件不存在会抛出EOSRuntimeException异常。
    • destFilePath为目标文件路径，如果该文件路径不存在，则会抛出EOSRuntimeException异常，如果路径中所包含文件名不存在，则会自动创建，如果该文件已经存在，则覆盖原文件。

  2. 规则说明 无。

# 【参考案例】

示例：将目录下的"a.txt"文件复制到目标目录下，并且重命名为"aaa.txt"。

  • 场景描述 需要复制文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String src_file 变量 传引用
参数 destFilePath String dest_file 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/to/aaa.txt</dest_DirPath>
        <src_DirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
               default\work\user\com.primeton.eos.foundation.example\com\primeton\eos\foundation\
               example\FileUtil/from/a.txt</src_DirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# copyFilesByFilter：复制满足条件的文件到指定目录路径

# 【功能说明】

复制满足条件的文件到指定目录路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyFilesByFilter，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径
参数 ignoreFileSuffixes String 忽略的文件后缀，多个之间用英文','分割。

  1. 抛出异常说明

    • 如果srcDirPath不是目录或者不存在会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 ignoreFileSuffixes忽略的文件后缀，多个之间用英文','分割。源文件夹路径下的子目录不被复制。

# 【参考案例】

示例：将一个目录下的 不是以.txt .xml .bmp结尾 的文件复制到另一个目录下。

  • 场景描述 需要复制文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String src_dir 变量 传引用
参数 destDirPath String dest_dir 变量 传引用
参数 ignoreFileSuffixes String suffix 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_dir __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/to</dest_dir>
        <src_dir __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                 default\work\user\com.primeton.eos.foundation.example\
                 com\primeton\eos\foundation\example\FileUtil/from</src_dir>
        <suffix __type="java:java.lang.String">.txt,.xml,.bmp</suffix>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# copyFileToDir：复制文件到指定文件目录

# 【功能说明】

复制文件到指定文件目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyFileToDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destDirPath String 目标文件夹

  1. 抛出异常说明

    • 如果srcFilePath不是文件或者不存在会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的"a.txt"文件复制到目标目录下。

  • 场景描述 需要复制文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String src_file 变量 传引用
参数 destDirPath String dest_dir 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_dir __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/to</dest_dir>
        <src_file __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/from/a.txt</src_file>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前

# copyLargeFile：复制大文件（超过2G）至指定文件路径

# 【功能说明】

复制大文件（超过2G）至指定文件路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyLargeFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destFilePath String 目标文件路径

  1. 抛出异常说明

    • 如果srcFilePath不是文件或者不存在会抛出EOSRuntimeException异常。
    • 如果destFilePath不是文件会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 如果文件小于2G，则等同于copyFile (opens new window)。

# 【参考案例】

示例：将一个目录下的"a.txt"文件复制到另一个目录下，并且重命名为"aaa.txt"。

  • 场景描述 需要复制大文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String src_file 变量 传引用
参数 destFilePath String dest_file 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_file __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                   default\work\user\com.primeton.eos.foundation.example\
                   com\primeton\eos\foundation\example\FileUtil/to/aaa.txt</dest_file>
        <src_file __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/from/a.txt</src_file>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# copyLargeFileToDir：复制大文件（超过2G）至指定目录路径

# 【功能说明】

复制大文件（超过2G）至指定目录路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.copyLargeFileToDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destDirPath String 目标文件夹

  1. 抛出异常说明

    • 如果srcFilePath不是文件或者不存在会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下"a.zip"文件复制到另一个目录下。

  • 场景描述 需要复制大文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String src_file 变量 传引用
参数 destDirPath String dest_dir 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <dest_dir __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/to</dest_dir>
        <src_file __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                  default\work\user\com.primeton.eos.foundation.example\
                  com\primeton\eos\foundation\example\FileUtil/from/a.zip</src_file>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# delete：删除指定路径（文件或目录）的内容

# 【功能说明】

删除指定路径的内容，指定路径可以是文件或目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.delete，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 path String 指定路径

  1. 抛出异常说明 无。

  2. 规则说明 无。

# 【参考案例】

示例：删除一个目录。

  • 场景描述 需要删除文件或目录时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 path String destDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# deleteDir：删除指定文件夹

# 【功能说明】

删除指定路径的内容，指定路径只能是目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.deleteDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 dirPath String 指定路径

  1. 抛出异常说明 如果dirPath不是一个目录会抛出EOSRuntimeException异常。

  2. 规则说明 无。

# 【参考案例】

示例：删除一个目录。

  • 场景描述 需要删除目录时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 dirPath String destDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# deleteFile：删除指定文件

# 【功能说明】

删除指定路径的文件。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.deleteFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 filePath String 指定路径

  1. 抛出异常说明 如果filePath不是一个文件则会抛出EOSRuntimeException异常。

  2. 规则说明 无。

# 【参考案例】

示例：将目录下的"a.txt"文件删除。

  • 场景描述 需要删除文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 filePath String destFilePath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                      default\work\user\com.primeton.eos.foundation.example\com\primeton\
                      eos\foundation\example\FileUtil/to/a.txt</destFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# deleteFilesByFilter：删除满足条件的文件

# 【功能说明】

删除满足条件的文件。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.deleteFilesByFilter，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 dirPath String 指定路径
参数 ignoreFileSuffixes String 忽略的文件后缀，多个之间用英文','分割

  1. 抛出异常说明 如果dirPath不是目录则会抛出EOSRuntimeException异常。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的 不是以.txt .xml .bmp结尾 的文件删除。

  • 场景描述 需要删除文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 dirPath String destDirPath 变量 传引用
参数 ignorFileSuffixes String suffix 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <suffix __type="java:java.lang.String">.txt,.xml,.bmp</suffix>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# listFilesByFilter：列出目录中满足条件的文件名称

# 【功能说明】

列出目录中满足条件的文件名称。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.listFilesByFilter，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 dirPath String 源文件夹路径
参数 ignoreFileSuffixes String 忽略的文件后缀，多个之间用英文','分割
返回值 out0 String[] 满足条件的文件名称列表

  1. 抛出异常说明 如果dirPath不是目录或者不存在则会抛出EOSRuntimeException异常。

  2. 规则说明 ignoreFileSuffixes为忽略的文件后缀，多个之间用英文','分割。

# 【参考案例】

示例：将一个目录下的 不是以.txt .xml .bmp结尾 的文件名称列出。

  • 场景描述 需要获取特殊类型的文件列表时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 dirPath String srcDirPath 变量 传引用
参数 ignoreFileSuffixes String suffix 变量 传引用
返回值 out0 String[] files 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <srcDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                    default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from</srcDirPath>
        <suffix __type="java:java.lang.String">.txt,.xml,.bmp</suffix>
    </__root>
</bizContext>
  • 调用后的bizContext
<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <files __id="1" __type="java:[Ljava.lang.String;">
            <__entry __index="0" __type="java:java.lang.String">a.zip</__entry>
            <__entry __index="1" __type="java:java.lang.String">b.doc</__entry>
            <__entry __index="2" __type="java:java.lang.String">c1.xml.bak</__entry>
        </files>
        <srcDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                    default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from</srcDirPath>
        <suffix __type="java:java.lang.String">.txt,.xml,.bmp</suffix>
    </__root>
</bizContext>

# moveDir：移动目录下的内容到指定目录路径(同时删除源目录)

# 【功能说明】

移动目录下的内容到指定目录路径(同时删除源目录)。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.moveDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径

  1. 抛出异常说明

    • 如果srcDirPath不是目录或者不存在则会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录则会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的文件移动到另一个目录下。

  • 场景描述 需要移动文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String movedDirPath 变量 传引用
参数 distDirPath String distDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <movedDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                      default\work\user\com.primeton.eos.foundation.example\
                      com\primeton\eos\foundation\example\FileUtil/moved</movedDirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# moveDirToDir：移动整个目录到指定目录

# 【功能说明】

移动整个目录到指定目录，被移动的目录将作为目标目录的子目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.moveDirToDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径

  1. 抛出异常说明

    • 如果srcDirPath不是目录或者不存在则会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录则会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 与moveDir (opens new window)不同的是，moveDirToDir会将源文件夹作为目标文件夹的子文件夹。

# 【参考案例】

示例：将一个目录移动到到另一个目录下作为子目录。

  • 场景描述 需要移动文件夹时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String movedDirPath 变量 传引用
参数 distDirPath String distDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <movedDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                      default\work\user\com.primeton.eos.foundation.example\
                      com\primeton\eos\foundation\example\FileUtil/moved</movedDirPath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# moveFilesByFilter：移动满足条件的文件到指定目录

# 【功能说明】

移动满足条件的文件到指定目录路径。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.moveFilesByFilter，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcDirPath String 源文件夹路径
参数 destDirPath String 目标文件夹路径
参数 ignoreFileSuffixes String 忽略的文件后缀，多个之间用英文','分割

  1. 抛出异常说明

    • 如果srcDirPath不是目录或者不存在则会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录则会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 ignoreFileSuffixes为忽略的文件后缀，多个之间用英文','分割。

# 【参考案例】

示例：将一个目录下的 不是以.txt .xml .bmp结尾 的文件移动到另一个目录下。

  • 场景描述 需要移动文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcDirPath String movedDirPath 变量 传引用
参数 distDirPath String distDirPath 变量 传引用
参数 ignoreFileSuffixes String suffix 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <movedDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                      default\work\user\com.primeton.eos.foundation.example\
                      com\primeton\eos\foundation\example\FileUtil/moved</movedDirPath>
        <suffix __type="java:java.lang.String">.txt,.xml,.bmp</suffix>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# moveFileToDir：移动文件到指定目录

# 【功能说明】

移动文件到指定目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.moveFileToDir，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destDirPath String 目标文件夹路径

  1. 抛出异常说明

    • 如果srcDirPath不是文件或者不存在则会抛出EOSRuntimeException异常。
    • 如果destDirPath不是目录则会抛出EOSRuntimeException异常，不存在则会自动创建。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的"a.txt"文件移动到另一个目录下。

  • 场景描述 需要移动文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String movedFilePath 变量 传引用
参数 distDirPath String distDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <movedFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                       default\work\user\com.primeton.eos.foundation.example\
                       com\primeton\eos\foundation\example\FileUtil/moved/a.txt</movedFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# readFile：把文件读成字符串

# 【功能说明】

把文件读成字符串。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.readFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 filePath String 源文件路径
参数 encoding String 读取时使用的编码，如果为null，用JVM默认的文件编码
返回值 out0 String 字符串结果

  1. 抛出异常说明 如果filePath不是文件或者不存在则会抛出EOSRuntimeException异常。

  2. 规则说明 如果文件编码为null，用JVM默认的文件编码。

# 【参考案例】

示例：将目录下的"c1.xml"文件按UTF-8的编码形式读取成字符串。

  • 场景描述 需要读取文件内容时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 filePath String srcFilePath 变量 传引用
参数 encoding String UTF-8 常量 传引用
返回值 out0 String[] text 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <srcFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from/c1.xml</srcFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext
<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <srcFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from/c1.xml</srcFilePath>
        <text __type="java:java.lang.String">
                    &lt;?xml version="1.0" encoding="UTF-8" standalone="no"?&gt;&#13;
                    &lt;root&gt;&#13;
                        &lt;users&gt;&#13;
                            &lt;user&gt;&#13;
                                &lt;name&gt;abc/name&gt;&#13;
                                &lt;password&gt;XXXX&lt;/password&gt;&#13;
                            &lt;/user&gt;&#13;
                        &lt;/users&gt;&#13;
                    &lt;/root&gt;
        </text>
    </__root>
</bizContext>

# renameFile：重命名文件

# 【功能说明】

重命名文件。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.renameFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 filePath String 源文件路径
参数 newFileName String 新文件名

  1. 抛出异常说明 如果filePath不是文件或者不存在则会抛出EOSRuntimeException异常。

  2. 规则说明 无。

# 【参考案例】

示例：将一个目录下的"a.doc"文件重命名为"b.doc"。

  • 场景描述 需要修改文件名时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 filePath String srcFilePath 变量 传引用
参数 newFileName String b.doc 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <srcFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from/a.doc</srcFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# smartCopyFile：复制文件到指定路径（文件或目录）

# 【功能说明】

复制文件到指定路径，指定路径可以是文件或目录。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.smartCopyFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 srcFilePath String 源文件路径
参数 destPath String 目标文件路径

  1. 抛出异常说明 如果srcFilePath不是文件或者不存在会抛出EOSRuntimeException异常。

  2. 规则说明 destPath可以是文件或者目录，如果destPath不存在，将按目录处理。

# 【参考案例】

示例：将一个目录下的"a.txt"文件复制到目标目录下。

  • 场景描述 需要复制文件时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 srcFilePath String srcFilePath 变量 传引用
参数 destFilePath String destDirPath 变量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <destDirPath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                 default\work\user\com.primeton.eos.foundation.example\
                 com\primeton\eos\foundation\example\FileUtil/to</destDirPath>
        <srcFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                 default\work\user\com.primeton.eos.foundation.example\
                 com\primeton\eos\foundation\example\FileUtil/from/a.txt</srcFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。

# writeFile：把字符串写成文件

# 【功能说明】

把字符串写成文件。

# 【版本说明】

从EOS 6.0开始提供。

# 【引用路径】

  1. 本运算逻辑构件对应JAVA方法路径： com.eos.foundation.common.utils.FileUtil.writeFile，包含在com.eos.foundation.jar中。
  2. 运算逻辑定义在构件包com.eos.foundation中。

# 【使用说明】

  1. 参数说明
类型 名称 数据类型 参数描述
参数 filePath String 文件路径
参数 data String 字符串内容
参数 encoding String 写文件使用的编码

  1. 抛出异常说明 如果filePath不是文件或者不存在则会抛出EOSRuntimeException异常。

  2. 规则说明 如果文件编码为null，用JVM默认的文件编码；如果文件路径不存在则会自动创建。

# 【参考案例】

示例：将字符串按UTF-8的编码保存到文件目录下的"a.txt"。

  • 场景描述 需要保存字符串内容时可使用该方法。

  • 参数设置

类型 名称 数据类型 值 值类别 传递方式
参数 filePath String srcFilePath 变量 传引用
参数 data String 中国 常量 传引用
参数 encoding String UTF-8 常量 传引用

  • 其他说明 无。

  • 调用前的bizContext

<bizContext>
    <__root __id="0" __type="java:java.util.HashMap">
        <srcFilePath __type="java:java.lang.String">D:\eos6studio\1277\eosserver\working\eos-
                     default\work\user\com.primeton.eos.foundation.example\
                     com\primeton\eos\foundation\example\FileUtil/from/a.txt</srcFilePath>
    </__root>
</bizContext>
  • 调用后的bizContext 同调用前。
上次更新: 2023/3/20下午3:44:43

← 日期 →