首页javascript

koa2 开发实践指南

hfpp2012发布于78 次阅读

1. 介绍

最近用koa2来开发应用,把自己的经验记录一下。

介绍koa的文章,请查看es6的generator和nodejs的下一代框架koa这篇文章。

2. n版本管理器

首先使用最新版本的nodejs。

我使用n来管理nodejs的版本,也用n来安装比较新的nodejs。

3. 用db-migrate来管理数据库迁移

我想像rails那样来管理migration,只有db-migrate才比较好用。

具体可以查看这篇文章node-db-migrate入门教程

4. 用bookshelf来作为数据库的orm

数据库我使用postgresql,而bookshelf才比较像rails的active_record。

const knex = require('knex')({
  client: 'pg',
  searchPath: 'public',
  connection: {
    host : '127.0.0.1',
    user : 'hfpp2012',
    password : '',
    database : 'tspd_dev'
  }
});

const bookshelf = require('bookshelf')(knex);

const Repo = bookshelf.Model.extend({
  tableName: 'regional_designs'
});

const Koa = require('koa');
const app = new Koa();

// 路由
const Router = require('koa-router');
const router = new Router({
  prefix: '/api'
});

// promise写法
router.get('/', function (ctx, next) {
  // new Repo({name: 'New Article', created_at: '2016-11-01T03:30:48.351Z', updated_at: '2016-11-01T03:30:48.351Z'}).save().then(function(model) {
  // });
  return Repo.where('id', 1).fetch().then((json) => {
    ctx.body = json;
  })
});

5. koa-views结合nunjucks作为模版引擎

koa-views作为koa的插件,支持koa2,它能够支持绝大多数nodejs的模版引擎,而我喜欢用nunjucks作模版引擎。

类似这样:

var views = require('koa-views');

// Must be used before any router is used
app.use(views(__dirname + '/views', {
  map: {
    njk: 'nunjucks',
    html: 'ejs'
  }
}));

router.get('/views', function (ctx, next) {
  // return next().then(() => {
  //   ctx.render('basic.ejs')
  // })
  ctx.state = {
    session: this.session,
    title: 'app',
    username: 'hfpp2012'
  };
  // return ctx.render('basic.html')
  return ctx.render('test.njk')
});

test.njk文件内容为:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title></title>
</head>
<body>
{% block header %}
This is the default content
{% endblock %}

<section class="left">
  {% block left %}{% endblock %}
</section>

<section class="right">
  {% block right %}
  This is more content
  {% endblock %}
</section>
</body>
</html>

6. 开发环境使用nodemon作为启动服务

nodemon可以修改完文件之后自动重启服务。

安装

npm install -g nodemon

7. 使用koa-logger来记录日志

koa默认没啥日志,[koa-logger]又支持koa2,所以用它来显示日志。

// 日志
const logger = require('koa-logger');
app.use(logger());

8. 用koa-router来作为路由控件

写一个应用,总要暴露路由给人用。koa-router支持koa2,又比较好用。

// 路由
const Router = require('koa-router');
const router = new Router({
  prefix: '/api'
});

router.post('/regional_design/repos.json', function (ctx, next) {
  let json = {"id":11,"name":"新的药库","pos_x":null,"pos_y":null,"parent_id":null,"drug_id":null,"created_at":"2016-12-23T03:16:58.728Z","updated_at":"2016-12-23T03:16:58.728Z"};
  ctx.body = json;
});

router.get("/regional_design/repos/:id(\\d+).json", function (ctx, next) {
  let json = {"name":"西药库","type":"RegionalDesign::Repo","children_object_type":"drug_repo","children":[{"id":5,"name":"药库","initialPos":{"x":73,"y":54}},{"id":6,"name":"药库","initialPos":{"x":276,"y":120}}]};
  ctx.body = json;
});

9. 使用koa-send发送静态文件

有时候需要直接提供html文件,或js css静态文件,在生产环境下可能可以直接使用nginx来读取,但是在开发环境下也可以用koa-send跟生产环境下保持一致。

var send = require('koa-send');

app.use(async function (ctx, next){
  await send(ctx, ctx.path, { root: __dirname + '/public' });
})

10. koa2的三种函数写法

第一种是最常见的写法,使用promise。

// promise写法
router.get('/', function (ctx, next) {
  // new Repo({name: 'New Article', created_at: '2016-11-01T03:30:48.351Z', updated_at: '2016-11-01T03:30:48.351Z'}).save().then(function(model) {
  // });
  return Repo.where('id', 1).fetch().then((json) => {
    ctx.body = json;
  })
});

第二种使用co库的写法:

// co写法
const co = require('co');

router.get('/', co.wrap(function *(ctx, next) {
  ctx.body = yield Repo.where('id', 1).fetch();
}));

第三种:async/await写法

router.get('/', async (ctx, next) => {
  ctx.body = await Repo.where('id', 1).fetch();
});

最后一种写法需要用babel来转化源码,转成node可以读取的代码。

使用babel-plugin-transform-async-to-generator这个插件就可以转化。

// .babelrc
{
  "plugins": ["transform-async-to-generator"]
}
// package.json
"scripts": {
    "start": "nodemon index.js",
    "build": "babel index.js --out-file main.js",
    "babel-start": "nodemon --exec babel-node index.js"
  },

11. 使用shipit和pm2来部署应用

shipit是全自动化部署脚本,有点类似于ruby的capistrano,使用它,以后只要一行命令就可以自动完成部署。

在生产环境下使用pm2来管理nodejs的进程。

部署脚本示例:

// shipitfile.js
module.exports = function (shipit) {
  require('shipit-deploy')(shipit);
  require('shipit-npm')(shipit);
  require('shipit-shared')(shipit);
  // require('shipit-db')(shipit);
  // require('shipit-assets')(shipit);

  shipit.initConfig({
    default: {
      workspace: './.deploy_build',
      deployTo: '/home/hfpp2012/koa-app-start',
      repositoryUrl: 'git@git.oschina.net:hfpp2012/koa-app-start.git',
      branch: 'master',
      ignores: ['.git', 'node_modules'],
      rsync: ['--del'],
      keepReleases: 2,
      shallowClone: true,
      shared: {
        overwrite: true,
        dirs: ['public/uploads'],
        files: ['database.json',
          {
            path: 'database.json',
            overwrite: false,
            chmod: '755',
          }
        ]
      }
    },
    production: {
      servers: 'hfpp2012@koa.rails365.net'
    }
  });

  shipit.task('install-db-migrate', function () {
    return shipit.remote('sudo npm install -g db-migrate');
  });

  shipit.task('db-migrate', function () {
    return shipit.remote('cd /home/hfpp2012/koa-app-start/current && db-migrate up -e prod');
  });

  shipit.on("published", function(){
    shipit.start("db-migrate");
  });

  require('shipit-pm2')(shipit);

  // shipit.task('pm2', function () {
  //   return shipit.remote('cd /home/hfpp2012/koa-app-start/current && pm2 startOrRestart ./app.json --env production');
  // });
};

以后可以使用一行命令来部署:

shipit production deploy

参考资料:使用Shipit+Gulp+PM2+Nginx自动部署Nodejs应用

nginx配置示例如下:

upstream my_nodejs_upstream {
    server 127.0.0.1:3001;
    keepalive 64;
}

server {
    listen 80;
    server_name koa.rails365.net;
    root /home/hfpp2012/koa-app-start/current/public;

    try_files $uri/index.html $uri @koa;
    location @koa {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_max_temp_file_size 0;
        proxy_pass http://my_nodejs_upstream;
        proxy_redirect off;
        proxy_read_timeout 240s;
    }
}

参考链接:

完结。

本站文章均为原创内容,如需转载请注明出处,谢谢。

0 条回复
暂无回复~~
喜欢

© Rails365 | 隐私条款 | 服务条款 | 粤ICP备15004902号 | 在线学员:23

Top