最近有一个需求,要将任务运行的日志实时显示在前端页面上,让用户及时了解该任务的执行情况。分两部分:后台如何获取日志信息?获取日志信息后,如何实时展示在前端页面上?
本文先讨论下实时展示到页面,可采取的方案有两种:①ajax轮询,隔3-5秒访问后台,获取日志信息响应;②无需前端请求,后台主动将日志信息推送到前端页面展示。以上两者都是可行的,没有绝对的优劣。本文就第二种方案使用websocket实现做了一个样例,说明:这里只有干货,websocket 的详细介绍可问度娘。。。。
1. 使用 swagger 接口文档进行调试(生产环境应关闭swagger访问配置), 若不习惯使用 swagger 接口调试,可忽略下面的swagger 的部分。
2. 使用 websocket 主动、实时推送信息到前端(注意事项:使用 websocket 前确定环境支持websocket;demo为本地环境,使用的谷歌浏览器;websocket 不兼容低版本的IE,若使用,请确认线上用户是否有浏览器的限制)
项目结构:
配置部分--
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
</parent>
<groupId>com.zlf</groupId>
<artifactId>websocket-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<lombok.version>1.16.6</lombok.version>
<commons.version>5.0.7</commons.version>
<junit.version>4.12</junit.version>
<springfox-swagger.version>2.7.0</springfox-swagger.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.11</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.system.commons</groupId>
<artifactId>commons</artifactId>
<version>${commons.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
<!-- websocket -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<!-- Swagger API文档 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox-swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox-swagger.version}</version>
</dependency>