✨ 毛利分析订单支持异步导出

This commit is contained in:
caojia
2026-11-17 14:55:54 +08:00
parent e104c5a3e9
commit d8f6ceda59
8 changed files with 576 additions and 26 deletions
@@ -8,6 +8,7 @@ import java.nio.file.Paths;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Map;
import com.github.pagehelper.PageHelper;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Autowired;
@@ -17,6 +18,7 @@ import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.bms.common.annotation.Log;
@@ -39,6 +41,7 @@ import com.bms.price.domain.vo.PrcProfitReportProductRow;
import com.bms.price.domain.vo.PrcProfitReportQuery;
import com.bms.price.domain.vo.PrcProfitReportSummary;
import com.bms.price.service.IPrcProfitReportService;
import com.bms.price.task.PrcProfitReportExportRunner;
/** 产品/订单维度毛利报表。 */
@RestController
@@ -51,6 +54,9 @@ public class PrcProfitReportController extends BaseController
@Autowired
private OssStorage ossStorage;
@Autowired
private PrcProfitReportExportRunner exportRunner;
/** 客户筛选选项,沿用毛利报表的访问权限和查询范围。 */
@PreAuthorize("@ss.hasPermi('report:profit:list')")
@GetMapping("/customer-options")
@@ -124,19 +130,23 @@ public class PrcProfitReportController extends BaseController
@Log(title = "毛利报表-订单维度", businessType = BusinessType.EXPORT)
@PreAuthorize("@ss.hasPermi('report:profit:export')")
@PostMapping("/orders/export")
public AjaxResult exportOrders(PrcProfitReportQuery query)
public AjaxResult exportOrders(@RequestBody PrcProfitReportQuery query)
{
PrcProfitReportExport export = beginExport("ORDER", "订单维度毛利分析");
try
{
List<PrcProfitReportOrderRow> rows = profitReportService.selectOrderRows(query);
return finishExport(export, rows, PrcProfitReportOrderRow.class, "订单毛利报表", query.getProfitRule());
}
catch (RuntimeException e)
{
failExport(export, e);
throw e;
}
return success(Map.of("taskId", exportRunner.submit(query, getUserId())));
}
@PreAuthorize("@ss.hasPermi('report:profit:export')")
@GetMapping("/orders/export/task/{taskId}")
public AjaxResult orderExportTask(@PathVariable String taskId)
{
return success(exportRunner.getTask(taskId, getUserId()));
}
@PreAuthorize("@ss.hasPermi('report:profit:export')")
@GetMapping("/orders/export/download/{taskId}")
public void downloadOrderExport(@PathVariable String taskId, HttpServletResponse response) throws Exception
{
exportRunner.download(taskId, getUserId(), response);
}
@Log(title = "毛利报表-产品维度", businessType = BusinessType.EXPORT)
@@ -0,0 +1,226 @@
package com.bms.report;
import static org.junit.jupiter.api.Assertions.*;
import java.io.InputStream;
import java.lang.reflect.Proxy;
import java.math.BigDecimal;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.time.Instant;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TimeZone;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.springframework.core.task.TaskRejectedException;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import com.bms.common.config.BmsConfig;
import com.bms.common.core.redis.RedisCache;
import com.bms.common.exception.ServiceException;
import com.bms.price.domain.PrcProfitReportExportTask;
import com.bms.price.domain.vo.PrcProfitReportOrderRow;
import com.bms.price.domain.vo.PrcProfitReportQuery;
import com.bms.price.enums.ProfitAreaRule;
import com.bms.price.service.IPrcProfitReportService;
import com.bms.price.task.PrcProfitReportExportRunner;
import com.github.pagehelper.PageHelper;
class ProfitReportAsyncExportTest
{
@TempDir
Path tempDir;
private String previousProfile;
@BeforeEach
void useTempProfile()
{
previousProfile = BmsConfig.getProfile();
new BmsConfig().setProfile(tempDir.toString());
}
@AfterEach
void restoreProfile()
{
new BmsConfig().setProfile(previousProfile);
PageHelper.clearPage();
}
@Test
void submissionQueuesWorkAndExportsAllRowsUsingTheSubmittedFiltersAndRegionColumns() throws Exception
{
for (String area : List.of("C", "GZ"))
{
AtomicInteger calls = new AtomicInteger();
HoldingExecutor executor = new HoldingExecutor();
PrcProfitReportExportRunner runner = new PrcProfitReportExportRunner(service(query -> {
calls.incrementAndGet();
assertNull(PageHelper.getLocalPage());
assertEquals(area, query.getCustomerArea());
assertEquals("UNBILLED", query.getArBillStatus());
assertEquals("P1", query.getProductCode());
query.setProfitRule(ProfitAreaRule.fromCustomerArea(area).name());
return List.of(row("ORDER-A"), row("ORDER-B"));
}), new MemoryRedis(), executor);
PrcProfitReportQuery query = query(area);
query.setProductCode("P1");
String taskId = runner.submit(query, 1L);
assertEquals(0, calls.get());
assertEquals("PENDING", runner.getTask(taskId, 1L).getStatus());
assertThrows(ServiceException.class, () -> runner.download(taskId, 1L, new MockHttpServletResponse()));
query.setProductCode("CHANGED-AFTER-SUBMIT");
PageHelper.startPage(2, 1);
executor.work.run();
PrcProfitReportExportTask task = runner.getTask(taskId, 1L);
assertEquals("SUCCESS", task.getStatus());
assertEquals(100, task.getPercent());
assertEquals(2, task.getRowCount());
assertEquals(1, calls.get());
assertNull(PageHelper.getLocalPage());
assertThrows(ServiceException.class, () -> runner.getTask(taskId, 2L));
assertThrows(ServiceException.class, () -> runner.download(taskId, 2L, new MockHttpServletResponse()));
Path file = tempDir.resolve("download").resolve(task.getStorageKey());
try (InputStream input = Files.newInputStream(file); Workbook workbook = WorkbookFactory.create(input))
{
var sheet = workbook.getSheetAt(0);
assertEquals(2, sheet.getLastRowNum());
Row header = sheet.getRow(0);
assertEquals(area.equals("C"), hasColumn(header, "产品价(目录价)"));
assertEquals(area.equals("C"), hasColumn(header, "红线毛利"));
assertTrue(hasColumn(header, "销售价"));
}
MockHttpServletResponse response = new MockHttpServletResponse();
runner.download(taskId, 1L, response);
assertArrayEquals(Files.readAllBytes(file), response.getContentAsByteArray());
assertTrue(response.getHeader("Content-Disposition").contains(".xlsx"));
}
}
@Test
void rejectedExecutionAndQueryFailuresBecomeVisibleFailedTasks() throws Exception
{
ThreadPoolTaskExecutor rejected = new ThreadPoolTaskExecutor() {
@Override
public void execute(Runnable task) { throw new TaskRejectedException("busy"); }
};
PrcProfitReportExportRunner runner = new PrcProfitReportExportRunner(service(query -> {
fail("Rejected tasks must not query orders");
return List.of();
}), new MemoryRedis(), rejected);
String rejectedId = runner.submit(query("C"), 1L);
assertEquals("FAIL", runner.getTask(rejectedId, 1L).getStatus());
assertEquals("导出任务较多,请稍后重试", runner.getTask(rejectedId, 1L).getError());
HoldingExecutor executor = new HoldingExecutor();
PrcProfitReportExportRunner failing = new PrcProfitReportExportRunner(service(query -> {
throw new ServiceException("该客户区域未配置毛利规则");
}), new MemoryRedis(), executor);
String failedId = failing.submit(query("INVALID"), 1L);
executor.work.run();
PrcProfitReportExportTask failed = failing.getTask(failedId, 1L);
assertEquals("FAIL", failed.getStatus());
assertEquals("该客户区域未配置毛利规则", failed.getError());
assertNull(failed.getStorageKey());
assertThrows(ServiceException.class, () -> failing.download(failedId, 1L, new MockHttpServletResponse()));
assertFalse(Files.exists(tempDir.resolve("download/profitReportExport/" + failedId + ".xlsx")));
}
@Test
void cleanupRemovesOnlyExpiredExportFiles() throws Exception
{
Path dir = Files.createDirectories(tempDir.resolve("download/profitReportExport"));
Path old = Files.writeString(dir.resolve("a".repeat(32) + ".xlsx"), "old");
Path recent = Files.writeString(dir.resolve("b".repeat(32) + ".xlsx"), "new");
Path other = Files.writeString(dir.resolve("unrelated.xlsx"), "other");
FileTime expired = FileTime.from(Instant.now().minusSeconds(TimeUnit.HOURS.toSeconds(25)));
Files.setLastModifiedTime(old, expired);
Files.setLastModifiedTime(other, expired);
PrcProfitReportExportRunner runner = new PrcProfitReportExportRunner(service(query -> List.of()),
new MemoryRedis(), new HoldingExecutor());
runner.cleanupExpiredFiles();
assertFalse(Files.exists(old));
assertTrue(Files.exists(recent));
assertTrue(Files.exists(other));
}
@Test
void jsonSubmissionRetainsTheListDateRangeAndFilters() throws Exception
{
ObjectMapper mapper = new ObjectMapper();
mapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
PrcProfitReportQuery query = mapper.readValue("""
{"customerArea":"C", "beginBizDate":"2026-10-18 00:00:00",
"endBizDate":"2026-11-17 23:59:59", "arBillStatus":"UNBILLED", "orderNo":"A\\nB"}
""", PrcProfitReportQuery.class);
assertEquals(Instant.parse("2026-10-17T16:00:00Z"), query.getBeginBizDate().toInstant());
assertEquals(Instant.parse("2026-11-17T15:59:59Z"), query.getEndBizDate().toInstant());
assertEquals("A\nB", query.getOrderNo());
assertEquals("UNBILLED", query.getArBillStatus());
}
private static PrcProfitReportQuery query(String area)
{
PrcProfitReportQuery query = new PrcProfitReportQuery();
query.setCustomerArea(area);
query.setArBillStatus("UNBILLED");
return query;
}
private static PrcProfitReportOrderRow row(String orderNo)
{
PrcProfitReportOrderRow row = new PrcProfitReportOrderRow();
row.setOrderNo(orderNo);
row.setSalesAmount(new BigDecimal("26.60"));
row.setArBillStatus("UNBILLED");
return row;
}
private static boolean hasColumn(Row header, String name)
{
for (var cell : header) if (name.equals(cell.getStringCellValue())) return true;
return false;
}
private static IPrcProfitReportService service(Function<PrcProfitReportQuery, List<PrcProfitReportOrderRow>> query)
{
return (IPrcProfitReportService) Proxy.newProxyInstance(ProfitReportAsyncExportTest.class.getClassLoader(),
new Class<?>[] { IPrcProfitReportService.class }, (proxy, method, args) -> {
if ("selectOrderRows".equals(method.getName())) return query.apply((PrcProfitReportQuery) args[0]);
throw new AssertionError("Unexpected service call: " + method.getName());
});
}
private static class HoldingExecutor extends ThreadPoolTaskExecutor
{
private Runnable work;
@Override
public void execute(Runnable task) { work = task; }
}
private static class MemoryRedis extends RedisCache
{
private final Map<String, Object> values = new HashMap<>();
@Override
public <T> void setCacheObject(String key, T value, Integer timeout, TimeUnit unit)
{
values.put(key, value);
}
@Override
@SuppressWarnings("unchecked")
public <T> T getCacheObject(String key) { return (T) values.get(key); }
}
}
@@ -0,0 +1,23 @@
package com.bms.price.config;
import java.util.concurrent.ThreadPoolExecutor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
/** 毛利分析导出专用线程池,限制全量订单查询与 Excel 生成的并发。 */
@Configuration
public class ProfitReportExportTaskConfig
{
@Bean(name = "profitReportExportTaskExecutor")
public ThreadPoolTaskExecutor profitReportExportTaskExecutor()
{
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(1);
executor.setMaxPoolSize(1);
executor.setQueueCapacity(2);
executor.setThreadNamePrefix("profit-report-export-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
return executor;
}
}
@@ -0,0 +1,21 @@
package com.bms.price.domain;
import java.io.Serializable;
import lombok.Data;
/** 毛利分析订单异步导出任务的临时状态。 */
@Data
public class PrcProfitReportExportTask implements Serializable
{
private static final long serialVersionUID = 1L;
private String taskId;
private Long userId;
private String status;
private int percent;
private String message;
private String error;
private int rowCount;
private String fileName;
private String storageKey;
}
@@ -2,6 +2,7 @@ package com.bms.price.domain.vo;
import java.util.Date;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonFormat;
import org.springframework.format.annotation.DateTimeFormat;
import com.bms.common.core.domain.BaseEntity;
import lombok.Data;
@@ -15,8 +16,10 @@ public class PrcProfitReportQuery extends BaseEntity
private static final long serialVersionUID = 1L;
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date beginBizDate;
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date endBizDate;
private String orderNo;
/** 订单号拆分后的多值查询条件。 */
@@ -0,0 +1,188 @@
package com.bms.price.task;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.stream.Stream;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.core.task.TaskRejectedException;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;
import com.bms.common.config.BmsConfig;
import com.bms.common.core.redis.RedisCache;
import com.bms.common.exception.ServiceException;
import com.bms.common.utils.DateUtils;
import com.bms.common.utils.file.FileUtils;
import com.bms.common.utils.poi.ExcelUtil;
import com.bms.common.utils.uuid.IdUtils;
import com.bms.price.domain.PrcProfitReportExportTask;
import com.bms.price.domain.vo.PrcProfitReportOrderRow;
import com.bms.price.domain.vo.PrcProfitReportQuery;
import com.bms.price.enums.ProfitAreaRule;
import com.bms.price.service.IPrcProfitReportService;
import com.github.pagehelper.PageHelper;
/** 毛利分析订单异步导出,沿用应收生成预览的任务、轮询、下载流程。 */
@Component
public class PrcProfitReportExportRunner
{
private static final Logger log = LoggerFactory.getLogger(PrcProfitReportExportRunner.class);
private static final String CACHE_PREFIX = "report:profit:orders:export:";
private static final String REL_DIR = "profitReportExport";
private static final int TTL_MINUTES = 60;
private static final long FILE_RETENTION_MILLIS = TimeUnit.HOURS.toMillis(24);
private final IPrcProfitReportService reportService;
private final RedisCache redisCache;
private final ThreadPoolTaskExecutor executor;
public PrcProfitReportExportRunner(IPrcProfitReportService reportService, RedisCache redisCache,
@Qualifier("profitReportExportTaskExecutor") ThreadPoolTaskExecutor executor)
{
this.reportService = reportService;
this.redisCache = redisCache;
this.executor = executor;
}
public String submit(PrcProfitReportQuery query, Long userId)
{
if (query == null || userId == null)
{
throw new ServiceException("导出参数无效");
}
PrcProfitReportQuery snapshot = new PrcProfitReportQuery();
BeanUtils.copyProperties(query, snapshot);
String taskId = IdUtils.fastSimpleUUID();
String fileName = "订单维度毛利分析_" + DateUtils.dateTimeNow() + ".xlsx";
put(taskId, userId, "PENDING", 0, "排队中", null, 0, fileName, null);
try
{
executor.execute(() -> run(taskId, userId, snapshot, fileName));
}
catch (TaskRejectedException e)
{
put(taskId, userId, "FAIL", 100, "导出失败", "导出任务较多,请稍后重试", 0, fileName, null);
}
return taskId;
}
private void run(String taskId, Long userId, PrcProfitReportQuery query, String fileName)
{
Path file = null;
try
{
// 导出全部匹配订单,不使用页面分页,也不执行分页 COUNT。
PageHelper.clearPage();
put(taskId, userId, "RUNNING", 5, "正在查询订单", null, 0, fileName, null);
List<PrcProfitReportOrderRow> rows = reportService.selectOrderRows(query);
put(taskId, userId, "RUNNING", 40, "正在生成 Excel", null, rows.size(), fileName, null);
ExcelUtil<PrcProfitReportOrderRow> util = new ExcelUtil<>(PrcProfitReportOrderRow.class);
if (ProfitAreaRule.GUANGZHOU.name().equals(query.getProfitRule()))
{
util.hideColumn("costAmount", "redlineGrossProfit", "redlineGrossMarginRate");
}
Path dir = Paths.get(BmsConfig.getDownloadPath(), REL_DIR).toAbsolutePath().normalize();
Files.createDirectories(dir);
file = dir.resolve(taskId + ".xlsx").normalize();
try (OutputStream output = Files.newOutputStream(file))
{
util.exportExcelToStream(rows, "订单毛利报表", output);
}
put(taskId, userId, "SUCCESS", 100, "导出完成,正在下载", null, rows.size(), fileName,
REL_DIR + "/" + taskId + ".xlsx");
}
catch (Exception e)
{
log.error("毛利分析订单导出失败 taskId={}", taskId, e);
if (file != null)
{
try { Files.deleteIfExists(file); }
catch (Exception cleanupError) { log.warn("清理导出文件失败 taskId={}", taskId, cleanupError); }
}
String error = e instanceof ServiceException ? e.getMessage() : "导出失败,请稍后重试";
put(taskId, userId, "FAIL", 100, "导出失败", error, 0, fileName, null);
}
finally
{
PageHelper.clearPage();
}
}
public PrcProfitReportExportTask getTask(String taskId, Long userId)
{
PrcProfitReportExportTask task = redisCache.getCacheObject(CACHE_PREFIX + taskId);
if (task == null || userId == null || !userId.equals(task.getUserId()))
{
throw new ServiceException("导出任务不存在或已过期");
}
return task;
}
public void download(String taskId, Long userId, HttpServletResponse response) throws Exception
{
PrcProfitReportExportTask task = getTask(taskId, userId);
String storageKey = task.getStorageKey();
if (!"SUCCESS".equals(task.getStatus()) || storageKey == null || !FileUtils.checkAllowDownload(storageKey))
{
throw new ServiceException("导出文件尚未生成");
}
Path root = Paths.get(BmsConfig.getDownloadPath(), REL_DIR).toAbsolutePath().normalize();
Path file = Paths.get(BmsConfig.getDownloadPath()).toAbsolutePath().normalize().resolve(storageKey).normalize();
if (!file.startsWith(root) || !Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS))
{
throw new ServiceException("导出文件不存在");
}
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
FileUtils.setAttachmentResponseHeader(response, task.getFileName());
FileUtils.writeBytes(file.toString(), response.getOutputStream());
}
@Scheduled(cron = "0 25 * * * ?")
public void cleanupExpiredFiles()
{
Path dir = Paths.get(BmsConfig.getDownloadPath(), REL_DIR).toAbsolutePath().normalize();
if (!Files.isDirectory(dir)) return;
long cutoff = System.currentTimeMillis() - FILE_RETENTION_MILLIS;
try (Stream<Path> files = Files.list(dir))
{
files.filter(file -> file.getFileName().toString().matches("[a-f0-9]{32}\\.xlsx"))
.filter(file -> Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS))
.forEach(file -> {
try
{
if (Files.getLastModifiedTime(file, LinkOption.NOFOLLOW_LINKS).toMillis() < cutoff)
{
Files.deleteIfExists(file);
}
}
catch (Exception e) { log.warn("清理过期毛利导出文件失败: {}", file, e); }
});
}
catch (Exception e) { log.warn("扫描过期毛利导出文件失败: {}", dir, e); }
}
private void put(String taskId, Long userId, String status, int percent, String message, String error,
int rowCount, String fileName, String storageKey)
{
PrcProfitReportExportTask task = new PrcProfitReportExportTask();
task.setTaskId(taskId);
task.setUserId(userId);
task.setStatus(status);
task.setPercent(percent);
task.setMessage(message);
task.setError(error);
task.setRowCount(rowCount);
task.setFileName(fileName);
task.setStorageKey(storageKey);
redisCache.setCacheObject(CACHE_PREFIX + taskId, task, TTL_MINUTES, TimeUnit.MINUTES);
}
}