【springboot+vue项目（十二）】文件上传状态管理

一、需求介绍 

        基于Spring Boot + MySQL + Vue + Element UI + easyexcel + WebSocket的完整方案，实现文件上传、解析、校验、入库，并存储实时日志的功能。

后端（Spring Boot）：

• 使用Spring Boot作为后端框架，搭建文件上传、解析、校验、入库的API接口。
• 使用MySQL作为数据库存储文件处理的结果和相关数据。
• 使用Spring WebSocket实现实时日志的推送功能。

前端（Vue + Element UI）：

• 使用Vue框架和Element UI构建前端页面，提供文件上传界面和实时日志展示界面。
• 通过Vue组件和Element UI组件实现文件上传、进度展示和实时日志展示等功能。

文件处理：

• 使用easyexcel库实现文件解析功能，将上传的Excel文件解析为数据对象。
• 执行数据校验逻辑，对解析后的数据进行校验，确保数据的准确性和有效性。
• 将校验通过的数据存储到MySQL数据库中的相应表中。

实时日志：

• 在文件处理过程中，使用WebSocket向前端实时推送日志信息。
• 在后端处理过程中，将关键的日志信息记录到MySQL数据库中，以便后续查询和分析。

 

二、开发流程 

        下面是一个详细的方案，包括搭建Spring Boot后端、Vue前端以及使用easyexcel和WebSocket实现文件处理和实时日志功能：

（一）搭建Spring Boot后端

a. 创建Spring Boot项目

        使用Spring Initializr（https://start.spring.io/）创建一个新的Spring Boot项目。
选择所需的依赖，如Spring Web、Spring Data JPA、MySQL连接器和Spring WebSocket。

b. 配置数据库连接

        在application.properties文件中配置数据库连接信息，如数据库URL、用户名和密码。

c. 创建文件上传接口

        创建一个FileUploadController类，使用@RestController注解标记为一个REST控制器。
在FileUploadController类中，使用@PostMapping注解定义一个处理文件上传请求的方法。
在文件上传方法中，使用MultipartFile参数接收上传的文件，并编写文件处理逻辑，包括解析、校验和入库。

d. 创建数据访问层

        创建相应的实体类，如FileData用于存储文件处理的结果。
创建FileDataRepository接口，继承JpaRepository，用于操作FileData实体类的数据。

e. 配置WebSocket

        （1）创建一个WebSocket配置类，如WebSocketConfig。
        （2）在WebSocketConfig类中，实现WebSocketConfigurer接口，并重写registerWebSocketHandlers()方法。
        （3）在registerWebSocketHandlers()方法中，注册WebSocket处理器和拦截器。

f. 创建WebSocket处理器

        （1）创建一个WebSocket处理器类，如LogWebSocketHandler，实现WebSocketHandler接口。
        （2）在LogWebSocketHandler类中，重写相应的WebSocket处理方法，如afterConnectionEstablished()和handleTextMessage()。
        （3）在afterConnectionEstablished()方法中，将WebSocketSession添加到一个全局的Set中，以便后续向所有连接的客户端推送日志信息。
        （4）在handleTextMessage()方法中，处理从前端发送过来的WebSocket消息。

（二）搭建Vue前端

a. 创建Vue项目

        使用Vue CLI（https://cli.vuejs.org/）初始化一个新的Vue项目。

b. 安装Element UI

        在命令行中运行npm install element-plus，安装Element UI库。

c. 创建文件上传组件

        创建一个文件上传组件，如FileUpload.vue，用于接收用户上传的文件。
        在FileUpload.vue中，使用组件实现文件上传功能，并使用axios或Fetch API将文件上传到后端API。

d. 创建实时日志展示组件

        创建一个实时日志展示组件，如RealTimeLog.vue，用于展示实时的日志信息。
在RealTimeLog.vue中，使用或组件实现日志信息的展示。

e. 连接WebSocket服务

         （1） 在Vue项目中，创建一个WebSocket实例，连接到后端的WebSocket服务。
        （2）监听WebSocket的onmessage事件，接收后端推送的日志消息。
        （3）将接收到的日志消息展示在实时日志展示组件中。

（三）easyexcel实现文件处理：

a. 添加easyexcel依赖：

在Spring Boot项目的pom.xml文件中，添加easyexcel的依赖项：

    com.alibaba
    easyexcel
    2.4.0

b. 解析上传的Excel文件：

       (1) 在文件上传的方法中，使用EasyExcel.read()方法读取上传的Excel文件，并指定数据解析的监听器。
       (2) 创建一个数据解析的监听器类，实现AnalysisEventListener接口，并重写相应的方法。
        (3)在监听器的invoke()方法中，处理解析后的数据。

c. 执行数据校验逻辑

        (1) 在解析后的数据处理逻辑中，编写数据校验的代码。
        (2) 根据业务需求，编写校验规则和逻辑，对解析后的数据进行校验。
        (3) 将校验通过的数据存储到数据库中，可以使用FileDataRepository进行数据的持久化操作。

(四)WebSocket实现实时日志功能：

a.记录关键的日志信息

        （1）在文件处理过程中，记录关键的日志信息，如文件上传开始、解析完成、校验通过等。

        （2）在文件处理的代码中，使用System.out.println()或日志框架（如Log4j或Slf4j）记录日志信息。
        （3）将关键日志信息存储到数据库中，可以创建一个LogData实体类，类似于FileData，用于存储日志信息。

b. 在LogWebSocketHandler类中，实现日志信息的推送逻辑。

       （1） 在文件处理过程中，将关键的日志信息通过WebSocket发送给前端。
       （2）在handleTextMessage()方法中，遍历所有连接的WebSocketSession，向每个客户端发送日志消息。

（五） 定时任务清理过期的日志数据

        创建一个定时任务，如LogDataCleanupTask，使用@Scheduled注解指定定时任务的执行时间。
        在定时任务中，编写清理过期日志数据的逻辑，可以使用FileDataRepository进行数据库操作。

三、总结 

        通过上述方案，可以搭建一个完整的文件处理和实时日志展示系统。后端使用Spring Boot框架提供API接口和WebSocket功能，使用easyexcel库实现文件解析和数据校验，使用MySQL存储文件处理的结果和日志信息。前端使用Vue和Element UI构建用户界面，实现文件上传和实时日志展示。通过WebSocket实现实时日志的推送功能，并使用定时任务和Spring Security等辅助功能增强系统的性能和安全性。