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


Posted in NodeJs onMarch 07, 2012

比如前两天我需要使用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来安装你的模块了。

NodeJs 相关文章推荐
轻松创建nodejs服务器(9):实现非阻塞操作
Dec 18 NodeJs
浅析Nodejs npm常用命令
Jun 14 NodeJs
nodejs redis 发布订阅机制封装实现方法及实例代码
Dec 15 NodeJs
简单实现nodejs上传功能
Jan 14 NodeJs
nodeJs链接Mysql做增删改查的简单操作
Feb 04 NodeJs
详解nodejs中exports和module.exports的区别
Feb 17 NodeJs
使用nodejs爬取前程无忧前端技能排行
May 06 NodeJs
Nodejs 和 Electron ubuntu下快速安装过程
May 04 NodeJs
nodejs 使用 js 模块的方法实例详解
Dec 04 NodeJs
NodeJS 文件夹拷贝以及删除功能
Sep 03 NodeJs
NodeJS http模块用法示例【创建web服务器/客户端】
Nov 05 NodeJs
linux 下以二进制的方式安装 nodejs
Feb 12 NodeJs
golang、python、php、c++、c、java、Nodejs性能对比
Mar 12 #NodeJs
PHPStorm 2020.1 调试 Nodejs的多种方法详解
Sep 17 #NodeJs
nodejs实用示例 缩址还原
Dec 28 #NodeJs
nodejs 后缀名判断限制代码
Mar 31 #NodeJs
NodeJS框架Express的模板视图机制分析
Jul 19 #NodeJs
用nodejs访问ActiveX对象,以操作Access数据库为例。
Dec 15 #NodeJs
nodejs入门详解(多篇文章结合)
Mar 07 #NodeJs
You might like
php session 预定义数组
2009/03/16 PHP
smarty模板引擎从php中获取数据的方法
2015/01/22 PHP
详解WordPress中用于更新和获取用户选项数据的PHP函数
2016/03/08 PHP
PHP生成静态HTML文档实现代码
2016/06/23 PHP
PHP入门教程之PHP操作MySQL的方法分析
2016/09/11 PHP
PHPExcel实现表格导出功能示例【带有多个工作sheet】
2018/06/13 PHP
JavaScript去掉数组中的重复元素
2011/01/13 Javascript
js精度溢出解决方案
2012/12/02 Javascript
JavaScript实现复制功能各浏览器支持情况实测
2013/07/18 Javascript
Javascript设置对象的ReadOnly属性(示例代码)
2013/12/25 Javascript
JS对象的深度克隆方法示例
2017/03/16 Javascript
NodeJs入门教程之定时器和队列
2019/03/08 NodeJs
Vue+Element-UI实现上传图片并压缩
2019/11/26 Javascript
Node.js API详解之 repl模块用法实例分析
2020/05/25 Javascript
javascript实现倒计时关闭广告
2021/02/09 Javascript
[01:03:51]2018DOTA2亚洲邀请赛 4.7 淘汰赛 VP vs LGD 第三场
2018/04/09 DOTA
[10:53]2018DOTA2国际邀请赛寻真——EG
2018/08/11 DOTA
python标准日志模块logging的使用方法
2013/11/01 Python
Python发送以整个文件夹的内容为附件的邮件的教程
2015/05/06 Python
python下载文件记录黑名单的实现代码
2017/10/24 Python
Python实现Kmeans聚类算法
2020/06/10 Python
Python定时发送消息的脚本:每天跟你女朋友说晚安
2018/10/21 Python
Django CBV类的用法详解
2019/07/26 Python
python实现一个函数版的名片管理系统过程解析
2019/08/27 Python
如何使用Python抓取网页tag操作
2020/02/14 Python
python查找特定名称文件并按序号、文件名分行打印输出的方法
2020/04/24 Python
Python模拟登录requests.Session应用详解
2020/11/17 Python
Python应用自动化部署工具Fabric原理及使用解析
2020/11/30 Python
python实现ping命令小程序
2020/12/28 Python
Matplotlib配色之Colormap详解
2021/01/05 Python
python 将Excel转Word的示例
2021/03/02 Python
Douglas意大利官网:购买香水和化妆品
2020/05/27 全球购物
工程建设实施方案
2014/03/14 职场文书
企业宣传工作方案
2014/06/02 职场文书
庆元旦主持词
2015/07/06 职场文书
优化经济发展环境工作总结
2015/08/11 职场文书