Skip to content
WeChat-Django旨在为接入微信公众平台的django开发者提供便捷的微信功能封装及最基本的后台管理支持
Branch: master
Clone or download
Latest commit ae94f8d May 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs 文档完善 Feb 23, 2019
sample python2.7 bug修复 May 17, 2019
wechat_django python2.7 bug修复 May 17, 2019
.gitignore menu Feb 14, 2019
.travis.yml 模板消息单元测试 May 17, 2019
LICENCE 整理admin结构 Mar 25, 2019
MANIFEST.in 文档完善 Feb 23, 2019
README.md 模板消息 May 16, 2019
requirements.tox.txt utf8 match test Feb 14, 2019
requirements.txt 小程序会话支持 May 1, 2019
runtests.py 权限单元测试 Feb 21, 2019
setup.cfg 修复一个bug May 1, 2019
setup.py python2.7 bug修复 May 17, 2019
tox.ini 小程序会话支持 May 1, 2019

README.md

WeChat-Django

PyPI Build Status

WeChat-Django旨在为接入微信公众平台的django开发者提供便捷的微信功能封装及最基本的后台管理支持.

项目官方地址: https://github.com/Xavier-Lam/wechat-django

本拓展基于wechatpy ,支持的最低django版本为1.11.

目前没有使用在生产环境使用本项目的案例,编写了部分单元测试,并进行了一部分简单的徒手测试.

0.2.0只是一个预览版本,可能存在较多bug,并且有api及数据结构变更可能,欢迎贡献代码

目录

功能

  • 公众号管理
  • 同步用户及用户查看,备注,用户标签管理
  • 菜单同步,查看及发布
  • 同步公众号自动回复,管理自动回复,转发和自定义自动回复业务,接收消息日志
  • 模板消息模板的同步及发送
  • 永久素材,图文的同步及查看
  • 微信网页授权
  • 主动调用微信api封装
  • 后台权限管理

安装及配置

初次安装

  1. 运行pip install wechat-django[cryptography]pip install wechat-django[pycrypto] 安装
  2. 在settings.py的INSTALLED_APPS中添加wechat_django
  3. 运行manage.py migrate wechat_django 来更新数据库结构
  4. 在urls.py 中引入wechat_django.sites.wechat.urls, 将其配置到urlpatterns中

至此,您已可以开始轻松使用wechat_django.项目尚未提供具体的使用文档,如需客制化需求,烦请先阅读代码

直接加入项目

想使用最新特性或是自行编辑代码,可clone本项目后,采用pip install -e 直接安装到你的django项目目录

更新

  1. 运行pip install -U wechat-django
  2. 运行python manage.py migrate wechat_django 来更新数据库结构

配置

一般而言,默认配置足以满足需求

参数名 默认值 说明
WECHAT_PATCHADMINSITE True 是否将django默认的adminsite替换为wechat_django默认的adminsite, 默认替换
WECHAT_SESSIONSTORAGE "django.core.cache.cache" 存储微信accesstoken等使用的Storage对象字符串,或一个接收 wechat_django.models.WeChatApp 对象并返回 wechatpy.session.SessionStorage 对象的callable或指向该callable的字符串
WECHAT_WECHATCLIENTFACTORY "wechat_django.client.get_client" 接受一个 wechat_django.models.WeChatApp 对象并返回指向一个 wechat_django.client.WeChatClient 子类的字符串,当默认的WeChatClient不能满足需求时,可通过修改生成工厂来定制自己的WeChatClient类,比如说某个公众号获取accesstoken的方式比较特殊,可以通过继承WeChatClient并复写fetch_access_token方法来实现
WECHAT_OAUTHCLIENTFACTORY "wechat_django.oauth.get_client" 接受一个 wechat_django.models.WeChatApp 对象并返回指向一个 wechat_django.oauth.WeChatOAuthClient 子类的字符串,当默认的WeChatOAuthClient不能满足需求时,可通过修改生成工厂来定制自己的WWeChatOAuthClient类
WECHAT_MESSAGETIMEOFFSET 180 微信请求消息时,timestamp与服务器时间差超过该值的请求将被抛弃
WECHAT_MESSAGENOREPEATNONCE True 是否对微信消息防重放检查 默认检查

日志

logger 说明
wechat.admin.{appname} admin异常日志 最低级别warning
wechat.api.{appname} api日志 最低级别debug
wechat.handler.{appname} 消息处理日志 最低级别debug
wechat.oauth.{appname} 网页授权异常日志 最低级别warning
wechat.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.oauth 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.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来解密客户端传来的敏感数据

encryptedData = ""
iv = ""
try:
    data = user.session.decrypt_message(
        encryptedData, iv)
except ValueError:
    pass # 无法正确解密数据 session_key可能过期了

亦可使用wechat_django.models.Session.validate_message来校验客户端传来的数据

from wechatpy.exceptions import InvalidSignatureException

signature = ""
rawData = ""
try:
    data = user.session.validate_message(
        rawData, signature)
except InvalidSignatureException:
    pass # 签名错误 session_key可能过期了

客户端调用wx.getUserInfo,可将rawData与signature传递至后端,后端通过调用wechat_django.models.Session.validate_messagewechat_django.models.User.update来更新用户信息

from django.http.response import HttpResponse
from wechatpy.exceptions import InvalidSignatureException

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

try:
    data = user.session.validate_message(
        rawData, signature)
except InvalidSignatureException:
    return HttpResponse(status=401)

user.update(data)

主动调用微信api

from wechat_django.models import WeChatApp
app = WeChatApp.get_by_name("your app name")
data = app.client.user.get_followers()

具体client的使用方式,请移步wechatpy文档

自定义微信回复

在后台配置自定义回复,填写自定义回复处理代码的路径,代码须由 wechat_django.decorators.message_handler 装饰对应的方法接收一个 wechat_django.models.WeChatMessageInfo 对象,返回字符串或一个 wechatpy.replies.BaseReply 对象

from wechat_django.handler 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())

后台使用简介

参见管理后台使用简介 文档

示例项目

可参考本项目sample文件夹

TODOS:

  • app层面的message log和reply log
  • 完善单元测试
  • 后台表单验证
  • 自定义消息处理规则

计划的功能

  • 微信支付统一下单
  • 完善模板消息
  • accesstoken开放给第三方并对接第三方accesstoken
  • 客服消息/对话
  • 清理及保护永久素材
  • 回复及一些查询缓存
  • 菜单及消息处理程序的导入导出
  • 素材Storage

已知bugs

  • 多次同步消息处理器会重复生成永久素材

ChangeLog

0.2.5

  • 模板消息

0.2.4

  • 小程序授权及验证/解密信息
  • 要求wechatpy最低版本1.8.2

0.2.2

  • 重构控制台路由及相关代码,引入django-object-tool
  • 可在控制台配置应用的accesstoken及oauth_url,以便接入第三方服务

0.2.0

  • 重构代码,修改站点url注册方式,修改部分低级api
  • 用户标签管理功能
  • 要求wechatpy最低版本1.8.0

0.1.0

  • 公众号管理及基本用法封装
  • 用户,自动回复,菜单,永久素材,图文的基本管理
  • 微信网页授权
  • 后台权限

Xavier-Lam@NetDragon

You can’t perform that action at this time.