一蒲牧、使用koa2-generator搭建koa項(xiàng)目
1.全局安裝Koa腳手架
npm install koa-generator -g
2.創(chuàng)建模板
koa2 my-project-name -e // -e代表使用ejs模板引擎
二却特、配置微信公眾號后臺
進(jìn)入后臺 -> 開發(fā) -> 基本配置
1.配置ip白名單
調(diào)用獲取access_token的ip地址,需要放進(jìn)白名單,比如你本地測試的ip和你之后部署的服務(wù)器ip(只需要填寫ip檬寂,不需要加上http://之類的)
2.獲取AppSecret
這是獲取access_token需要用的密碼,一定在保存好,微信生成后不會存儲求厕,只會重置。
三扰楼、使用koa獲取access_token
1.開發(fā)前先仔細(xì)閱讀下微信的開發(fā)文檔
看完之后呀癣,你會了解到,調(diào)取幾乎所有微信的接口都需要這個(gè)access_token弦赖,所以獲取這個(gè)access_token是第一步项栏,獲取access_token需要3個(gè)參數(shù),分別是:appid蹬竖、secret(即上面所說的appsecret)和grant_type(值為:client_credential)沼沈,這三個(gè)值你可以放到項(xiàng)目的配置文件中,因?yàn)樗麄兊闹祹缀醪粫儯ǔ悄骋惶炷闩獊G了appsecret币厕,需要重置)列另。
2.接口調(diào)用
使用 https請求方式 GET請求
請求地址:https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
其中APPID和APPSECRET是變量,從你的配置文件中讀取旦装。
3.在koa中如何調(diào)用第三方的接口
我使用的是koa2-request
使用npm i koa2-request -S
并加載const koaReq = require('koa2-request')
以下是我的調(diào)用方法访递,從配置文件中讀取appid,secret,grant_type,qs
中就是GET請求參數(shù)
const koaReq = require('koa2-request')
getAccessTokenApi(){
const {appid,secret,grant_type} = wechat
return new Promise((resolve,reject)=>{
koaReq({
method: 'get',
url: `https://api.weixin.qq.com/cgi-bin/token`,
qs: { appid, secret, grant_type },
json: true//設(shè)置返回的數(shù)據(jù)為json
},(error, response, body)=> {
if(error){
reject(error)
}else{
resolve(body)
}
})
})
}
正常情況下同辣,微信會返回下述JSON數(shù)據(jù)包給公眾號:
{"access_token":"ACCESS_TOKEN","expires_in":7200}
由于access_token
的過期時(shí)間是2小時(shí)(7200秒)拷姿,所以需要我們定時(shí)去重新獲取,才能保證調(diào)用其他微信方法時(shí)access_token
不會失效
我將access_token
和過期時(shí)間expires_time
保存在文件中旱函,設(shè)置過期時(shí)間expires_time
為當(dāng)前時(shí)間+(7200-1800)秒响巢,也就是當(dāng)前時(shí)間的1個(gè)半小時(shí)后是我的過期時(shí)間。我使用了一個(gè)定時(shí)任務(wù)插件(node-schedule
)棒妨,每10分鐘去判斷一下當(dāng)前時(shí)間和過期時(shí)間踪古,如果當(dāng)前時(shí)間大于過期時(shí)間,則需要重新獲取access_token
// schedule.js
// 先書寫一個(gè)每10分鐘執(zhí)行一次的定時(shí)任務(wù)
const schedule = require('node-schedule');
const fs = require('fs')
const path = require('path')
const os = require("os");
module.exports = {
refreshTokenSchedule(callback){
console.log('啟動定時(shí)任務(wù)');
const loggerPath = path.resolve(__dirname,'../file/scheuleLogger.txt')
var rule = new schedule.RecurrenceRule();
rule.minute = [0,10,20,30,40,50];
const j = schedule.scheduleJob(rule, function(){
let now = new Date().format('yyyy年M月d日 hh:mm:ss');
fs.appendFile(loggerPath,now+=os.EOL,(err)=>{
if(err) throw err
})
callback && callback()
});
}
}
const koaReq = require('koa2-request')
const path = require('path')
const { wechat } = require('../config')
const { refreshTokenSchedule } = require('../config/schedule')
const { readFile, writeFile, isFile } = require('../config/file')
const FILEPATH = path.resolve(__dirname, '../file/accessToken.txt')
class Token {
constructor() {
// 執(zhí)行定時(shí)器券腔,定時(shí)去判斷是否過期伏穆,如果過期就重新獲取
refreshTokenSchedule(async () => {
try {
let isFileExist;
try {
isFileExist = await isFile(FILEPATH);
} catch (e) {
// 說明文件還不存在
this.writeTokenToFile()
}
if (isFileExist) {
const oldAccessTokenObj = await readFile(FILEPATH)
const { expires_time } = JSON.parse(oldAccessTokenObj)
if (new Date().getTime() > expires_time) {
// 即將過期-重新獲取
this.writeTokenToFile()
}
}
} catch (err) {
console.error(err);
}
})
}
// 將token寫入文件
async writeTokenToFile() {
try {
const { access_token, expires_in } = await this.getAccessTokenApi();
let expires_time = new Date().getTime() + (expires_in - 1800) * 1000; //提前半小時(shí)
writeFile(FILEPATH, JSON.stringify({ access_token, expires_time }))
} catch (err) {
console.error(err.errmsg || 'ERROR')
}
}
// 調(diào)用獲取access_token的接口
getAccessTokenApi() {
const { appid, secret, grant_type } = wechat
return new Promise((resolve, reject) => {
koaReq({
method: 'get',
url: `https://api.weixin.qq.com/cgi-bin/token`,
qs: { appid, secret, grant_type },
json: true//設(shè)置返回的數(shù)據(jù)為json
}, (error, response, body) => {
if (error) {
reject(error)
} else {
if (body.errcode) {
reject(body)
} else {
resolve(body)
}
}
})
})
}
}
module.exports = Token
// file.js
const fs = require('fs')
const os = require("os");
module.exports = {
// 讀取文件
readFile(fileName){
return new Promise((resolve,reject)=>{
fs.readFile(fileName, (err, data) => {
if (err) {
reject(err);
}else{
resolve(data)
}
});
})
},
// 寫入文件
writeFile(fileName,data){
return new Promise((resolve,reject)=>{
fs.writeFile(fileName,data,'utf8',(err) => {
if (err) {
reject(err);
}else{
resolve(data)
}
});
})
},
appendFile(fileName,data){
return new Promise((resolve,reject)=>{
fs.appendFile(fileName,data+=os.EOL,(err) => {
if (err) {
reject(err);
}else{
resolve(data)
}
});
})
},
// 是否是file
isFile(fileName){
return new Promise((resolve,reject)=>{
fs.stat(fileName, (err,stats) => {
if(err){
// 文件不存在
reject(err);
}else{
resolve(stats.isFile())
}
});
})
}
}
四、配置服務(wù)器地址
這個(gè)時(shí)候我們已經(jīng)可以拿到access_token可以調(diào)用其他的微信方法了纷纫,現(xiàn)在我們進(jìn)行服務(wù)器配置枕扫,可以先查看微信開發(fā)文檔了解如何配置。
其中要了解的是需要填寫的Token辱魁,相當(dāng)于是微信方和你之間的秘密烟瞧,這個(gè)值是你任意填寫的诗鸭,但是之后會用到。當(dāng)你配置服務(wù)器地址URL時(shí)参滴,微信會發(fā)送一個(gè)GET請求到你填寫的服務(wù)器地址URL上强岸,其中GET請求的請求參數(shù)是signature、timestamp砾赔、nonce蝌箍、echostr
,當(dāng)你接收到之后暴心,你需要將timestamp十绑、nonce
以及你之前填寫在微信后臺的Token,進(jìn)行一個(gè)字典序排序酷勺,并進(jìn)行sha1(npm i sha1 -S
)加密本橙,如果加密后的字符串,與微信的請求中的signature
的值一模一樣脆诉,說明這個(gè)請求來自微信甚亭,你需要返回之前微信給你的echostr
,這樣你和微信之間才做好了服務(wù)器的驗(yàn)證击胜。如果上面的功能你都完成了亏狰,你可以填寫配置服務(wù)器地址URL,如果成功了偶摔,則說明驗(yàn)證成功暇唾,如果失敗了,微信會給出提示辰斋。
// router/wechat.js
const router = require('koa-router')()
const sha1 = require('sha1')
const {wechat:{token}} = require('../config')
router.prefix('/wechat');
router.get('/', async (ctx, next) => {
const {signature,nonce,timestamp,echostr} = ctx.query
const passStr = [token, timestamp, nonce].sort().join('');
const shaStr = sha1(passStr);
if(shaStr === signature){
// 說明該請求來自微信
ctx.body = echostr;
}else{
ctx.body = 'error'
}
})
Tips:因?yàn)槲⑿殴娞栭_發(fā)需要域名策州,如何在本地實(shí)時(shí)開發(fā)呢?我用的是ngrok宫仗,進(jìn)行內(nèi)網(wǎng)映射够挂,免費(fèi)的,教程在此藕夫。免去每次都要重新部署到服務(wù)器的煩惱孽糖。
五、如何回復(fù)后臺消息
之前我們配置服務(wù)器地址的時(shí)候毅贮,寫了一個(gè)GET接口办悟,現(xiàn)在我們在此接口基礎(chǔ)上,寫一個(gè)POST請求滩褥,就可以處理消息了病蛉。但是要注意,微信接收到用戶的消息,給你時(shí)是一個(gè)xml數(shù)據(jù)包铡恕,所以你需要對xml進(jìn)行解析,并且再回復(fù)時(shí)丢间,也需要將json串轉(zhuǎn)為xml探熔,再返回給微信。接收消息文檔烘挫。
// router/wechat.js
const router = require('koa-router')()
const {wechat:{token}} = require('../config')
const xml = require('../utils/xmlParse')
const {message} = require('../utils/wx')
router.post('/', async (ctx, next) => {
const promise = new Promise((resolve, reject) => {
let buf = ''
ctx.req.setEncoding('utf8')
ctx.req.on('data', (chunk) => {
buf += chunk
})
ctx.req.on('end', () => {
xml.xmlToJson(buf)
.then(resolve)
.catch(reject)
})
})
await promise.then((xmlResult = {}) => {
try{
const {xml:msg} = xmlResult;
let replyResult = ''; //回復(fù)信息
switch(msg.MsgType[0]){
case 'text':
replyResult = message.text(msg,'你的文采太好啦~')
break;
case 'voice':
replyResult = message.text(msg,'你的聲音太好聽啦诀艰!')
break;
default:
replyResult = message.text(msg,'成功了哦!')
break;
}
ctx.body = replyResult;
}catch(e){
console.error(e)
}
})
.catch((e) => {
e.status = 400
})
await next()
})
回復(fù)微信消息饮六,json轉(zhuǎn)xml
// utils/wx
const xml = require('../utils/xmlParse')
exports.message = {
text (msg, content) {
return xml.jsonToXml({
xml: {
ToUserName: msg.FromUserName,
FromUserName: msg.ToUserName,
CreateTime: Date.now(),
// MsgType: msg.MsgType,
MsgType: 'text',
Content: content
}
})
},
}
解析xml使用了xml2js插件 npm i xml2js -S
// utils/xmlParse
const xml2js = require('xml2js')
exports.xmlToJson = (str) => {
return new Promise((resolve, reject) => {
const parseString = xml2js.parseString
parseString(str, (err, result) => {
if (err) {
reject(err)
} else {
resolve(result)
}
})
})
}
exports.jsonToXml = (obj) => {
const builder = new xml2js.Builder()
return builder.buildObject(obj)
}
這樣你就可以試著給你的公眾號發(fā)消息啦其垄!他已經(jīng)會回復(fù)你了哦