Package: wechat-django
WeChat-DjangoWeChat-Django旨在为接入微信公众平台的django开发者提供便捷的微信及微信支付功能封装及基本的后台管理支持.项目官方地址:https://github.com/Xavier-Lam/wechat-django本拓展基于wechatpy,支持的最低django版本为1.11. WeChat-Django只是一个预览版本,可能存在较多bug并且有api及数据结构变更可能,请密切关注CHANGELOG).目录功能安装及配置初次安装直接加入项目更新配置日志注意事项部分功能使用说明网页授权小程序授权小程序信息加解密及用户数据更新主动调用微信api自定义微信回复微信支付统一下单订单更新(回调)通知django-rest-framework后台使用简介示例项目TODOS:计划的功能已知bugsChangelog功能公众号管理同步用户及用户查看,备注,用户标签管理菜单同步,查看及发布同步公众号自动回复,管理自动回复,转发和自定义自动回复业务,接收消息日志模板消息模板的同步及发送永久素材,图文的同步及查看微信网页授权主动调用微信api封装微信支付api封装微信支付订单管理及信号后台权限管理django-rest-framework APIView兼容迁移公众号自动回复/菜单/素材(不建议)安装及配置初次安装运行pip install wechat-django[cryptography]或pip install wechat-django[pycrypto]安装在settings.py的INSTALLED_APPS中添加wechat_django运行manage.py migrate wechat_django来更新数据库结构在urls.py 中引入wechat_django.sites.wechat.urls, 将其配置到urlpatterns中至此,您已可以开始轻松使用wechat_django.项目尚未提供具体的使用文档,如需客制化需求,烦请先阅读代码直接加入项目想使用最新特性或是自行编辑代码,可clone本项目后,采用pip install -e 直接安装到你的django项目目录更新运行pip install -U wechat-django运行python manage.py migrate来更新数据库结构配置一般而言,默认配置足以满足需求参数名默认值说明WECHAT_SITE_HOSTNone用于接收微信回调的默认域名WECHAT_SITE_HTTPSTrue接收微信回调域名是否是httpsWECHAT_PATCHADMINSITETrue是否将django默认的adminsite替换为wechat_django默认的adminsite, 默认替换WECHAT_SESSIONSTORAGE"django.core.cache.cache"用于存储微信accesstoken等数据的wechatpy.session.SessionStorage对象,或接收wechat_django.models.WeChatApp对象并生成其实例的工厂方法WECHAT_MESSAGETIMEOFFSET180微信请求消息时,timestamp与服务器时间差超过该值的请求将被抛弃WECHAT_MESSAGENOREPEATNONCETrue是否对微信消息防重放检查 默认检查日志logger说明wechat.admin.{appname}admin异常日志 最低级别warningwechat.api.{appname}api日志 最低级别debugwechat.handler.{appname}消息处理日志 最低级别debugwechat.oauth.{appname}网页授权异常日志 最低级别warningwechat.site.{appname}站点view异常日志(如素材代理) 最低级别warning注意事项框架默认采用django的cache管理accesstoken,如果有多个进程,或是多台机器部署,请确保所有worker使用公用cache以免造成token争用,如果希望不使用django的cache管理accesstoken,可以在配置项中定义SessionStorage请确保在https环境下部署,否则有secretkey泄露的风险部分功能使用说明网页授权可通过wechat_django.oauth.wechat_auth装饰器进行网页授权,授权后,request将被附上一个名为wechat的wechat_django.oauth.WeChatOAuthInfo对象,可通过 request.wechat.user 拿到wechat_django.models.WeChatUser实例,通过 request.wechat.app 拿到wechat_django.models.WeChatApp实例,以下是一个基本示例from wechat_django import wechat_auth

@wechat_auth("your_app_name")
def your_view(request, *args, **kwargs):
    """:type request: wechat_django.requests.WeChatOAuthRequest"""
    user = request.wechat.user对于默认重定向行为不满意的,可以自定义response,具体的参数说明参见wechat_django.oauth.wechat_auth装饰器的docstring对于class based view,可继承wechat_django.oauth.WeChatOAuthView类,具体参见代码小程序授权通过wechat_django.models.WeChatApp.auth进行授权,输入客户端传来的code, 输出一个用户对象以及原始响应.这个方法只能拿到用户的openid与unionid.from wechat_django.models import WeChatApp
app = WeChatApp.objects.get_by_name("your app name")
user, data = app.auth(code)对于授权后得到的session_key,框架会持久化至数据库,此后可以通过调用wechat_django.models.WeChatUser.session来执行相关操作.auth方法同样适用于网页授权,第二个参数填写网页授权的scope,默认base.小程序信息加解密及用户数据更新对于已经进行过小程序授权并且session_key尚未过期的用户,可以使用wechat_django.models.Session.decrypt_message来解密客户端传来的敏感数据encrypted_data = ""
iv = ""
try:
    data = user.session.decrypt_message(
        encrypted_data, iv)
except ValueError:
    pass # 无法正确解密数据 session_key可能过期了亦可使用wechat_django.models.Session.validate_message来校验客户端传来的数据from wechatpy.exceptions import InvalidSignatureException

signature = ""
raw_data = ""
try:
    data = user.session.validate_message(raw_data, signature)
except InvalidSignatureException:
    pass # 签名错误 session_key可能过期了客户端调用wx.getUserInfo,可将rawData与signature传递至后端,后端通过调用wechat_django.models.Session.validate_message与wechat_django.models.User.update来更新用户信息from django.http.response import HttpResponse
from wechatpy.exceptions import InvalidSignatureException

signature = request.POST["signature"]
raw_data = request.POST["rawData"]

try:
    data = user.session.validate_message(raw_data, signature)
except InvalidSignatureException:
    return HttpResponse(status=401)使用update方法更新用户数据user.update(data)主动调用微信apifrom wechat_django.models import WeChatApp
app = WeChatApp.get_by_name("your app name")
data = app.client.user.get_followers()具体client的使用方式,请移步wechatpy文档自定义微信回复在后台配置自定义回复,填写自定义回复处理代码的路径,代码须由wechat_django.handler.message_handler装饰对应的方法接收一个wechat_django.models.WeChatMessageInfo对象,返回字符串或一个wechatpy.replies.BaseReply对象from wechat_django import message_handler

@message_handler
def custom_business(message):
    """
    :type message: wechat_django.models.WeChatMessageInfo
    """
    user = message.user
    msg = message.message
    text = "hello, {0}! we received a {1} message.".format(
        user, msg.type)
    return TextReply(content=text.encode())微信支付使用微信支付,需要在INSTALLED_APP的wechat_django后添加wechat_django.pay.统一下单from wechat_django.models import WeChatApp
app = WeChatApp.objects.get_by_name("your app name")
order = app.pay.create_order(
    user="user-instance", body="body", total_fee=1,
    out_trade_no="***debug***20190613001") # 也可以用openid="openid"代替user参数
prepay = order.prepay(request)将jsapi参数交给前端jsapi_params = order.jsapi_params(prepay["prepay_id"])主动查询订单状态order.sync()订单更新(回调)通知当订单更新时,会发出wechat_django.pay.signals.order_updated信号,sender为订单wechat_django.utils.func.Static("{appname}.{payname}").信号提供4个变量变量说明result订单结果(wechat_django.pay.models.UnifiedOrderResult)order更新的订单(wechat_django.pay.models.UnifiedOrder)state订单状态(wechat_django.pay.models.UnifiedOrderResult.State)attach结果附带的信息(生成订单时传给微信服务器的attach)使用示例from django.dispatch import receiver
from wechat_django.pay import signals

@receiver(signals.order_updated)
def order_updated(result, order, state, attach):
    if state == UnifiedOrderResult.State.SUCCESS:
        pass注意! 每次主动调用,微信通知或是后台重新触发都会发送信号,请自行确保订单成功信号逻辑只执行一次!django-rest-framework本项目class-based OAuth授权兼容django-rest-framework.构造一个继承wechat_django.oauth.WeChatOAuthViewMixin的视图类;在视图类中定义appname属性;根据需要,定义permission_classes(如若资源必须授权才可访问,请在permission_classes中添加wechat_django.oauth.WeChatAuthenticated);根据需要,自行处理异常,在handle_exception方法中捕获rest_framework.exceptions.NotAuthenticated,自行处理.可以参见示例项目的rest.py文件.后台使用简介参见管理后台使用简介文档示例项目可参考本项目sample文件夹TODOS:是否可做成migrate权限全自助?重构权限模块?可选加密存储敏感数据Cookbookapp层面的message log和reply log完善单元测试后台表单验证计划的功能命令行工具accesstoken开放给第三方并对接第三方accesstoken客服消息/对话清理及保护永久素材回复及一些查询缓存菜单及消息处理程序的导入导出素材Storage已知bugs多次同步消息处理器会重复生成永久素材ChangelogXavier-Lam@NetDragon