新建CabloyJS项目

在进行后续模块的安装之前,您必须先创建一个CabloyJS项目

请务必参照文档步骤配置MySQL数据库连接参数

请参见:指南:快速开始

安装企业微信模块

安装企业微信模块a-wxwork

$ npm i egg-born-module-a-wxwork

安装企业微信测试模块(可选)

企业微信测试模块用于演示如何在模块a-wxwork的基础上进行具体的业务开发(同时包含企业微信小程序的demo程序)。有两种方式来使用企业微信测试模块

1. 安装到node_modules

如果仅仅是预览效果,可以直接安装到{project}/node_modules

$ npm i egg-born-module-test-wxwork

2. 安装到src/module

可以将测试模块安装到{projecct}/src/module,然后在此模块的基础上进行自定义开发

$ git clone https://github.com/zhennann/egg-born-module-test-wxwork.git src/module/test-wxwork

配置企业微信参数

直接在项目配置文件中配置自建应用小程序的参数

src/backend/config/config.default.js

// modules
  config.modules = {
    'a-wxwork': {
      account: {
        wxwork: {
          corpid: 'ww1fe9daaaa045aaaa',
          apps: {
            selfBuilt: {
              agentid: '1000008',
              secret: 'JLz3NL6PbFaaaabp64_RJpxaaaa7xROrgxraaaa-XXs',
              token: 'zNjSn7aaaaoJNk',
              encodingAESKey: 'DHc6kaaaa6BuGdnD6NRHtohqbCaaaaMDfgHtoaaaaUV',
              message: {
                reply: {
                  default: 'You are welcome!',
                },
              },
            },
            contacts: {
              secret: 'jwvLlaaaa-1Zfa4KaaaaL193-6Y5ChURkEDaaaa630Y',
              token: 'X1g3Dooaaaa1WwWYlzaaaaB5OiN',
              encodingAESKey: 'qJKICJaaaaC1DfM3Td5lr54H8Pla499EgJ9aaaaxGzg',
            },
          },
          // minis
          minis: {
            default: {
              secret: 'jwaaaacRK-1Zfa4K01aaaa93-6Y5ChURkEDaaaa630Y',
              appID: 'wx823df0aaaab9659f',
              appSecret: 'c2e4442daaaaa5e4073cf49381baaaa9',
            },
          },
        },
      },
    },
};
名称 说明
apps 配置所有微信应用的参数,包括:企业微信内置应用、第三方应用,以及自建应用。如需访问其他应用提供的API接口,直接在apps添加新的配置即可
apps.selfBuilt 自建应用
apps.contacts 企业微信内置应用 - 通讯录应用
minis 支持多个微信小程序。为了实际开发上的便利,我们默认提供一个default小程序。如果需要开发其他微信小程序,直接在minis添加新的配置即可

运行

启动后端服务

$ npm run dev:backend

启动前端服务

$ npm run dev:front

nginx配置

由于企业微信应用一定要绑定域名。为了支持开发调试,可以有不同的策略。如果我们想在服务器上配置开发环境,然后通过nginx把前端服务和后端服务反向代理给前端,请参见:nginx配置

如何访问系统

1. 进入后台管理页面

2. 同步通讯录

只有加入到企业微信通讯录中的用户才可以访问自建应用企业微信小程序。因此,我们需要先进行通讯录同步操作

当第一次同步完部门和成员后,以后所有的变更(增、删、改)都会自动进行同步

依次进入:首页->设置->企业微信->通讯录管理

contacts-sync-zhcn

3. 企业微信Mobile网页

企业微信中直接访问首页,系统会自动进行企业微信登录

4. 企业微信小程序

测试模块test-wxwork已经包含了一个企业微信小程序的demo程序,使用步骤如下:

  1. 微信开发者工具中直接导入demo程序,目录路径:{project}/src/module/test-wxwork/front/demo/miniprogram

  2. 修改小程序中的appid,文件路径:{project}/src/module/test-wxwork/front/demo/miniprogram/project.config.json

  3. 修改小程序中的baseURL,文件路径:{project}/src/module/test-wxwork/front/demo/miniprogram/cabloy/data.js

  4. 默认对应的是default小程序,如果要开发其他小程序,只需修改如下参数:

{project}/src/module/test-wechat/front/demo/miniprogram/app.js

// 初始化cabloy
this.cabloy = Cabloy(this, { scene: 'default' });
名称 说明
scene 小程序名称,默认为default