KoaHub.js:使用ES6/7特性开发Node.js框架

NUANUAA 发布于 2016/09/21 10:59
阅读 367
收藏 0

介绍

 

KoaHub.js -- 基于 Koa.js 平台的 Node.js web 快速开发框架。可以直接在项目里使用 ES6/7Generator Function, Class, Async & Await)等特性,借助 Babel 编译,可稳定运行在 Node.js 环境上。

 

//base controller, admin/controller/base.controller.js

export default class extends koahub.http{

 

    constructor() {

        super();

        console.log('base constructor');

    }

 

    isLogin() {

        console.log('base isLogin');

    }

}

 

//index controller, admin/controller/index.controller.js

import base from "./base.controller";

export default class extends base{

 

    constructor() {

        super();

        console.log('index constructor');

    }

 

    index() {

        super.isLogin();

        super.json({msg: 'this is a msg'});

        console.log('index index');

    }

}

项目中可以使用 ES6/7 里的所有特性,借助 Babel 编译,可以稳定运行在 >=0.12.0 Node.js 环境中。

组件1

koahub-loader

Installation

$ npm install koahub-loader

Use with koa

 

 // 1.model loader

 var model = loader([

 {

     root: './app/model',

     suffix: '.model.js'

 },

 {

     root: './addon',

     suffix: '.model.js',

     filter: [/\w*\/model\//]

 }

 ]);

 

 // 2.controller loader

 var app = require('koa')();

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

 var controller = loader([

 {

    root: './app/controller',

    suffix: '.controller.js',

    prefix: '/',

 }, {

    root: './addon',

    suffix: '.controller.js',

    prefix: '/addon/',

    filter: [/\w*\/controller\//]

 }

 ]);

 

 for (var key in controller) {

    router.use(key, controller[key].routes());

 }

 app.use(router.routes());

 

 // 3.util loader

 var util = loader([

 {

     root: './app/common',

     suffix: '.util.js'

 },

 {

     root: './addon',

     suffix: '.util.js',

     filter: [/\w*\/common\//]

 }

 ]);

 

官网:http://js.koahub.com

组件2:
koahub-skip

koahub skip middleware

koahub skip
Conditionally skip a middleware when a condition is met.

Install

npm i koahub-skip --save
Usage

With existing middlewares:

var skip = require('koahub-skip');
var serve  = require('koa-static');

var static = serve(__dirname + '/public');
static.skip = skip;

app.use(static.skip({ method: 'OPTIONS' }));
If you are authoring a middleware you can support skip as follow:

module.exports = function () {
  var mymid = function *(next) {
    // Do something 
  };

  mymid.skip = require('koahub-skip');

  return mymid;
};
Current options

method it could be an string or an array of strings. If the request method match the middleware will not run.
path it could be an string, a regexp or an array of any of those. If the request path match, the middleware will not run.
ext it could be an string or an array of strings. If the request path ends with one of these extensions the middleware will not run.
custom it must be a function that returns true / false. If the function returns true for the given request, ithe middleware will not run. The function will have access to Koa's context via this
useOriginalUrl it should be true or false, default is true. if false, path will match against ctx.url instead of ctx.originalUrl.
Examples

Require authentication for every request skip the path is index.html.

app.use(requiresAuth().skip({ path: ['/index.html', '/'] }))
Avoid a fstat for request to routes doesnt end with a given extension.

app.use(static.skip(function () {
  var ext = url.parse(this.originalUrl).pathname.substr(-4);
  return !~['.jpg', '.html', '.css', '.js'].indexOf(ext);
}));
官网:http://js.koahub.com

 


加载中
0
NUANUAA
NUANUAA
已上传https://git.oschina.net/einsqing/koahubjs
0
NUANUAA
NUANUAA
组件3:koahub-body-res koahub body res Format koa's respond json. Installation $ npm install koahub-body-res Use with koa var app = require('koa')(); var koaRes = require('koahub-body-res'); app.use(koaRes()); this.data = 'This is a body'; this.msg = 'This is a msg'; this.go = 'This is a go url'; output this.body = { code: 200, data: 'This is a body', msg: 'This is a msg' } this.body = { code: 200, data: 'This is a body', msg: 'This is a msg', go: 'This is a go url' }; 官网:http://js.koahub.com
0
NUANUAA
NUANUAA

组件3:koahub-body-res

koahub body res

Format koa's respond json.

Installation

		
$ npm install koahub-body-res

Use with koa

var app = require('koa')(); 
var koaRes = require('koahub-body-res'); 
app.use(koaRes()); 
  
this.data = 'This is a body'; 
this.msg = 'This is a msg'; 
this.go = 'This is a go url'; 
  
output 
  
this.body = { 
    code: 200, 
    data: 'This is a body', 
    msg: 'This is a msg' 

  
this.body = { 
    code: 200, 
    data: 'This is a body', 
    msg: 'This is a msg', 
    go: 'This is a go url' 
}; 

官网:http://js.koahub.com

0
NUANUAA
NUANUAA

组件4:koahub-handlebars

 

koahub-handlebars

koahub handlebars templates

Installation

$ npm install koahub-handlebars

Use with koa

 var koa = require('koa'); var hbs = require('koahub-handlebars');  var app = koa();  // koahub-handlebars is middleware. `use` it before you want to render a view  app.use(hbs.middleware({   viewPath: __dirname + '/views' }));  // Render is attached to the koa context. Call `this.render` in your middleware  // to attach rendered html to the koa response body.  app.use(function *() {   yield this.render('index', {title: 'koahub-handlebars'}); })  app.listen(3000);

Registering Helpers

Helpers are registered using the #registerHelper method. Here is an example using the default instance (helper stolen from official Handlebars docs:

hbs = require('koahub-handlebars'); hbs.registerHelper('link', function(text, url) {  text = hbs.Utils.escapeExpression(text);  url  = hbs.Utils.escapeExpression(url);   var result = '<a href="' + url + '">' + text + '</a>';   return new hbs.SafeString(result);});

Your helper is then accessible in all views by using, {{link "Google" "http://google.com"}}

The registerHelper, Utils, and SafeString methods all proxy to an internal Handlebars instance. If passing an alternative instance of Handlebars to the middleware configurator, make sure to do so before registering helpers via the koahub-handlebars proxy of the above functions, or just register your helpers directly via your Handlebars instance.

You can also access the current Koa context in your helper. If you want to have a helper that outputs the current URL, you could write a helper like the following and call it in any template as {{requestURL}}.

hbs.registerHelper('requestURL', function() {  var url = hbs.templateOptions.data.koa.request.url;  return url;});

Registering Partials

The simple way to register partials is to stick them all in a directory, and pass the partialsPath option when generating the middleware. Say your views are in ./views, and your partials are in ./views/partials. Configuring the middleware via

app.use(hbs.middleware({  viewPath: __dirname + '/views',  partialsPath: __dirname + '/views/partials'}));

will cause them to be automatically registered. Alternatively, you may register partials one at a time by calling hbs.registerPartial which proxies to the cached handlebars #registerPartial method.

Layouts

Passing defaultLayout with the a layout name will cause all templates to be inserted into the {{{body}}} expression of the layout. This might look like the following.

<!DOCTYPE html><html><head>  <title>{{title}}</title></head><body>  {{{body}}}</body></html>

In addition to, or alternatively, you may specify a layout to render a template into. Simply specify {{!< layoutName }} somewhere in your template. koahub-handlebars will load your layout from layoutsPath if defined, or from viewPath otherwise.

At this time, only a single content block ({{{body}}}) is supported.

Options

The plan for koahub-handlebars is to offer identical functionality as koa-hbs (eventaully). These options are supported now.

  • viewPath: [required] Full path from which to load templates (Array|String)

  • handlebars: Pass your own instance of handlebars

  • templateOptions: Hash of handlebars options to pass to template()

  • extname: Alter the default template extension (default: '.html')

  • partialsPath: Full path to partials directory (Array|String)

  • defaultLayout: Name of the default layout

  • layoutsPath: Full path to layouts directory (String)

  • disableCache: Disable template caching (default: '.true')

Locals

Application local variables ([this.state](https://github.com/koajs/koa/blob/master/docs/api/context.md#ctxstate)) are provided to all templates rendered within the application.

app.use(function *(next) {  this.state.title = 'My App';  this.state.email = 'me@myapp.com';  yield next;});

The state object is a JavaScript Object. The properties added to it will be exposed as local variables within your views.

<title>{{title}}</title> <p>Contact : {{email}}</p>

Thanks

koa-hbs

Differents

  1. Configuration file incremental changes

  2. Modify some of the features and the default configuration

  3. ...

 

官网:http://js.koahub.com

返回顶部
顶部