Django-Oscar扩展开发指南
项目地址: https://gitcode.com/gh_mirrors/dj/django-oscar 本文深入探讨了Django-Oscar电子商务框架的四大核心扩展开发领域：自定义支付网关集成、物流配送系统扩展、会员等级与积分系统构建，以及社交媒体与营销工具集成。文章提供了详细的技术实现方案、架构设计、代码示例和最佳实践，帮助开发者构建功能完善、性能优越的电商平台扩展功能。
自定义支付网关集成
Django-Oscar 提供了灵活的支付处理架构，允许开发者轻松集成各种第三方支付网关。本文将深入探讨如何实现自定义支付网关的集成，涵盖核心概念、实现步骤和最佳实践。
支付处理架构概览
Django-Oscar 的支付处理基于可扩展的设计模式，主要通过 OrderPlacementMixin 类来处理支付相关的逻辑。以下是支付处理的核心组件关系：
核心支付方法详解
handle_payment 方法
这是支付处理的核心方法，需要在自定义支付网关中重写：
def handle_payment(self, order_number, total, **kwargs):
"""
处理支付流程，包括与第三方支付网关的交互
参数:
- order_number: 订单编号
- total: 订单总金额
- kwargs: 其他支付参数
"""
# 初始化支付网关
gateway = CustomPaymentGateway(
api_key=settings.PAYMENT_API_KEY,
secret_key=settings.PAYMENT_SECRET_KEY
)
# 处理支付请求
payment_result = gateway.process_payment(
order_number=order_number,
amount=total.incl_tax, # 含税金额
currency=total.currency
)
if payment_result['success']:
# 记录支付来源
source = Source(
source_type=payment_result['gateway'],
amount_allocated=total.incl_tax,
reference=payment_result['transaction_id']
)
self.add_payment_source(source)
# 记录支付事件
self.add_payment_event('paid', total.incl_tax,
payment_result['transaction_id'])
else:
raise PaymentError(payment_result['error_message'])
支付网关基类实现
创建一个基础的支付网关类，为所有自定义支付网关提供统一的接口：
class PaymentGatewayBase:
"""支付网关基类，定义统一的接口规范"""
def __init__(self, api_key=None, secret_key=None, **kwargs):
self.api_key = api_key
self.secret_key = secret_key
self.config = kwargs
def process_payment(self, order_number, amount, currency, **kwargs):
"""处理支付请求，返回支付结果"""
raise NotImplementedError("子类必须实现此方法")
def handle_callback(self, request_data):
"""处理支付回调验证"""
raise NotImplementedError("子类必须实现此方法")
def get_redirect_url(self, payment_data):
"""获取支付跳转URL"""
raise NotImplementedError("子类必须实现此方法")
def verify_signature(self, data, signature):
"""验证签名"""
raise NotImplementedError("子类必须实现此方法")
实现自定义支付网关
以下是一个完整的支付宝集成示例：
import hashlib
import hmac
import json
from urllib.parse import urlencode
import requests
from django.conf import settings
from oscar.core.loading import get_model
Source = get_model('payment', 'Source')
class AlipayGateway(PaymentGatewayBase):
"""支付宝支付网关实现"""
GATEWAY_NAME = 'alipay'
API_BASE_URL = 'https://openapi.alipay.com/gateway.do'
def __init__(self, app_id=None, private_key=None, alipay_public_key=None):
super().__init__()
self.app_id = app_id or settings.ALIPAY_APP_ID
self.private_key = private_key or settings.ALIPAY_PRIVATE_KEY
self.alipay_public_key = alipay_public_key or settings.ALIPAY_PUBLIC_KEY
def process_payment(self, order_number, amount, currency, **kwargs):
"""处理支付宝支付"""
# 构建支付请求参数
biz_content = {
'out_trade_no': order_number,
'total_amount': str(amount),
'subject': f'订单 {order_number}',
'product_code': 'FAST_INSTANT_TRADE_PAY'
}
# 签名并发送请求
signed_params = self._sign_params(biz_content)
response = self._make_api_request(signed_params)
return self._parse_response(response)
def handle_callback(self, request_data):
"""处理支付宝回调验证"""
# 验证签名
if not self.verify_signature(request_data):
raise ValueError("签名验证失败")
# 处理支付结果
if request_data.get('trade_status') == 'TRADE_SUCCESS':
return {
'success': True,
'transaction_id': request_data['trade_no'],
'order_number': request_data['out_trade_no']
}
return {'success': False}
def _sign_params(self, biz_content):
"""生成签名参数"""
params = {
'app_id': self.app_id,
'method': 'alipay.trade.page.pay',
'charset': 'utf-8',
'sign_type': 'RSA2',
'timestamp': datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
'version': '1.0',
'biz_content': json.dumps(biz_content, separators=(',', ':'))
}
# 排除空值和签名参数
params = {k: v for k, v in params.items() if v and k != 'sign'}
sorted_params = sorted(params.items())
# 生成待签名字符串
sign_content = '&'.join([f'{k}={v}' for k, v in sorted_params])
signature = self._generate_signature(sign_content)
params['sign'] = signature
return params
def _generate_signature(self, content):
"""生成RSA2签名"""
# 实际实现中使用RSA2签名算法
# 这里简化处理
return hashlib.sha256(content.encode()).hexdigest()
def verify_signature(self, data, signature):
"""验证签名"""
# 实际实现中验证RSA2签名
return True
def _make_api_request(self, params):
"""发送API请求"""
try:
response = requests.post(self.API_BASE_URL, data=params, timeout=30)
response.raise_for_status()
return response.json()
except requests.RequestException as e:
raise PaymentError(f"API请求失败: {str(e)}")
def _parse_response(self, response):
"""解析API响应"""
alipay_response = response.get('alipay_trade_page_pay_response', {})
if alipay_response.get('code') == '10000':
return {
'success': True,
'redirect_url': alipay_response.get('redirect_url', ''),
'transaction_id': alipay_response.get('trade_no', '')
}
else:
return {
'success': False,
'error_message': alipay_response.get('sub_msg', '支付失败')
}
支付流程时序图
以下是自定义支付网关集成的完整流程时序图：
配置和设置
在项目的 settings.py 中配置支付网关参数：
# 支付设置
PAYMENT_GATEWAYS = {
'alipay': {
'class': 'yourapp.payment.gateways.AlipayGateway',
'config': {
'app_id': 'your_app_id',
'private_key': 'path/to/private/key.pem',
'alipay_public_key': 'path/to/alipay/public/key.pem',
'return_url': 'https://yourdomain.com/payment/return/',
'notify_url': 'https://yourdomain.com/payment/notify/'
}
},
'wechatpay': {
'class': 'yourapp.payment.gateways.WechatPayGateway',
'config': {
'app_id': 'your_wechat_app_id',
'mch_id': 'your_merchant_id',
'api_key': 'your_api_key'
}
}
}
# 默认支付网关
DEFAULT_PAYMENT_GATEWAY = 'alipay'
支付网关工厂模式
实现一个支付网关工厂来管理多个支付网关：
class PaymentGatewayFactory:
"""支付网关工厂，统一管理多个支付网关实例"""
_gateways = {}
@classmethod
def get_gateway(cls, gateway_name, **config):
"""获取支付网关实例"""
if gateway_name not in cls._gateways:
gateway_config = settings.PAYMENT_GATEWAYS.get(gateway_name, {})
gateway_class = import_string(gateway_config['class'])
# 合并配置
gateway_config = {**gateway_config.get('config', {}), **config}
cls._gateways[gateway_name] = gateway_class(**gateway_config)
return cls._gateways[gateway_name]
@classmethod
def get_available_gateways(cls):
"""获取所有可用的支付网关"""
return list(settings.PAYMENT_GATEWAYS.keys())
错误处理和日志记录
实现完善的错误处理和日志记录机制：
import logging
from django.core.exceptions import ValidationError
logger = logging.getLogger('oscar.payment')
class PaymentError(Exception):
"""支付相关异常基类"""
pass
class GatewayError(PaymentError):
"""支付网关异常"""
pass
class ValidationError(PaymentError):
"""参数验证异常"""
pass
def handle_payment_exceptions(func):
"""支付异常处理装饰器"""
def wrapper(*args, **kwargs):
try:
return func(*args, **kwargs)
except GatewayError as e:
logger.error(f"支付网关错误: {str(e)}", exc_info=True)
raise
except ValidationError as e:
logger.warning(f"支付参数验证失败: {str(e)}")
raise
except Exception as e:
logger.critical(f"未预期的支付错误: {str(e)}", exc_info=True)
raise PaymentError("支付处理失败") from e
return wrapper
测试策略
为支付网关编写全面的测试用例：
from django.test import TestCase
from unittest.mock import patch, Mock
from yourapp.payment.gateways import AlipayGateway
class PaymentGatewayTests(TestCase):
def setUp(self):
self.gateway = AlipayGateway(
app_id='test_app_id',
private_key='test_private_key'
)
@patch('requests.post')
def test_successful_payment(self, mock_post):
"""测试成功的支付流程"""
mock_response = Mock()
mock_response.json.return_value = {
'alipay_trade_page_pay_response': {
'code': '10000',
'trade_no': '2025010120004001110050000000001',
'redirect_url': 'https://alipay.com/pay'
}
}
mock_post.return_value = mock_response
result = self.gateway.process_payment(
order_number='ORDER123',
amount=100.00,
currency='CNY'
)
self.assertTrue(result['success'])
self.assertEqual(result['transaction_id'], '2025010120004001110050000000001')
def test_signature_generation(self):
"""测试签名生成"""
params = {'test': 'value'}
signature = self.gateway._generate_signature('test_content')
self.assertIsInstance(signature, str)
self.assertEqual(len(signature), 64) # SHA256哈希长度
性能优化建议
- 连接池管理: 使用 requests.Session 重用 HTTP 连接
- 异步处理: 对于非关键操作使用异步任务
- 缓存机制: 缓存支付网关配置和访问令牌
- 批量处理: 支持批量查询支付状态
# 使用连接池优化性能
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry
class OptimizedPaymentGateway(PaymentGatewayBase):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.session = self._create_session()
def _create_session(self):
"""创建优化的HTTP会话"""
session = requests.Session()
# 配置重试策略
retry_strategy = Retry(
total=3,
backoff_factor=0.5,
status_forcelist=[429, 500, 502, 503, 504]
)
adapter = HTTPAdapter(
max_retries=retry_strategy,
pool_connections=10,
pool_maxsize=100
)
session.mount("https://", adapter)
session.mount("http://", adapter)
return session
通过以上实现，您可以构建出健壮、可扩展的自定义支付网关集成方案，满足各种商业场景的支付需求。
物流配送系统扩展
Django-Oscar的物流配送系统是其电子商务框架中的核心组件之一，提供了灵活的配送管理和运费计算功能。通过扩展和定制物流配送系统，开发者可以满足不同业务场景下的配送需求，从简单的按重量计费到复杂的多区域配送策略。
配送地址管理
Django-Oscar使用抽象地址模型来管理配送地址，提供了AbstractShippingAddress类作为配送地址的基础模型：
class AbstractShippingAddress(AbstractAddress):
"""
配送地址模型
配送地址在订单提交后不应被编辑，应保持只读状态。
"""
phone_number = PhoneNumberField(
_("Phone number"),
blank=True,
help_text=_("In case we need to call you about your order"),
)
notes = models.TextField(
blank=True,
verbose_name=_("Instructions"),
help_text=_("Tell us anything we should know when delivering your order."),
)
class Meta:
abstract = True
app_label = "order"
verbose_name = _("Shipping address")
verbose_name_plural = _("Shipping addresses")
@property
def order(self):
"""返回与此配送地址关联的订单"""
return self.order_set.first()
基于重量的配送方法
Django-Oscar提供了基于重量的配送方法管理系统，通过WeightBased和WeightBand模型实现：
配送方法配置表单
系统提供了完整的表单配置界面来管理配送方法：
class WeightBasedForm(forms.ModelForm):
"""基于重量的配送方法表单"""
class Meta:
model = get_model("shipping", "WeightBased")
fields = ["name", "description", "default_weight", "countries"]
class WeightBandForm(forms.ModelForm):
"""配送费用区间表单"""
def __init__(self, method, *args, **kwargs):
super().__init__(*args, **kwargs)
self.instance.method = method
class Meta:
model = get_model("shipping", "WeightBand")
fields = ("upper_limit", "charge")
配送管理视图
Django-Oscar提供了完整的配送管理视图系统，支持配送方法的CRUD操作：
class WeightBasedListView(generic.ListView):
"""配送方法列表视图"""
model = WeightBased
template_name = "oscar/dashboard/shipping/weight_based_list.html"
context_object_name = "methods"
class WeightBasedCreateView(generic.CreateView):
"""创建配送方法视图"""
model = WeightBased
form_class = WeightBasedForm
template_name = "oscar/dashboard/shipping/weight_based_form.html"
class WeightBasedDetailView(generic.CreateView):
"""配送方法详情视图（同时用于创建费用区间）"""
model = WeightBand
form_class = WeightBandForm
template_name = "oscar/dashboard/shipping/weight_based_detail.html"
配送费用计算流程
配送费用的计算遵循清晰的流程，确保准确性和灵活性：
sequenceDiagram
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
