美文网首页Web前端之路让前端飞
(二)CommonJS规范与模块化

(二)CommonJS规范与模块化

作者: 间阳幕宾 | 来源:发表于2017-11-28 08:13 被阅读546次

在之前的学习中我们使用require()来引入我们需要的包,这其实就是模块化,各模块相互独立,可以通过某种方式引入别的模块。而这些引入方式都是遵循一定的规范的,这就是CommonJS规范。

一、Commonjs规范

目前JS标准定义的API是为了构建基于浏览器的应用程序,没有制定一个用于更广泛的应用程序的标准库。CommonJS规范致力于提供一个类似java、python等语言的标准库,使JS可以开发服务器端应用程序、命令行工具、桌面图形界面应用程序

二、Nodejs中的模块化

Node应用程序由各种模块组成,采用CommomJS模块规范。

1、模块分类

Nodejs中模块分为两类,一类是由Node提供的核心模块;另一类是由用户编写的文件模块。

核心模块

核心模块在Node源代码的编译过程中被编译进了二进制文件。在Node进程启动时,核心模块会被直接加载进内存,所以在引入这些核心模块时,文件定位和编译执行这两步可以省略。并且在路径分析中优先判断,所以它的加载速度是最快的。HTTP模块、URL模块、fs模块都是Node内置的核心模块,可以直接引用。

文件模块

文件模块则是在运行时动态加载,需要完整的路径分析、文件定位、编译执行过程,速度相比核心模块稍微慢一些,但是用处非常多。这些模块需要我们自己定义,下面我们来看一下自定义模块。

2、自定义模块

我们把公共的功能抽成一个单独的js文件作为一个模块,默认情况下外部是无法访问这个模块里的方法或者属性。如果想让外部访问模块内的属性和方法,必须在模块里通过exports或者module.exports暴露需要被外部访问的属性和方法。

在需要使用这些模块的文件中通过require引入该模块。这样就可以使用这个模块里暴露的属性和方法。

定义模块,暴露属性或方法

//tools.js

var tools = {
    name:'Node'
    sayHello:function () {
        return 'Hello NodeJs';
    }
}

//暴露属性或方法
//module.exports = tools;
    
exports.add = tools.name;
exports.sayHello = tools.sayHello;

在别的文件里引入模块

//引入自定义模块
var tools = require('./tools');

//使用该模块里暴露的方法
tools.name;            //  Node
tools.sayHello();      //  Hello NodeJs

3、第三方模块

Nodejs中也可以使用第三方模块,Nodejs中第三方模块由包组成,包又包含若干模块,通过包来对一组具有相互依赖关系的模块进行统一管理。

完全符合CommonJs规范的包目录一般包含如下这些文件:

  • package.json:包描述文件
  • bin:用于存放可执行二进制文件的目录
  • lib:用于存放Javascript代码的目录
  • doc:用于存放文档的目录

我们使用npm安装第三方模块

npm install silly-datetime -Save

安装完npm后我们就可以使用这个包了:

var sd = require('silly-datetime');
sd.format(new Date(),'YYYY-MM-DD-HH:mm');

三、npm

1、什么是npm

npm全称Node Package Manager,是Node.js的包管理器。可以使用它在Node.js应用程序中创建、共享和重用模块。

模块就是可重用的代码库。比如用来与数据库交互的模块、支持web开发的模块以及通过web套接字协助通信的模块。

2、使用npm安装模块

安装模块有两种方式:本地安装、全局安装

本地安装

本地安装模块意味着模块会被安装在项目内名为node_modules的文件夹中,而且它只可以在该项目中使用。这是推荐的安装方式。

使用下列命令开始安装模块:

npm install [module_name]

这个命令意思是向服务器发送一个请求,将该模块的最新版本下载到计算机上。当模块下载成功后会有下列语句输出:

module_name@1.2.0 ./node_modules/module_name

这行输出告诉我们模块的名称、版本以及下载的位置。

全局安装

全局安装意味着该模块可在系统的任意地方使用。其他与本地安装一致。与本地安装稍有不同的是全局安装需要加上-g:

npm install [module_name] -g

3、使用模块

要在Node.js应用程序中使用模块,必须将其引入应用程序中,引入方法如下:

var module = require('module');

我们把它赋值给一个变量,以便于在以后使用这个模块。

4、查找模块文档

有时候我们需要查看模块文档,可以使用一下命令:

npm docs [module_name]

这个命令必须在Node.js项目文件夹的根目录下运行,并且该模块已经下载到了node_modules文件夹下。

5、使用package.json指定依赖关系(dependency)

npm允许开发人员使用package.json文件来指定在应用程序中要使用的模块,并且通过单个命令来安装它们:

npm install

这样做的好处有下列三点:

  • 无需一个个安装模块
  • 其他开发人员可以容易的安装你的应用程序
  • 应用程序的依赖存储在单一的地方

一个最小的package.json文件是这样的:

{
    "name":"example1",
    "version":"0.0.1",
    "dependencies":{
        "underscore":"~1.2.1"
    }
}

相关文章

  • Js 模块

    AMD,CMD,CommonJS是目前最常用的三种模块化书写规范。 CommonJS CommonJS规范是诞生比...

  • JS模块化

    模块化规范:CommonJS,AMD,CMD,UMD,ES6 Module CommonJS CommonJS是服...

  • 前端工程化的一些理解

    一、模块化 主要是js模块化,可以使用CommonJS、AMD、CMD等模块化规范,其中的区别是CommonJS对...

  • webpack基础

    模块化 CommonJS CommonJS是一种使用广泛的 JavaScript模块化规范,核心思想是通过 req...

  • 模块化开发

    一提到模块化开发,就会提到 CommonJS 规范和AMD规范,这些都是模块化的依据规范, RequireJS 就...

  • Webpack原理-从前端模块化开始

    当前主流 JS 模块化方案 CommonJS 规范,nodejs 实现的规范 AMD 规范,requirejs 实...

  • js模块化

    首先梳理一下模块化的发展情况~ 无模块化-->CommonJS规范-->AMD规范-->CMD规范-->ES6模块...

  • (二)CommonJS规范与模块化

    在之前的学习中我们使用require()来引入我们需要的包,这其实就是模块化,各模块相互独立,可以通过某种方式引入...

  • JS模块化规范

    模块化规范 服务器端规范主要是CommonJS,node.js用的就是CommonJS规范。客户端规范主要有:AM...

  • webpack

    模块化: 命名冲突 文件依赖 模块化编程: 函数写法 对象写法 立即执行函数写法 CommonJS规范AMD规范 ...

网友评论

    本文标题:(二)CommonJS规范与模块化

    本文链接:https://www.haomeiwen.com/subject/ucqsbxtx.html