利用OpenShift托管Node.js Web服务进行微信公众号开发

2023-10-28 13:05:40

最近写了一个微信的翻译机器人。用户只要关注该微信号，发送英文的消息，就能收到中文翻译的回复。后台是用Node.js写的，托管在OpenShift的Paas平台上。翻译过程实际上是调用微软的Bing translation API做的，代码中用到了alexu84的bing-translate和JacksonTian的wechat这两个npm模块。下面把做的过程详细说一下。

1. 微信公众号开发

首先是要到https://mp.weixin.qq.com 申请一个公众号，并申请成为开发者。目前个人只能申请订阅号，不过订阅号也可以和用户进行消息的交互，这对我们的应用来说足够了。

成为开发者后，微信会给你一个AppID和一个AppSecret，都是一长串的字符串。在开发我们这个应用时，只要用到AppID。

微信客户端会接受用户输入的消息，并把它们转给我们的Web服务。所以微信会要求我们填写我们Web服务的URL地址，Token（令牌)，EncodingAESKey（消息加解密密钥）。页面如下图所示：

大致上，填写好信息并提交后，微信服务器会发送一个GET请求到我们的Web服务，携带上Token和一个随机字符串。我们的Web服务必须按照微信开发者文档规定的方式处理这个请求，原样返回这个随机字符串，这样微信服务器才认为我们的Web服务是符合它的接入要求的。微信服务器转发消息给我们自己的Web服务时，是以一个POST消息携带上一个XML数据包，我们的web服务必须解析这个XML数据包才能取得用户发的消息。同样，当我们回复消息给微信服务器时，也要满足其规定的要求。所有这些，在微信的开发者文档中都有详细的描述。

我们当然可以仔细阅读微信的开发者文档，并自己按要求一一实现对应的接口，不过这样太麻烦了:-)。更方便的方式是使用JacksonTian的微信开发Node.js模块。使用这个模块，我们只需要填入我们的Token，APPID以及EncodingAESKey，它自动就帮我们处理好微信服务器的验证请求，并允许我们直接获取/回复用户的字符串消息，使我们不用处理XML数据解析等细节问题。在下文我会详细介绍如何使用这个模块。

2. 利用OpenShift托管Node.js Web服务

首先，我们要知道如何用Node.js开发一个Web服务。本文不打算详细介绍这部分内容。基本上，利用express模块，只需几行代码就可以搭起一个Web服务，像这样：

var express = require(‘express‘);

var app = express();
app.listen(80);

app.get(‘/‘, function (req, res) {
    res.send("hello world‘);
});

搭建好web服务后，我们需要一个拥有公有IP的服务器来运行这些代码。在这方面，我们有很多选择，本文使用OpenShift的应用托管服务。

Youtube上有一个很好的视频介绍如何利用OpenShift建立和发布一个Node.js应用，step by step级别的，非常的详细。我们只需要看前30分钟就行了。基本上，Openshift使用git来管理代码开发以及发布的过程。你建立一个应用，OpenShift就在云端为你创建了一个Git仓库，包含一个示例的Node.js应用，并把它在云端运行起来了。我们只要把这个Git仓库的代码Clone到本地，修改其中的server.js，并把修改好的代码push到云端，Openshift就会自动帮我们停掉当前的示例服务，重新编译代码，重新发布并把我们修改过后的服务运行起来。超级的简单，是不是？

下面是稍微详细一点的步骤：

1）安装OpenShift的客户端工具rhc，我们需要利用这个工具创建、发布Node.js应用

2）在command line窗口运行 $ rhc app create <my app name> nodejs-0.10。这个命令为我们在云端创建了一个Git仓库，把内含的示例应用运行起来，并把代码帮我们clone到了本地。

3）修改server.js，运行：

$ git commit -am <some comment>

$ git push

我们自己的web服务就在云端运行起来了!

3. 使用bing-translate 和wechat NPM module

这一部分稍微详细介绍一下如何修改server.js，也就是如何使用bing-translate和wechat这两个NPM模块的。

还是直接上代码吧，因为总共就不到40行代码。其中第18行展示了如何使用wechat，第23行展示了如何使用bing-translate。

var express = require(‘express‘);
var kutil = require(‘./util/kutil.js‘);
var wechat = require(‘wechat‘);

var server_port = process.env.OPENSHIFT_NODEJS_PORT || 8080
var server_ip_address = process.env.OPENSHIFT_NODEJS_IP || ‘127.0.0.1‘

var client_id_secret = kutil.readJsonFromFile(‘./res/client_id_secret.json‘);
var wechat_app_config = kutil.readJsonFromFile(‘./res/wechat_app_config.json‘);

var bt = require(‘./util/bing-translate.js‘).init(client_id_secret);

var app = express();
app.listen(server_port, server_ip_address);

// wechat API
app.use(express.query());
app.use(‘/wechat‘, wechat(wechat_app_config, function (req, res, next) {
    var message = req.weixin;
    if (message.MsgType == ‘text‘) {
        var input_word = message.Content;

        bt.translate(input_word, ‘en‘, ‘zh-CHS‘, function (translate_err, translate_res) {
            if (translate_err) {
                res.reply({
                    content: ‘translation error‘,
                    type: ‘text‘
                });
                return;
            }

            var translate_result = translate_res["translated_text"];
            res.reply({
                content: translate_result,
                type: ‘text‘
            });
        });
    }
}));

因为我不想在开源的代码中明文写上我的微信APPID等敏感信息，我又写了一个util从Json文件中读取这些信息。第8行是读Bing translation app的ID和secret，第9行是读微信的APPID等信息。这些信息都分别写在一个Json文件中，格式如下:

{
    "client_id": "your-Bing-translator-app-client_id",
    "client_secret": "your-Bing-translator-app-client_secret"
}

{
    "token": "your_wechat_app_token",
    "appid": "your_wechat_app_appid",
    "encodingAESKey": "your_wechat_app_AESKey"
}

另外，有人可能会注意到我没有直接使用alexu84的bing-translate模块，而是引用了一个本地的bing-translate.js文件。这是因为我对该模块的源文件做了少量的改动，主要是在本地cache了一个Bing translation API的token，这样就不用每次翻译的时候都去调微软的Web API重新拿token了，翻译响应的速度会大大提高。有空的时候我会把这个改动push给alexu84试试看。

4. 关于Microsoft Bing Translation API

大家都注意到在上一部分我们要填入Bing Translation的client ID和client secret。这是因为Bing Translation API也是一个Web服务，我们需要到这个页面去申请一个Bing Translation的app，申请好后，就有了我们自己的client ID 和 secret。当然这里可能涉及要注册微软的账号什么的，这里就不赘述了。

最后，我的代码都放到了GitHub上，除了把APPID和secret什么的替换成示例的字符串，其他的就和我在OpenShift上发布的代码一模一样了。

参考资源

1. Jose Annunziato 如何利用OpenShift 发布 Node.js应用的视频：https://www.youtube.com/watch?v=wnRtA7a0ST0

2. alexu84: Bing translation API 的Node.js wrapper https://github.com/alexu84/bing-translatehttps://github.com/alexu84/bing-translate

3. JacksonTian: 微信API的Node.js wrapper https://github.com/node-webot/wechat

4. Bing Translation API: http://blogs.msdn.com/b/translation/p/gettingstarted1.aspx

5. 我的代码示例：https://github.com/kaige/KDict/tree/master/openshift_host_code/kdict