【Django DRF Apps】从零搭建一个导出 Excel 和 PDF的app应用 ...

在已有的django drf项目中创建一个用于报表天生的 Django DRF 应用，支持 Excel 和 PDF 格式的报表天生与导出功能，可以分为几个步调来完成：

• 集整天生 Excel 和 PDF 的库：
  
  
  
  • Excel：利用 openpyxl 或 xlsxwriter。
    
  • PDF：利用 reportlab 或 weasyprint。
    
  
  
• 创建 API 端点：通过 DRF 提供 Excel 和 PDF 报表的下载接口。
  

一、安装必要的库

首先，安装所需的库：

1. pip install openpyxl reportlab

复制代码

二、创建 Django App

假设我们创建一个名为 report 的应用，用于报表天生功能。

1. python manage.py startapp report_app

复制代码

在 report 应用中创建报表天生逻辑。
三、实现报表天生功能

1. Excel 报表天生

利用 openpyxl 来天生 Excel 格式的报表。

1. # report/utils.py
3. from openpyxl import Workbook
4. from io import BytesIO
6. def generate_excel_report(data):
7.     wb = Workbook()
8.     ws = wb.active
10.     # 设置表头
11.     ws.append(["ID", "Name", "Amount"])
13.     # 填充数据
14.     for row in data:
15.         ws.append([row['id'], row['name'], row['amount']])
17.     # 保存为字节流
18.     byte_io = BytesIO()
19.     wb.save(byte_io)
20.     byte_io.seek(0)
21.     return byte_io

复制代码

2. PDF 报表天生

利用 reportlab 来天生 PDF 格式的报表。

1. # report/utils.py
3. from reportlab.lib.pagesizes import letter
4. from reportlab.pdfgen import canvas
5. from io import BytesIO
7. def generate_pdf_report(data):
8.     buffer = BytesIO()
9.     c = canvas.Canvas(buffer, pagesize=letter)
10.     c.setFont("Helvetica", 12)
11.     y_position = 750
13.     # 写入表头
14.     c.drawString(100, y_position, "ID")
15.     c.drawString(200, y_position, "Name")
16.     c.drawString(300, y_position, "Amount")
17.     y_position -= 20
19.     # 写入数据
20.     for row in data:
21.         c.drawString(100, y_position, str(row['id']))
22.         c.drawString(200, y_position, row['name'])
23.         c.drawString(300, y_position, str(row['amount']))
24.         y_position -= 20
26.     # 保存为字节流
27.     c.save()
28.     buffer.seek(0)
29.     return buffer

复制代码

3. 创建 API 端点

在 report/views.py 中创建 API 端点来返回报表。

1. # report/views.py
3. from rest_framework.views import APIView
4. from rest_framework.response import Response
5. from rest_framework import status
6. from rest_framework.permissions import IsAuthenticated
7. from django.http import HttpResponse
8. from .utils import generate_excel_report, generate_pdf_report
10. class ReportGenerationView(APIView):
11.     permission_classes = [IsAuthenticated]
13.     def get(self, request, report_type):
14.         # 模拟数据，实际应用中可以从数据库中获取
15.         data = [
16.             {"id": 1, "name": "John", "amount": 100},
17.             {"id": 2, "name": "Jane", "amount": 200},
18.             {"id": 3, "name": "Doe", "amount": 300}
19.         ]
20.         
21.         if report_type == 'excel':
22.             file = generate_excel_report(data)
23.             response = HttpResponse(file, content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
24.             response['Content-Disposition'] = 'attachment; filename="report.xlsx"'
25.             return response
26.         
27.         elif report_type == 'pdf':
28.             file = generate_pdf_report(data)
29.             response = HttpResponse(file, content_type='application/pdf')
30.             response['Content-Disposition'] = 'attachment; filename="report.pdf"'
31.             return response
32.         
33.         return Response({"error": "Invalid report type"}, status=status.HTTP_400_BAD_REQUEST)

复制代码

4. 配置 URL 路由

在 report/urls.py 配置路由，将报表天生功能暴露为 API 端点。

1. # report/urls.py
3. from django.urls import path
4. from .views import ReportGenerationView
6. urlpatterns = [
7.     path('generate-report/<str:report_type>/', ReportGenerationView.as_view(), name='generate-report'),
8. ]

复制代码

5. 注册 URL 路由

确保在主项目的 urls.py 中注册 report 应用的 URL。

1. # project/urls.py
3. from django.contrib import admin
4. from django.urls import path, include
6. urlpatterns = [
7.     path('admin/', admin.site.urls),
8.     path('report/', include('report.urls')),
9. ]

复制代码

四、完成后端逻辑

如今，我们已经完成了以下功能：

• 报表天生的 API (/report/generate-report/excel/ 或 /report/generate-report/pdf/)。
  
• 支持 Excel 和 PDF 格式的报表天生与导出。
  

五、测试

启动 Django 项目并利用 API 哀求：

• GET /report/generate-report/excel/：下载 Excel 报表。
  
• GET /report/generate-report/pdf/：下载 PDF 报表。
  

六、扩展功能（可选）

• 分页支持：当数据量很大时，可以支持分页天生报表。
  
• 格式定制：根据需求，可以自界说报表的格式，如添加更多的表头、内容格式化等。
  
• 权限控制：根据用户权限，限制哪些用户可以下载报表。
  

这样就完成了一个基本的报表天生 Django DRF 应用，可以根据需要进一步扩展和优化。
源码

已在github开源

Django封装高复用高可移植的apps系列

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。