NodeJS 模块开发及发布详解分享

 更新时间:2012年03月07日 07:58:33   作者:  
NodeJS 是一门年轻的语言,扩展模块并不太全,经常我们想用某个模块但是却找不到合适的
比如前两天我需要使用hmac和sha1来做签名,就没有找到一个比较好用的模块,这时候就需要我们自己来实现相应的功能了。自己写完之后,再把它打包成一个模块分享给大家来用,即方便了其他人,又能让自己有点小小的成就感,实在是一件一举多得的好事情。接下来,我就为大家介绍一下如何封装一个NodeJS模块并把它分享给其他人。

NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。

接下来,我们做一个非常简单的模块 “hello”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其官方网站都有介绍,这里就不再多说了。

首先,我们创建一个名为”hello”的目录,作为模块的主目录。进入该目录,开始我们的工作。

然后,写模块的核心代码,很简单,只有以下三行:
复制代码 代码如下:

exports.Hello = function ( name ) {
console.log( "Hello " + name );
}

把它保存为 hello.js。

NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。

我们可以在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:
复制代码 代码如下:

$ npm init
Package name: (hello) //模块名字,npm init会自动取当前目录名作为默认名字,这里不需要改,直接确认即可
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号,这个大家按自己习惯来定就可以
Project homepage: (none) //模块的主页,如果有的话可以填在这里,也可以不填
Project git repository: (none) //模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库
Author name: Elmer Zhang //模块作者名字
Author email: (none) freeboy6716@gmail.com //模块作者邮箱
Author url: (none) http://www.elmerzhang.com //模块作者URL
Main module/entry point: (none) hello.js //模块的入口文件,我们这里是hello.js
Test command: (none) //测试脚本,选填
What versions of node does it run on? (~v0.5.7) * //依赖的node版本号,我们这个脚本可以运行在任何版本的node上,因此填 *
About to write to /home/elmer/hello/package.json
// 以下是生成的package.json文件内容预览
{
"author": "Elmer Zhang <freeboy6716@gmail.com> (http://www.elmerzhang.com)",
"name": "hello",
"description": "A example for write a module",
"version": "0.0.1",
"repository": {
"url": ""
},
"main": "hello.js",
"engines": {
"node": "*"
},
"dependencies": {},
"devDependencies": {}
}
Is this ok? (yes) //对以上内容确认无误后,就可以直接回车确认了

到此为止,我们这个模块就写完了。这时hello目录下应该有两个文件:hello.js和package.json。

我们可以返回到hello的上级目录,来测试安装一下这个模块:
复制代码 代码如下:

$ npm install hello/
hello@0.0.1 ./node_modules/hello

显示安装成功。简单的测试一下:
复制代码 代码如下:

$ node
> var Hello = require('hello').Hello;
> Hello('world');

Hello world正确输出了”Hello world”。

接下来我们把它发布到NPM上。

首先,我们需要有一个NPM帐号,可以使用npm adduser来注册一个:
复制代码 代码如下:

$ npm adduser
Username: elmerzhang
Password:
Email: freeboy6716@gmail.com

简单三步,一个NPM用户注册成功。

最后回到 hello 根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去 http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest Updates”一栏里了。

至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。

相关文章

  • JS搜狐面试题分析

    JS搜狐面试题分析

    这篇文章主要介绍了JS搜狐面试题,涉及javascript数组、字符串及面向对象程序设计相关技巧,需要的朋友可以参考下
    2016-12-12
  • javascript中的this作用域详解

    javascript中的this作用域详解

    这篇文章主要介绍了javascript中的this作用域详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • js图片实时加载提供网页打开速度

    js图片实时加载提供网页打开速度

    没必要一开始加载就要把全部图片加载出来,这样子打开网面的速度得到了很好提高,下面有个不错的思路,大家可以看看
    2014-09-09
  • PHP+jQuery+Ajax+Mysql如何实现发表心情功能

    PHP+jQuery+Ajax+Mysql如何实现发表心情功能

    这篇文章通过php+jquery+ajax+mysql相结合,实现当用户浏览网站文章或者是论坛帖子后,想表达自己浏览后的心情,发表自己的感受,很多网站都提供了用户发表心情的功能,通过此功能可以很直观的分析文章或者是论坛对浏览者的用户体验度
    2015-08-08
  • 使用dynatrace-ajax跟踪JavaScript的性能

    使用dynatrace-ajax跟踪JavaScript的性能

    DynaTrace 致力于分析后台应用性能的表现已经好几年了,最近,他们通过发布dynaTrace Ajax Edition进入了前端性能分析领域. 它是一个运行在IE下的BHO免费工具. 虽然我喜欢Firefox和它下面的所有插件,但我知道基于IE的测试和调试也是很重要的。
    2010-04-04
  • 五种js判断是否为整数类型方式

    五种js判断是否为整数类型方式

    这篇文章主要介绍了五种JavaScript判断是否为整数类型方式,需要的朋友可以参考下
    2015-12-12
  • 给网页加个彩色窗口

    给网页加个彩色窗口

    给网页加个彩色窗口...
    2006-07-07
  • JavaScript中isPrototypeOf函数作用和使用实例

    JavaScript中isPrototypeOf函数作用和使用实例

    这篇文章主要介绍了JavaScript中isPrototypeOf函数作用和使用实例,本文讲解了它的作用和使用方法以及使用实例,需要的朋友可以参考下
    2015-06-06
  • JavaScript实现隐藏省略文字效果的方法

    JavaScript实现隐藏省略文字效果的方法

    这篇文章主要介绍了JavaScript实现隐藏省略文字效果的方法,涉及javascript基于事件响应实现页面字符串元素的获取、截取、设置等相关操作技巧,需要的朋友可以参考下
    2017-04-04
  • js实现用户输入的小写字母自动转大写字母的方法

    js实现用户输入的小写字母自动转大写字母的方法

    下面小编就为大家带来一篇js实现用户输入的小写字母自动转大写字母的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01

最新评论