WriteTempletFile (autest

java.lang.Object
- com.auxiliary.tool.file.WriteTempletFile<T>

Type Parameters:

T - 子类

All Implemented Interfaces:

AddPlaceholder

Direct Known Subclasses:

WriteMultipleTempletFile, WriteSingleTempletFile
```
public abstract class WriteTempletFile<T extends WriteTempletFile<T>>
extends Object
implements AddPlaceholder
```
文件名：WriteTempletFile.java

用途： 快速写入模板型的文件进行的工具。可通过类中提供的词语替换和默认内容的方法，对一类模板型的文件内容（如，测试用例）进行快速写作，提高工作效率。并且，若存在内容相同，但模板不同的文件，还可通过调用toWriteFileJson()方法以完成各个子类之间的消息互通，达到快速生成多种同一内容，不同存放文件的目的。

在注释中，存在以下名词需要解释：
- 用例：写入到模板文件中的一条数据，类似于一条测试用例
- 内容：写入到模板文件中的所有数据，类似于写在测试用例文件中的所有测试用例
编码时间：2021年5月15日上午11:13:26

修改时间：2023年5月22日下午5:22:17
Since:

JDK 1.8, autest 2.0.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`caseIndex` 指向当前需要编写的用例下标
`protected WriteFileData`	`data` 存储需要写入到文件中的数据
`protected String`	`endField` 存储判断是否自动换行的字段
`static String`	`KEY_CASE`
`static String`	`KEY_CONTENT`
`static String`	`KEY_DATA`
`static String`	`KEY_DEFAULT`
`static String`	`KEY_TEMPLET`
`static String`	`KEY_TEXT`
`protected Placeholder`	`placeholder` 占位符类对象
`static String`	`WORD_SIGN` 待替换词语的标记
`protected int`	`writeRowNum` 存储需要分页的行数

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`WriteTempletFile()` 无参构造，方便子类进行特殊的构造方法
`protected`	`WriteTempletFile(FileTemplet templet)` 构造对象，初始化创建文件的模板

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addContent(String field, int index, Placeholder placeholder, String... contents)` 根据传入的字段信息，将指定的内容插入到用例相应字段的指定下标下，并且可传入临时的占位符类对象，对文本中的占位符进行替换，且不影响已添加的替换词语
`T`	`addContent(String field, int index, String... contents)` 根据传入的字段信息，将指定的内容插入到用例相应字段的指定下标下
`T`	`addContent(String field, Placeholder placeholder, String... contents)` 根据传入的字段信息，将指定的内容插入到用例相应字段的末尾，并且可传入临时的占位符类对象，对文本中的占位符进行替换，且不影响已添加的替换词语
`T`	`addContent(String field, String... contents)` 根据传入的字段信息，将指定的内容插入到用例相应字段的最后一行
`void`	`addReplaceFunction(String regex, DataFunction function)` 用于添加待替换的词语及相应的替换方法
`void`	`addReplaceWord(String word, String replaceWord)` 该方法用于添加被替换的词语以及替换的内容
`protected int`	`analysisIndex(int maxNum, int index, boolean isReciprocal)` 用于解析真实下标内容
`void`	`clearCase(int index)` 用于移除指定下标的一条用例
`T`	`clearContent(String field, int index)` 用于清除用例字段下指定下标段落的内容
`void`	`clearFieldValue(String field)` 用于移除字段的默认值
`protected abstract void`	`contentWriteTemplet(FileTemplet templet, int caseStartIndex, int caseEndIndex)` 用于将缓存的数据内容，写入到模板中
`protected abstract void`	`createTempletFile(FileTemplet templet)` 用于创建模板文件
`protected T`	`disposeWriteFieldsContent(Collection<String> fieldList, VoidSupplier sup)` 该方法用于处理在一次性插入多个字段内容时，进行的自动换行处理。
`T`	`end()` 标记完成一条用例数据的编写，并将内容插入到最后一行内容下
`T`	`end(int contentIndex)` 标记完成一条用例数据的编写，并将内容插入到指定行内容下
`protected abstract List<String>`	`getAllTempletJson()` 将类中存储的模板类转换为模板json串，通过List集合收集后，进行返回
`T`	`getCase(int index)` 用于获取指定下标的用例内容，并对内容进行重写
`Placeholder`	`getPlaceholder()` 该方法用于返回当前存储的占位符类对象，若修改了占位符类对象的内容，需要通过`setPlaceholder(Placeholder)`方法对重新生成的占位符类对象进行整体设置
`protected com.alibaba.fastjson.JSONObject`	`getTextJson(String field, int textIndex)` 用于返回指定下标的文本json
`WriteFileData`	`getWriteData()` 用于返回当前待写入模板的信息类对象
`protected void`	`replenishDefaultContent()` 用于在用例中补充默认的字段内容，若用例存在内容，则不添加默认值
`void`	`setContentJson(String writeJsonText)` 用于接收一个内容json串来替换当前写入的内容
`void`	`setEndField(String endField)` 该方法用于设置自动换行的字段，当重新插入该字段后，则自动切换到下一行
`void`	`setFieldValue(String field, String... contents)` 用于向字段中添加默认内容
`void`	`setFileTemplet(FileTemplet templet)` 用于重置当前的写入模板
`void`	`setPlaceholder(Placeholder placeholder)` 该方法用于设置自定义的占位符类对象
`void`	`setWriteData(WriteFileData data)` 用于将其他写入类对象的待写入信息设置到当前类对象中
`void`	`setWriteRowNum(int writeRowNum)` 用于设置自动写入文件的极限用例数量
`String`	`toTempletJson()` 用于根据当前实际的模板数量，返回拼接后的模板json内容
`String`	`toWriteFileJson()` 用于返回主体json串
`abstract void`	`write()` 用于将编写的所有内容写入到文件中
`protected abstract void`	`write(FileTemplet templet, int caseStartIndex, int caseEndIndex)` 用于将编写的部分内容写入到文件中

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_CONTENT
```
public static final String KEY_CONTENT
```
    See Also:
    
    Constant Field Values
  - KEY_TEXT
```
public static final String KEY_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_DEFAULT
```
public static final String KEY_DEFAULT
```
    See Also:
    
    Constant Field Values
  - KEY_CASE
```
public static final String KEY_CASE
```
    See Also:
    
    Constant Field Values
  - KEY_TEMPLET
```
public static final String KEY_TEMPLET
```
    See Also:
    
    Constant Field Values
  - KEY_DATA
```
public static final String KEY_DATA
```
    See Also:
    
    Constant Field Values
  - WORD_SIGN
```
public static final String WORD_SIGN
```
    待替换词语的标记
    
    See Also:
    
    Constant Field Values
  - data
```
protected WriteFileData data
```
    存储需要写入到文件中的数据
  - caseIndex
```
protected int caseIndex
```
    指向当前需要编写的用例下标
  - writeRowNum
```
protected int writeRowNum
```
    存储需要分页的行数
  - endField
```
protected String endField
```
    存储判断是否自动换行的字段
  - placeholder
```
protected Placeholder placeholder
```
    占位符类对象
    
    Since:
    
    autest 4.2.0
- Constructor Detail
  - WriteTempletFile
```
protected WriteTempletFile(FileTemplet templet)
```
    构造对象，初始化创建文件的模板
    
    Parameters:
    
    templet - 模板类对象
  - WriteTempletFile
```
protected WriteTempletFile()
```
    无参构造，方便子类进行特殊的构造方法
- Method Detail
  - getPlaceholder
```
public Placeholder getPlaceholder()
```
    该方法用于返回当前存储的占位符类对象，若修改了占位符类对象的内容，需要通过setPlaceholder(Placeholder)方法对重新生成的占位符类对象进行整体设置
    
    Returns:
    
    占位符类对象
    
    Since:
    
    autest 4.2.0
  - setPlaceholder
```
public void setPlaceholder(Placeholder placeholder)
```
    该方法用于设置自定义的占位符类对象
    注意：该方法是对整个占位符类对象进行整体设置，需要保证添加的占位符的前后标志与设置的占位符标志保持一致
    
    Parameters:
    
    placeholder - 占位符类对象
    
    Since:
    
    autest 4.2.0
  - addReplaceWord
```
public void addReplaceWord(String word,
                           String replaceWord)
```
    Description copied from interface: AddPlaceholder
    
    该方法用于添加被替换的词语以及替换的内容
    
    Specified by:
    
    addReplaceWord in interface AddPlaceholder
    
    Parameters:
    
    word - 需要替换的内容
    
    replaceWord - 替换后的内容
  - addReplaceFunction
```
public void addReplaceFunction(String regex,
                               DataFunction function)
```
    Description copied from interface: AddPlaceholder
    用于添加待替换的词语及相应的替换方法
    该方法允许添加待替换词语的处理方式，在写入用例时，若指定的待替换内容符合此方法指定的正则时，则会使用存储的替换方式，对词语进行替换。例如，占位符前后标志均为“#”，则：
```
  @Test
 public void addReplaceWordTest_DataDriverFunction() {
  // 定义词语匹配规则和处理方式，当匹配到正则后，将获取“随机：”后的字母
  // 若字母为“N”，则随机生成两位数字字符串
  // 若字母为“Y”，则随机生成两位中文字符串
  test.addReplaceWord(new DataDriverFunction("随机：[NC]", text -> {
      return "N".equals(text.split("：")[1]) ? RandomString.randomString(2, 2, StringMode.NUM)
              : RandomString.randomString(2, 2, StringMode.CH);
  }));
 }
 
```
    部分定义方法可调用工具类Functions类获取，以其中一个方法为例，其传参方法为如下：
```
 DataDriverFunction driverFunction = Functions.randomCarId();
 addReplaceFunction(DataDriverFunction.getRegex(), DataDriverFunction.getFunction());
 
```
    Specified by:
    
    addReplaceFunction in interface AddPlaceholder
    
    Parameters:
    
    regex - 需要替换的内容正则表达式
    
    function - 替换词语使用的函数
  - setFieldValue
```
public void setFieldValue(String field,
                          String... contents)
```
    用于向字段中添加默认内容
    当完成一条用例编写后，若未写入存在默认内容的字段时，则在完成用例后自动将默认内容写入字段中。若字段存在内容，则不会写入默认值
    
    注意：若模板中不存在指定的字段，则不写入该默认值；每次重新编写字段默认值时，会覆盖上次编写的内容
    
    Parameters:
    
    field - 字段
    
    contents - 默认内容
  - setWriteRowNum
```
public void setWriteRowNum(int writeRowNum)
```
    用于设置自动写入文件的极限用例数量
    设置该值后，则开启自动写入文件功能，当用例数达到指定数量时，则会自动调用写入文件的方法，将缓存的内容写入到文件中
    
    注意：自动写入文件并非会将所有的内容写入到文件中，例如，设置值为5，用例存在11条，则前10条用例会被自动写入到文件，而最后一条数据，由于未达到设定值，则不会写入到文件中，需要手动调用write()方法
    
    Parameters:
    
    writeRowNum - 自动写入到文件的极限用例数量
  - clearFieldValue
```
public void clearFieldValue(String field)
```
    用于移除字段的默认值
    
    Parameters:
    
    field - 字段
  - setFileTemplet
```
public void setFileTemplet(FileTemplet templet)
```
    用于重置当前的写入模板
    
    Parameters:
    
    templet - 模板类对象
  - setContentJson
```
public void setContentJson(String writeJsonText)
```
    用于接收一个内容json串来替换当前写入的内容
    该方法可用于在更换内容但不替换当前模板时使用。可通过其他写入类的toWriteFileJson()方法，获取到内容json串后，来替换当前类对象的内容json串
    
    注意：设置内容json串后，当前写入的内容将被覆盖
    
    Parameters:
    
    writeJsonText - 指定的内容json串
  - setWriteData
```
public void setWriteData(WriteFileData data)
```
    用于将其他写入类对象的待写入信息设置到当前类对象中
    调用该方法后，会将传入的WriteFileData类对象中，除模板外的信息覆盖到当前的模板类中，等同于进行数据的复制
    
    Parameters:
    
    data - 待写入信息类对象，可通过getWriteData()方法获取
  - setEndField
```
public void setEndField(String endField)
```
    该方法用于设置自动换行的字段，当重新插入该字段后，则自动切换到下一行
    注意：若不启动该功能，则将自动换行字段设置为空或不存在的字段即可
    
    Parameters:
    
    endField - 自动换行字段
    
    Since:
    
    autest 3.1.0
  - getWriteData
```
public WriteFileData getWriteData()
```
    用于返回当前待写入模板的信息类对象
    
    Returns:
    
    信息类对象
  - getCase
```
public T getCase(int index)
```
    用于获取指定下标的用例内容，并对内容进行重写
    调用该方法后，当前编写的用例将指向为指定下标的用例。若当前正在编写用例，调用该方法后，将覆盖当前编写的用例。
    
    注意：若下标为负数或大于当前内容最大个数时，则不获取指定内容。下标从0开始计算，及0表示第一条用例
    
    Parameters:
    
    index - 用例下标
    
    Returns:
    
    类本身
  - addContent
```
public T addContent(String field,
                    String... contents)
```
    根据传入的字段信息，将指定的内容插入到用例相应字段的最后一行
    方法允许传入多条内容，每条内容在写入到文件时，均以换行符隔开。
    
    注意：当设置了自动换行字段时，则在插入该字段内容后（内容非空时），则会自动进行换行，可参考setEndField(String)方法
    
    Parameters:
    
    field - 字段id
    
    contents - 相应字段的内容
    
    Returns:
    
    类本身
  - addContent
```
public T addContent(String field,
                    int index,
                    String... contents)
```
    根据传入的字段信息，将指定的内容插入到用例相应字段的指定下标下
    方法允许传入多条内容，每条内容在写入到文件时，均以换行符隔开。若指定的下标小于0或大于当前内容的最大个数时，则将内容写入到集合最后
    
    注意：当设置了自动换行字段时，则在插入该字段内容后（内容非空时），则会在插入当前内容前自动进行换行，再插入该内容，可参考setEndField(String)的设置方法
    
    Parameters:
    
    field - 字段id
    
    index - 指定插入的位置
    
    contents - 相应字段的内容
    
    Returns:
    
    类本身
  - addContent
```
public T addContent(String field,
                    int index,
                    Placeholder placeholder,
                    String... contents)
```
    根据传入的字段信息，将指定的内容插入到用例相应字段的指定下标下，并且可传入临时的占位符类对象，对文本中的占位符进行替换，且不影响已添加的替换词语
    方法允许传入多条内容，每条内容在写入到文件时，均以换行符隔开。若指定的下标小于0或大于当前内容的最大个数时，则将内容写入到集合最后
    
    注意：
    1. 当设置了自动换行字段时，则在插入该字段内容后（内容非空时），则会在插入当前内容前自动进行换行，再插入该内容，可参考setEndField(String)的设置方法
    2. 若临时替换的词语集合中包含类中添加的替换词语，则以类中设置替换词语为主
    Parameters:
    
    field - 字段id
    
    index - 指定插入的位置
    
    placeholder - 占位符类
    
    contents - 相应字段的内容
    
    Returns:
    
    类本身
    
    Since:
    
    autest 4.2.0
  - addContent
```
public T addContent(String field,
                    Placeholder placeholder,
                    String... contents)
```
    根据传入的字段信息，将指定的内容插入到用例相应字段的末尾，并且可传入临时的占位符类对象，对文本中的占位符进行替换，且不影响已添加的替换词语
    方法允许传入多条内容，每条内容在写入到文件时，均以换行符隔开。若指定的下标小于0或大于当前内容的最大个数时，则将内容写入到集合最后
    
    注意：
    1. 当设置了自动换行字段时，则在插入该字段内容后（内容非空时），则会在插入当前内容前自动进行换行，再插入该内容，可参考setEndField(String)的设置方法
    2. 若临时替换的词语集合中包含类中添加的替换词语，则以类中设置替换词语为主
    Parameters:
    
    field - 字段id
    
    placeholder - 占位符类对象
    
    contents - 相应字段的内容
    
    Returns:
    
    类本身
    
    Since:
    
    autest 4.2.0
  - clearContent
```
public T clearContent(String field,
                      int index)
```
    用于清除用例字段下指定下标段落的内容
    
    Parameters:
    
    field - 字段
    
    index - 段落下标
    
    Returns:
    
    类本身
  - clearCase
```
public void clearCase(int index)
```
    用于移除指定下标的一条用例
    
    Parameters:
    
    index - 用例下标
  - end
```
public T end()
```
    标记完成一条用例数据的编写，并将内容插入到最后一行内容下
    调用该方法后，则将数据的缓存写入到文本的缓存内容中，以表示当前段落数据编写完成，之后再次调用添加数据方法时，则写入一段新的内容。
    
    Returns:
    
    类本身
  - end
```
public T end(int contentIndex)
```
    标记完成一条用例数据的编写，并将内容插入到指定行内容下
    调用该方法后，则将数据的缓存写入到文本的缓存内容中，以表示当前段落数据编写完成，之后再次调用添加数据方法时，则写入一段新的内容。
    
    注意：若调用了getCase(int)方法覆盖指定行内容的用例时，则传入的下标无效
    
    Parameters:
    
    contentIndex - 内容下标
    
    Returns:
    
    类本身
  - toWriteFileJson
```
public String toWriteFileJson()
```
    用于返回主体json串
    在主体json串中，包括文件模板内容、默认值内容以及需要写入到文件中的内容，可通过该json串对文件写入类进行构造
    
    Returns:
    
    主体json串
  - write
```
public abstract void write()
```
    用于将编写的所有内容写入到文件中
  - write
```
protected abstract void write(FileTemplet templet,
                              int caseStartIndex,
                              int caseEndIndex)
```
    用于将编写的部分内容写入到文件中
    方法支持反序遍历，即指定的下标为负数时，则表示反序遍历用例集，至指定位置的用例。若两个下标一致，则不处理数据
    
    Parameters:
    
    templet - 需要写入的模板类对象
    
    caseStartIndex - 写入文件开始下标
    
    caseEndIndex - 写入文件结束下标
  - contentWriteTemplet
```
protected abstract void contentWriteTemplet(FileTemplet templet,
                                            int caseStartIndex,
                                            int caseEndIndex)
```
    用于将缓存的数据内容，写入到模板中
    
    Parameters:
    
    templet - 模板类
    
    caseStartIndex - 用例起始行
    
    caseEndIndex - 用例结束行
  - toTempletJson
```
public String toTempletJson()
```
    用于根据当前实际的模板数量，返回拼接后的模板json内容
    由于部分写入类可传入多个模板，为方便构造，则需要对所有模板的json进行返回
    
    Returns:
    
    拼接所有模板json后得到的模板json内容
  - getAllTempletJson
```
protected abstract List<String> getAllTempletJson()
```
    将类中存储的模板类转换为模板json串，通过List集合收集后，进行返回
    
    Returns:
    
    返回类中所有的模板json串
  - replenishDefaultContent
```
protected void replenishDefaultContent()
```
    用于在用例中补充默认的字段内容，若用例存在内容，则不添加默认值
  - getTextJson
```
protected com.alibaba.fastjson.JSONObject getTextJson(String field,
                                                      int textIndex)
```
    用于返回指定下标的文本json
    获取文本json支持反序遍历，当传入的内容为负数时，则表示反序遍历集合，找到指定下标的内容
    
    Parameters:
    
    field - 字段
    
    textIndex - 文本下标
    
    Returns:
    
    文本json
  - analysisIndex
```
protected int analysisIndex(int maxNum,
                            int index,
                            boolean isReciprocal)
```
    用于解析真实下标内容
    数字最大为下标允许的最大值，是可以达到的，在解析集合下标时，其最大限制一定为“集合长度 - 1”
    
    Parameters:
    
    maxNum - 数字最大限制
    
    index - 下标
    
    isReciprocal - 是否允许反向遍历
    
    Returns:
    
    真实下标
  - createTempletFile
```
protected abstract void createTempletFile(FileTemplet templet)
```
    用于创建模板文件
    
    Parameters:
    
    templet - 模板文件对象
  - disposeWriteFieldsContent
```
protected T disposeWriteFieldsContent(Collection<String> fieldList,
                                      VoidSupplier sup)
```
    该方法用于处理在一次性插入多个字段内容时，进行的自动换行处理。
    当需要一次性对多个字段进行写入时（例如，插入一条测试用例），则需要将所有的字段看成是一个整体，若需要插入的字段包含自动换行的字段时，则先进行换行操作，再插入整体内容
    
    Parameters:
    
    fieldList - 需要换行的字段集合
    
    sup - 需要执行的操作，为函数式接口VoidSupplier
    
    Returns:
    
    类本身
    
    Since:
    
    autest 3.1.0

Class WriteTempletFile<T extends WriteTempletFile<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_CONTENT

KEY_TEXT

KEY_DEFAULT

KEY_CASE

KEY_TEMPLET

KEY_DATA

WORD_SIGN

data

caseIndex

writeRowNum

endField

placeholder

Constructor Detail

WriteTempletFile

WriteTempletFile

Method Detail

getPlaceholder

setPlaceholder

addReplaceWord

addReplaceFunction

setFieldValue

setWriteRowNum

clearFieldValue

setFileTemplet

setContentJson

setWriteData

setEndField

getWriteData

getCase

addContent

addContent

addContent

addContent

clearContent

clearCase

end

end

toWriteFileJson

write

write

contentWriteTemplet

toTempletJson

getAllTempletJson

replenishDefaultContent

getTextJson

analysisIndex

createTempletFile

disposeWriteFieldsContent