Skip to content

Latest commit

 

History

History
158 lines (109 loc) · 3.36 KB

README_zh.md

File metadata and controls

158 lines (109 loc) · 3.36 KB

MySrv

Mysrv 是 "My Server" 的缩写，是一款基于Koa2的Node.js MVC框架。

该框架尚在测试开发中， 请慎用

功能特色

  • 支持 Express 式 URL 路由

  • 模块化开发 将一个页面拆分为多个子模块，加载子模块时会执行完整的action，不是仅仅是include模版

  • 默认使用 Nunjucks 作为模版引擎

  • 基于Koa2，使用 async/await 写出同步代码，拒绝地狱式回调

  • 易扩展

    支持自定义中间件(middleware)，插件

安装

npm install mysrv

项目结构

--assets/
	-css/
	-js/
	-favicon.ico
--components/
	-contollers/
	-middlewares/
	-models/
	-plugins/
	-services/
--tasks/
--config/
--views/
--app.js

示例

Controller

class IndexController {

    /**
     * default welcome page
     * 默认首页
     */
    index() {

        this.render({title: 'Hello'}); //渲染模版，第一个参数传递的数据，可以在模版直接使用
    }

    /**
     * convenient action annotation
     * 方便的action注解指令
     * 下面action映射的URL为 '/user/login'，并且只允许POST请求
     */
    async login($method = 'POST', $url='/user/login') {
    	
    	//使用async/await 拒绝地狱式回调
    	const resultModel = await this.userService(this.params.userName, this.params.pass);
       	
       	if(resultModel.success) {
          ...
       	}else{
          ...
       	}
       	
       	this.render(null, {layout: 'login'}); //使用名称为 "login" 的布局文件
    }
    
    /**
    * Output JSON
    */
    api() {
      
      // 不渲染模版。直接输出Json数据
      this.json({
      	data: 'Hello Mysrv'
      });
    }
}

module.exports = IndexController;

视图

在action中调用 this.render() 开始模版渲染流程。如果在模版中调用 {% render "index:child %} 会渲染子模版，并返回渲染后的HTML。注意{% render "index:child %}不仅仅只是将其渲染后的HTML包含进来，它会执行完整的 action !

view.html

<div>
	{% render "index:child %}
</div>

上面完成了view.html模版的渲染后，还不能直接返回给浏览器，他不是完整的HTML。下面还要渲染 Layout 布局模版，{{ view}} 会替换为上面的 view.html渲染后的内容，这样 view.html 和 layout.html拼接起来才是一个完整的HTML 页面。

layout.html

<head>
    <title>{{ title }}</title>
    ...
</head>
<body>
    {% render "layout:header" %}

    <div class="container">
    
        {{ $view }}
    
    </div>
    
    {% render "layout:footer" %}
</body>
</html>

布局模版 顾名思义，即定义一个HTML的基本结构。如一个网站的头部、尾部每个页面基本相同，只是中间内容在发生变化，这些公用的部分就应该放在__布局模版__中，以减少重复代码，主模版就只是中间变化的这部分内容。

布局模版默认是开启的，如果你的主模版(如上面的view.html)已经包含完整的HTML，不想拼接布局模版，通过设置this.render 第二个参数 layout = null 来关闭布局模式。即 this.render(data, {layout: null})。

演示程序

安装 Mysrv 及依赖

$ git clone https://github.com/k1995/mysrv.git
$ cd mysrv
$ npm install

进入 examples 目录，然后执行任意示例

$ cd examples
$ node hello