程序包 cn.isliu.core.builder

类 SheetBuilder<T>

java.lang.Object
cn.isliu.core.builder.SheetBuilder<T>
public class SheetBuilder<T> extends Object
表格构建器 提供链式调用方式创建飞书表格，支持字段过滤等高级功能。

  • 构造器详细资料

    • SheetBuilder

      public SheetBuilder(String sheetName, String spreadsheetToken, Class<T> clazz)
      构造函数
      参数:
      sheetName - 工作表名称
      spreadsheetToken - 电子表格Token
      clazz - 实体类Class对象

  • 方法详细资料

    • includeColumnField

      public SheetBuilder<T> includeColumnField(List<String> fields)
      设置包含的字段列表 指定要包含在表格中的字段名称列表。如果不设置，则包含所有带有@TableProperty注解的字段。
      参数:
      fields - 要包含的字段名称列表
      返回:
      SheetBuilder实例，支持链式调用

    • addCustomProperty

      public SheetBuilder<T> addCustomProperty(String key, Object value)
      设置自定义属性 添加一个自定义属性，可以在构建表格时使用
      参数:
      key - 属性键
      value - 属性值
      返回:
      SheetBuilder实例，支持链式调用

    • addCustomProperties

      public SheetBuilder<T> addCustomProperties(Map<String,Object> properties)
      批量设置自定义属性 批量添加自定义属性，可以在构建表格时使用
      参数:
      properties - 自定义属性映射
      返回:
      SheetBuilder实例，支持链式调用

    • getCustomProperty

      public Object getCustomProperty(String key)
      获取自定义属性 根据键获取已设置的自定义属性值
      参数:
      key - 属性键
      返回:
      属性值，如果不存在则返回null

    • getCustomProperties

      public Map<String,Object> getCustomProperties()
      获取所有自定义属性
      返回:
      包含所有自定义属性的映射

    • fieldDescription

      public SheetBuilder<T> fieldDescription(Map<String,String> fieldDescriptions)
      设置字段描述映射 为实体类字段设置自定义描述信息，用于在表格描述行中显示。 如果字段在映射中存在描述，则使用映射中的描述；否则使用注解中的描述。
      参数:
      fieldDescriptions - 字段名到描述的映射，key为字段名，value为描述文本
      返回:
      SheetBuilder实例，支持链式调用

    • fieldDescription

      public SheetBuilder<T> fieldDescription(String fieldName, String description)
      设置单个字段描述 为指定字段设置自定义描述信息。
      参数:
      fieldName - 字段名
      description - 描述文本
      返回:
      SheetBuilder实例，支持链式调用

    • getFieldDescriptions

      public Map<String,String> getFieldDescriptions()
      获取字段描述映射
      返回:
      包含所有字段描述的映射

    • build

      public String build()
      构建表格并返回工作表ID 根据配置的参数创建飞书表格，包括表头、样式、单元格格式和下拉选项等。
      返回:
      创建成功返回工作表ID