feat(excel): 支持动态表达式处理导出字段

refactor(handler): 使用StandardCharsets替换硬编码字符集
test(enum): 更新测试数据字段名
docs(readme): 更新版本号至3.4.1

Author: lltx

README.md

@@ -20,7 +20,7 @@
 
 | 版本    | 支持版本            |
 |-------|-------------------|
-| 3.4.0 | 适配 Spring Boot 3.x |
+| 3.4.1 | 适配 Spring Boot 3.x |
 | 1.2.7 | 适配 Spring Boot 2.x |
 
 在 `pom.xml` 中添加以下依赖：
@@ -33,64 +33,6 @@
 </dependency>
 ```
 
-## 导入 Excel
-
-### 控制器示例
-
-你可以通过在接口方法中使用 `@RequestExcel` 注解来接收上传的 Excel 文件并将其解析为 Java 对象列表：
-
-```java
-@PostMapping("/upload")
-public void upload(@RequestExcel List<DemoData> dataList, BindingResult bindingResult) {
-  // JSR 303 校验通用校验获取失败的数据
-  List<ErrorMessage> errorMessageList = (List<ErrorMessage>) bindingResult.getTarget();
-}
-```
-
-### 实体类定义
-
-需要先定义与 Excel 表格对应的实体类，并使用 `@ExcelProperty` 注解来标注 Excel 列的索引：
-
-```java
-@Data
-public class Demo {
-  @ExcelProperty(index = 0)
-  private String username;
-
-  @ExcelProperty(index = 1)
-  private String password;
-}
-```
-
-### 示例表格
-
-下图展示了与上述实体类对应的 Excel 表格：
-
-![Example Excel](https://minio.pigx.top/oss/1618560470.png)
-
-## 导出 Excel
-
-你只需在控制器方法中返回一个 `List`，并使用 `@ResponseExcel` 注解即可将数据导出为 Excel 文件：
-
-```java
-@Documented
-@Target(ElementType.METHOD)
-@Retention(RetentionPolicy.RUNTIME)
-public @interface ResponseExcel {
-  String name() default "";
-  ExcelTypeEnum suffix() default ExcelTypeEnum.XLSX;
-  String password() default "";
-  Sheet[] sheets() default @Sheet(sheetName = "sheet1");
-  boolean inMemory() default false;
-  String template() default "";
-  String[] include() default {};
-  String[] exclude() default {};
-  Class<? extends WriteHandler>[] writeHandler() default {};
-  Class<? extends Converter>[] converter() default {};
-  Class<? extends HeadGenerator> headGenerator() default HeadGenerator.class;
-}
-```
-
 ## 使用文档
 
 更多详细的使用说明，请参考文档：[https://www.yuque.com/pig4cloud/ogf9nv](https://www.yuque.com/pig4cloud/ogf9nv)

pom.xml

@@ -10,7 +10,7 @@
     </parent>
     <groupId>com.pig4cloud.excel</groupId>
     <artifactId>excel-spring-boot-starter</artifactId>
-    <version>3.4.0</version>
+    <version>3.4.1</version>
     <name>excel-spring-boot-starter</name>
     <description>easy and high performance excel</description>
     <url>https://pig4cloud.com</url>

src/main/java/com/pig4cloud/plugin/excel/aop/DynamicNameAspect.java

@@ -12,7 +12,10 @@
 import org.springframework.web.context.request.RequestContextHolder;
 
 import java.time.LocalDateTime;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Objects;
+import java.util.stream.Collectors;
 
 /**
  * @author lengleng
@@ -24,6 +27,8 @@ public class DynamicNameAspect {
 
 	public static final String EXCEL_NAME_KEY = "__EXCEL_NAME_KEY__";
 
+	public static final String EXCEL_INCLUDES_KEY = "__EXCEL_INCLUDES_KEY__";
+
 	private final NameProcessor processor;
 
 	@Before("@annotation(excel)")
@@ -41,6 +46,23 @@ public void around(JoinPoint point, ResponseExcel excel) {
 
 		RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
 		Objects.requireNonNull(requestAttributes).setAttribute(EXCEL_NAME_KEY, name, RequestAttributes.SCOPE_REQUEST);
+
+		// 针对include 字段的表达式处理
+		if (excel.include().length == 1) {
+			String includeFields = processor.doDetermineName(point.getArgs(), ms.getMethod(), excel.include()[0]);
+
+			if (!StringUtils.hasText(includeFields)) {
+				return;
+			}
+
+			List<String> includes = Arrays.stream(includeFields.split(","))
+				.map(String::trim)
+				.filter(s -> !s.isEmpty())
+				.collect(Collectors.toList());
+			Objects.requireNonNull(requestAttributes)
+				.setAttribute(EXCEL_INCLUDES_KEY, includes, RequestAttributes.SCOPE_REQUEST);
+		}
+
 	}
 
 }

src/main/java/com/pig4cloud/plugin/excel/handler/AbstractSheetWriteHandler.java

@@ -40,9 +40,9 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.UnsupportedEncodingException;
 import java.lang.reflect.Modifier;
 import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
@@ -77,7 +77,6 @@ public void check(ResponseExcel responseExcel) {
 	}
 
 	@Override
-	@SneakyThrows(UnsupportedEncodingException.class)
 	public void export(Object o, HttpServletResponse response, ResponseExcel responseExcel) {
 		check(responseExcel);
 		RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
@@ -86,7 +85,8 @@ public void export(Object o, HttpServletResponse response, ResponseExcel respons
 		if (name == null) {
 			name = UUID.randomUUID().toString();
 		}
-		String fileName = String.format("%s%s", URLEncoder.encode(name, "UTF-8"), responseExcel.suffix().getValue());
+		String fileName = String.format("%s%s", URLEncoder.encode(name, StandardCharsets.UTF_8),
+				responseExcel.suffix().getValue());
 		// 根据实际的文件类型找到对应的 contentType
 		String contentType = MediaTypeFactory.getMediaType(fileName)
 			.map(MediaType::toString)
@@ -122,7 +122,18 @@ public ExcelWriter getExcelWriter(HttpServletResponse response, ResponseExcel re
 		}
 
 		if (responseExcel.include().length != 0) {
-			writerBuilder.includeColumnFieldNames(Arrays.asList(responseExcel.include()));
+			RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
+			Object attribute = Objects.requireNonNull(requestAttributes)
+				.getAttribute(DynamicNameAspect.EXCEL_INCLUDES_KEY, RequestAttributes.SCOPE_REQUEST);
+
+			if (Objects.isNull(attribute)) {
+				writerBuilder.includeColumnFieldNames(Arrays.asList(responseExcel.include()));
+			}
+			else {
+				// 处理 include 字段的表达式
+				List<String> spelIncludes = (List<String>) attribute;
+				writerBuilder.includeColumnFieldNames(spelIncludes);
+			}
 		}
 
 		if (responseExcel.exclude().length != 0) {

src/test/java/com/pig4cloud/plugin/excel/enums/DemoController.java

@@ -19,9 +19,9 @@
 @RequestMapping("/demo")
 public class DemoController {
 
-	@ResponseExcel
+	@ResponseExcel(include = "#str")
 	@RequestMapping("/test")
-	public List<IndexOrNameData2> test() {
+	public List<IndexOrNameData2> test(String str) {
 		List<IndexOrNameData2> list = new ArrayList<>();
 		IndexOrNameData2 indexOrNameData2 = new IndexOrNameData2();
 		indexOrNameData2.setSex("0");

src/test/java/com/pig4cloud/plugin/excel/enums/IndexOrNameData2.java

@@ -16,7 +16,7 @@ public class IndexOrNameData2 {
 	/**
 	 * 读取第一列
 	 */
-	@ExcelProperty(value = "列1")
+	@ExcelProperty(value = "aa")
 	// 指定对应的枚举类 （字符串）
 	@DictTypeProperty(enums = SexEnum.class)
 	private String sex;