SpringBoot中实现JSON转Word格式的示例详解
作者：搬砖牛马人
这篇文章主要为大家详细介绍了如何使用SpringBoot实现JSON转Word格式,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
以下是一个在 Spring Boot 中实现 JSON 转 Word 的示例：
1.首先，需要在项目中引入相关的依赖，如 json 和 Apache POI 等。在 pom.xml 文件中添加以下内容：
<!-- JSON 相关依赖 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.13.3</version>
</dependency>
<!-- Apache POI 相关依赖 -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>5.2.3</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>5.2.3</version>
</dependency>2.创建一个 Java 类，用于将 JSON 转换为 Word 文档，以下是示例代码：
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import java.io.ByteArrayOutputStream;
import java.io.IOExceptionimport;
java.util.Map;
@RestController
@RequestMapping("/json-to-word")
public class JsonToWordController {
@PostMapping
public ResponseEntity<byte[]> jsonToWord(@RequestBody Map<String, Object> json) throws IOException {
// 创建一个 Word 文档
XWPFDocument document = new XWPFDocument();
// 创建一个新的段落
XWPFParagraph paragraph = document.createParagraph();
// 设置段落的文本内容为 JSON 的字符串形式
paragraph.createRun().setText(new ObjectMapper().writeValueAsString(json));
// 将 Word 文档转换为字节数组
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
document.write(outputStream);
byte[] wordBytes = outputStream.toByteArray();
// 设置响应头，指定内容类型为 Word 文，并档设置文件名
return ResponseEntity.ok()
.header("Content-Type", "application/vnd.openxmlformats-officedocument.wordprocessingml.document")
.header("Content-Disposition", "attachment; filename=generated-word.docx")
.body(wordBytes);
}
}3.知识延展
springboot自带json转换
阿里fastjson反序列化漏洞，实在太多了，经常换版本，改成springboot自带的jackson。
Maven单独使用
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.1</version>
</dependency>
web项目spring-boot-starter-web已经包含了，无需再单独引用
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>package test;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Test {
public static void main(String[] args) throws Exception {
ObjectMapper mapper = new ObjectMapper();
Map<String, Object> person = new HashMap<>();
person.put("name", "zhangsan");
person.put("age", 18);
List<Map<String, Object>> personList = new ArrayList<>();
personList.add(person);
//对象转json字符串
String jsonmap = mapper.writeValueAsString(person);
System.out.println(jsonmap);//{"name":"zhangsan","age":18}
String jsonlist = mapper.writeValueAsString(personList);
System.out.println(jsonlist);//[{"name":"zhangsan","age":18}]
//json字符串转对象
Map<String, Object> map = mapper.readValue(jsonmap, Map.class);
List<Map<String, Object>> list = mapper.readValue(jsonlist, List.class);
System.out.println();
}
}fastapi 接口实现json格式转word
fastapi api 运行之后 浏览器进入 http://127.0.0.1:8000/redoc 下载接口json
openapi_data 为json文件中的内容，需要把json中的true 修改为True，会在同级目录下生成一个word文档。代码如下：
from docx import Document
from io import BytesIO
openapi_data = {
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"paths": {
"/download-model": {
"post": {
"summary": "Download Model",
"description": "下载训练好的模型文件的API端点。\n\nArgs:\n request (DownloadRequest): 包含模型文件路径的请求体。 file_path: str # 文件路径，必须提供\n\nReturns:\n FileResponse: 返回模型文件流。\n\nRaises:\n HTTPException: 如果文件不存在，返回404错误。\n HTTPException: 如果路径无效，返回400错误。",
"operationId": "download_model_download_model_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadRequest"
}
}
},
"required": True
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
}
}
doc = Document()
doc.add_heading('API Documentation', 0)
# Add API information
doc.add_heading('API Information', level=1)
doc.add_paragraph(f"Title: {openapi_data['info']['title']}")
doc.add_paragraph(f"Version: {openapi_data['info']['version']}")
# Add path information
doc.add_heading('API Endpoints', level=1)
for path, methods in openapi_data['paths'].items():
for method, details in methods.items():
doc.add_heading(f"{method.upper()} {path}", level=2)
doc.add_paragraph(f"Summary: {details.get('summary', 'No summary')}")
doc.add_paragraph(f"Description: {details.get('description', 'No description')}")
if 'requestBody' in details:
doc.add_heading('Request Body', level=3)
for content_type, content in details['requestBody']['content'].items():
doc.add_paragraph(f"Content-Type: {content_type}")
schema_ref = content['schema'].get('$ref', None)
if schema_ref:
schema_name = schema_ref.split('/')[-1]
schema = openapi_data['components']['schemas'][schema_name]
doc.add_paragraph(f"Schema: {schema_name}")
doc.add_paragraph(f"Description: {schema.get('description', 'No description')}")
doc.add_paragraph(f"Required: {', '.join(schema.get('required', []))}")
doc.add_paragraph(f"Properties:")
for prop, prop_details in schema.get('properties', {}).items():
doc.add_paragraph(f"- {prop} ({prop_details.get('type', 'unknown')}): {prop_details.get('title', '')}")
if 'responses' in details:
doc.add_heading('Responses', level=3)
for status_code, response in details['responses'].items():
doc.add_paragraph(f"Status Code: {status_code}")
doc.add_paragraph(f"Description: {response.get('description', 'No description')}")
# Save the document to a BytesIO buffer
buffer = BytesIO()
doc.save(buffer)
buffer.seek(0)
# Save the file to disk (or you can return it as a download in a web app)
with open("api_documentation.docx", "wb") as f:
f.write(buffer.read())
到此这篇关于SpringBoot中实现JSON转Word格式的示例详解的文章就介绍到这了,更多相关SpringBoot JSON转Word内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！