#### 2.2 注解
##### 注解介绍
autopoi起因就是Excel的导入导出,最初的模板是实体和Excel的对应,model--row,filed--col 这样利用注解我们可以和容易做到excel到导入导出 经过一段时间发展,现在注解有5个类分别是
* @Excel 作用到filed上面,是对Excel一列的一个描述
* @ExcelCollection 表示一个集合,主要针对一对多的导出,比如一个老师对应多个科目,科目就可以用集合表示
* @ExcelEntity 表示一个继续深入导出的实体,但他没有太多的实际意义,只是告诉系统这个对象里面同样有导出的字段
* @ExcelIgnore 和名字一样表示这个字段被忽略跳过这个导导出
* @ExcelTarget 这个是作用于最外层的对象,描述这个对象的id,以便支持一个对象可以针对不同导出做出不同处理
注解中的ID的用法 这个ID算是一个比较独特的例子,比如
~~~
@ExcelTarget("teacherEntity")
public class TeacherEntity implements java.io.Serializable {
/** name */
@Excel(name = "主讲老师_teacherEntity,代课老师_absent", orderNum = "1", mergeVertical = true,needMerge=true,isImportField = "true_major,true_absent")
private String name;
~~~
这里的@ExcelTarget 表示使用teacherEntity这个对象是可以针对不同字段做不同处理 同样的ExcelEntity 和ExcelCollection 都支持这种方式 当导出这对象时,name这一列对应的是主讲老师,而不是代课老师还有很多字段都支持这种做法
##### @Excel
这个是必须使用的注解,如果需求简单只使用这一个注解也是可以的,涵盖了常用的Excel需求,需要大家熟悉这个功能,主要分为基础,图片处理,时间处理,合并处理几块,name\_id是上面讲的id用法,这里就不累言了
| 属性 | 类型 | 默认值 | 功能 |
| --- | --- | --- | --- |
| name | String| null| 列名,支持name\_id|
| needMerge | boolean| fasle | 是否需要纵向合并单元格(用于含有list中,单个的单元格,合并list创建的多个row) |
| orderNum| String| "0"| 列的排序,支持name\_id|
| replace | String\[\]| {} | 值得替换 导出是{a\_id,b\_id} 导入反过来|
| savePath| String| "upload" | 导入文件保存路径,如果是图片可以填写,默认是upload/className/ IconEntity这个类对应的就是upload/Icon/|
| type | int| 1| 导出类型 1 是文本 2 是图片,3 是函数,4 是数字 默认是文本|
| width| double| 10| 列宽|
| height | double| 10| **列高,后期打算统一使用@ExcelTarget的height,这个会被废弃,注意** |
| isStatistics | boolean| fasle| 自动统计数据,在追加一行统计,把所有数据都和输出 **这个处理会吞没异常,请注意这一点**|
| isHyperlink | boolean| false | 超链接,如果是需要实现接口返回对象|
|isImportField| boolean | true| 校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name\_id|
| exportFormat| String| ""| 导出的时间格式,以这个是否为空来判断是否需要格式化日期|
| importFormat| String| ""| 导入的时间格式,以这个是否为空来判断是否需要格式化日期 |
| format | String | ""| 时间格式,相当于同时设置了exportFormat 和 importFormat|
| databaseFormat | String| "yyyyMMddHHmmss"| 导出时间设置,如果字段是Date类型则不需要设置 数据库如果是string 类型,这个需要设置这个数据库格式,用以转换时间格式输出|
| numFormat| String | ""| 数字格式化,参数是Pattern,使用的对象是DecimalFormat|
| imageType| int | 1| 导出类型 1 从file读取 2 是从数据库中读取 默认是文件 同样导入也是一样的|
| suffix| String| "" | 文字后缀,如% 90 变成90%|
| isWrap| boolean | true| 是否换行 即支持\\n |
| mergeRely| int\[\]| {}| 合并单元格依赖关系,比如第二列合并是基于第一列 则{0}就可以了|
| mergeVertical| boolean| fasle| 纵向合并内容相同的单元格 |
| fixedIndex| int | \-1 | 对应excel的列,忽略名字，**首列index从0开始** |
| isColumnHidden| boolean| false| 导出隐藏列|
##### @ExcelTarget
限定一个到处实体的注解,以及一些通用设置,作用于最外面的实体
| 属性 | 类型 | 默认值 | 功能 |
| --- | --- | --- | --- |
| value| String | null| 定义ID |
| height| double| 10| 设置行高|
| fontSize| short| 11 | 设置文字大小|
##### @ExcelEntity
标记是不是导出excel 标记为实体类,一遍是一个内部属性类,标记是否继续穿透,可以自定义内部id
| 属性 | 类型 | 默认值 | 功能 |
| --- | --- | --- | --- |
| id | String|null| 定义ID |
| name| String|null| 合并表头文本 |
| show| String|false| 是否显示合并表头 |
##### @ExcelCollection
一对多的集合注解,用以标记集合是否被数据以及集合的整体排序
| 属性 | 类型 | 默认值 | 功能 |
| --- | --- | --- | --- |
| id | String| null| 定义ID|
| name| String | null | 定义集合列名,支持nanm\_id |
| orderNum| int | 0| 排序,支持name\_id|
| type| Class| ArrayList.class| 导入时创建对象使用 |
##### @ExcelIgnore
忽略这个属性,多使用需循环引用中,无需多解释吧^^
- 1.前传
- 1.1前言
- 1.2 Autopoi 介绍
- 1.3 使用
- 1.4 测试项目
- 1.5 快速文档
- 1.6 示例
- 1.6.1 单表数据导出多表头示例
- 单表数据多表头导入注意bak
- 1.6.2 单表数据导出多sheet示例
- 1.6.3 excel根据模板导出
- 1.6.4 一对多导出needMerge示例
- 1.6.5 大数据导出示例
- 1.7 导出自定义选择列导出
- 2. Excel 注解版
- 2.0 @excel注解的使用
- 2.1 Excel导入导出
- 2.2 注解
- 2.3 注解导出,导入
- 2.3.1 对象定义
- 2.3.2 集合定义
- 2.3.3 图片的导出
- 2.3.4 Excel导入介绍
- 2.3.5 Excel导入小功能
- 2.3.6 图片的导入
- 2.3.7 Excel多Sheet导出
- 2.4 注解变种-更自由的导出
- 2.5 Map导入,自由发挥
- 2.6 Excel的样式自定义
- 2.7 如何自定义数据处理
- 2.8 Excel导入校验(暂不支持)
- 2.9 Excel 大批量读取
- 2.10 Excel大数据导出
- 2.11 groupname和ExcelEntity的name属性
- 3. Excel 模板版
- 3.1 模板 指令介绍
- 3.2 基本导出
- 3.3 模板当中使用注解
- 3.4 图片导出
- 3.5 横向遍历
- 4. Excel<->Html
- 4.1 Excel 的Html预览
- 4.2 html转Excel更神奇的导出
- 5. Word
- 5.1 word模板导出
- 6. PDF
- 7. Spring MVC
- 7.1 View 介绍
- 7.2 大数据导出View的用法
- 7.3 注解导出View用法
- 7.4 注解变种Map类型的导出View
- 7.5Excel模板导出View
- 7.6 PoiBaseView.render view的补救
- 8.问题归档
- 9.大数据量处理
- 10.autopoi升级4.0版本修改记录