Easyexcel（7-自定义样式）

相关文章链接

1. Easyexcel（1-注解使用）
2. Easyexcel（2-文件读取）
3. Easyexcel（3-文件导出）
4. Easyexcel（4-模板文件）
5. Easyexcel（5-自定义列宽）
6. Easyexcel（6-单元格合并）
7. Easyexcel（7-自定义样式）

注解

@ContentStyle

用于设置内容格式注解，可作用于类和字段上

1. dataFormat：日期格式
2. hidden：设置单元格使用此样式隐藏
3. locked：设置单元格使用此样式锁定
4. quotePrefix：在单元格前面增加`符号，数字或公式将以字符串形式展示
5. horizontalAlignment：设置是否水平居中
6. wrapped：设置文本是否应换行。将此标志设置为true通过在多行上显示使单元格中的所有内容可见
7. verticalAlignment：设置是否垂直居中
8. rotation：设置单元格中文本旋转角度。03版本的Excel旋转角度区间为-90°90°，07版本的Excel旋转角度区间为0°180°
9. indent：设置单元格中缩进文本的空格数
10. borderLeft：设置左边框的样式
11. borderRight：设置右边框样式
12. borderTop：设置上边框样式
13. borderBottom：设置下边框样式
14. leftBorderColor：设置左边框颜色
15. rightBorderColor：设置右边框颜色
16. topBorderColor：设置上边框颜色
17. bottomBorderColor：设置下边框颜色
18. fillPatternType：设置填充类型
19. fillBackgroundColor：设置背景色
20. fillForegroundColor：设置前景色
21. shrinkToFit：设置自动单元格自动大小

@ContentFontStyle

用于设置单元格内容字体格式的注解，可作用于类和字段上

1. fontName：字体名称
2. fontHeightInPoints：字体高度
3. italic：是否斜体
4. strikeout：是否设置删除水平线
5. color：字体颜色
6. typeOffset：偏移量
7. underline：下划线
8. bold：是否加粗
9. charset：编码格式

@HeadStyle

用于设置标题样式，可作用于类和字段上

1. dataFormat：日期格式
2. hidden：设置单元格使用此样式隐藏
3. locked：设置单元格使用此样式锁定
4. quotePrefix：在单元格前面增加`符号，数字或公式将以字符串形式展示
5. horizontalAlignment：设置是否水平居中
6. wrapped：设置文本是否应换行。将此标志设置为true通过在多行上显示使单元格中的所有内容可见
7. verticalAlignment：设置是否垂直居中
8. rotation：设置单元格中文本旋转角度。03版本的Excel旋转角度区间为-90°90°，07版本的Excel旋转角度区间为0°180°
9. indent：设置单元格中缩进文本的空格数
10. borderLeft：设置左边框的样式
11. borderRight：设置右边框样式
12. borderTop：设置上边框样式
13. borderBottom：设置下边框样式
14. leftBorderColor：设置左边框颜色
15. rightBorderColor：设置右边框颜色
16. topBorderColor：设置上边框颜色
17. bottomBorderColor：设置下边框颜色
18. fillPatternType：设置填充类型
19. fillBackgroundColor：设置背景色
20. fillForegroundColor：设置前景色
21. shrinkToFit：设置自动单元格自动大小

@HeadFontStyle

用于定制标题字体格式，可作用于类和字段上

1. fontName：设置字体名称
2. fontHeightInPoints：设置字体高度
3. italic：设置字体是否斜体
4. strikeout：是否设置删除线
5. color：设置字体颜色
6. typeOffset：设置偏移量
7. underline：设置下划线
8. charset：设置字体编码
9. bold：设置字体是否加粗

类方法

AbstractCellStyleStrategy

通过继承AbstractCellStyleStrategy类，实现其setHeadCellStyle和setContentCellStyle方法可以自定义设置表头和单元格内容样式

public abstract class AbstractCellStyleStrategy implements CellWriteHandler {@Overridepublic int order() {return OrderConstant.DEFINE_STYLE;}@Overridepublic void afterCellDispose(CellWriteHandlerContext context) {if (context.getHead() == null) {return;}if (context.getHead()) {setHeadCellStyle(context);} else {setContentCellStyle(context);}}/*** 设置表头样式*/protected void setHeadCellStyle(CellWriteHandlerContext context) {setHeadCellStyle(context.getCell(), context.getHeadData(), context.getRelativeRowIndex());}/*** 设置表头样式*/protected void setHeadCellStyle(Cell cell, Head head, Integer relativeRowIndex) {throw new UnsupportedOperationException("Custom styles must override the setHeadCellStyle method.");}/*** 设置单元格内容样式*/protected void setContentCellStyle(CellWriteHandlerContext context) {setContentCellStyle(context.getCell(), context.getHeadData(), context.getRelativeRowIndex());}/*** 设置单元格内容样式*/protected void setContentCellStyle(Cell cell, Head head, Integer relativeRowIndex) {throw new UnsupportedOperationException("Custom styles must override the setContentCellStyle method.");}
}

HorizontalCellStyleStrategy

HorizontalCellStyleStrategy 是提供的一个水平样式策略，只需实现CellWriteHandlerContext类自定义样式即可，通过设置构建这个策略对象基本上可以满足一般的要求了，比如：设置表头和内容的边框、底色、对齐方式、文字字体、文字颜色、文字大小等。设置完之后，需要创建 HorizontalCellStyleStrategy 对象，然后在导出文件时注册这个策略的 handler 即可。

Getter
@Setter
@EqualsAndHashCode
public class HorizontalCellStyleStrategy extends AbstractCellStyleStrategy {private WriteCellStyle headWriteCellStyle;private List<WriteCellStyle> contentWriteCellStyleList;public HorizontalCellStyleStrategy() {}public HorizontalCellStyleStrategy(WriteCellStyle headWriteCellStyle,List<WriteCellStyle> contentWriteCellStyleList) {this.headWriteCellStyle = headWriteCellStyle;this.contentWriteCellStyleList = contentWriteCellStyleList;}public HorizontalCellStyleStrategy(WriteCellStyle headWriteCellStyle, WriteCellStyle contentWriteCellStyle) {this.headWriteCellStyle = headWriteCellStyle;if (contentWriteCellStyle != null) {this.contentWriteCellStyleList = ListUtils.newArrayList(contentWriteCellStyle);}}/*** 设置表头样式*/@Overrideprotected void setHeadCellStyle(CellWriteHandlerContext context) {if (stopProcessing(context) || headWriteCellStyle == null) {return;}WriteCellData<?> cellData = context.getFirstCellData();WriteCellStyle.merge(headWriteCellStyle, cellData.getOrCreateStyle());}/*** 设置单元格内容样式*/@Overrideprotected void setContentCellStyle(CellWriteHandlerContext context) {if (stopProcessing(context) || CollectionUtils.isEmpty(contentWriteCellStyleList)) {return;}WriteCellData<?> cellData = context.getFirstCellData();if (context.getRelativeRowIndex() == null || context.getRelativeRowIndex() <= 0) {WriteCellStyle.merge(contentWriteCellStyleList.get(0), cellData.getOrCreateStyle());} else {WriteCellStyle.merge(contentWriteCellStyleList.get(context.getRelativeRowIndex() % contentWriteCellStyleList.size()),cellData.getOrCreateStyle());}}/*** 判断单元格是否为空*/protected boolean stopProcessing(CellWriteHandlerContext context) {return context.getFirstCellData() == null;}
}

DefaultStyle

Easyexcel在导出文件内容时默认使用DefaultStyle类来设置表头和单元格样式

public class DefaultStyle extends HorizontalCellStyleStrategy {@Overridepublic int order() {return OrderConstant.DEFAULT_DEFINE_STYLE;}public DefaultStyle() {super();WriteCellStyle headWriteCellStyle = new WriteCellStyle();headWriteCellStyle.setWrapped(true);headWriteCellStyle.setVerticalAlignment(VerticalAlignment.CENTER);headWriteCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);headWriteCellStyle.setLocked(true);headWriteCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);headWriteCellStyle.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.getIndex());headWriteCellStyle.setBorderTop(BorderStyle.THIN);headWriteCellStyle.setBorderBottom(BorderStyle.THIN);headWriteCellStyle.setBorderLeft(BorderStyle.THIN);headWriteCellStyle.setBorderRight(BorderStyle.THIN);WriteFont headWriteFont = new WriteFont();headWriteFont.setFontName("宋体");headWriteFont.setFontHeightInPoints((short)14);headWriteFont.setBold(true);headWriteCellStyle.setWriteFont(headWriteFont);setHeadWriteCellStyle(headWriteCellStyle);}
}

Easyexcel的默认风格是，对于表头会显示灰色背景，但是如果取消使用默认风格之后，表头的背景颜色就会恢复白色

Easyexcel控制是否开启默认风格的属性方法是：useDefaultStyle(false)

注意：useDefaultStyle方法一定要放在sheet方法前面，否则会失效（放在后面会因为在构造ExcelWriter类时获取不到useDefaultStyle的值，从而导致使用的是默认风格）

public void test01() {EasyExcel.write("test01.xlsx", DemoData.class)//禁用默认风格.useDefaultStyle(false).sheet("testSheet01").doWrite(demoData);
}

样式工具类

/*** EasyExcel 样式工具类*/
public class CustomExcelStyleUtil {/*** 标题样式** @return*/public static WriteCellStyle getHeadStyle() {// 头的策略WriteCellStyle headWriteCellStyle = new WriteCellStyle();// 背景颜色//headWriteCellStyle.setFillForegroundColor(IndexedColors.LIGHT_TURQUOISE1.getIndex());//headWriteCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);// 字体WriteFont headWriteFont = new WriteFont();headWriteFont.setFontName("宋体");//设置字体名字headWriteFont.setFontHeightInPoints((short) 14);//设置字体大小headWriteFont.setBold(true);//字体加粗headWriteCellStyle.setWriteFont(headWriteFont); //在样式用应用设置的字体;// 样式headWriteCellStyle.setBorderBottom(BorderStyle.THIN);//设置底边框;headWriteCellStyle.setBottomBorderColor((short) 0);//设置底边框颜色;headWriteCellStyle.setBorderLeft(BorderStyle.THIN);  //设置左边框;headWriteCellStyle.setLeftBorderColor((short) 0);//设置左边框颜色;headWriteCellStyle.setBorderRight(BorderStyle.THIN);//设置右边框;headWriteCellStyle.setRightBorderColor((short) 0);//设置右边框颜色;headWriteCellStyle.setBorderTop(BorderStyle.THIN);//设置顶边框;headWriteCellStyle.setTopBorderColor((short) 0); //设置顶边框颜色;headWriteCellStyle.setWrapped(true);  //设置自动换行;headWriteCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);//设置水平对齐的样式为居中对齐;headWriteCellStyle.setVerticalAlignment(VerticalAlignment.CENTER);  //设置垂直对齐的样式为居中对齐;headWriteCellStyle.setShrinkToFit(true);//设置文本收缩至合适return headWriteCellStyle;}/*** 内容样式** @return*/public static WriteCellStyle getContentStyle() {// 内容的策略WriteCellStyle contentWriteCellStyle = new WriteCellStyle();// 背景颜色// 这里需要指定 FillPatternType 为FillPatternType.SOLID_FOREGROUND 不然无法显示背景颜色.头默认了 FillPatternType所以可以不指定//contentWriteCellStyle.setFillForegroundColor(IndexedColors.PALE_BLUE.getIndex());//contentWriteCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);// 设置字体WriteFont contentWriteFont = new WriteFont();contentWriteFont.setFontHeightInPoints((short) 12);//设置字体大小contentWriteFont.setFontName("宋体"); //设置字体名字contentWriteCellStyle.setWriteFont(contentWriteFont);//在样式用应用设置的字体;//设置样式;contentWriteCellStyle.setBorderBottom(BorderStyle.THIN);//设置底边框;contentWriteCellStyle.setBottomBorderColor((short) 0);//设置底边框颜色;contentWriteCellStyle.setBorderLeft(BorderStyle.THIN);  //设置左边框;contentWriteCellStyle.setLeftBorderColor((short) 0);//设置左边框颜色;contentWriteCellStyle.setBorderRight(BorderStyle.THIN);//设置右边框;contentWriteCellStyle.setRightBorderColor((short) 0);//设置右边框颜色;contentWriteCellStyle.setBorderTop(BorderStyle.THIN);//设置顶边框;contentWriteCellStyle.setTopBorderColor((short) 0); ///设置顶边框颜色;contentWriteCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);// 水平居中contentWriteCellStyle.setVerticalAlignment(VerticalAlignment.CENTER);// 垂直居中contentWriteCellStyle.setWrapped(true); //设置自动换行;contentWriteCellStyle.setShrinkToFit(true);//设置文本收缩至合适return contentWriteCellStyle;}
}

@Data
public class User {@ExcelProperty(value = "用户Id")private Integer userId;@ExcelProperty(value = "姓名")private String name;@ExcelProperty(value = "手机")private String phone;@ExcelProperty(value = "邮箱")private String email;@ExcelProperty(value = "创建时间")private Date createTime;
}

@GetMapping("/download1")
public void download1(HttpServletResponse response) {try {response.setContentType("application/vnd.ms-excel");response.setCharacterEncoding("utf-8");// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");User user = new User();user.setUserId(123);user.setName("as");user.setPhone("15213");user.setEmail("5456");user.setCreateTime(new Date());EasyExcel.write(response.getOutputStream(), User.class).sheet("模板").registerWriteHandler(new HorizontalCellStyleStrategy(CustomExcelStyleUtil.getHeadStyle(), CustomExcelStyleUtil.getContentStyle())).doWrite(Arrays.asList(user));} catch (Exception e) {e.printStackTrace();}
}