Atom官方博客

Nodejs开发框架Express搭建及使用详细记录说明(一)

atom-ls Nodejs开发框架Express

最近接手一个小项目,因为涉及到用身份证信息去请求第三方的数据库,因此需要用Express搭建一个本地的Server,然后身份证信息直接上传到本地,进行hmac256加密后再请求第三方数据,当然公司要求只是先写一个简单的demo,功能相对简单。之前也没用过Express的框架,不过用了之后发现还是比较好用的.

本次开发系统环境

Win7 64bit
Nodejs: 6.10.2
Npm: 3.10.10

安装及搭建Express框架

    -- 搭建的前提是已经安装了Nodejs(自带npm包管理工具)。

1.首先,我们需要安装express库。在Express3.6.x之前的版本,Express需要全局安装,项目构建器模块是合并在Express项目中的, 后来这个构建器被拆分出来,独立成为了一个项目express-generator,现在我们只需要全局安装express-generator项目就好。

npm install -g express-generator

2.安装好express-generator包,让我们在命令行使用一下Express命令,这里是4.15.2版本

express -V #大写的V

3.接下来让我们用命令来搭建项目,进入需要创建项目的文件夹下,我们现在就直接在demo9文件下创建项目,放置项目的文件夹名称叫做expressDemo

express -e expressDemo #expressDemo为自定义的文件夹名称

4.运行 cd expressDemo && npm install (切换到expressDemo文件下并安装所需要的依赖包)

注意,运行完该命令,已经切换到expressDemo目录下面咯

5.启动项目 npm start

一个最基础的欢迎界面就出来了 ^_^

这就是最基本的搭建项目了,其实相对而言不是那么复杂,Express框架帮我们处理了大部分依赖包的选择,切换目录以及一些配置文件的设置,也都配置好了,老版本的express可能还存在express-generator和express不匹配的问题,找到问题在app.js文件中,注释 //var users = require(‘./routes/users’); //app.use(‘/users’, users); 当然,本人没遇到这样的问题…

目录结构

接下来咱们来点深入的,了解一下项目的结构

  • bin, 存放启动项目的脚本文件
  • node_modules, 存放所有的项目依赖库(这里比较多,就没展开了哈)
  • public,静态文件(css,js,img)
  • routes,路由文件(MVC中的C,controller)
  • views,页面文件(Ejs模板)
  • package.json,项目依赖配置及开发者信息
  • app.js,应用核心配置文件

package.json 和 bin/www

这里主要看 scripts 的设置,这里其实相当于express框架帮我们自定义了启动命令叫做npm start ,它实际上的指令是 node ./bin/www

那么bin文件下面的www又有什么内容呢?

我们来看一下

www文件也是一个node的脚本,用于分离配置和启动程序。需要注意的,已经在图上用红框框出,是express帮我们封装的监听网络服务端口以及一些异常处理,主要还是基于nodejs中http模块。对于我们而言,一般改动不大,要注意的一点是port那里,如果放在服务器上,配置是则是环境的端口,不过这个本人未实践,还不太清楚,如果各位感兴趣,可自行去了解一下;本地端口默认是3000,可能存在被占用的情况,可以在此处进行更改

app.js 核心文件

关于核心文件,express最主要的配置都在这里,我这里直接把自己项目里的配置放在这里吧,并且已经有中文注释,其中users已经删除,因为本人项目中并没有用到,还有就是app.use(‘/’,index),因为主要内容都是在index中设置。

//加载依赖模块

var express = require('express');

var path = require('path');

var favicon = require('serve-favicon');

var logger = require('morgan');

var cookieParser = require('cookie-parser');

var bodyParser = require('body-parser');

// 加载路由控制,这里是主要的,因为本人本次的项目主要都是在index.js中设置的

var index = require('./routes/index');

// 创建项目实例

var app = express();

// 定义EJS模板引擎和模板文件位置,也可以使用jade或其他模型引擎

app.set('views', path.join(__dirname, 'views'));

//这里设置引擎可以更改,也可以更改为html

app.set('view engine', 'ejs');

// 定义icon图标,这里需要将ico文件放在public下面,不然每次还是会报not found错误,不过不用管它

//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));

// 定义日志和输出级别

app.use(logger('dev'));

// 定义数据解析器

app.use(bodyParser.json());

app.use(bodyParser.urlencoded({ extended: false }));

// 定义cookie解析器

app.use(cookieParser());

// 定义静态文件目录

app.use(express.static(path.join(__dirname, 'public')));

//定义引用第三方包目录

app.use(express.static(path.join(__dirname,'node_modules')));

// 匹配路径和路由,这里是应用

app.use('/', index);

// 404错误处理

app.use(function(req, res, next) {

  var err = new Error('Not Found');

  err.status = 404;

  next(err);

});

// 报错处理

app.use(function(err, req, res, next) {

  // set locals, only providing error in development

  res.locals.message = err.message;

  res.locals.error = req.app.get('env') === 'development' ? err : {};

  // render the error page

  res.status(err.status || 500);

  res.render('error');

});

module.exports = app;

简单说一下 public 下面的文件

public下面是一些静态文件以及在最前端的一些交互体验,由于在app.js中已经定义静态文件目录是从public文件夹开始,定义引用第三方包目录是从node_modules开始,因此我们在引用静态文件的时候,可以省略public以上的路径,同样引用第三方包的时候,也可以直接省略node_modules以上的路径。还是看图更直观(node_modules太长没截图,是同样的道理)

当然public里面对于静态文件的处理比较有优势的一点就是类似模版的功能,可以相互拼接,提取功能的部分,分别保存,然后再单独设置不同的核心部分,这样对于核心部分的代码维护,简洁,易维护。 我们把index.ejs页面切分成3个部分:header.ejs, index.ejs, footer.ejs,用于网站页面的模块化

这样的话,核心部分的代码就只有index一部分了,当然这个模块的划分也完全可以根据你自己的需求来,如果每个模块你需要引用不同的js或者css,你完全可以划分到link之前,或者script之前.

那么问题来了,如果我点击之后要跳转到其它页面怎么办呢?这个就设计到路由的问题了,我们进到下一部分

路由功能 (get and post)

关于路由,其实app.js中已经设置了,再回过头来看一下

// 加载路由控制,这里是主要的,因为本人本次的项目主要都是在index.js中设置的

var index = require('./routes/index');

// 匹配路径和路由,这里是应用

app.use('/', index);

那么就需要在index.js里面进行设置了,在这里之前,我们先要做一些事情 - 在index.ejs做一下链接的设置,只是样式的设置,至于怎么跳转,我们后续再说

  • 增加一个details的页面,简单设置一个就好

好啦,接下来我们设置index.js,一切尽在图上(快结束了吧,好长~)

//引入依赖的模块
var express = require('express');
var router = express.Router();

/* 设置跳转到index模块 */
router.get('/', function (req, res, next) {
  //注意这里,render是指渲染哪个views,这里渲染的是index.ejs(后缀不用写),
  //后面紧接的对象是需要传过去的内容,这里是可以动态设置的
  res.render('index', {
    title: 'Express'
  });
});

//接下来让我们自己设置跳转到details
router.get('/details', (req, res, next) => {
  res.render('details', {
    title: '详情页面',
    details: '这是details页面,点击下面会有更精彩的哦'
  })
})

//导出router
module.exports = router;

然后我们重启一下命令行,ctrl+c 2次,停止,然后npm start 重启,在浏览器地址栏输入localhost:3000,如图

我们点击这里跳转

注意红框内的变化

那么又有个问题,有没有必要每次都重新写一个页面呢?

完全没必要,我们可以重复渲染,再动态填充加载内容,这也是每次加载传参的好处,我们再来修改,增加一个新的路由,但是还是借用index.ejs的模版内容

//这个是新路由,但是渲染的还是index.ejs的模版,只不过传参有所改变

router.get('/more',(req,res,next)=>{
  res.render('index',{
    title:'这是更多页面,不是首页'
  })
})

命令行重启一下,然后我们再来看一下,点击details下面链接跳转的more页面

当然以上介绍的主要都是get方法,下面介绍一下post方法

post方法

其实post方法和get方法差不多,post方法也是router.post(路由地址,(req,res,next)=>{}),只不过在传参问题上,前端通过form表单或者ajax传递参数过来,express通过req.body获取对应的参数,如果是提交一些参数的话,我们可以在index.ejs里增加一个表单

<form action='/details' method='post'> 
    <input type='text' name='name' value='fred'> 
    <input type='text' name='tel' value='0926xxx572'> 
    <input type='submit' value='Submit'> 
</form>

同时在index.js页面设置路由方法

//设置post方法的路由
router.post('/details',(req,res,next)=>{
  res.render('details', {
    title: '详情页面',
    details: '这是details页面,点击下面会有更精彩的哦'
  })
  //后台打印参数
  console.log('req.body--->',req.body);
})

显示index页面如图

点击submit提交,会跳转到details页面

后台打印结果如图

不过要注意,前端如果上传的是文件file,那么express接收的是req.files,另外还涉及到form表单刷新提交(即上面的form表单提交)和无刷新提交(ajax方法),关于这个问题,后续有空再写一篇博客吧;

然后就可以在后台进行其它后续的操作了,比如:

  • 转发,加密后,请求远端的服务器,需加载request模块,调用request.post方法

  • 返回前端数据,res.send()

  • …

好啦,今天就先码到这里吧,本人也是初次使用express框架,感觉还是比较好用的,这次博客还没写完,下一篇具体,讲解一下post方面中表单提交及文件处理的部分,这也是本人这次项目中的一些难点,也涉及到一些开发环境的问题。

码字不易,如果各位需要转载,请注明出处,谢谢!也欢迎各位如果有问题,大家可以交流交流,wechat:13666882100;

参考资料:

张丹的粉丝日志:http://blog.fens.me/nodejs-express4/

官网:http://www.expressjs.com.cn/

atom-ls
耕读者,我们都在成为更好的自己