整合营销服务商
电脑端+手机端+微信端=数据同步管理
免费咨询热线：
电脑端+手机端+微信端=数据同步管理
免费咨询热线：
ECharts是一款基于JavaScript的数据可视化图表库，提供直观，生动，可交互，可个性化定制的数据可视化图表。 ECharts最初由百度团队开源，并于2018年初捐赠给Apache基金会，成为ASF孵化级项目。 2021年1月26日晚，Apache基金会官方宣布ECharts项目正式毕业。
实现股票日K线图
<?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">
<parent>
<artifactId>springboot-demo</artifactId>
<groupId>com.et</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>echarts</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>访问根目录，跳转到首页
package com.et.echats.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloWorldController {
@RequestMapping("/")
public String index()
{
return"index";
}
}常量data0 可以通过接口从后端获取，这里直接用静态数据
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>flask+echarts项目</title>
<!-- 导入下载的 echarts.min.js -->
<script src="../js/echarts.min.js"></script>
</head>
<body>
<div id="main" style="width:100%;height:500px;"></div>
<script type="text/javascript">
// 基于准备好的dom，初始化echarts实例
var myChart=echarts.init(document.getElementById('main'));
// 自定义图表的宽高
// var myChart=echarts.init(document.getElementById('main'),null,{width:500,height:400});
// 跟随浏览器的宽度自适应图表大小
// var myChart=echarts.init(document.getElementById('main'));
// window.addEventListener('resize',function(){myChart.resize();});
const upColor="#ec0000";
const upBorderColor="#8A0000";
const downColor="#00da3c";
const downBorderColor="#008F28";
// 拆分数据
function splitData(rawData) {
// 类型年份数据
const categoryData=[];
// 开盘价，收盘价，最低价，最高价
const values=[];
for (var i=0; i < rawData.length; i++) {
categoryData.push(rawData[i].splice(0, 1)[0]);
values.push(rawData[i]);
}
return {
categoryData: categoryData,
values: values
}
};
// 数据解释：时间，开盘价，收盘价，最低价，最高价
const data0=splitData([
['2023/1/24', 2320.26, 2320.26, 2287.3, 2362.94],
['2023/1/25', 2300, 2291.3, 2288.26, 2308.38],
['2023/1/28', 2295.35, 2346.5, 2295.35, 2346.92],
['2023/1/29', 2347.22, 2358.98, 2337.35, 2363.8],
['2023/1/30', 2360.75, 2382.48, 2347.89, 2383.76],
['2023/1/31', 2383.43, 2385.42, 2371.23, 2391.82],
['2023/2/1', 2377.41, 2419.02, 2369.57, 2421.15],
['2023/2/4', 2425.92, 2428.15, 2417.58, 2440.38],
['2023/2/5', 2411, 2433.13, 2403.3, 2437.42],
['2023/2/6', 2432.68, 2434.48, 2427.7, 2441.73],
['2023/2/7', 2430.69, 2418.53, 2394.22, 2433.89],
['2023/2/8', 2416.62, 2432.4, 2414.4, 2443.03],
['2023/2/18', 2441.91, 2421.56, 2415.43, 2444.8],
['2023/2/19', 2420.26, 2382.91, 2373.53, 2427.07],
['2023/2/20', 2383.49, 2397.18, 2370.61, 2397.94],
['2023/2/21', 2378.82, 2325.95, 2309.17, 2378.82],
['2023/2/22', 2322.94, 2314.16, 2308.76, 2330.88],
['2023/2/25', 2320.62, 2325.82, 2315.01, 2338.78],
['2023/2/26', 2313.74, 2293.34, 2289.89, 2340.71],
['2023/2/27', 2297.77, 2313.22, 2292.03, 2324.63],
['2023/2/28', 2322.32, 2365.59, 2308.92, 2366.16],
['2023/3/1', 2364.54, 2359.51, 2330.86, 2369.65],
['2023/3/4', 2332.08, 2273.4, 2259.25, 2333.54],
['2023/3/5', 2274.81, 2326.31, 2270.1, 2328.14],
['2023/3/6', 2333.61, 2347.18, 2321.6, 2351.44],
['2023/3/7', 2340.44, 2324.29, 2304.27, 2352.02],
['2023/3/8', 2326.42, 2318.61, 2314.59, 2333.67],
['2023/3/11', 2314.68, 2310.59, 2296.58, 2320.96],
['2023/3/12', 2309.16, 2286.6, 2264.83, 2333.29],
['2023/3/13', 2282.17, 2263.97, 2253.25, 2286.33],
['2023/3/14', 2255.77, 2270.28, 2253.31, 2276.22],
['2023/3/15', 2269.31, 2278.4, 2250, 2312.08],
['2023/3/18', 2267.29, 2240.02, 2239.21, 2276.05],
['2023/3/19', 2244.26, 2257.43, 2232.02, 2261.31],
['2023/3/20', 2257.74, 2317.37, 2257.42, 2317.86],
['2023/3/21', 2318.21, 2324.24, 2311.6, 2330.81],
['2023/3/22', 2321.4, 2328.28, 2314.97, 2332],
['2023/3/25', 2334.74, 2326.72, 2319.91, 2344.89],
['2023/3/26', 2318.58, 2297.67, 2281.12, 2319.99],
['2023/3/27', 2299.38, 2301.26, 2289, 2323.48],
['2023/3/28', 2273.55, 2236.3, 2232.91, 2273.55],
['2023/3/29', 2238.49, 2236.62, 2228.81, 2246.87],
['2023/4/1', 2229.46, 2234.4, 2227.31, 2243.95],
['2023/4/2', 2234.9, 2227.74, 2220.44, 2253.42],
['2023/4/3', 2232.69, 2225.29, 2217.25, 2241.34],
['2023/4/8', 2196.24, 2211.59, 2180.67, 2212.59],
['2023/4/9', 2215.47, 2225.77, 2215.47, 2234.73],
['2023/4/10', 2224.93, 2226.13, 2212.56, 2233.04],
['2023/4/11', 2236.98, 2219.55, 2217.26, 2242.48],
['2023/4/12', 2218.09, 2206.78, 2204.44, 2226.26],
['2023/4/15', 2199.91, 2181.94, 2177.39, 2204.99],
['2023/4/16', 2169.63, 2194.85, 2165.78, 2196.43],
['2023/4/17', 2195.03, 2193.8, 2178.47, 2197.51],
['2023/4/18', 2181.82, 2197.6, 2175.44, 2206.03],
['2023/4/19', 2201.12, 2244.64, 2200.58, 2250.11],
['2023/4/22', 2236.4, 2242.17, 2232.26, 2245.12],
['2023/4/23', 2242.62, 2184.54, 2182.81, 2242.62],
['2023/4/24', 2187.35, 2218.32, 2184.11, 2226.12],
['2023/4/25', 2213.19, 2199.31, 2191.85, 2224.63],
['2023/4/26', 2203.89, 2177.91, 2173.86, 2210.58],
['2023/5/2', 2170.78, 2174.12, 2161.14, 2179.65],
['2023/5/3', 2179.05, 2205.5, 2179.05, 2222.81],
['2023/5/6', 2212.5, 2231.17, 2212.5, 2236.07],
['2023/5/7', 2227.86, 2235.57, 2219.44, 2240.26],
['2023/5/8', 2242.39, 2246.3, 2235.42, 2255.21],
['2023/5/9', 2246.96, 2232.97, 2221.38, 2247.86],
['2023/5/10', 2228.82, 2246.83, 2225.81, 2247.67],
['2023/5/13', 2247.68, 2241.92, 2231.36, 2250.85],
['2023/5/14', 2238.9, 2217.01, 2205.87, 2239.93],
['2023/5/15', 2217.09, 2224.8, 2213.58, 2225.19],
['2023/5/16', 2221.34, 2251.81, 2210.77, 2252.87],
['2023/5/17', 2249.81, 2282.87, 2248.41, 2288.09],
['2023/5/20', 2286.33, 2299.99, 2281.9, 2309.39],
['2023/5/21', 2297.11, 2305.11, 2290.12, 2305.3],
['2023/5/22', 2303.75, 2302.4, 2292.43, 2314.18],
['2023/5/23', 2293.81, 2275.67, 2274.1, 2304.95],
['2023/5/24', 2281.45, 2288.53, 2270.25, 2292.59],
['2023/5/27', 2286.66, 2293.08, 2283.94, 2301.7],
['2023/5/28', 2293.4, 2321.32, 2281.47, 2322.1],
['2023/5/29', 2323.54, 2324.02, 2321.17, 2334.33],
['2023/5/30', 2316.25, 2317.75, 2310.49, 2325.72],
['2023/5/31', 2320.74, 2300.59, 2299.37, 2325.53],
['2023/6/3', 2300.21, 2299.25, 2294.11, 2313.43],
['2023/6/4', 2297.1, 2272.42, 2264.76, 2297.1],
['2023/6/5', 2270.71, 2270.93, 2260.87, 2276.86],
['2023/6/6', 2264.43, 2242.11, 2240.07, 2266.69],
['2023/6/7', 2242.26, 2210.9, 2205.07, 2250.63],
['2023/6/13', 2190.1, 2148.35, 2126.22, 2190.1]
]);
// 计算MA（移动平均值）
function calaculateMA(dayCount) {
var result=[];
for (var i=0, len=data0.values.length; i < len; i++) {
if (i < dayCount) {
result.push("-");
continue;
}
var sum=0;
for (var j=0; j < dayCount; j++) {
sum +=data0.values[i - j][1];
}
result.push(Math.round(sum/dayCount));
}
return result
};
// 指定图表的配置项和数据
var option={
// 图表标题配置
title: {
text: 'K line graph'
},
// 提示框配置
tooltip: {
// 是否显示提示框
show: true,
// 触发类型，axis 移动到坐标轴就触发
trigger: "axis",
// 坐标轴上提示点设置
axisPointer: {
type: "cross"
}
},
// 图例配置
legend: {
data: ['day K', 'MA5', 'MA10', 'MA20', 'MA30']
},
// X 轴配置项
xAxis: {
type: "category",
data: data0.categoryData,
boundaryGap: false,
axisLine: {
onZero: false
},
splitLine: {
show: true
},
min: "dataMin",
max: "dataMax"
},
// y 轴配置项
yAxis: {
scale: true,
splitArea: {
show: true
}
},
dataZoom: [{
type: "inside",
start: 50,
end: 100
},
{
show: true,
type: "slider",
top: "90%",
start: 50,
end: 100
}
],
// 系列配置，根据不同图表有不同的配置
series: [
{
name: "day K",
// 图表类型
type: 'candlestick',
// 数据内容
data: data0.values,
// K 线图的图形样式
itemStyle: {
// 阳线 图形的颜色
color: upColor,
// 阴线 图形的颜色。
color0: downColor,
// 阳线 图形的描边颜色
borderColor: upBorderColor,
// 阴线 图形的描边颜色
borderVolor0: downBorderColor
},
// 标记点配置
markPoint: {
// 标注的文本
label: {
// 标签内容格式器，支持字符串模板和回调函数两种形式，字符串模板与回调函数返回的字符串均支持用 \n 换行。
// 参数 params 是 formatter 需要的单个数据集, value是传入的数据值。
formatter: function(param) {
return param !=null ? Math.round(param.value) + "" : "";
}
},
// 标注的数据数组。每个数组项是一个对象
data: [
// 用 coord 属性指定数据在相应坐标系上的坐标位置
{
name: "Mark",
// 标注的坐标。坐标格式视系列的坐标系而定
coord: ['2023/5/31', 2300],
value: 2300,
itemStyle: {
color: 'rgb(41,60,85)'
}
},
// 特殊的标注类型，用于标注最大值最小值等
{
name: "highest value",
type: "max",
// 在使用 type 时有效，用于指定在哪个维度上指定最大值最小值。
valueDim: "highest",
},
{
name: 'lowest value',
type: 'min',
valueDim: 'lowest'
},
{
name: 'average value on close',
type: 'average',
valueDim: 'close'
}
],
// 提示框浮层内容格式器，支持字符串模板和回调函数两种形式。
tooltip:{
// params 是 formatter 需要的数据集
formatter:function(param){
// name数据名，类目名,data传入的原始数据项
return param.name+"<br>"+(param.data.coord || "")
}
}
},
markLine:{
// 标线两端的标记类型，可以是一个数组分别指定两端，也可以是单个统一指定
symbol:['none','none'],
// 标线的数据数组。每个数组项可以是一个两个值的数组，分别表示线的起点和终点，每一项是一个对象
data:[
[
// 定义从最小值到最大值的线
{
name:"from lowest to highest",
type:"min",
valueDim:"lowest",
symbol:"circle",
symbolSize: 10,
label:{show:false},
emphasis:{label:{show:false}}
},
{
type:"max",
valueDim:"highest",
symbol:"circle",
symbolSize:10,
label:{show:false},
emphasis:{label:{show:false}}
},
],
// 最小值水平线
{
name:"min line on close",
type:"min",
valueDim:"close"
},
// 最大值水平线
{
name:"max line on close",
type:"max",
valueDim:"close"
},
],
}
},
{
name:"MA5",
type:"line",
data:calaculateMA(5),
smooth:true,
lineStyle:{opacity:0.5}
},
{
name:"MA10",
type:"line",
data:calaculateMA(10),
smooth:true,
lineStyle:{opacity:0.5}
},
{
name:"MA20",
type:"line",
data:calaculateMA(20),
smooth:true,
lineStyle:{opacity:0.5}
},
{
name:"MA30",
type:"line",
data:calaculateMA(30),
smooth:true,
lineStyle:{opacity:0.5}
},
]
};
//使用刚指定的配置项和数据显示图像
myChart.setOption(option);
</script>
</body>
</html>spring.thymeleaf.cache=false
spring.thymeleaf.suffix=.html以上只是一些关键代码，所有代码请参见下面代码仓库
Tika是一个内容分析工具，自带全面的parser工具类，能解析基本所有常见格式的文件，得到文件的metadata，content等内容，返回格式化信息。总的来说可以作为一个通用的解析工具。特别对于搜索引擎的数据抓去和处理步骤有重要意义。Tika是Apache的Lucene项目下面的子项目，在lucene的应用中可以使用tika获取大批量文档中的内容来建立索引，非常方便，也很容易使用。Apache Tika toolkit可以自动检测各种文档(如word,ppt,xml,csv,ppt等)的类型并抽取文档的元数据和文本内容。Tika集成了现有的文档解析库，并提供统一的接口，使针对不同类型的文档进行解析变得更简单。Tika针对搜索引擎索引、内容分析、转化等非常有用。
应用程序员可以很容易地在他们的应用程序集成Tika。Tika提供了一个命令行界面和图形用户界面，使它比较人性化。在本章中，我们将讨论构成Tika架构的四个重要模块。下图显示了Tika的四个模块的体系结构：
每当一个文本文件被传递到Tika，它将检测在其中的语言。它接受没有语言的注释文件和通过检测该语言添加在该文件的元数据信息。支持语言识别，Tika 有一类叫做语言标识符在包org.apache.tika.language及语言识别资料库里面包含了语言检测从给定文本的算法。Tika 内部使用N-gram算法语言检测。
Tika可以根据MIME标准检测文档类型。Tika默认MIME类型检测是使用org.apache.tika.mime.mimeTypes。它使用org.apache.tika.detect.Detector 接口大部分内容类型检测。内部Tika使用多种技术，如文件匹配替换，内容类型提示，魔术字节，字符编码，以及其他一些技术。
org.apache.tika.parser 解析器接口是Tika解析文档的主要接口。该接口从提取文档中的文本和元数据，并总结了其对外部用户愿意写解析器插件。采用不同的具体解析器类，具体为各个文档类型，Tika 支持大量的文件格式。这些格式的具体类不同的文件格式提供支持，无论是通过直接实现逻辑分析器或使用外部解析器库。
使用的Tika facade类是从Java调用Tika的最简单和直接的方式，而且也沿用了外观的设计模式。可以在 Tika API的org.apache.tika包Tika 找到外观facade类。通过实现基本用例，Tika作为facade的代理。它抽象了的Tika库的底层复杂性，例如MIME检测机制，解析器接口和语言检测机制，并提供给用户一个简单的接口来使用。
实现word文档转html
<?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">
<parent>
<artifactId>springboot-demo</artifactId>
<groupId>com.et</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>tika</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.tika</groupId>
<artifactId>tika-parsers</artifactId>
<version>1.17</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>package com.et.tika.controller;
import com.et.tika.convertor.WordToHtmlConverter;
import com.et.tika.dto.ConvertedDocumentDTO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.util.HashMap;
import java.util.Map;
@RestController
@Slf4j
public class HelloWorldController {
@RequestMapping("/hello")
public Map<String, Object> showHelloWorld(){
Map<String, Object> map=new HashMap<>();
map.put("msg", "HelloWorld");
return map;
}
@Autowired
WordToHtmlConverter converter;
/**
* Transforms the Word document into HTML document and returns the transformed document.
*
* @return The content of the uploaded document as HTML.
*/
@RequestMapping(value="/api/word-to-html", method=RequestMethod.POST)
public ConvertedDocumentDTO convertWordDocumentIntoHtmlDocument(@RequestParam(value="file", required=true) MultipartFile wordDocument) {
log.info("Converting word document into HTML document");
ConvertedDocumentDTO htmlDocument=converter.convertWordDocumentIntoHtml(wordDocument);
log.info("Converted word document into HTML document.");
log.trace("The created HTML markup looks as follows: {}", htmlDocument);
return htmlDocument;
}
}package com.et.tika.convertor;
import com.et.tika.dto.ConvertedDocumentDTO;
import com.et.tika.exception.DocumentConversionException;
import lombok.extern.slf4j.Slf4j;
import org.apache.tika.exception.TikaException;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.parser.Parser;
import org.apache.tika.parser.microsoft.ooxml.OOXMLParser;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;
import org.xml.sax.SAXException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.TransformerException;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
/**
*
*/
@Component
@Slf4j
public class WordToHtmlConverter {
/**
* Converts a .docx document into HTML markup. This code
* is based on <a href="http://stackoverflow.com/a/9053258/313554">this StackOverflow</a> answer.
*
* @param wordDocument The converted .docx document.
* @return
*/
public ConvertedDocumentDTO convertWordDocumentIntoHtml(MultipartFile wordDocument) {
log.info("Converting word document: {} into HTML", wordDocument.getOriginalFilename());
try {
InputStream input=wordDocument.getInputStream();
Parser parser=new OOXMLParser();
StringWriter sw=new StringWriter();
SAXTransformerFactory factory=(SAXTransformerFactory)
SAXTransformerFactory.newInstance();
TransformerHandler handler=factory.newTransformerHandler();
handler.getTransformer().setOutputProperty(OutputKeys.ENCODING, "utf-8");
handler.getTransformer().setOutputProperty(OutputKeys.METHOD, "html");
handler.getTransformer().setOutputProperty(OutputKeys.INDENT, "yes");
handler.setResult(new StreamResult(sw));
Metadata metadata=new Metadata();
metadata.add(Metadata.CONTENT_TYPE, "text/html;charset=utf-8");
parser.parse(input, handler, metadata, new ParseContext());
return new ConvertedDocumentDTO(wordDocument.getOriginalFilename(), sw.toString());
}
catch (IOException | SAXException | TransformerException | TikaException ex) {
log.error("Conversion failed because an exception was thrown", ex);
throw new DocumentConversionException(ex.getMessage(), ex);
}
}
}package com.et.tika.dto;
import org.apache.commons.lang.builder.ToStringBuilder;
/**
*
*/
public class ConvertedDocumentDTO {
private final String contentAsHtml;
private final String filename;
public ConvertedDocumentDTO(String filename, String contentAsHtml) {
this.contentAsHtml=contentAsHtml;
this.filename=filename;
}
public String getContentAsHtml() {
return contentAsHtml;
}
public String getFilename() {
return filename;
}
@Override
public String toString() {
return new ToStringBuilder(this)
.append("filename", this.filename)
.append("contentAsHtml", this.contentAsHtml)
.toString();
}
}package com.et.tika.exception;
/**
*
*/
public final class DocumentConversionException extends RuntimeException {
public DocumentConversionException(String message, Exception ex) {
super(message, ex);
}
}以上只是一些关键代码，所有代码请参见下面代码仓库
启动Spring Boot应用
前在SpringBoot项目中一直使用的是SpringFox提供的Swagger库，上了下官网发现已经有接近两年没出新版本了！前几天升级了SpringBoot 2.6.x 版本，发现这个库的兼容性也越来越不好了，有的常用注解属性被废弃了居然都没提供替代！无意中发现了另一款Swagger库SpringDoc，试用了一下非常不错，推荐给大家！
SpringDoc是一款可以结合SpringBoot使用的API文档生成工具，基于OpenAPI 3，目前在Github上已有1.7K+Star，更新发版还是挺勤快的，是一款更好用的Swagger库！值得一提的是SpringDoc不仅支持Spring WebMvc项目，还可以支持Spring WebFlux项目，甚至Spring Rest和Spring Native项目，总之非常强大，下面是一张SpringDoc的架构图。
接下来我们介绍下SpringDoc的使用，使用的是之前集成SpringFox的mall-tiny-swagger项目，我将把它改造成使用SpringDoc。
首先我们得集成SpringDoc，在pom.xml中添加它的依赖即可，开箱即用，无需任何配置。
<!--springdoc 官方Starter-->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.6</version>
</dependency>
/**
* 品牌管理Controller
* Created by macro on 2019/4/19.
*/
@Tag(name="PmsBrandController", description="商品品牌管理")
@Controller
@RequestMapping("/brand")
public class PmsBrandController {
@Autowired
private PmsBrandService brandService;
private static final Logger LOGGER=LoggerFactory.getLogger(PmsBrandController.class);
@Operation(summary="获取所有品牌列表",description="需要登录后访问")
@RequestMapping(value="listAll", method=RequestMethod.GET)
@ResponseBody
public CommonResult<List<PmsBrand>> getBrandList() {
return CommonResult.success(brandService.listAllBrand());
}
@Operation(summary="添加品牌")
@RequestMapping(value="/create", method=RequestMethod.POST)
@ResponseBody
@PreAuthorize("hasRole('ADMIN')")
public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {
CommonResult commonResult;
int count=brandService.createBrand(pmsBrand);
if (count==1) {
commonResult=CommonResult.success(pmsBrand);
LOGGER.debug("createBrand success:{}", pmsBrand);
} else {
commonResult=CommonResult.failed("操作失败");
LOGGER.debug("createBrand failed:{}", pmsBrand);
}
return commonResult;
}
@Operation(summary="更新指定id品牌信息")
@RequestMapping(value="/update/{id}", method=RequestMethod.POST)
@ResponseBody
@PreAuthorize("hasRole('ADMIN')")
public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrandDto, BindingResult result) {
CommonResult commonResult;
int count=brandService.updateBrand(id, pmsBrandDto);
if (count==1) {
commonResult=CommonResult.success(pmsBrandDto);
LOGGER.debug("updateBrand success:{}", pmsBrandDto);
} else {
commonResult=CommonResult.failed("操作失败");
LOGGER.debug("updateBrand failed:{}", pmsBrandDto);
}
return commonResult;
}
@Operation(summary="删除指定id的品牌")
@RequestMapping(value="/delete/{id}", method=RequestMethod.GET)
@ResponseBody
@PreAuthorize("hasRole('ADMIN')")
public CommonResult deleteBrand(@PathVariable("id") Long id) {
int count=brandService.deleteBrand(id);
if (count==1) {
LOGGER.debug("deleteBrand success :id={}", id);
return CommonResult.success(null);
} else {
LOGGER.debug("deleteBrand failed :id={}", id);
return CommonResult.failed("操作失败");
}
}
@Operation(summary="分页查询品牌列表")
@RequestMapping(value="/list", method=RequestMethod.GET)
@ResponseBody
@PreAuthorize("hasRole('ADMIN')")
public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value="pageNum", defaultValue="1")
@Parameter(description="页码") Integer pageNum,
@RequestParam(value="pageSize", defaultValue="3")
@Parameter(description="每页数量") Integer pageSize) {
List<PmsBrand> brandList=brandService.listBrand(pageNum, pageSize);
return CommonResult.success(CommonPage.restPage(brandList));
}
@Operation(summary="获取指定id的品牌详情")
@RequestMapping(value="/{id}", method=RequestMethod.GET)
@ResponseBody
@PreAuthorize("hasRole('ADMIN')")
public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {
return CommonResult.success(brandService.getBrand(id));
}
}
/**
* SpringDoc API文档相关配置
* Created by macro on 2022/3/4.
*/
@Configuration
public class SpringDocConfig {
@Bean
public OpenAPI mallTinyOpenAPI() {
return new OpenAPI()
.info(new Info().title("Mall-Tiny API")
.description("SpringDoc API 演示")
.version("v1.0.0")
.license(new License().name("Apache 2.0").url("https://github.com/macrozheng/mall-learning")))
.externalDocs(new ExternalDocumentation()
.description("SpringBoot实战电商项目mall（50K+Star）全套文档")
.url("http://www.macrozheng.com"));
}
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("brand")
.pathsToMatch("/brand/**")
.build();
}
@Bean
public GroupedOpenApi adminApi() {
return GroupedOpenApi.builder()
.group("admin")
.pathsToMatch("/admin/**")
.build();
}
}
/**
* SpringSecurity的配置
* Created by macro on 2018/4/26.
*/
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled=true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity httpSecurity) throws Exception {
httpSecurity.csrf()// 由于使用的是JWT，我们这里不需要csrf
.disable()
.sessionManagement()// 基于token，所以不需要session
.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
.and()
.authorizeRequests()
.antMatchers(HttpMethod.GET, // Swagger的资源路径需要允许访问
"/",
"/swagger-ui.html",
"/swagger-ui/",
"/*.html",
"/favicon.ico",
"/**/*.html",
"/**/*.css",
"/**/*.js",
"/swagger-resources/**",
"/v3/api-docs/**"
)
.permitAll()
.antMatchers("/admin/login")// 对登录注册要允许匿名访问
.permitAll()
.antMatchers(HttpMethod.OPTIONS)//跨域请求会先进行一次options请求
.permitAll()
.anyRequest()// 除上面外的所有请求全部需要鉴权认证
.authenticated();
}
}
/**
* SpringDoc API文档相关配置
* Created by macro on 2022/3/4.
*/
@Configuration
public class SpringDocConfig {
private static final String SECURITY_SCHEME_NAME="BearerAuth";
@Bean
public OpenAPI mallTinyOpenAPI() {
return new OpenAPI()
.info(new Info().title("Mall-Tiny API")
.description("SpringDoc API 演示")
.version("v1.0.0")
.license(new License().name("Apache 2.0").url("https://github.com/macrozheng/mall-learning")))
.externalDocs(new ExternalDocumentation()
.description("SpringBoot实战电商项目mall（50K+Star）全套文档")
.url("http://www.macrozheng.com"))
.addSecurityItem(new SecurityRequirement().addList(SECURITY_SCHEME_NAME))
.components(new Components()
.addSecuritySchemes(SECURITY_SCHEME_NAME,
new SecurityScheme()
.name(SECURITY_SCHEME_NAME)
.type(SecurityScheme.Type.HTTP)
.scheme("bearer")
.bearerFormat("JWT")));
}
}
SpringDoc还有一些常用的配置可以了解下，更多配置可以参考官方文档。
springdoc:
swagger-ui:
# 修改Swagger UI路径
path: /swagger-ui.html
# 开启Swagger UI界面
enabled: true
api-docs:
# 修改api-docs路径
path: /v3/api-docs
# 开启api-docs
enabled: true
# 配置需要生成接口文档的扫描包
packages-to-scan: com.macro.mall.tiny.controller
# 配置需要生成接口文档的接口路径
paths-to-match: /brand/**,/admin/**
在SpringFox的Swagger库好久不出新版的情况下，迁移到SpringDoc确实是一个更好的选择。今天体验了一把SpringDoc，确实很好用，和之前熟悉的用法差不多，学习成本极低。而且SpringDoc能支持WebFlux之类的项目，功能也更加强大，使用SpringFox有点卡手的朋友可以迁移到它试试！
https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-springdoc
来源：https://mp.weixin.qq.com/s/scityFhZp9BOJorZSdCG0w
*请认真填写需求信息，我们会在24小时内与您取得联系。
